Skip to main content
POST
Create story highlight

Authorizations

Authorization
string
header
required

Link access token for one Sandbox, Test, or Live authorization.

x-linked-account-id
string
header
required

Selects one of the authorization's linked accounts via the x-linked-account-id header.

Headers

x-linked-account-id
string
required

The linked account to use. The user must have shared it with your app. A missing account returns linked_account_required; an account outside your access returns linked_account_not_granted.

Example:

"conn_example123"

Body

application/json
title
string
required

Story highlight title

Required string length: 1 - 100
storyIds
integer[]
required

Story IDs to include in the highlight

Minimum array length: 1
Required range: x > 0
coverStoryId
integer
required

Story ID to use as highlight cover

Required range: x > 0

Response

Successful response

cover
string
required
coverStoryId
number
required
createdAt
string
required
id
number
required
storiesCount
number
required
title
string
required
userId
number
required