Skip to content

Create Post API

The Create Post API creates a post that can be saved as a draft, published immediately, or scheduled for future publishing. It uses POST /v1/posts/ with an x-access-key header, a required content string, a required platforms array, optional mediaItems, and publishing-mode fields that control whether the post is drafted, published now, or scheduled with scheduledFor.

Create Post API operation summary

Use POST /v1/posts/ to create, publish, or schedule a post. Set saveAsDraft to true to save without accounts or credits, set publishNow to true to publish immediately, or provide scheduledFor to schedule the post. The request body is application/json and the operation returns application/json responses. Before sending a request, confirm the access key, the target account identifiers, the media URLs, and the publishing mode you intend to use, because those choices determine whether the result is a draft, an immediate publish, or a scheduled post.

Authorization

Send the access key in the x-access-key header. The header name is accessKey in the captured authorization description and the wire header is x-access-key. Include Content-Type: application/json for the JSON request body. If the header is missing or invalid, treat the request as not ready to send and correct the credential before retrying, rather than changing the endpoint path or field names.

Request body field map

The top-level request requires content as a string and platforms as an array of objects. Optional top-level fields are mediaItems, publishNow, saveAsDraft, scheduledFor, timezone, and idempotencyKey. Each mediaItems entry requires type and url, with type limited to image, video, gif, or document, url formatted as a URI, optional altText from 1 to 1000 characters, and optional thumbnail formatted as a URI. Each platforms entry requires platform and accountId, allows an optional per-platform content override, and allows optional platformSpecificData whose fields depend on the selected platform. When per-platform content is omitted, the top-level content is used for that platform. The platforms description states that drafts may be saved without an account, while the typed contract marks platforms and each entry's accountId as required.

Publishing mode, scheduling and idempotency

Choose exactly one publishing intent. Use saveAsDraft true for a draft, publishNow true for immediate publishing, or scheduledFor for future publishing. scheduledFor takes precedence when provided alongside publishNow. saveAsDraft cannot be combined with publishNow true or scheduledFor. For scheduled posts, scheduledFor must be an ISO 8601 date-time string and timezone may be an IANA timezone such as America/New_York, defaulting to UTC when omitted. For safe retries, provide idempotencyKey between 1 and 255 characters; if a post was already created with the same key for the same project, the original result is returned instead of creating or publishing a duplicate, and a fresh key should be used for each distinct post.

Platform targeting and platformSpecificData

Target one or more platform accounts through the platforms array. Each entry selects a platform value and an accountId, which is the integration identifier found through the integrations listing operation referenced in the contract. Add platformSpecificData only for the platform you are targeting, because the configuration object changes by platform. Examples include Twitter community, reply, thread, long-post and poll settings, where threadItems entries require content and poll requires options and durationMinutes; Instagram story, audio, trial, cover and collaborator settings, where audioConfiguration requires audioId and trialParams requires graduationStrategy; YouTube title, tags, visibility and category settings; TikTok privacy and draft settings; Pinterest board settings, where boardId is required; LinkedIn visibility, mentions and article settings, where each mentions entry requires text and urn; Bluesky language and alt-text settings; Facebook content type and publishing settings; Threads reply control and alt-text settings; and Google Business topic, call-to-action, event and offer settings. Keep required fields for the chosen variant and do not copy fields from another platform variant into the wrong entry.

Worked HTTP example

The worked HTTP example in the Create Post API request example section shows the exact POST method, the /v1/posts/ path with {{API_BASE_URL}} as the origin, the x-access-key header, and a minimal JSON body with content, one twitter platform target, and publishNow set to true. Replace the token and accountId placeholders with your own values before use. Check the request before sending: content is present, platforms contains the intended account, media URLs are publicly accessible URIs when mediaItems are included, and only one publishing mode is selected.

Response body and status codes

Read the response by status code and by shape. The captured success shape for 200 and 202 contains success, status, scheduledFor, postId, and a platforms array whose entries contain platform, success, platformPostUrl, error, and warningMessage. The captured message shape for 400, 402, 403, and 503 contains success and message. After a successful call, inspect each platform entry separately: a top-level success does not remove the need to check per-platform success, platformPostUrl, error, and warningMessage fields. For error statuses, use the message field as the returned explanation and do not assume additional fields that are not in the captured shape.

Failure checks before implementation

Before treating this reference as a working integration, verify the exact endpoint, header, field names, requiredness, enums, and status shapes against the implementation you are building. The most common failure checks are a missing or wrong x-access-key header, a missing content or platforms field, an invalid mediaItems type or non-URI url, combining saveAsDraft with publishNow or scheduledFor, reusing an idempotencyKey for a different post, and copying platformSpecificData fields across different platform variants. Correct the request field or mode rather than changing the documented method or path.

Create Post API request fields
FieldTypeRequiredConstraints and notes
contentstringrequiredPost text body
mediaItemsarray<object>optionalMedia attachments (images, videos, GIFs)
mediaItems[].typestringrequired"image" | "video" | "gif" | "document"
mediaItems[].urlstringrequiredFormat: uri; publicly accessible URL
mediaItems[].altTextstringoptional1 <= length <= 1000
mediaItems[].thumbnailstringoptionalFormat: uri
platformsarray<object>requiredTarget platform accounts. Drafts may be saved without an account.
platforms[].platformstringrequiredOne platform variant value, such as "twitter"
platforms[].accountIdstringrequiredIntegration identifier for the target account
platforms[].contentstringoptionalPer-platform text override; top-level content is used when omitted
platforms[].platformSpecificDataobjectoptionalPer-platform configuration for the selected platform
publishNowbooleanoptionalPublish immediately. scheduledFor takes precedence when provided.
saveAsDraftbooleanoptionalSave without publishing or scheduling. Cannot be combined with publishNow=true or scheduledFor.
scheduledForstringoptionalFormat: date-time; ISO 8601 datetime to schedule the post for future publishing
timezonestringoptionalIANA timezone for the scheduled time (e.g. America/New_York). Defaults to UTC.
idempotencyKeystringoptional1 <= length <= 255; scoped per project; reuse a fresh key for each distinct post

Exact captured request contract; platformSpecificData variants are summarized in the platform configuration table.

Publishing mode decision table
Mode fieldValueEffectCompatibility
saveAsDrafttrueSave without publishing or schedulingCannot be combined with publishNow=true or scheduledFor
publishNowtruePublish immediatelyscheduledFor takes precedence when provided
scheduledForISO 8601 date-time stringSchedule for future publishingTakes precedence over publishNow
timezoneIANA timezone stringTimezone for scheduledForDefaults to UTC
idempotencyKeystring, 1-255 charsSafe retry; original result returned for same project and keyUse a fresh key for each distinct post

Captured precedence and incompatibility rules preserved exactly.

platformSpecificData variants by platform
Platform valueplatformSpecificData fieldsRequired within variantNotable constraints
"twitter"communityId, shareWithFollowers, replyToTweetId, replySettings, threadItems, longPost, pollthreadItems[].content when threadItems used; poll.options and poll.durationMinutes when poll usedreplySettings: "following" | "mentionedUsers" | "subscribers" | "verified"; poll.options 2-4 items; poll.durationMinutes 5-10080; poll cannot be combined with media or threadItems
"instagram"locationId, audioConfiguration, contentType, isAiGenerated, shareToFeed, trialParams, coverUrl, thumbOffset, audioName, collaboratorsaudioConfiguration.audioId when audioConfiguration used; trialParams.graduationStrategy when trialParams usedcontentType: "story"; graduationStrategy: "MANUAL" | "SS_PERFORMANCE"; collaborators 1-3 items; audioVolume/videoVolume 1-100
"youtube"title, tags, visibility, madeForKids, containsSyntheticMedia, categoryId, playlistId, firstCommentNone listed as required in the variant summaryvisibility: "public" | "private" | "unlisted"; title length <= 100; firstComment length <= 10000
"tiktok"privacyLevel, disableComment, disableDuet, disableStitch, brandContentToggle, brandOrganicToggle, isAigc, videoCoverTimestampMs, autoAddMusic, photoCoverIndex, description, draftNone listed as required in the variant summaryprivacyLevel: "PUBLIC_TO_EVERYONE" | "MUTUAL_FOLLOW_FRIENDS" | "FOLLOWER_OF_CREATOR" | "SELF_ONLY"; description length <= 4000
"pinterest"boardId, title, link, altText, dominantColor, coverImageUrlboardIdtitle length <= 100; altText length <= 500; link and coverImageUrl are URIs
"linkedin"visibility, mentions, articleUrl, articleTitle, articleDescription, documentTitlementions[].text and mentions[].urn when mentions are usedvisibility: "PUBLIC" | "CONNECTIONS"; mentions items <= 30; urn matches ^urn:li:organization:.+$
"bluesky"langs, altTextNone listed as required in the variant summarylangs and altText are arrays of strings
"facebook"contentType, link, isAiGenerated, published, videoThumbnailUrlNone listed as required in the variant summarycontentType: "reel" | "story"; link and videoThumbnailUrl are URIs
"threads"replyControl, altTextNone listed as required in the variant summaryreplyControl: "everyone" | "accounts_you_follow" | "mentioned_only"
"googlebusiness"topicType, callToActionType, callToActionUrl, eventTitle, eventStartDate, eventStartTime, eventEndDate, eventEndTime, offerCouponCode, offerRedeemOnlineUrl, offerTermsConditionsNone listed as required in the variant summarytopicType: "STANDARD" | "EVENT" | "OFFER"; callToActionType: "BOOK" | "ORDER" | "SHOP" | "LEARN_MORE" | "SIGN_UP" | "CALL" | "GET_OFFER"

Variant summary from captured typed contract; full field-level detail remains in the immutable contract sheet.

Create Post API status and response matrix
StatusCaptured response shapeFieldsQualification
200application/json success shapesuccess, status, scheduledFor, postId, platforms[] with platform, success, platformPostUrl, error, warningMessageCaptured example shape retained
202application/json success shapesuccess, status, scheduledFor, postId, platforms[] with platform, success, platformPostUrl, error, warningMessageCaptured example appears identical to 200; ambiguity flagged
400application/json message shapesuccess, messageMeaning beyond code and shape not supplied
402application/json message shapesuccess, messageMeaning beyond code and shape not supplied; no credit or offer claims included
403application/json message shapesuccess, messageMeaning beyond code and shape not supplied
503application/json message shapesuccess, messageMeaning beyond code and shape not supplied

Factual hold: captured examples for 200 and 202 appear identical, while the typed contract graph defines a success/message response; no semantics invented.

Frequently asked questions

How do I save a post as a draft instead of publishing it?

Set saveAsDraft to true to save without publishing or scheduling. That mode cannot be combined with publishNow set to true or with scheduledFor. The platforms field is required, each platforms entry requires platform and accountId, and the field description states that drafts may be saved without an account.

How does scheduling work with scheduledFor and timezone?

Provide scheduledFor as an ISO 8601 date-time string and, when needed, timezone as an IANA timezone such as America/New_York. The timezone defaults to UTC. When scheduledFor is provided, it takes precedence over publishNow.

How can I safely retry a Create Post API request?

Provide an idempotencyKey from 1 to 255 characters long. If a post was already created with the same key for the same project, the original result is returned instead of creating or publishing a duplicate. Use a fresh key for each distinct post.

What fields are required for mediaItems?

Include mediaItems as an array of objects. Each item requires type, one of image, video, gif or document, and url as a URI. Optional altText is 1 to 1000 characters and thumbnail is a URI.

Where do I put platform-specific settings?

Add platformSpecificData to the relevant platforms entry. The available fields depend on the platform value, such as twitter, instagram, youtube, tiktok, pinterest, linkedin, bluesky, facebook, threads or googlebusiness, and each variant has its own required and optional fields, including nested objects such as poll, audioConfiguration, trialParams, threadItems and mentions.

Create Post API request example
curl -X POST "{{API_BASE_URL}}/v1/posts/" \
  -H "Content-Type: application/json" \
  -H "x-access-key: <token>" \
  -d '{
    "content": "A short example update.",
    "platforms": [
      {
        "platform": "twitter",
        "accountId": "<your-account-id>"
      }
    ],
    "publishNow": true
  }'
Captured success response shape for 200 and 202
{
  "success": true,
  "status": "draft",
  "scheduledFor": "2019-08-24T14:15:22Z",
  "postId": "string",
  "platforms": [
    {
      "platform": "twitter",
      "success": true,
      "platformPostUrl": "string",
      "error": "string",
      "warningMessage": "string"
    }
  ]
}
Captured message response shape for 400, 402, 403 and 503
{
  "success": true,
  "message": "string"
}
Interface fields
ScopeFieldTypeType referenceRequiredDescriptionConstraints
body#1bodyobject__0Yes
body#1body.contentstring__1YesPost text body
body#1body.mediaItemsarray<object>__2NoMedia attachments (images, videos, GIFs)
body#1body.mediaItems[]object__3
body#1body.mediaItems[].typestring__4Yeskind: schemaValueIn; value: "image" | "video" | "gif" | "document"
body#1body.mediaItems[].urlstring__5YesPublicly accessible URL for the media file. the service or the platform provider must be able to fetch it without authentication.kind: schemaFormat; value: uri
body#1body.mediaItems[].altTextstring__6NoAccessibility description for an image. Supported platforms forward it when publishing images; unsupported platforms and non-image media ignore it.kind: schemaLength; value: 1 <= length <= 1000
body#1body.mediaItems[].thumbnailstring__7NoThumbnail image URL for Facebook videos and YouTube regular videos (not Shorts). YouTube accepts JPEG, PNG, or GIF, max 2 MB, min 640 px wide.kind: schemaFormat; value: uri
body#1body.platformsarray<object>__8YesTarget platform accounts. Drafts may be saved without an account.
body#1body.platforms[]object__9
body#1body.platforms[][variant1]object__9_extends:__10
body#1body.platforms[][variant1].platformstring__11Yeskind: schemaValueIn; value: "twitter"
body#1body.platforms[][variant1].accountIdstring__12YesIntegration._id — find yours via GET /connect/integrations
body#1body.platforms[][variant1].contentstring__13NoOptional per-platform text override. Use when you want to change the text for this platform because different platforms talk differently. When omitted, the top-level content is used.
body#1body.platforms[][variant1].platformSpecificDataobject#/components/schemas/TwitterConfigurationsNoPass this object in platformSpecificData when posting to Twitter/X, including Community post options.
body#1body.platforms[][variant1].platformSpecificData.communityIdstring__14NoCommunity ID to publish this post into.
body#1body.platforms[][variant1].platformSpecificData.shareWithFollowersboolean__15NoWhen posting to a Community, also share the post with followers.
body#1body.platforms[][variant1].platformSpecificData.replyToTweetIdstring__16NoTweet ID to reply to.
body#1body.platforms[][variant1].platformSpecificData.replySettingsstring__17Nokind: schemaValueIn; value: "following" | "mentionedUsers" | "subscribers" | "verified"
body#1body.platforms[][variant1].platformSpecificData.threadItemsarray<object>__18NoAdditional tweets to chain as a thread. The root tweet uses post.content.
body#1body.platforms[][variant1].platformSpecificData.threadItems[]object__19
body#1body.platforms[][variant1].platformSpecificData.threadItems[].contentstring__20YesText of this thread tweet (max 280 chars)
body#1body.platforms[][variant1].platformSpecificData.threadItems[].mediaItemsarray<object>__21No
body#1body.platforms[][variant1].platformSpecificData.threadItems[].mediaItems[]object__22
body#1body.platforms[][variant1].platformSpecificData.threadItems[].mediaItems[].typestring__23Yeskind: ; value: "image" | "video" | "gif" | "document"
body#1body.platforms[][variant1].platformSpecificData.threadItems[].mediaItems[].urlstring__24YesPublicly accessible URL for the media file. the service or the platform provider must be able to fetch it without authentication.kind: ; value: uri
body#1body.platforms[][variant1].platformSpecificData.threadItems[].mediaItems[].altTextstring__25NoAccessibility description for an image. Supported platforms forward it when publishing images; unsupported platforms and non-image media ignore it.kind: ; value: 1 <= length <= 1000
body#1body.platforms[][variant1].platformSpecificData.threadItems[].mediaItems[].thumbnailstring__26NoThumbnail image URL for Facebook videos and YouTube regular videos (not Shorts). YouTube accepts JPEG, PNG, or GIF, max 2 MB, min 640 px wide.kind: ; value: uri
body#1body.platforms[][variant1].platformSpecificData.longPostboolean__27NoOpt in to long posts (over 280 characters). Skips the service's 280-character pre-check so X can accept up to 25,000 characters for eligible Premium / Premium+ accounts. If the connected account is not eligible, X rejects the post and the error is surfaced back. No extra API cost.
body#1body.platforms[][variant1].platformSpecificData.pollobject__28NoCannot be combined with media or threadItems.
body#1body.platforms[][variant1].platformSpecificData.poll.optionsarray<string>__29Yes2–4 poll options.kind: ; value: 2 <= items <= 4
body#1body.platforms[][variant1].platformSpecificData.poll.options[]string__30
body#1body.platforms[][variant1].platformSpecificData.poll.durationMinutesnumber__31YesPoll duration in minutes (5 min – 7 days).kind: ; value: 5 <= value <= 10080
body#1body.platforms[][variant2]object__9_extends:__32
body#1body.platforms[][variant2].platformstring__33Yeskind: ; value: "instagram"
body#1body.platforms[][variant2].accountIdstring__34YesIntegration._id — find yours via GET /connect/integrations
body#1body.platforms[][variant2].contentstring__35NoOptional per-platform text override. Use when you want to change the text for this platform because different platforms talk differently. When omitted, the top-level content is used.
body#1body.platforms[][variant2].platformSpecificDataobject#/components/schemas/InstagramConfigurationsNoPass this object in platformSpecificData when posting to Instagram. Use contentType to publish Stories; the remaining fields customize feed posts and Reels.
body#1body.platforms[][variant2].platformSpecificData.locationIdstring__36NoNumeric Facebook Page ID with location data. Feed posts, Reels and whole carousels only; not Stories.kind: ; value: ^\d+$
body#1body.platforms[][variant2].platformSpecificData.audioConfigurationobject__37NoCatalog audio for single-video Reels, requires Facebook Login. Volumes default to 100. Audio must remain available at publish time.
body#1body.platforms[][variant2].platformSpecificData.audioConfiguration.audioIdstring__38Yeskind: ; value: ^\d+$
body#1body.platforms[][variant2].platformSpecificData.audioConfiguration.audioVolumeinteger__39Nokind: ; value: 1 <= value <= 100
body#1body.platforms[][variant2].platformSpecificData.audioConfiguration.videoVolumeinteger__40Nokind: ; value: 1 <= value <= 100
body#1body.platforms[][variant2].platformSpecificData.contentTypestring__41NoSet to "story" to publish an Instagram Story. Omit for the existing behavior: images publish to Feed and videos publish as Reels.kind: ; value: "story"
body#1body.platforms[][variant2].platformSpecificData.isAiGeneratedboolean__42NoSelf-discloses that the post contains AI-generated images or video so Instagram can show its AI info label. Applies to feed posts, Reels, Stories, and carousel parents; it does not describe AI-written captions.
body#1body.platforms[][variant2].platformSpecificData.shareToFeedboolean__43NoReels-only. When true (default), the Reel also appears in the account's main feed grid. Set false to publish to Reels only.
body#1body.platforms[][variant2].platformSpecificData.trialParamsobject__44NoReels-only. Publishes a single video as a Trial Reel, initially shown to non-followers.
body#1body.platforms[][variant2].platformSpecificData.trialParams.graduationStrategystring__45YesControls how a Trial Reel is shared with followers. MANUAL keeps graduation manual; SS_PERFORMANCE lets Instagram share it automatically when it performs well.kind: ; value: "MANUAL" | "SS_PERFORMANCE"
body#1body.platforms[][variant2].platformSpecificData.coverUrlstring__46NoVideo-only. Public URL of an image Instagram will use as the cover frame for the Reel/video post. Ignored for image posts.kind: ; value: uri
body#1body.platforms[][variant2].platformSpecificData.thumbOffsetinteger__47NoVideo-only. Timestamp in milliseconds Instagram extracts as the cover frame. Ignored when coverUrl is set or for image posts.kind: ; value: 0 <= value
body#1body.platforms[][variant2].platformSpecificData.audioNamestring__48NoReels-only. Sets the name shown for the Reel audio. This only labels audio already in the video file. Use audioConfiguration to attach catalog audio through Facebook Login.kind: ; value: 1 <= length <= 100
body#1body.platforms[][variant2].platformSpecificData.collaboratorsarray<string>__49NoFeed posts, carousels, and Reels only. Up to three Instagram usernames to invite as collaborators. Each account must accept the invitation in Instagram.kind: ; value: 1 <= items <= 3
body#1body.platforms[][variant2].platformSpecificData.collaborators[]string__50Instagram username without the leading @.kind: ; value: ^[A-Za-z0-9._]+$ | kind: ; value: 1 <= length <= 30
body#1body.platforms[][variant3]object__9_extends:__51
body#1body.platforms[][variant3].platformstring__52Yeskind: ; value: "youtube"
body#1body.platforms[][variant3].accountIdstring__53YesIntegration._id — find yours via GET /connect/integrations
body#1body.platforms[][variant3].contentstring__54NoOptional per-platform text override. Use when you want to change the text for this platform because different platforms talk differently. When omitted, the top-level content is used.
body#1body.platforms[][variant3].platformSpecificDataobject#/components/schemas/YouTubeConfigurationsNoPass this object in platformSpecificData when posting to YouTube.
body#1body.platforms[][variant3].platformSpecificData.titlestring__55NoVideo title (max 100 chars, no < or >). Defaults to first 100 chars of content, or "Untitled Video".kind: ; value: length <= 100
body#1body.platforms[][variant3].platformSpecificData.tagsarray<string>__56NoVideo tags. Total characters across all tags must be ≤500.
body#1body.platforms[][variant3].platformSpecificData.tags[]string__57
body#1body.platforms[][variant3].platformSpecificData.visibilitystring__58NoWho can see the video. Defaults to "public". Scheduled posts remain queued in the service and upload at the scheduled time using this visibility.kind: ; value: "public" | "private" | "unlisted"
body#1body.platforms[][variant3].platformSpecificData.madeForKidsboolean__59NoCOPPA compliance flag. Setting to true permanently disables comments, notification bell, personalized ads, end screens, and cards on the video. Defaults to false.
body#1body.platforms[][variant3].platformSpecificData.containsSyntheticMediaboolean__60NoAI-generated content disclosure. YouTube is increasingly enforcing this requirement. Defaults to false.
body#1body.platforms[][variant3].platformSpecificData.categoryIdstring__61NoYouTube category ID. Defaults to "22" (People & Blogs). Common values: "1" Film & Animation, "10" Music, "20" Gaming, "22" People & Blogs, "27" Education, "28" Science & Technology.
body#1body.platforms[][variant3].platformSpecificData.playlistIdstring__62NoPlaylist to add the uploaded video to. Retrieve available IDs from the YouTube playlists endpoint.kind: ; value: 1 <= length
body#1body.platforms[][variant3].platformSpecificData.firstCommentstring__63NoAuto-posted comment after upload. Max 10,000 characters. For publishNow posts: posted immediately after upload. For scheduled posts: posted after the upload at the scheduled time.kind: ; value: length <= 10000
body#1body.platforms[][variant4]object__9_extends:__64
body#1body.platforms[][variant4].platformstring__65Yeskind: ; value: "tiktok"
body#1body.platforms[][variant4].accountIdstring__66YesIntegration._id — find yours via GET /connect/integrations
body#1body.platforms[][variant4].contentstring__67NoOptional per-platform text override. Use when you want to change the text for this platform because different platforms talk differently. When omitted, the top-level content is used.
body#1body.platforms[][variant4].platformSpecificDataobject#/components/schemas/TikTokConfigurationsNoPass this object in platformSpecificData when posting to TikTok.
body#1body.platforms[][variant4].platformSpecificData.privacyLevelstring__68NoWho can see this post. Defaults to "PUBLIC_TO_EVERYONE".kind: ; value: "PUBLIC_TO_EVERYONE" | "MUTUAL_FOLLOW_FRIENDS" | "FOLLOWER_OF_CREATOR" | "SELF_ONLY"
body#1body.platforms[][variant4].platformSpecificData.disableCommentboolean__69NoDisable comments on this post. Defaults to false.
body#1body.platforms[][variant4].platformSpecificData.disableDuetboolean__70NoDisable duet for this video. Videos only. Defaults to false.
body#1body.platforms[][variant4].platformSpecificData.disableStitchboolean__71NoDisable stitch for this video. Videos only. Defaults to false.
body#1body.platforms[][variant4].platformSpecificData.brandContentToggleboolean__72NoMark as branded content (paid partnership). Defaults to false.
body#1body.platforms[][variant4].platformSpecificData.brandOrganicToggleboolean__73NoMark as organic brand promotion. Defaults to false.
body#1body.platforms[][variant4].platformSpecificData.isAigcboolean__74NoAI-generated content disclosure for photo and video posts. Defaults to false.
body#1body.platforms[][variant4].platformSpecificData.videoCoverTimestampMsnumber__75NoTimestamp in milliseconds to use as the video cover frame. Videos only.kind: ; value: 0 <= value
body#1body.platforms[][variant4].platformSpecificData.autoAddMusicboolean__76NoAutomatically add background music to photo carousels. Photo posts only. Defaults to true.
body#1body.platforms[][variant4].platformSpecificData.photoCoverIndexnumber__77No0-indexed position of the cover image in a photo carousel. Photo posts only. Defaults to 0.kind: ; value: 0 <= value
body#1body.platforms[][variant4].platformSpecificData.descriptionstring__78NoSeparate description for a TikTok photo or carousel post. Max 4,000 characters. When omitted, the post content is also used as the description. Photo posts only.kind: ; value: length <= 4000
body#1body.platforms[][variant4].platformSpecificData.draftboolean__79NoWhen true, sends content to the creator's TikTok inbox as a draft. Defaults to false (publishes immediately via DIRECT_POST).
body#1body.platforms[][variant5]object__9_extends:__80
body#1body.platforms[][variant5].platformstring__81Yeskind: ; value: "pinterest"
body#1body.platforms[][variant5].accountIdstring__82YesIntegration._id — find yours via GET /connect/integrations
body#1body.platforms[][variant5].contentstring__83NoOptional per-platform text override. Use when you want to change the text for this platform because different platforms talk differently. When omitted, the top-level content is used.
body#1body.platforms[][variant5].platformSpecificDataobject#/components/schemas/PinterestConfigurationsNoPass this object in platformSpecificData when posting to Pinterest.
body#1body.platforms[][variant5].platformSpecificData.boardIdstring__84YesTarget board ID. Retrieve available boards via GET /v1/pinterest/boards.
body#1body.platforms[][variant5].platformSpecificData.titlestring__85NoPin title. Max 100 characters. Defaults to first line of content.kind: ; value: length <= 100
body#1body.platforms[][variant5].platformSpecificData.linkstring__86NoHTTPS destination URL when the pin is clicked. Important for driving traffic.kind: ; value: uri
body#1body.platforms[][variant5].platformSpecificData.altTextstring__87NoAccessible image description. Max 500 characters.kind: ; value: length <= 500
body#1body.platforms[][variant5].platformSpecificData.dominantColorstring__88NoHex color for the loading placeholder (e.g. "#6E7874").
body#1body.platforms[][variant5].platformSpecificData.coverImageUrlstring__89NoCustom cover image URL for video pins.kind: ; value: uri
body#1body.platforms[][variant6]object__9_extends:__90
body#1body.platforms[][variant6].platformstring__91Yeskind: ; value: "linkedin"
body#1body.platforms[][variant6].accountIdstring__92YesIntegration._id — find yours via GET /connect/integrations
body#1body.platforms[][variant6].contentstring__93NoOptional per-platform text override. Use when you want to change the text for this platform because different platforms talk differently. When omitted, the top-level content is used.
body#1body.platforms[][variant6].platformSpecificDataobject#/components/schemas/LinkedInConfigurationsNoPass this object in platformSpecificData when posting to LinkedIn.
body#1body.platforms[][variant6].platformSpecificData.visibilitystring__94NoPost visibility. "PUBLIC" = visible to everyone, "CONNECTIONS" = visible to connections only. Defaults to "PUBLIC".kind: ; value: "PUBLIC" | "CONNECTIONS"
body#1body.platforms[][variant6].platformSpecificData.mentionsarray<object>__95NoTag company pages in the post text. Each entry maps an exact substring of content to the organization URN to mention; LinkedIn renders it as a clickable @mention. Only company pages can be mentioned, not personal profiles.kind: ; value: items <= 30
body#1body.platforms[][variant6].platformSpecificData.mentions[]object__96
body#1body.platforms[][variant6].platformSpecificData.mentions[].textstring__97YesExact substring within the post content to turn into a clickable mention (e.g. "Acme Corp"). Case-sensitive, must appear exactly once in content.kind: ; value: 1 <= length
body#1body.platforms[][variant6].platformSpecificData.mentions[].urnstring__98YesLinkedIn URN of the company page to mention, e.g. "urn:li:organization:12345". LinkedIn's API only supports mentioning organization/company pages, not personal profiles.kind: ; value: ^urn:li:organization:.+$
body#1body.platforms[][variant6].platformSpecificData.articleUrlstring__99NoURL for an article/link post. When provided, the post becomes a link share with a preview card.kind: ; value: uri
body#1body.platforms[][variant6].platformSpecificData.articleTitlestring__100NoTitle for the article preview card. Max 400 characters.kind: ; value: length <= 400
body#1body.platforms[][variant6].platformSpecificData.articleDescriptionstring__101NoDescription for the article preview card. Max 400 characters.kind: ; value: length <= 400
body#1body.platforms[][variant6].platformSpecificData.documentTitlestring__102NoTitle shown on the document card when posting a PDF. Required by LinkedIn when a document media item is included.kind: ; value: length <= 200
body#1body.platforms[][variant7]object__9_extends:__103
body#1body.platforms[][variant7].platformstring__104Yeskind: ; value: "bluesky"
body#1body.platforms[][variant7].accountIdstring__105YesIntegration._id — find yours via GET /connect/integrations
body#1body.platforms[][variant7].contentstring__106NoOptional per-platform text override. Use when you want to change the text for this platform because different platforms talk differently. When omitted, the top-level content is used.
body#1body.platforms[][variant7].platformSpecificDataobject#/components/schemas/BlueskyConfigurationsNoPass this object in platformSpecificData when posting to Bluesky.
body#1body.platforms[][variant7].platformSpecificData.langsarray<string>__107NoBCP-47 language tags for the post (e.g. ["en"], ["en-US", "es"]). Defaults to ["en"].
body#1body.platforms[][variant7].platformSpecificData.langs[]string__108
body#1body.platforms[][variant7].platformSpecificData.altTextarray<string>__109NoAlt text for each image, in the same order as mediaItems. Strongly encouraged for accessibility.
body#1body.platforms[][variant7].platformSpecificData.altText[]string__110
body#1body.platforms[][variant8]object__9_extends:__111
body#1body.platforms[][variant8].platformstring__112Yeskind: ; value: "facebook"
body#1body.platforms[][variant8].accountIdstring__113YesIntegration._id — find yours via GET /connect/integrations
body#1body.platforms[][variant8].contentstring__114NoOptional per-platform text override. Use when you want to change the text for this platform because different platforms talk differently. When omitted, the top-level content is used.
body#1body.platforms[][variant8].platformSpecificDataobject#/components/schemas/FacebookConfigurationsNoPass this object in platformSpecificData when posting to Facebook Pages.
body#1body.platforms[][variant8].platformSpecificData.contentTypestring__115NoSet to "reel" to publish exactly one video as a Facebook Page Reel, or "story" to publish exactly one image or video as a Story. Omit for a feed post. Stories expire after 24 hours; captions, links, and custom thumbnails are ignored. published: false is not supported for Stories.kind: ; value: "reel" | "story"
body#1body.platforms[][variant8].platformSpecificData.linkstring__116NoWhen provided on a text-only post, Facebook renders a link preview card from this URL's Open Graph tags. Ignored when mediaItems are attached.kind: ; value: uri
body#1body.platforms[][variant8].platformSpecificData.isAiGeneratedboolean__117NoSelf-discloses that the uploaded video is AI-generated. Supported for Facebook Page feed videos, Reels, and video Stories; it is not applied to text, photo, or carousel posts.
body#1body.platforms[][variant8].platformSpecificData.publishedboolean__118NoWhen false, the post is created on the Page in unpublished/draft state — useful for staging or scheduling via Facebook's own composer. Defaults to true.
body#1body.platforms[][variant8].platformSpecificData.videoThumbnailUrlstring__119NoVideo posts only. Optional Facebook-specific override for mediaItems[].thumbnail. Applied as a follow-up call after publish — if the upload fails, the post still succeeds (Facebook just auto-picks a frame). Ignored when no video is attached.kind: ; value: uri
body#1body.platforms[][variant9]object__9_extends:__120
body#1body.platforms[][variant9].platformstring__121Yeskind: ; value: "threads"
body#1body.platforms[][variant9].accountIdstring__122YesIntegration._id — find yours via GET /connect/integrations
body#1body.platforms[][variant9].contentstring__123NoOptional per-platform text override. Use when you want to change the text for this platform because different platforms talk differently. When omitted, the top-level content is used.
body#1body.platforms[][variant9].platformSpecificDataobject#/components/schemas/ThreadsConfigurationsNoPass this object in platformSpecificData when posting to Threads.
body#1body.platforms[][variant9].platformSpecificData.replyControlstring__124NoWho can reply to this thread. Defaults to "everyone" when omitted.kind: ; value: "everyone" | "accounts_you_follow" | "mentioned_only"
body#1body.platforms[][variant9].platformSpecificData.altTextarray<string>__125NoAlt text for each image, in the same order as mediaItems. Strongly encouraged for accessibility.
body#1body.platforms[][variant9].platformSpecificData.altText[]string__126
body#1body.platforms[][variant10]object__9_extends:__127
body#1body.platforms[][variant10].platformstring__128Yeskind: ; value: "googlebusiness"
body#1body.platforms[][variant10].accountIdstring__129YesIntegration._id — find yours via GET /connect/integrations
body#1body.platforms[][variant10].contentstring__130NoOptional per-platform text override. Use when you want to change the text for this platform because different platforms talk differently. When omitted, the top-level content is used.
body#1body.platforms[][variant10].platformSpecificDataobject#/components/schemas/GoogleBusinessConfigurationsNoPass this object in platformSpecificData when posting to Google Business Profile. Posts appear on Google Search and Maps.
body#1body.platforms[][variant10].platformSpecificData.topicTypestring__131NoPost type. Defaults to STANDARD. Use EVENT for event posts, OFFER for promotional offer posts.kind: ; value: "STANDARD" | "EVENT" | "OFFER"
body#1body.platforms[][variant10].platformSpecificData.callToActionTypestring__132NoCall-to-action button shown on the post.kind: ; value: "BOOK" | "ORDER" | "SHOP" | "LEARN_MORE" | "SIGN_UP" | "CALL" | "GET_OFFER"
body#1body.platforms[][variant10].platformSpecificData.callToActionUrlstring__133NoURL for the call-to-action. Required for all CTA types except CALL.kind: ; value: uri
body#1body.platforms[][variant10].platformSpecificData.eventTitlestring__134NoEvent title. Required when topicType is EVENT.
body#1body.platforms[][variant10].platformSpecificData.eventStartDatestring__135NoEvent start date in YYYY-MM-DD format. Required when topicType is EVENT.
body#1body.platforms[][variant10].platformSpecificData.eventStartTimestring__136NoEvent start time in HH:MM (24-hour) format. Required when topicType is EVENT.
body#1body.platforms[][variant10].platformSpecificData.eventEndDatestring__137NoEvent end date in YYYY-MM-DD format. Required when topicType is EVENT.
body#1body.platforms[][variant10].platformSpecificData.eventEndTimestring__138NoEvent end time in HH:MM (24-hour) format. Required when topicType is EVENT.
body#1body.platforms[][variant10].platformSpecificData.offerCouponCodestring__139NoCoupon code for OFFER posts.
body#1body.platforms[][variant10].platformSpecificData.offerRedeemOnlineUrlstring__140NoOnline redemption URL for OFFER posts.kind: ; value: uri
body#1body.platforms[][variant10].platformSpecificData.offerTermsConditionsstring__141NoTerms and conditions text for OFFER posts.
body#1body.publishNowboolean__142NoPublish immediately. scheduledFor takes precedence when provided.
body#1body.saveAsDraftboolean__143NoSave without publishing or scheduling. Cannot be combined with publishNow=true or scheduledFor.
body#1body.scheduledForstring__144NoISO 8601 datetime to schedule the post for future publishingkind: ; value: date-time
body#1body.timezonestring__145NoIANA timezone for the scheduled time (e.g. America/New_York). Defaults to UTC.
body#1body.idempotencyKeystring__146NoOptional unique key to safely retry this request. If a post was already created with the same key for this project, the original result is returned instead of creating or publishing a duplicate. Scoped per project; reuse a fresh key for each distinct post.kind: ; value: 1 <= length <= 255
response#2responseobject__0
response#2response.successboolean__1Yes
response#2response.messagestring__2Yes