MCP tool
Cancel Threads sequence
sosoapi_cancel_threads_sequenceCancel unpublished sequence work with exact versions; preserve Drafts, accepted ids and published content.
Read as MarkdownProfiles and transports
Profiles: full · Transports: stdio, http
Choose core or full to control which tools your client sees; this does not change its permissions. Local file upload requires stdio and is unavailable over HTTP. Set SOSOAPI_OUTPUT_SCHEMAS=1 to include output schemas in discovery. Tools return structured results with or without that setting.
Permissions and side effects
Annotations help clients describe a tool. Each call still checks the user’s authentication, role, resource access and capability grants.
{
"readOnlyHint": false,
"destructiveHint": true,
"idempotentHint": true,
"openWorldHint": true
}- /studio-api/threads-sequences/cancel: agent:publish · canonical per-Post terminal outcomes; atomic admission is not publication and successful prefixes are never recreated
Input fields
Required means required inside its parent object and selected branch. A required child does not make an optional parent required. Rules and field names below are copied from the contract.
| Field / branch | Type / required | Constraints |
|---|---|---|
$ | objectRequired in parent |
|
workspace_id | stringRequired in parent |
|
id | stringRequired in parent |
|
expected_version | integerRequired in parent |
|
expected_versions | objectRequired in parent |
|
expected_versions.* | integerOptional / item |
|
Complete JSON Schema
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"id": {
"type": "string",
"format": "uuid"
},
"expected_version": {
"$ref": "#/$defs/s0"
},
"expected_versions": {
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/s0"
}
}
},
"required": [
"workspace_id",
"id",
"expected_version",
"expected_versions"
],
"additionalProperties": false,
"$defs": {
"s0": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
}
}Structured output
This schema describes structuredContent in a successful tool result. The MCP response also includes content and may set isError when a call fails. For publishing, read the post’s final result rather than treating an accepted request or text response as confirmation. The linked API operation explains permissions and retry rules.
Required means required inside its parent object and selected branch. A required child does not make an optional parent required. Rules and field names below are copied from the contract.
| Field / branch | Type / required | Constraints |
|---|---|---|
$ | objectRequired in parent |
|
sequence | objectRequired in parent |
|
sequence.workspace_id | stringRequired in parent |
|
sequence.id | stringRequired in parent |
|
sequence.social_account_id | stringRequired in parent |
|
sequence.version | integerRequired in parent |
|
sequence.state | stringRequired in parent |
|
sequence.item_count | integerRequired in parent |
|
sequence.caption_preview | stringRequired in parent |
|
sequence.created_at | stringRequired in parent |
|
sequence.updated_at | stringRequired in parent |
|
sequence.items | arrayRequired in parent |
|
sequence.items[] | objectOptional / item |
|
sequence.items[].item_id | stringRequired in parent |
|
sequence.items[].ordinal | integerRequired in parent |
|
sequence.items[].draft | objectRequired in parent |
|
sequence.items[].draft.id | stringRequired in parent |
|
sequence.items[].draft.workspace_id | stringRequired in parent |
|
sequence.items[].draft.revision | integerRequired in parent |
|
sequence.items[].draft.state | stringRequired in parent |
|
sequence.items[].draft.content | objectRequired in parent |
|
sequence.items[].draft.content.schemaVersion | numberRequired in parent |
|
sequence.items[].draft.content.accountIds | arrayRequired in parent |
|
sequence.items[].draft.content.accountIds[] | stringOptional / item |
|
sequence.items[].draft.content.caption | stringRequired in parent |
|
sequence.items[].draft.content.hashtags | stringRequired in parent |
|
sequence.items[].draft.content.assetIds | arrayRequired in parent |
|
sequence.items[].draft.content.assetIds[] | stringOptional / item |
|
sequence.items[].draft.content.threadsTextOnly | booleanRequired in parent |
|
sequence.items[].draft.content.threadsOptions | objectOptional / item |
|
sequence.items[].draft.content.threadsOptions.post_type | stringOptional / item |
|
sequence.items[].draft.content.threadsOptions.reply_to_id | stringOptional / item |
|
sequence.items[].draft.content.threadsOptions.quote_post_id | stringOptional / item |
|
sequence.items[].draft.content.threadsOptions.repost_target_id | stringOptional / item |
|
sequence.items[].draft.content.threadsOptions.reply_control | stringOptional / item |
|
sequence.items[].draft.content.threadsOptions.enable_reply_approvals | booleanOptional / item | — |
sequence.items[].draft.content.threadsOptions.link_attachment | stringOptional / item |
|
sequence.items[].draft.content.threadsOptions.poll_attachment | objectOptional / item |
|
sequence.items[].draft.content.threadsOptions.poll_attachment.option_a | stringRequired in parent |
|
sequence.items[].draft.content.threadsOptions.poll_attachment.option_b | stringRequired in parent |
|
sequence.items[].draft.content.threadsOptions.poll_attachment.option_c | stringOptional / item |
|
sequence.items[].draft.content.threadsOptions.poll_attachment.option_d | stringOptional / item |
|
sequence.items[].draft.content.threadsOptions.gif_attachment | objectOptional / item |
|
sequence.items[].draft.content.threadsOptions.gif_attachment.gif_id | stringRequired in parent |
|
sequence.items[].draft.content.threadsOptions.gif_attachment.provider | stringRequired in parent |
|
sequence.items[].draft.content.threadsOptions.text_attachment | objectOptional / item |
|
sequence.items[].draft.content.threadsOptions.text_attachment.plaintext | stringRequired in parent |
|
sequence.items[].draft.content.threadsOptions.text_attachment.link_attachment_url | stringOptional / item |
|
sequence.items[].draft.content.threadsOptions.text_attachment.text_with_styling_info | arrayOptional / item |
|
sequence.items[].draft.content.threadsOptions.text_attachment.text_with_styling_info[] | objectOptional / item |
|
sequence.items[].draft.content.threadsOptions.text_attachment.text_with_styling_info[].offset | integerRequired in parent |
|
sequence.items[].draft.content.threadsOptions.text_attachment.text_with_styling_info[].length | integerRequired in parent |
|
sequence.items[].draft.content.threadsOptions.text_attachment.text_with_styling_info[].styling_info | arrayRequired in parent |
|
sequence.items[].draft.content.threadsOptions.text_attachment.text_with_styling_info[].styling_info[] | stringOptional / item |
|
sequence.items[].draft.content.threadsOptions.topic_tag | stringOptional / item |
|
sequence.items[].draft.content.threadsOptions.text_entities | arrayOptional / item |
|
sequence.items[].draft.content.threadsOptions.text_entities[] | objectOptional / item |
|
sequence.items[].draft.content.threadsOptions.text_entities[].entity_type | stringRequired in parent |
|
sequence.items[].draft.content.threadsOptions.text_entities[].offset | integerRequired in parent |
|
sequence.items[].draft.content.threadsOptions.text_entities[].length | integerRequired in parent |
|
sequence.items[].draft.content.threadsOptions.is_spoiler_media | booleanOptional / item | — |
sequence.items[].draft.content.threadsOptions.is_ghost_post | booleanOptional / item | — |
sequence.items[].draft.content.threadsOptions.location_id | stringOptional / item |
|
sequence.items[].draft.content.threadsOptions.allowlisted_country_codes | arrayOptional / item |
|
sequence.items[].draft.content.threadsOptions.allowlisted_country_codes[] | stringOptional / item |
|
sequence.items[].draft.content.threadsOptions.crossreshare_to_ig | booleanOptional / item | — |
sequence.items[].draft.content.threadsOptions.crossreshare_to_ig_dark_mode | booleanOptional / item | — |
sequence.items[].draft.content.threadsOptions.auto_publish_text | booleanOptional / item | — |
sequence.items[].draft.content.threadsOptions.media_options | arrayOptional / item |
|
sequence.items[].draft.content.threadsOptions.media_options[] | objectOptional / item |
|
sequence.items[].draft.content.threadsOptions.media_options[].asset_id | integerRequired in parent |
|
sequence.items[].draft.content.threadsOptions.media_options[].alt_text | stringOptional / item |
|
sequence.items[].draft.content.threadsOptions.media_options[].is_spoiler_media | booleanOptional / item | — |
sequence.items[].draft.content.instagramMode | stringRequired in parent |
|
sequence.items[].draft.content.youtubeTitle | stringRequired in parent |
|
sequence.items[].draft.content.youtubePrivacy | stringRequired in parent |
|
sequence.items[].draft.content.youtubeSynthetic | booleanRequired in parent |
|
sequence.items[].draft.content.youtubeCategoryId | stringRequired in parent |
|
sequence.items[].draft.content.youtubeShort | booleanRequired in parent |
|
sequence.items[].draft.content.linkUrl | stringRequired in parent |
|
sequence.items[].draft.content.scheduledAt | stringRequired in parent |
|
sequence.items[].draft.content.displayTimezone | stringRequired in parent |
|
sequence.items[].draft.content.publishNow | booleanRequired in parent |
|
sequence.items[].draft.content.destinationOverrides | objectRequired in parent |
|
sequence.items[].draft.content.destinationOverrides.* | objectOptional / item |
|
sequence.items[].draft.content.destinationOverrides.*.caption | stringOptional / item |
|
sequence.items[].draft.content.destinationOverrides.*.scheduledAt | stringOptional / item |
|
sequence.items[].draft.content.expiresAt | stringRequired in parent |
|
sequence.items[].draft.created_by | string | nullRequired in parent | — |
sequence.items[].draft.created_byanyOf 1 | stringRequired in parent |
|
sequence.items[].draft.created_byanyOf 2 | nullRequired in parent | — |
sequence.items[].draft.updated_by | string | nullRequired in parent | — |
sequence.items[].draft.updated_byanyOf 1 | stringRequired in parent |
|
sequence.items[].draft.updated_byanyOf 2 | nullRequired in parent | — |
sequence.items[].draft.created_at | stringRequired in parent |
|
sequence.items[].draft.updated_at | stringRequired in parent |
|
sequence.items[].draft.submission | object | nullRequired in parent | — |
sequence.items[].draft.submissionanyOf 1 | objectRequired in parent |
|
sequence.items[].draft.submission.idanyOf 1 | stringRequired in parent |
|
sequence.items[].draft.submission.expected_revisionanyOf 1 | integerRequired in parent |
|
sequence.items[].draft.submission.started_atanyOf 1 | stringRequired in parent |
|
sequence.items[].draft.submission.receiptanyOf 1 | object | nullRequired in parent | — |
sequence.items[].draft.submission.receiptanyOf 1 / anyOf 1 | objectRequired in parent |
|
sequence.items[].draft.submission.receipt.batch_idanyOf 1 / anyOf 1 | string | nullRequired in parent | — |
sequence.items[].draft.submission.receipt.batch_idanyOf 1 / anyOf 1 / anyOf 1 | stringRequired in parent |
|
sequence.items[].draft.submission.receipt.batch_idanyOf 1 / anyOf 1 / anyOf 2 | nullRequired in parent | — |
sequence.items[].draft.submission.receipt.successesanyOf 1 / anyOf 1 | arrayRequired in parent |
|
sequence.items[].draft.submission.receipt.successes[]anyOf 1 / anyOf 1 | objectOptional / item |
|
sequence.items[].draft.submission.receipt.successes[].social_account_idanyOf 1 / anyOf 1 | stringRequired in parent |
|
sequence.items[].draft.submission.receipt.successes[].post_idanyOf 1 / anyOf 1 | stringRequired in parent |
|
sequence.items[].draft.submission.receipt.failuresanyOf 1 / anyOf 1 | arrayRequired in parent |
|
sequence.items[].draft.submission.receipt.failures[]anyOf 1 / anyOf 1 | objectOptional / item |
|
sequence.items[].draft.submission.receipt.failures[].social_account_idanyOf 1 / anyOf 1 | stringRequired in parent |
|
sequence.items[].draft.submission.receipt.failures[].codeanyOf 1 / anyOf 1 | stringRequired in parent |
|
sequence.items[].draft.submission.receipt.failures[].messageanyOf 1 / anyOf 1 | stringRequired in parent |
|
sequence.items[].draft.submission.receiptanyOf 1 / anyOf 2 | nullRequired in parent | — |
sequence.items[].draft.submissionanyOf 2 | nullRequired in parent | — |
sequence.items[].draft.brand_context | object | nullOptional / item | — |
sequence.items[].draft.brand_contextanyOf 1 | objectOptional / item |
|
sequence.items[].draft.brand_context.workspace_idanyOf 1 | stringRequired in parent |
|
sequence.items[].draft.brand_context.selectionanyOf 1 | objectRequired in parent |
|
sequence.items[].draft.brand_context.selection.profile_idanyOf 1 | stringRequired in parent |
|
sequence.items[].draft.brand_context.selection.version_idanyOf 1 | stringRequired in parent |
|
sequence.items[].draft.brand_context.selection.revisionanyOf 1 | integerRequired in parent |
|
sequence.items[].draft.brand_context.selection.content_digestanyOf 1 | stringRequired in parent |
|
sequence.items[].draft.brand_context.selection.context_digestanyOf 1 | stringRequired in parent |
|
sequence.items[].draft.brand_context.availabilityanyOf 1 | stringRequired in parent |
|
sequence.items[].draft.brand_context.profile_stateanyOf 1 | string | nullRequired in parent | — |
sequence.items[].draft.brand_context.profile_stateanyOf 1 / anyOf 1 | stringRequired in parent |
|
sequence.items[].draft.brand_context.profile_stateanyOf 1 / anyOf 2 | nullRequired in parent | — |
sequence.items[].draft.brand_context.contentanyOf 1 | object | nullRequired in parent | — |
sequence.items[].draft.brand_context.contentanyOf 1 / anyOf 1 | objectRequired in parent |
|
sequence.items[].draft.brand_context.content.nameanyOf 1 / anyOf 1 | stringRequired in parent |
|
sequence.items[].draft.brand_context.content.audienceanyOf 1 / anyOf 1 | stringRequired in parent |
|
sequence.items[].draft.brand_context.content.voiceanyOf 1 / anyOf 1 | stringRequired in parent |
|
sequence.items[].draft.brand_context.content.languageanyOf 1 / anyOf 1 | string | nullRequired in parent | — |
sequence.items[].draft.brand_context.content.languageanyOf 1 / anyOf 1 / anyOf 1 | stringRequired in parent |
|
sequence.items[].draft.brand_context.content.languageanyOf 1 / anyOf 1 / anyOf 2 | nullRequired in parent | — |
sequence.items[].draft.brand_context.content.preferred_termsanyOf 1 / anyOf 1 | arrayRequired in parent |
|
sequence.items[].draft.brand_context.content.preferred_terms[]anyOf 1 / anyOf 1 | stringOptional / item |
|
sequence.items[].draft.brand_context.content.prohibited_termsanyOf 1 / anyOf 1 | arrayRequired in parent |
|
sequence.items[].draft.brand_context.content.prohibited_terms[]anyOf 1 / anyOf 1 | stringOptional / item |
|
sequence.items[].draft.brand_context.content.locked_factsanyOf 1 / anyOf 1 | arrayRequired in parent |
|
sequence.items[].draft.brand_context.content.locked_facts[]anyOf 1 / anyOf 1 | stringOptional / item |
|
sequence.items[].draft.brand_context.content.call_to_actionanyOf 1 / anyOf 1 | string | nullRequired in parent | — |
sequence.items[].draft.brand_context.content.call_to_actionanyOf 1 / anyOf 1 / anyOf 1 | stringRequired in parent |
|
sequence.items[].draft.brand_context.content.call_to_actionanyOf 1 / anyOf 1 / anyOf 2 | nullRequired in parent | — |
sequence.items[].draft.brand_context.contentanyOf 1 / anyOf 2 | nullRequired in parent | — |
sequence.items[].draft.brand_context.sourcesanyOf 1 | objectRequired in parent |
|
sequence.items[].draft.brand_context.sources.websiteanyOf 1 | stringRequired in parent |
|
sequence.items[].draft.brand_context.sources.logoanyOf 1 | stringRequired in parent |
|
sequence.items[].draft.brand_context.sources.own_postsanyOf 1 | objectRequired in parent |
|
sequence.items[].draft.brand_context.sources.own_posts.selectedanyOf 1 | integerRequired in parent |
|
sequence.items[].draft.brand_context.sources.own_posts.availableanyOf 1 | integerRequired in parent |
|
sequence.items[].draft.brand_context.sources.own_posts.unavailableanyOf 1 | integerRequired in parent |
|
sequence.items[].draft.brand_context.sources.own_posts.erasedanyOf 1 | integerRequired in parent |
|
sequence.items[].draft.brand_contextanyOf 2 | nullOptional / item | — |
sequence.items[].draft.brand_review | object | nullOptional / item | — |
sequence.items[].draft.brand_reviewanyOf 1 | objectOptional / item |
|
sequence.items[].draft.brand_review.rule_versionanyOf 1 | numberRequired in parent |
|
sequence.items[].draft.brand_review.context_digestanyOf 1 | stringRequired in parent |
|
sequence.items[].draft.brand_review.content_digestanyOf 1 | stringRequired in parent |
|
sequence.items[].draft.brand_review.statusanyOf 1 | stringRequired in parent |
|
sequence.items[].draft.brand_review.issuesanyOf 1 | arrayRequired in parent |
|
sequence.items[].draft.brand_review.issues[]anyOf 1 | objectOptional / item |
|
sequence.items[].draft.brand_review.issues[].codeanyOf 1 | stringRequired in parent |
|
sequence.items[].draft.brand_review.issues[].targetanyOf 1 | stringRequired in parent |
|
sequence.items[].draft.brand_review.issues[].rule_indexanyOf 1 | integer | nullRequired in parent | — |
sequence.items[].draft.brand_review.issues[].rule_indexanyOf 1 / anyOf 1 | integerRequired in parent |
|
sequence.items[].draft.brand_review.issues[].rule_indexanyOf 1 / anyOf 2 | nullRequired in parent | — |
sequence.items[].draft.brand_review.issues[].messageanyOf 1 | stringRequired in parent |
|
sequence.items[].draft.brand_reviewanyOf 2 | nullOptional / item | — |
sequence.items[].predecessor_post_id | string | nullRequired in parent | — |
sequence.items[].predecessor_post_idanyOf 1 | stringRequired in parent |
|
sequence.items[].predecessor_post_idanyOf 2 | nullRequired in parent | — |
sequence.items[].post | object | nullRequired in parent | — |
sequence.items[].postanyOf 1 | objectRequired in parent |
|
sequence.items[].post.idanyOf 1 | stringRequired in parent |
|
sequence.items[].post.workspace_idanyOf 1 | stringRequired in parent |
|
sequence.items[].post.social_account_idanyOf 1 | string | nullRequired in parent | — |
sequence.items[].post.social_account_idanyOf 1 / anyOf 1 | stringRequired in parent |
|
sequence.items[].post.social_account_idanyOf 1 / anyOf 2 | nullRequired in parent | — |
sequence.items[].post.platformanyOf 1 | stringRequired in parent |
|
sequence.items[].post.destinationanyOf 1 | objectRequired in parent |
|
sequence.items[].post.destination.social_account_idanyOf 1 | string | nullRequired in parent | — |
sequence.items[].post.destination.social_account_idanyOf 1 / anyOf 1 | stringRequired in parent |
|
sequence.items[].post.destination.social_account_idanyOf 1 / anyOf 2 | nullRequired in parent | — |
sequence.items[].post.destination.platformanyOf 1 | stringRequired in parent |
|
sequence.items[].post.destination.platform_user_idanyOf 1 | string | nullRequired in parent | — |
sequence.items[].post.destination.account_labelanyOf 1 | string | nullRequired in parent | — |
sequence.items[].post.captionanyOf 1 | string | nullRequired in parent | — |
sequence.items[].post.hashtagsanyOf 1 | arrayRequired in parent | — |
sequence.items[].post.hashtags[]anyOf 1 | stringOptional / item | — |
sequence.items[].post.mediaanyOf 1 | arrayRequired in parent | — |
sequence.items[].post.media[]anyOf 1 | objectOptional / item |
|
sequence.items[].post.media[].kindanyOf 1 | stringRequired in parent |
|
sequence.items[].post.media[].urlanyOf 1 | stringRequired in parent |
|
sequence.items[].post.media[].cover_urlanyOf 1 | string | nullOptional / item | — |
sequence.items[].post.media[].cover_urlanyOf 1 / anyOf 1 | stringOptional / item |
|
sequence.items[].post.media[].cover_urlanyOf 1 / anyOf 2 | nullOptional / item | — |
sequence.items[].post.media[].cover_asset_idanyOf 1 | integer | nullOptional / item | — |
sequence.items[].post.media[].cover_asset_idanyOf 1 / anyOf 1 | integerOptional / item |
|
sequence.items[].post.media[].cover_asset_idanyOf 1 / anyOf 2 | nullOptional / item | — |
sequence.items[].post.media[].asset_idanyOf 1 | integer | nullOptional / item | — |
sequence.items[].post.media[].asset_idanyOf 1 / anyOf 1 | integerOptional / item |
|
sequence.items[].post.media[].asset_idanyOf 1 / anyOf 2 | nullOptional / item | — |
sequence.items[].post.media[].mime_typeanyOf 1 | string | nullOptional / item | — |
sequence.items[].post.media[].mime_typeanyOf 1 / anyOf 1 | stringOptional / item |
|
sequence.items[].post.media[].mime_typeanyOf 1 / anyOf 2 | nullOptional / item | — |
sequence.items[].post.media[].preview_urlanyOf 1 | string | nullOptional / item | Temporary authorized read URL; keep url as persisted Scheduled Post media identity. — |
sequence.items[].post.media[].preview_urlanyOf 1 / anyOf 1 | stringOptional / item |
|
sequence.items[].post.media[].preview_urlanyOf 1 / anyOf 2 | nullOptional / item | — |
sequence.items[].post.media[].cover_preview_urlanyOf 1 | string | nullOptional / item | Temporary authorized cover read URL; keep cover_url as persisted media identity. — |
sequence.items[].post.media[].cover_preview_urlanyOf 1 / anyOf 1 | stringOptional / item |
|
sequence.items[].post.media[].cover_preview_urlanyOf 1 / anyOf 2 | nullOptional / item | — |
sequence.items[].post.media[].preview_expires_atanyOf 1 | string | nullOptional / item | — |
sequence.items[].post.media[].preview_expires_atanyOf 1 / anyOf 1 | stringOptional / item |
|
sequence.items[].post.media[].preview_expires_atanyOf 1 / anyOf 2 | nullOptional / item | — |
sequence.items[].post.link_urlanyOf 1 | string | nullOptional / item | — |
sequence.items[].post.link_urlanyOf 1 / anyOf 1 | stringOptional / item |
|
sequence.items[].post.link_urlanyOf 1 / anyOf 2 | nullOptional / item | — |
sequence.items[].post.publish_optionsanyOf 1 | objectRequired in parent |
|
sequence.items[].post.publish_options.post_typeanyOf 1 | stringOptional / item |
|
sequence.items[].post.publish_options.location_idanyOf 1 | stringOptional / item |
|
sequence.items[].post.publish_options.share_to_feedanyOf 1 | booleanOptional / item | — |
sequence.items[].post.publish_options.collaboratorsanyOf 1 | arrayOptional / item |
|
sequence.items[].post.publish_options.collaborators[]anyOf 1 | stringOptional / item |
|
sequence.items[].post.publish_options.first_commentanyOf 1 | stringOptional / item |
|
sequence.items[].post.publish_options.topic_taganyOf 1 | stringOptional / item |
|
sequence.items[].post.publish_options.thumb_offset_msanyOf 1 | integerOptional / item |
|
sequence.items[].post.publish_options.titleanyOf 1 | stringOptional / item |
|
sequence.items[].post.publish_options.youtube_privacy_statusanyOf 1 | stringOptional / item |
|
sequence.items[].post.publish_options.youtube_category_idanyOf 1 | stringOptional / item |
|
sequence.items[].post.publish_options.youtube_contains_synthetic_mediaanyOf 1 | booleanOptional / item | — |
sequence.items[].post.publish_options.descriptionanyOf 1 | stringOptional / item |
|
sequence.items[].post.publish_options.category_idanyOf 1 | stringOptional / item |
|
sequence.items[].post.publish_options.privacy_statusanyOf 1 | stringOptional / item |
|
sequence.items[].post.publish_options.cancellation_modeanyOf 1 | stringOptional / item |
|
sequence.items[].post.publish_options.tagsanyOf 1 | arrayOptional / item | — |
sequence.items[].post.publish_options.tags[]anyOf 1 | stringOptional / item | — |
sequence.items[].post.publish_options.default_languageanyOf 1 | stringOptional / item | — |
sequence.items[].post.publish_options.localizationsanyOf 1 | objectOptional / item |
|
sequence.items[].post.publish_options.localizations.*anyOf 1 | any JSON valueOptional / item | — |
sequence.items[].post.publish_options.licenseanyOf 1 | stringOptional / item |
|
sequence.items[].post.publish_options.embeddableanyOf 1 | booleanOptional / item | — |
sequence.items[].post.publish_options.public_stats_viewableanyOf 1 | booleanOptional / item | — |
sequence.items[].post.publish_options.self_declared_made_for_kidsanyOf 1 | booleanOptional / item | — |
sequence.items[].post.publish_options.contains_synthetic_mediaanyOf 1 | booleanOptional / item | — |
sequence.items[].post.publish_options.has_paid_product_placementanyOf 1 | booleanOptional / item | — |
sequence.items[].post.publish_options.recording_dateanyOf 1 | stringOptional / item | — |
sequence.items[].post.publish_options.notify_subscribersanyOf 1 | booleanOptional / item | — |
sequence.items[].post.publish_options.thumbnail_asset_idanyOf 1 | integerOptional / item |
|
sequence.items[].post.publish_options.surface_expectationanyOf 1 | stringOptional / item |
|
sequence.items[].post.publish_options.brand_partneranyOf 1 | objectOptional / item |
|
sequence.items[].post.publish_options.brand_partner.*anyOf 1 | any JSON valueOptional / item | — |
sequence.items[].post.publish_options.cover_asset_idanyOf 1 | integerOptional / item |
|
sequence.items[].post.publish_options.audio_nameanyOf 1 | stringOptional / item | — |
sequence.items[].post.publish_options.trial_paramsanyOf 1 | objectOptional / item |
|
sequence.items[].post.publish_options.trial_params.*anyOf 1 | any JSON valueOptional / item | — |
sequence.items[].post.publish_options.is_ai_generatedanyOf 1 | booleanOptional / item | — |
sequence.items[].post.publish_options.branded_content_sponsor_idsanyOf 1 | arrayOptional / item | — |
sequence.items[].post.publish_options.branded_content_sponsor_ids[]anyOf 1 | stringOptional / item | — |
sequence.items[].post.publish_options.is_paid_partnershipanyOf 1 | booleanOptional / item | — |
sequence.items[].post.publish_options.media_optionsanyOf 1 | arrayOptional / item | — |
sequence.items[].post.publish_options.media_options[]anyOf 1 | objectOptional / item |
|
sequence.items[].post.publish_options.media_options[].*anyOf 1 | any JSON valueOptional / item | — |
sequence.items[].post.publish_options.reply_to_idanyOf 1 | stringOptional / item | — |
sequence.items[].post.publish_options.quote_post_idanyOf 1 | stringOptional / item | — |
sequence.items[].post.publish_options.repost_target_idanyOf 1 | stringOptional / item | — |
sequence.items[].post.publish_options.reply_controlanyOf 1 | stringOptional / item | — |
sequence.items[].post.publish_options.enable_reply_approvalsanyOf 1 | booleanOptional / item | — |
sequence.items[].post.publish_options.link_attachmentanyOf 1 | stringOptional / item |
|
sequence.items[].post.publish_options.poll_attachmentanyOf 1 | objectOptional / item |
|
sequence.items[].post.publish_options.poll_attachment.*anyOf 1 | any JSON valueOptional / item | — |
sequence.items[].post.publish_options.gif_attachmentanyOf 1 | objectOptional / item |
|
sequence.items[].post.publish_options.gif_attachment.*anyOf 1 | any JSON valueOptional / item | — |
sequence.items[].post.publish_options.text_attachmentanyOf 1 | objectOptional / item |
|
sequence.items[].post.publish_options.text_attachment.*anyOf 1 | any JSON valueOptional / item | — |
sequence.items[].post.publish_options.text_entitiesanyOf 1 | arrayOptional / item | — |
sequence.items[].post.publish_options.text_entities[]anyOf 1 | objectOptional / item |
|
sequence.items[].post.publish_options.text_entities[].*anyOf 1 | any JSON valueOptional / item | — |
sequence.items[].post.publish_options.is_spoiler_mediaanyOf 1 | booleanOptional / item | — |
sequence.items[].post.publish_options.is_ghost_postanyOf 1 | booleanOptional / item | — |
sequence.items[].post.publish_options.allowlisted_country_codesanyOf 1 | arrayOptional / item | — |
sequence.items[].post.publish_options.allowlisted_country_codes[]anyOf 1 | stringOptional / item | — |
sequence.items[].post.publish_options.crossreshare_to_iganyOf 1 | booleanOptional / item | — |
sequence.items[].post.publish_options.crossreshare_to_ig_dark_modeanyOf 1 | booleanOptional / item | — |
sequence.items[].post.publish_options.auto_publish_textanyOf 1 | booleanOptional / item | — |
sequence.items[].post.publish_options.publication_modeanyOf 1 | stringOptional / item |
|
sequence.items[].post.publish_options.backdated_timeanyOf 1 | numberOptional / item | — |
sequence.items[].post.publish_options.backdated_time_granularityanyOf 1 | stringOptional / item |
|
sequence.items[].post.publish_options.placeanyOf 1 | stringOptional / item | — |
sequence.items[].post.publish_options.feed_targetinganyOf 1 | objectOptional / item |
|
sequence.items[].post.publish_options.feed_targeting.*anyOf 1 | any JSON valueOptional / item | — |
sequence.items[].post.publish_options.targetinganyOf 1 | objectOptional / item |
|
sequence.items[].post.publish_options.targeting.*anyOf 1 | any JSON valueOptional / item | — |
sequence.items[].post.publish_options.child_attachmentsanyOf 1 | arrayOptional / item | — |
sequence.items[].post.publish_options.child_attachments[]anyOf 1 | objectOptional / item |
|
sequence.items[].post.publish_options.child_attachments[].*anyOf 1 | any JSON valueOptional / item | — |
sequence.items[].post.publish_options.multi_share_end_cardanyOf 1 | booleanOptional / item | — |
sequence.items[].post.publish_options.multi_share_optimizedanyOf 1 | booleanOptional / item | — |
sequence.items[].post.publish_options.unpublished_content_typeanyOf 1 | stringOptional / item | — |
sequence.items[].post.publish_options.no_storyanyOf 1 | booleanOptional / item | — |
sequence.items[].post.publish_options.crossposted_video_idanyOf 1 | stringOptional / item | — |
sequence.items[].post.publish_options.sphericalanyOf 1 | booleanOptional / item | — |
sequence.items[].post.scheduled_atanyOf 1 | stringRequired in parent | — |
sequence.items[].post.display_timezoneanyOf 1 | stringRequired in parent |
|
sequence.items[].post.local_scheduled_atanyOf 1 | string | nullOptional / item | — |
sequence.items[].post.local_scheduled_atanyOf 1 / anyOf 1 | stringOptional / item |
|
sequence.items[].post.local_scheduled_atanyOf 1 / anyOf 2 | nullOptional / item | — |
sequence.items[].post.schedule_timezoneanyOf 1 | string | nullOptional / item | — |
sequence.items[].post.schedule_timezoneanyOf 1 / anyOf 1 | stringOptional / item |
|
sequence.items[].post.schedule_timezoneanyOf 1 / anyOf 2 | nullOptional / item | — |
sequence.items[].post.schedule_dst_disambiguationanyOf 1 | string | nullOptional / item | — |
sequence.items[].post.schedule_dst_disambiguationanyOf 1 / anyOf 1 | stringOptional / item |
|
sequence.items[].post.schedule_dst_disambiguationanyOf 1 / anyOf 2 | nullOptional / item | — |
sequence.items[].post.schedule_intent_stateanyOf 1 | stringOptional / item |
|
sequence.items[].post.expires_atanyOf 1 | string | nullRequired in parent | — |
sequence.items[].post.statusanyOf 1 | stringRequired in parent |
|
sequence.items[].post.versionanyOf 1 | integerRequired in parent |
|
sequence.items[].post.automatic_retry_enabledanyOf 1 | booleanRequired in parent | — |
sequence.items[].post.delete_requested_atanyOf 1 | string | nullRequired in parent | — |
sequence.items[].post.deletionanyOf 1 | objectOptional / item |
|
sequence.items[].post.deletion.stateanyOf 1 | stringRequired in parent |
|
sequence.items[].post.deletion.retry_atanyOf 1 | string | nullRequired in parent | — |
sequence.items[].post.deletion.retry_atanyOf 1 / anyOf 1 | stringRequired in parent |
|
sequence.items[].post.deletion.retry_atanyOf 1 / anyOf 2 | nullRequired in parent | — |
sequence.items[].post.published_atanyOf 1 | string | nullRequired in parent | — |
sequence.items[].post.deleted_atanyOf 1 | string | nullRequired in parent | — |
sequence.items[].post.provider_post_idanyOf 1 | string | nullRequired in parent | — |
sequence.items[].post.permalinkanyOf 1 | string | nullRequired in parent | — |
sequence.items[].post.permalinkanyOf 1 / anyOf 1 | stringRequired in parent |
|
sequence.items[].post.permalinkanyOf 1 / anyOf 2 | nullRequired in parent | — |
sequence.items[].post.created_atanyOf 1 | stringRequired in parent | — |
sequence.items[].post.updated_atanyOf 1 | stringRequired in parent | — |
sequence.items[].post.project_idanyOf 1 | string | nullRequired in parent | — |
sequence.items[].post.project_idanyOf 1 / anyOf 1 | stringRequired in parent |
|
sequence.items[].post.project_idanyOf 1 / anyOf 2 | nullRequired in parent | — |
sequence.items[].post.batch_idanyOf 1 | string | nullRequired in parent | — |
sequence.items[].post.batch_idanyOf 1 / anyOf 1 | stringRequired in parent |
|
sequence.items[].post.batch_idanyOf 1 / anyOf 2 | nullRequired in parent | — |
sequence.items[].post.source_refanyOf 1 | object | nullRequired in parent | — |
sequence.items[].post.source_refanyOf 1 / anyOf 1 | objectRequired in parent |
|
sequence.items[].post.source_ref.*anyOf 1 / anyOf 1 | any JSON valueOptional / item | — |
sequence.items[].post.source_refanyOf 1 / anyOf 2 | nullRequired in parent | — |
sequence.items[].postanyOf 2 | nullRequired in parent | — |
sequence.items[].retry_allowed | booleanRequired in parent | — |
sequence.expected_versions | objectRequired in parent |
|
sequence.expected_versions.* | integerOptional / item |
|
sequence.actions | arrayRequired in parent |
|
sequence.actions[] | objectOptional / item |
|
sequence.actions[].action | stringRequired in parent |
|
sequence.actions[].allowed | booleanRequired in parent | — |
sequence.actions[].reason_code | stringRequired in parent |
|
sequence.actions[].message | stringRequired in parent |
|
replayed | booleanOptional / item | — |
Complete JSON Schema
{
"type": "object",
"properties": {
"sequence": {
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"id": {
"type": "string",
"format": "uuid"
},
"social_account_id": {
"type": "string",
"format": "uuid"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"state": {
"type": "string",
"enum": [
"draft",
"admitted",
"cancelled"
]
},
"item_count": {
"type": "integer",
"minimum": 2,
"maximum": 25
},
"caption_preview": {
"type": "string",
"maxLength": 500
},
"created_at": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
"updated_at": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
"items": {
"minItems": 2,
"maxItems": 25,
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "string",
"format": "uuid"
},
"ordinal": {
"type": "integer",
"minimum": 1,
"maximum": 25
},
"draft": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspace_id": {
"type": "string",
"format": "uuid"
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"state": {
"type": "string",
"enum": [
"draft",
"submitting",
"submitted"
]
},
"content": {
"type": "object",
"properties": {
"schemaVersion": {
"default": 1,
"type": "number",
"const": 1
},
"accountIds": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"caption": {
"default": "",
"type": "string",
"maxLength": 5000
},
"hashtags": {
"default": "",
"type": "string",
"maxLength": 5000
},
"assetIds": {
"default": [],
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"maxLength": 16,
"pattern": "^[1-9][0-9]*$"
}
},
"threadsTextOnly": {
"default": false,
"type": "boolean"
},
"threadsOptions": {
"type": "object",
"properties": {
"post_type": {
"type": "string",
"enum": [
"TEXT",
"IMAGE",
"VIDEO",
"CAROUSEL",
"REPOST"
]
},
"reply_to_id": {
"type": "string",
"maxLength": 128
},
"quote_post_id": {
"type": "string",
"maxLength": 128
},
"repost_target_id": {
"type": "string",
"maxLength": 128
},
"reply_control": {
"type": "string",
"enum": [
"everyone",
"accounts_you_follow",
"mentioned_only",
"parent_post_author_only",
"followers_only"
]
},
"enable_reply_approvals": {
"type": "boolean"
},
"link_attachment": {
"type": "string",
"maxLength": 2048
},
"poll_attachment": {
"type": "object",
"properties": {
"option_a": {
"type": "string",
"maxLength": 25
},
"option_b": {
"type": "string",
"maxLength": 25
},
"option_c": {
"type": "string",
"maxLength": 25
},
"option_d": {
"type": "string",
"maxLength": 25
}
},
"required": [
"option_a",
"option_b"
],
"additionalProperties": false
},
"gif_attachment": {
"type": "object",
"properties": {
"gif_id": {
"type": "string",
"maxLength": 128
},
"provider": {
"type": "string",
"const": "GIPHY"
}
},
"required": [
"gif_id",
"provider"
],
"additionalProperties": false
},
"text_attachment": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"maxLength": 10000
},
"link_attachment_url": {
"type": "string",
"maxLength": 2048
},
"text_with_styling_info": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"length": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"styling_info": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"bold",
"italic",
"highlight",
"underline",
"strikethrough"
]
}
}
},
"required": [
"offset",
"length",
"styling_info"
],
"additionalProperties": false
}
}
},
"required": [
"plaintext"
],
"additionalProperties": false
},
"topic_tag": {
"type": "string",
"maxLength": 50
},
"text_entities": {
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"entity_type": {
"type": "string",
"enum": [
"SPOILER",
"spoiler"
]
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"length": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"entity_type",
"offset",
"length"
],
"additionalProperties": false
}
},
"is_spoiler_media": {
"type": "boolean"
},
"is_ghost_post": {
"type": "boolean"
},
"location_id": {
"type": "string",
"maxLength": 128
},
"allowlisted_country_codes": {
"minItems": 1,
"maxItems": 249,
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Z]{2}$"
}
},
"crossreshare_to_ig": {
"type": "boolean"
},
"crossreshare_to_ig_dark_mode": {
"type": "boolean"
},
"auto_publish_text": {
"type": "boolean"
},
"media_options": {
"maxItems": 20,
"type": "array",
"items": {
"type": "object",
"properties": {
"asset_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"alt_text": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"is_spoiler_media": {
"type": "boolean"
}
},
"required": [
"asset_id"
],
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"instagramMode": {
"default": "REELS",
"type": "string",
"enum": [
"IMAGE",
"REELS",
"CAROUSEL",
"STORY_IMAGE",
"STORY_VIDEO"
]
},
"youtubeTitle": {
"default": "",
"type": "string",
"maxLength": 100
},
"youtubePrivacy": {
"default": "private",
"type": "string",
"enum": [
"private",
"unlisted",
"public"
]
},
"youtubeSynthetic": {
"default": false,
"type": "boolean"
},
"youtubeCategoryId": {
"default": "",
"type": "string",
"maxLength": 32
},
"youtubeShort": {
"default": false,
"type": "boolean"
},
"linkUrl": {
"default": "",
"type": "string",
"maxLength": 2048
},
"scheduledAt": {
"default": "",
"type": "string",
"maxLength": 64
},
"displayTimezone": {
"default": "UTC",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"publishNow": {
"default": false,
"type": "boolean"
},
"destinationOverrides": {
"default": {},
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid"
},
"additionalProperties": {
"type": "object",
"properties": {
"caption": {
"type": "string",
"maxLength": 5000
},
"scheduledAt": {
"type": "string",
"maxLength": 64
}
},
"additionalProperties": false
}
},
"expiresAt": {
"default": "",
"type": "string",
"maxLength": 64
}
},
"required": [
"schemaVersion",
"accountIds",
"caption",
"hashtags",
"assetIds",
"threadsTextOnly",
"instagramMode",
"youtubeTitle",
"youtubePrivacy",
"youtubeSynthetic",
"youtubeCategoryId",
"youtubeShort",
"linkUrl",
"scheduledAt",
"displayTimezone",
"publishNow",
"destinationOverrides",
"expiresAt"
],
"additionalProperties": false
},
"created_by": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"updated_by": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
"updated_at": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
"submission": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"expected_revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"started_at": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
"receipt": {
"anyOf": [
{
"type": "object",
"properties": {
"batch_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"successes": {
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"social_account_id": {
"type": "string",
"format": "uuid"
},
"post_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
}
},
"required": [
"social_account_id",
"post_id"
],
"additionalProperties": false
}
},
"failures": {
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"social_account_id": {
"type": "string",
"format": "uuid"
},
"code": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"message": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"social_account_id",
"code",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"batch_id",
"successes",
"failures"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"expected_revision",
"started_at",
"receipt"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"brand_context": {
"anyOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"selection": {
"type": "object",
"properties": {
"profile_id": {
"type": "string",
"format": "uuid"
},
"version_id": {
"type": "string",
"format": "uuid"
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"content_digest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"context_digest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"profile_id",
"version_id",
"revision",
"content_digest",
"context_digest"
],
"additionalProperties": false
},
"availability": {
"type": "string",
"enum": [
"available",
"missing"
]
},
"profile_state": {
"anyOf": [
{
"type": "string",
"enum": [
"active",
"archived"
]
},
{
"type": "null"
}
]
},
"content": {
"anyOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 120
},
"audience": {
"type": "string",
"maxLength": 2000
},
"voice": {
"type": "string",
"maxLength": 2000
},
"language": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 64
},
{
"type": "null"
}
]
},
"preferred_terms": {
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 120
}
},
"prohibited_terms": {
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 120
}
},
"locked_facts": {
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"call_to_action": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"audience",
"voice",
"language",
"preferred_terms",
"prohibited_terms",
"locked_facts",
"call_to_action"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"sources": {
"type": "object",
"properties": {
"website": {
"type": "string",
"enum": [
"available",
"not_available"
]
},
"logo": {
"type": "string",
"enum": [
"none",
"present",
"missing"
]
},
"own_posts": {
"type": "object",
"properties": {
"selected": {
"type": "integer",
"minimum": 0,
"maximum": 10
},
"available": {
"type": "integer",
"minimum": 0,
"maximum": 10
},
"unavailable": {
"type": "integer",
"minimum": 0,
"maximum": 10
},
"erased": {
"type": "integer",
"minimum": 0,
"maximum": 10
}
},
"required": [
"selected",
"available",
"unavailable",
"erased"
],
"additionalProperties": false
}
},
"required": [
"website",
"logo",
"own_posts"
],
"additionalProperties": false
}
},
"required": [
"workspace_id",
"selection",
"availability",
"profile_state",
"content",
"sources"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"brand_review": {
"anyOf": [
{
"type": "object",
"properties": {
"rule_version": {
"type": "number",
"const": 1
},
"context_digest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"content_digest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"status": {
"type": "string",
"enum": [
"clear",
"attention",
"unavailable"
]
},
"issues": {
"maxItems": 5151,
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"prohibited_term",
"locked_fact_missing",
"conflicting_rule",
"context_unavailable"
]
},
"target": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"rule_index": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 49
},
{
"type": "null"
}
]
},
"message": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"code",
"target",
"rule_index",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"rule_version",
"context_digest",
"content_digest",
"status",
"issues"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspace_id",
"revision",
"state",
"content",
"created_by",
"updated_by",
"created_at",
"updated_at",
"submission"
],
"additionalProperties": false
},
"predecessor_post_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"post": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
},
"workspace_id": {
"type": "string",
"format": "uuid"
},
"social_account_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"platform": {
"type": "string",
"enum": [
"instagram",
"threads",
"facebook",
"youtube",
"x"
]
},
"destination": {
"type": "object",
"properties": {
"social_account_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"platform": {
"type": "string",
"enum": [
"instagram",
"threads",
"facebook",
"youtube",
"x"
]
},
"platform_user_id": {
"type": [
"string",
"null"
]
},
"account_label": {
"type": [
"string",
"null"
]
}
},
"required": [
"social_account_id",
"platform",
"platform_user_id",
"account_label"
],
"additionalProperties": false
},
"caption": {
"type": [
"string",
"null"
]
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"media": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"image",
"video"
]
},
"url": {
"type": "string",
"format": "uri"
},
"cover_url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"cover_asset_id": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"asset_id": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"mime_type": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 160
},
{
"type": "null"
}
]
},
"preview_url": {
"description": "Temporary authorized read URL; keep url as persisted Scheduled Post media identity.",
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"cover_preview_url": {
"description": "Temporary authorized cover read URL; keep cover_url as persisted media identity.",
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"preview_expires_at": {
"anyOf": [
{
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"format": "date-time"
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"url"
],
"additionalProperties": false
}
},
"link_url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"publish_options": {
"type": "object",
"properties": {
"post_type": {
"type": "string",
"enum": [
"TEXT",
"LINK",
"IMAGE",
"MULTI_IMAGE",
"VIDEO",
"CAROUSEL",
"REELS",
"STORY_IMAGE",
"STORY_VIDEO",
"REPOST",
"SHORT"
]
},
"location_id": {
"type": "string",
"minLength": 1
},
"share_to_feed": {
"type": "boolean"
},
"collaborators": {
"maxItems": 3,
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"first_comment": {
"type": "string",
"minLength": 1,
"maxLength": 2200
},
"topic_tag": {
"type": "string",
"minLength": 1
},
"thumb_offset_ms": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"title": {
"type": "string",
"maxLength": 255
},
"youtube_privacy_status": {
"type": "string",
"enum": [
"private",
"unlisted",
"public"
]
},
"youtube_category_id": {
"type": "string",
"pattern": "^\\d+$"
},
"youtube_contains_synthetic_media": {
"type": "boolean"
},
"description": {
"type": "string",
"maxLength": 5000
},
"category_id": {
"type": "string",
"pattern": "^\\d+$"
},
"privacy_status": {
"type": "string",
"enum": [
"private",
"unlisted",
"public"
]
},
"cancellation_mode": {
"type": "string",
"enum": [
"DELETE",
"UNSCHEDULE_KEEP_PRIVATE"
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"default_language": {
"type": "string"
},
"localizations": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"license": {
"type": "string",
"enum": [
"youtube",
"creativeCommon"
]
},
"embeddable": {
"type": "boolean"
},
"public_stats_viewable": {
"type": "boolean"
},
"self_declared_made_for_kids": {
"type": "boolean"
},
"contains_synthetic_media": {
"type": "boolean"
},
"has_paid_product_placement": {
"type": "boolean"
},
"recording_date": {
"type": "string"
},
"notify_subscribers": {
"type": "boolean"
},
"thumbnail_asset_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"surface_expectation": {
"type": "string",
"const": "SHORT"
},
"brand_partner": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"cover_asset_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"audio_name": {
"type": "string"
},
"trial_params": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"is_ai_generated": {
"type": "boolean"
},
"branded_content_sponsor_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"is_paid_partnership": {
"type": "boolean"
},
"media_options": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"reply_to_id": {
"type": "string"
},
"quote_post_id": {
"type": "string"
},
"repost_target_id": {
"type": "string"
},
"reply_control": {
"type": "string"
},
"enable_reply_approvals": {
"type": "boolean"
},
"link_attachment": {
"type": "string",
"format": "uri"
},
"poll_attachment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"gif_attachment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"text_attachment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"text_entities": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"is_spoiler_media": {
"type": "boolean"
},
"is_ghost_post": {
"type": "boolean"
},
"allowlisted_country_codes": {
"type": "array",
"items": {
"type": "string"
}
},
"crossreshare_to_ig": {
"type": "boolean"
},
"crossreshare_to_ig_dark_mode": {
"type": "boolean"
},
"auto_publish_text": {
"type": "boolean"
},
"publication_mode": {
"type": "string",
"enum": [
"PUBLISH",
"DRAFT"
]
},
"backdated_time": {
"type": "number"
},
"backdated_time_granularity": {
"type": "string",
"enum": [
"year",
"month",
"day",
"hour",
"minute"
]
},
"place": {
"type": "string"
},
"feed_targeting": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"targeting": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"child_attachments": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"multi_share_end_card": {
"type": "boolean"
},
"multi_share_optimized": {
"type": "boolean"
},
"unpublished_content_type": {
"type": "string"
},
"no_story": {
"type": "boolean"
},
"crossposted_video_id": {
"type": "string"
},
"spherical": {
"type": "boolean"
}
},
"additionalProperties": false
},
"scheduled_at": {
"type": "string"
},
"display_timezone": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"local_scheduled_at": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?$"
},
{
"type": "null"
}
]
},
"schedule_timezone": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80
},
{
"type": "null"
}
]
},
"schedule_dst_disambiguation": {
"anyOf": [
{
"type": "string",
"enum": [
"exact",
"earlier",
"later"
]
},
{
"type": "null"
}
]
},
"schedule_intent_state": {
"type": "string",
"enum": [
"verified",
"legacy_unverified"
]
},
"expires_at": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string",
"enum": [
"scheduled",
"publishing",
"published",
"failed",
"expired",
"needs_reschedule",
"cancelled",
"deleted"
]
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"automatic_retry_enabled": {
"type": "boolean"
},
"delete_requested_at": {
"type": [
"string",
"null"
]
},
"deletion": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"pending",
"retry_scheduled",
"failed",
"unconfirmed",
"confirmed",
"unpublished_cancelled"
]
},
"retry_at": {
"anyOf": [
{
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"format": "date-time"
},
{
"type": "null"
}
]
}
},
"required": [
"state",
"retry_at"
],
"additionalProperties": false
},
"published_at": {
"type": [
"string",
"null"
]
},
"deleted_at": {
"type": [
"string",
"null"
]
},
"provider_post_id": {
"type": [
"string",
"null"
]
},
"permalink": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"project_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"batch_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"source_ref": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspace_id",
"social_account_id",
"platform",
"destination",
"caption",
"hashtags",
"media",
"publish_options",
"scheduled_at",
"display_timezone",
"expires_at",
"status",
"version",
"automatic_retry_enabled",
"delete_requested_at",
"published_at",
"deleted_at",
"provider_post_id",
"permalink",
"created_at",
"updated_at",
"project_id",
"batch_id",
"source_ref"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"retry_allowed": {
"type": "boolean"
}
},
"required": [
"item_id",
"ordinal",
"draft",
"predecessor_post_id",
"post",
"retry_allowed"
],
"additionalProperties": false
}
},
"expected_versions": {
"type": "object",
"propertyNames": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
},
"additionalProperties": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"actions": {
"minItems": 2,
"maxItems": 2,
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"resume",
"cancel"
]
},
"allowed": {
"type": "boolean"
},
"reason_code": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"message": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"action",
"allowed",
"reason_code",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"workspace_id",
"id",
"social_account_id",
"version",
"state",
"item_count",
"caption_preview",
"created_at",
"updated_at",
"items",
"expected_versions",
"actions"
],
"additionalProperties": false
},
"replayed": {
"type": "boolean"
}
},
"required": [
"sequence"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}Example tool call
These examples use fictional values checked against the schemas. Replace the IDs with ones you are authorized to use, the media with ready assets and the dates with your confirmed publishing time. Check the account’s eligibility before submitting a write. This page sends no API requests.
{
"name": "sosoapi_cancel_threads_sequence",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"id": "33333333-3333-4333-8333-333333333333",
"expected_version": 2,
"expected_versions": {
"90000000-0000-4000-8000-000000000001": 2,
"90000000-0000-4000-8000-000000000002": 2
}
}
}structuredContent
{
"sequence": {
"id": "33333333-3333-4333-8333-333333333333",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"social_account_id": "22222222-2222-4222-8222-222222222222",
"version": 3,
"state": "cancelled",
"item_count": 2,
"caption_preview": "A fictional announcement.",
"created_at": "2099-01-14T09:00:00Z",
"updated_at": "2099-01-14T09:00:00Z",
"items": [
{
"item_id": "80000000-0000-4000-8000-000000000001",
"ordinal": 1,
"draft": {
"id": "70000000-0000-4000-8000-000000000001",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"revision": 3,
"state": "submitted",
"content": {
"schemaVersion": 1,
"accountIds": [
"22222222-2222-4222-8222-222222222222"
],
"caption": "A fictional announcement.",
"hashtags": "",
"assetIds": [],
"threadsTextOnly": false,
"threadsOptions": {
"post_type": "TEXT"
},
"instagramMode": "REELS",
"youtubeTitle": "",
"youtubePrivacy": "private",
"youtubeSynthetic": false,
"youtubeCategoryId": "",
"youtubeShort": false,
"linkUrl": "",
"scheduledAt": "2099-01-15T09:00:00Z",
"displayTimezone": "UTC",
"publishNow": false,
"destinationOverrides": {},
"expiresAt": ""
},
"created_by": null,
"updated_by": null,
"created_at": "2099-01-14T09:00:00Z",
"updated_at": "2099-01-14T09:00:00Z",
"submission": {
"id": "60000000-0000-4000-8000-000000000031",
"expected_revision": 1,
"started_at": "2099-01-14T09:00:00Z",
"receipt": {
"batch_id": "50000000-0000-4000-8000-000000000001",
"successes": [
{
"social_account_id": "22222222-2222-4222-8222-222222222222",
"post_id": "90000000-0000-4000-8000-000000000001"
}
],
"failures": []
}
}
},
"predecessor_post_id": null,
"post": {
"id": "90000000-0000-4000-8000-000000000001",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"social_account_id": "22222222-2222-4222-8222-222222222222",
"platform": "threads",
"destination": {
"social_account_id": "22222222-2222-4222-8222-222222222222",
"platform": "threads",
"platform_user_id": "12345",
"account_label": "Fictional Threads account"
},
"caption": "A fictional announcement.",
"hashtags": [],
"media": [],
"publish_options": {
"post_type": "TEXT"
},
"scheduled_at": "2099-01-15T09:00:00Z",
"display_timezone": "UTC",
"expires_at": null,
"status": "cancelled",
"version": 3,
"automatic_retry_enabled": false,
"delete_requested_at": null,
"published_at": null,
"deleted_at": null,
"provider_post_id": null,
"permalink": null,
"project_id": null,
"batch_id": "50000000-0000-4000-8000-000000000001",
"source_ref": null,
"created_at": "2099-01-14T09:00:00Z",
"updated_at": "2099-01-14T09:00:00Z"
},
"retry_allowed": false
},
{
"item_id": "80000000-0000-4000-8000-000000000002",
"ordinal": 2,
"draft": {
"id": "70000000-0000-4000-8000-000000000002",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"revision": 3,
"state": "submitted",
"content": {
"schemaVersion": 1,
"accountIds": [
"22222222-2222-4222-8222-222222222222"
],
"caption": "A fictional first reply.",
"hashtags": "",
"assetIds": [],
"threadsTextOnly": false,
"threadsOptions": {
"post_type": "TEXT"
},
"instagramMode": "REELS",
"youtubeTitle": "",
"youtubePrivacy": "private",
"youtubeSynthetic": false,
"youtubeCategoryId": "",
"youtubeShort": false,
"linkUrl": "",
"scheduledAt": "2099-01-15T09:00:00Z",
"displayTimezone": "UTC",
"publishNow": false,
"destinationOverrides": {},
"expiresAt": ""
},
"created_by": null,
"updated_by": null,
"created_at": "2099-01-14T09:00:00Z",
"updated_at": "2099-01-14T09:00:00Z",
"submission": {
"id": "60000000-0000-4000-8000-000000000032",
"expected_revision": 1,
"started_at": "2099-01-14T09:00:00Z",
"receipt": {
"batch_id": "50000000-0000-4000-8000-000000000002",
"successes": [
{
"social_account_id": "22222222-2222-4222-8222-222222222222",
"post_id": "90000000-0000-4000-8000-000000000002"
}
],
"failures": []
}
}
},
"predecessor_post_id": "90000000-0000-4000-8000-000000000001",
"post": {
"id": "90000000-0000-4000-8000-000000000002",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"social_account_id": "22222222-2222-4222-8222-222222222222",
"platform": "threads",
"destination": {
"social_account_id": "22222222-2222-4222-8222-222222222222",
"platform": "threads",
"platform_user_id": "12345",
"account_label": "Fictional Threads account"
},
"caption": "A fictional first reply.",
"hashtags": [],
"media": [],
"publish_options": {
"post_type": "TEXT"
},
"scheduled_at": "2099-01-15T09:00:00Z",
"display_timezone": "UTC",
"expires_at": null,
"status": "cancelled",
"version": 3,
"automatic_retry_enabled": false,
"delete_requested_at": null,
"published_at": null,
"deleted_at": null,
"provider_post_id": null,
"permalink": null,
"project_id": null,
"batch_id": "50000000-0000-4000-8000-000000000002",
"source_ref": null,
"created_at": "2099-01-14T09:00:00Z",
"updated_at": "2099-01-14T09:00:00Z"
},
"retry_allowed": false
}
],
"expected_versions": {
"90000000-0000-4000-8000-000000000001": 3,
"90000000-0000-4000-8000-000000000002": 3
},
"actions": [
{
"action": "resume",
"allowed": false,
"reason_code": "no_failed_items",
"message": "No safe failed suffix is present in this fictional snapshot."
},
{
"action": "cancel",
"allowed": false,
"reason_code": "already_cancelled",
"message": "Only unsent items can be cancelled; published content stays in place."
}
]
},
"replayed": false
}