Engagement
Bookmark
Bookmarks one published destination or platform-native post.
POST
header
x-api-key<token>Workspace API key, sent in the x-api-key header. Keys start with op_ and are created in the dashboard.
application/json- body
post?stringOnepostly post id or platform-native post id. Native ids also need accountId. You can omit it when you pass destinationId.
Length
1 <= lengthaccountId?stringLength
1 <= lengthdestinationId?stringDestination id. It identifies one destination on its own, so post and accountId become optional.
Length
1 <= lengthBookmarked
application/json- response
postId*stringdestinationId*stringplatform*stringkind*stringactive*booleanExample Request
import { Configuration, EngagementApi } from "@onepostly/sdk";const engagementApi = new EngagementApi( new Configuration({ apiKey: process.env.ONEPOSTLY_API_KEY }));const response = await engagementApi.bookmark({ engagementTargetBody: { "post": "1699f415-7fb6-43f4-9d2a-c447491f32a8" },});console.log(response);Example Response
{ "postId": "1699f415-7fb6-43f4-9d2a-c447491f32a8", "destinationId": "d4e5f6a7-8b9c-4d0e-8f1a-2b3c4d5e6f7a", "platform": "x", "kind": "bookmark", "active": true}