Skip to content

Edit Post API: Edit a Draft or Scheduled Post

The Edit Post API uses PUT /v1/posts/{postId} to replace an editable post. If you need to edit scheduled post content, revise a draft, change text or media, or change its outcome, this operation covers all three outcomes: keep it as a draft, publish it right away, or set a future scheduled time. The mode is selected in the request body, and the full replacement body is sent in the request described in the Request body field map table.

Edit a draft or scheduled post

This endpoint replaces an editable post. Three outcomes are available through the body fields: a draft can stay a draft, go live immediately, or move to a scheduled time, and an already scheduled post can retain its existing schedule when scheduled mode is used. Send PUT to /v1/posts/{postId}, where postId is the required string path parameter identifying the post to replace. Before calling, confirm the postId, the full replacement content, the target platforms, and which outcome you intend: draft, immediate publish, or scheduled.

Authorization

Authenticate every request with the accessKey header named x-access-key. Place the token in the x-access-key header and set Content-Type to application/json for the request body.

Path Parameters

The path parameter postId is a required string and is the identifier of the post being edited. Use the exact identifier returned for the draft or scheduled post you intend to replace, and verify it against the post you retrieved before sending the PUT request.

Request Body

The request body is application/json and uses the PostPayload shape. The required fields are content, a string containing the post text body, and platforms, an array of target platform account objects. The optional mediaItems field is an array of media attachment objects for images, videos, and GIFs, and each item requires type and url, with optional altText and thumbnail. Each platforms item requires platform and accountId, and may include an optional per-platform content override and platformSpecificData for that platform. Drafts may be saved without an account, as stated in the platforms description. For safe retries, idempotencyKey is an optional string with length from 1 to 255, scoped per project, and a fresh key should be used for each distinct post. When scheduling, scheduledFor is an optional ISO 8601 date-time string and timezone is an optional IANA timezone string for the scheduled time, defaulting to UTC when omitted. The worked request example below shows the minimal captured shape with content and a single twitter platform entry. The full nested platformSpecificData fields for each platform variant are listed in the Platform-specific configuration table.

Choosing saveAsDraft, publishNow or scheduledFor

Choose exactly one outcome for the edited post. Set saveAsDraft=true to save without publishing or scheduling, and do not combine it with publishNow=true or scheduledFor. Set publishNow=true to publish immediately, noting that scheduledFor takes precedence when provided. Set scheduledFor to an ISO 8601 datetime to schedule the post for future publishing, optionally with timezone set to an IANA timezone such as America/New_York. If you need to edit a scheduled post without changing its schedule, keep the scheduled mode rather than switching to draft or immediate publish. The mode comparison table below summarizes precedence and the prohibition on combining saveAsDraft with the other two modes.

Response Body

A successful edit returns a JSON body with success, status, scheduledFor, postId, and a platforms array. Each platform result includes platform, success, platformPostUrl, error, and warningMessage. Check the top-level success and status first, then inspect each platform entry so a per-platform error or warning is not missed. Error responses use the shared shape with success and message. The status matrix below lists every documented status code, 200, 202, 400, 402, 403, 404, 409, and 503, with only the response shape shown in the source and no invented cause for any error status.

Request body field map
FieldTypeRequiredConstraints / Notes
contentstringYesPost text body
mediaItemsarray<object>NoMedia attachments (images, videos, GIFs)
mediaItems[].typestringYes (per item)"image" | "video" | "gif" | "document"
mediaItems[].urlstringYes (per item)Format: uri; publicly accessible URL fetchable without authentication
mediaItems[].altTextstringNo1 <= length <= 1000
mediaItems[].thumbnailstringNoFormat: uri
platformsarray<object>YesTarget platform accounts. Drafts may be saved without an account.
platforms[].platformstringYes (per item)"twitter" | "instagram" | "youtube" | "tiktok" | "pinterest" | "linkedin" | "bluesky" | "facebook" | "threads" | "googlebusiness"
platforms[].accountIdstringYes (per item)Integration._id
platforms[].contentstringNoOptional per-platform text override; top-level content used when omitted
platforms[].platformSpecificDataobjectNoPlatform-specific configuration object for the selected platform; see Platform-specific configuration table
publishNowbooleanNoPublish immediately. scheduledFor takes precedence when provided.
saveAsDraftbooleanNoSave without publishing or scheduling. Cannot be combined with publishNow=true or scheduledFor.
scheduledForstringNoFormat: date-time; ISO 8601 datetime to schedule the post for future publishing
timezonestringNoIANA timezone for the scheduled time (e.g. America/New_York). Defaults to UTC.
idempotencyKeystringNo1 <= length <= 255; optional unique key to safely retry; scoped per project; reuse a fresh key for each distinct post

Captured contract fields; nested platformSpecificData variants summarized by platform enum.

Platform-specific configuration
PlatformplatformSpecificData fields (type, required, constraints)
twitter (TwitterConfigurations)communityId string?; shareWithFollowers boolean?; replyToTweetId string?; replySettings string? "following"|"mentionedUsers"|"subscribers"|"verified"; threadItems array<object>? with content string* and mediaItems array<object>? (type* "image"|"video"|"gif"|"document", url* uri, altText? 1-1000, thumbnail? uri); longPost boolean?; poll object? with options array<string>* 2-4 items and durationMinutes number* 5-10080
instagram (InstagramConfigurations)locationId string? ^\d+$; audioConfiguration object? with audioId string* ^\d+$, audioVolume integer? 1-100, videoVolume integer? 1-100; contentType string? "story"; isAiGenerated boolean?; shareToFeed boolean?; trialParams object? with graduationStrategy string* "MANUAL"|"SS_PERFORMANCE"; coverUrl string? uri; thumbOffset integer? >=0; audioName string? 1-100; collaborators array<string>? 1-3 items, each ^[A-Za-z0-9._]+$ 1-30
youtube (YouTubeConfigurations)title string? length<=100; tags array<string>?; visibility string? "public"|"private"|"unlisted"; madeForKids boolean?; containsSyntheticMedia boolean?; categoryId string?; playlistId string? length>=1; firstComment string? length<=10000
tiktok (TikTokConfigurations)privacyLevel string? "PUBLIC_TO_EVERYONE"|"MUTUAL_FOLLOW_FRIENDS"|"FOLLOWER_OF_CREATOR"|"SELF_ONLY"; disableComment boolean?; disableDuet boolean?; disableStitch boolean?; brandContentToggle boolean?; brandOrganicToggle boolean?; isAigc boolean?; videoCoverTimestampMs number? >=0; autoAddMusic boolean?; photoCoverIndex number? >=0; description string? length<=4000; draft boolean?
pinterest (PinterestConfigurations)boardId string*; title string? length<=100; link string? uri; altText string? length<=500; dominantColor string?; coverImageUrl string? uri
linkedin (LinkedInConfigurations)visibility string? "PUBLIC"|"CONNECTIONS"; mentions array<object>? items<=30 with text string* length>=1 and urn string* ^urn:li:organization:.+$; articleUrl string? uri; articleTitle string? length<=400; articleDescription string? length<=400; documentTitle string? length<=200
bluesky (BlueskyConfigurations)langs array<string>?; altText array<string>?
facebook (FacebookConfigurations)contentType string? "reel"|"story"; link string? uri; isAiGenerated boolean?; published boolean?; videoThumbnailUrl string? uri
threads (ThreadsConfigurations)replyControl string? "everyone"|"accounts_you_follow"|"mentioned_only"; altText array<string>?
googlebusiness (GoogleBusinessConfigurations)topicType string? "STANDARD"|"EVENT"|"OFFER"; callToActionType string? "BOOK"|"ORDER"|"SHOP"|"LEARN_MORE"|"SIGN_UP"|"CALL"|"GET_OFFER"; callToActionUrl string? uri; eventTitle string?; eventStartDate string?; eventStartTime string?; eventEndDate string?; eventEndTime string?; offerCouponCode string?; offerRedeemOnlineUrl string? uri; offerTermsConditions string?

Captured serialized contract graph fields; descriptions only where captured, no invented descriptions.

Choosing saveAsDraft, publishNow or scheduledFor
Mode fieldResultPrecedence and combinations
saveAsDraft=trueDrafts remain drafts; saved without publishing or schedulingCannot be combined with publishNow=true or scheduledFor
publishNow=truePublish immediatelyscheduledFor takes precedence when provided
scheduledFor=<ISO 8601 datetime>Become scheduled for future publishing; scheduled posts keep their scheduleTakes precedence over publishNow; pair with timezone (IANA timezone, defaults to UTC)

Decision criteria from captured field descriptions.

Response status matrix
StatusResponse shape shown in source
200 application/jsonsuccess, status, scheduledFor, postId, platforms[] with platform, success, platformPostUrl, error, warningMessage
202 application/jsonsuccess, status, scheduledFor, postId, platforms[] with platform, success, platformPostUrl, error, warningMessage
400 application/jsonErrorResponse: success (boolean, required), message (string, required)
402 application/jsonErrorResponse: success (boolean, required), message (string, required)
403 application/jsonErrorResponse: success (boolean, required), message (string, required)
404 application/jsonErrorResponse: success (boolean, required), message (string, required)
409 application/jsonErrorResponse: success (boolean, required), message (string, required)
503 application/jsonErrorResponse: success (boolean, required), message (string, required)

Only shapes shown in source; no invented error causes.

Edit Post API request example
curl -X PUT "{{API_BASE_URL}}/v1/posts/{postId}" \
  -H "Content-Type: application/json" \
  -H "x-access-key: <token>" \
  -d '{
    "content": "string",
    "platforms": [
      {
        "platform": "twitter",
        "accountId": "string"
      }
    ]
  }'
Edit Post API 200 and 202 response example
{
  "success": true,
  "status": "draft",
  "scheduledFor": "2019-08-24T14:15:22Z",
  "postId": "string",
  "platforms": [
    {
      "platform": "twitter",
      "success": true,
      "platformPostUrl": "string",
      "error": "string",
      "warningMessage": "string"
    }
  ]
}
Edit Post API error response example
{
  "success": true,
  "message": "string"
}
Interface fields
ScopeFieldTypeType referenceRequiredDescriptionConstraints
body#1bodyobject#/components/schemas/PostPayloadYes
body#1body.contentstring__0YesPost text body
body#1body.mediaItemsarray<object>__1NoMedia attachments (images, videos, GIFs)
body#1body.mediaItems[]object__2
body#1body.mediaItems[].typestring__3Yeskind: schemaValueIn; value: "image" | "video" | "gif" | "document"
body#1body.mediaItems[].urlstring__4YesPublicly 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__5NoAccessibility 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__6NoThumbnail 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>__7YesTarget platform accounts. Drafts may be saved without an account.
body#1body.platforms[]object__8
body#1body.platforms[][variant1]object__8_extends:__9
body#1body.platforms[][variant1].platformstring__10Yeskind: schemaValueIn; value: "twitter"
body#1body.platforms[][variant1].accountIdstring__11YesIntegration._id — find yours via GET /connect/integrations
body#1body.platforms[][variant1].contentstring__12NoOptional 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__13NoCommunity ID to publish this post into.
body#1body.platforms[][variant1].platformSpecificData.shareWithFollowersboolean__14NoWhen posting to a Community, also share the post with followers.
body#1body.platforms[][variant1].platformSpecificData.replyToTweetIdstring__15NoTweet ID to reply to.
body#1body.platforms[][variant1].platformSpecificData.replySettingsstring__16Nokind: schemaValueIn; value: "following" | "mentionedUsers" | "subscribers" | "verified"
body#1body.platforms[][variant1].platformSpecificData.threadItemsarray<object>__17NoAdditional tweets to chain as a thread. The root tweet uses post.content.
body#1body.platforms[][variant1].platformSpecificData.threadItems[]object__18
body#1body.platforms[][variant1].platformSpecificData.threadItems[].contentstring__19YesText of this thread tweet (max 280 chars)
body#1body.platforms[][variant1].platformSpecificData.threadItems[].mediaItemsarray<object>__20No
body#1body.platforms[][variant1].platformSpecificData.threadItems[].mediaItems[]object__21
body#1body.platforms[][variant1].platformSpecificData.threadItems[].mediaItems[].typestring__22Yeskind: ; value: "image" | "video" | "gif" | "document"
body#1body.platforms[][variant1].platformSpecificData.threadItems[].mediaItems[].urlstring__23YesPublicly 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__24NoAccessibility 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__25NoThumbnail 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__26NoOpt 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__27NoCannot be combined with media or threadItems.
body#1body.platforms[][variant1].platformSpecificData.poll.optionsarray<string>__28Yes2–4 poll options.kind: ; value: 2 <= items <= 4
body#1body.platforms[][variant1].platformSpecificData.poll.options[]string__29
body#1body.platforms[][variant1].platformSpecificData.poll.durationMinutesnumber__30YesPoll duration in minutes (5 min – 7 days).kind: ; value: 5 <= value <= 10080
body#1body.platforms[][variant2]object__8_extends:__31
body#1body.platforms[][variant2].platformstring__32Yeskind: ; value: "instagram"
body#1body.platforms[][variant2].accountIdstring__33YesIntegration._id — find yours via GET /connect/integrations
body#1body.platforms[][variant2].contentstring__34NoOptional 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__35NoNumeric Facebook Page ID with location data. Feed posts, Reels and whole carousels only; not Stories.kind: ; value: ^\d+$
body#1body.platforms[][variant2].platformSpecificData.audioConfigurationobject__36NoCatalog 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__37Yeskind: ; value: ^\d+$
body#1body.platforms[][variant2].platformSpecificData.audioConfiguration.audioVolumeinteger__38Nokind: ; value: 1 <= value <= 100
body#1body.platforms[][variant2].platformSpecificData.audioConfiguration.videoVolumeinteger__39Nokind: ; value: 1 <= value <= 100
body#1body.platforms[][variant2].platformSpecificData.contentTypestring__40NoSet 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__41NoSelf-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__42NoReels-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__43NoReels-only. Publishes a single video as a Trial Reel, initially shown to non-followers.
body#1body.platforms[][variant2].platformSpecificData.trialParams.graduationStrategystring__44YesControls 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__45NoVideo-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__46NoVideo-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__47NoReels-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>__48NoFeed 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__49Instagram username without the leading @.kind: ; value: ^[A-Za-z0-9._]+$ | kind: ; value: 1 <= length <= 30
body#1body.platforms[][variant3]object__8_extends:__50
body#1body.platforms[][variant3].platformstring__51Yeskind: ; value: "youtube"
body#1body.platforms[][variant3].accountIdstring__52YesIntegration._id — find yours via GET /connect/integrations
body#1body.platforms[][variant3].contentstring__53NoOptional 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__54NoVideo 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>__55NoVideo tags. Total characters across all tags must be ≤500.
body#1body.platforms[][variant3].platformSpecificData.tags[]string__56
body#1body.platforms[][variant3].platformSpecificData.visibilitystring__57NoWho 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__58NoCOPPA 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__59NoAI-generated content disclosure. YouTube is increasingly enforcing this requirement. Defaults to false.
body#1body.platforms[][variant3].platformSpecificData.categoryIdstring__60NoYouTube 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__61NoPlaylist to add the uploaded video to. Retrieve available IDs from the YouTube playlists endpoint.kind: ; value: 1 <= length
body#1body.platforms[][variant3].platformSpecificData.firstCommentstring__62NoAuto-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__8_extends:__63
body#1body.platforms[][variant4].platformstring__64Yeskind: ; value: "tiktok"
body#1body.platforms[][variant4].accountIdstring__65YesIntegration._id — find yours via GET /connect/integrations
body#1body.platforms[][variant4].contentstring__66NoOptional 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__67NoWho 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__68NoDisable comments on this post. Defaults to false.
body#1body.platforms[][variant4].platformSpecificData.disableDuetboolean__69NoDisable duet for this video. Videos only. Defaults to false.
body#1body.platforms[][variant4].platformSpecificData.disableStitchboolean__70NoDisable stitch for this video. Videos only. Defaults to false.
body#1body.platforms[][variant4].platformSpecificData.brandContentToggleboolean__71NoMark as branded content (paid partnership). Defaults to false.
body#1body.platforms[][variant4].platformSpecificData.brandOrganicToggleboolean__72NoMark as organic brand promotion. Defaults to false.
body#1body.platforms[][variant4].platformSpecificData.isAigcboolean__73NoAI-generated content disclosure for photo and video posts. Defaults to false.
body#1body.platforms[][variant4].platformSpecificData.videoCoverTimestampMsnumber__74NoTimestamp in milliseconds to use as the video cover frame. Videos only.kind: ; value: 0 <= value
body#1body.platforms[][variant4].platformSpecificData.autoAddMusicboolean__75NoAutomatically add background music to photo carousels. Photo posts only. Defaults to true.
body#1body.platforms[][variant4].platformSpecificData.photoCoverIndexnumber__76No0-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__77NoSeparate 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__78NoWhen 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__8_extends:__79
body#1body.platforms[][variant5].platformstring__80Yeskind: ; value: "pinterest"
body#1body.platforms[][variant5].accountIdstring__81YesIntegration._id — find yours via GET /connect/integrations
body#1body.platforms[][variant5].contentstring__82NoOptional 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__83YesTarget board ID. Retrieve available boards via GET /v1/pinterest/boards.
body#1body.platforms[][variant5].platformSpecificData.titlestring__84NoPin title. Max 100 characters. Defaults to first line of content.kind: ; value: length <= 100
body#1body.platforms[][variant5].platformSpecificData.linkstring__85NoHTTPS destination URL when the pin is clicked. Important for driving traffic.kind: ; value: uri
body#1body.platforms[][variant5].platformSpecificData.altTextstring__86NoAccessible image description. Max 500 characters.kind: ; value: length <= 500
body#1body.platforms[][variant5].platformSpecificData.dominantColorstring__87NoHex color for the loading placeholder (e.g. "#6E7874").
body#1body.platforms[][variant5].platformSpecificData.coverImageUrlstring__88NoCustom cover image URL for video pins.kind: ; value: uri
body#1body.platforms[][variant6]object__8_extends:__89
body#1body.platforms[][variant6].platformstring__90Yeskind: ; value: "linkedin"
body#1body.platforms[][variant6].accountIdstring__91YesIntegration._id — find yours via GET /connect/integrations
body#1body.platforms[][variant6].contentstring__92NoOptional 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__93NoPost visibility. "PUBLIC" = visible to everyone, "CONNECTIONS" = visible to connections only. Defaults to "PUBLIC".kind: ; value: "PUBLIC" | "CONNECTIONS"
body#1body.platforms[][variant6].platformSpecificData.mentionsarray<object>__94NoTag 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__95
body#1body.platforms[][variant6].platformSpecificData.mentions[].textstring__96YesExact 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__97YesLinkedIn 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__98NoURL 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__99NoTitle for the article preview card. Max 400 characters.kind: ; value: length <= 400
body#1body.platforms[][variant6].platformSpecificData.articleDescriptionstring__100NoDescription for the article preview card. Max 400 characters.kind: ; value: length <= 400
body#1body.platforms[][variant6].platformSpecificData.documentTitlestring__101NoTitle 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__8_extends:__102
body#1body.platforms[][variant7].platformstring__103Yeskind: ; value: "bluesky"
body#1body.platforms[][variant7].accountIdstring__104YesIntegration._id — find yours via GET /connect/integrations
body#1body.platforms[][variant7].contentstring__105NoOptional 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>__106NoBCP-47 language tags for the post (e.g. ["en"], ["en-US", "es"]). Defaults to ["en"].
body#1body.platforms[][variant7].platformSpecificData.langs[]string__107
body#1body.platforms[][variant7].platformSpecificData.altTextarray<string>__108NoAlt text for each image, in the same order as mediaItems. Strongly encouraged for accessibility.
body#1body.platforms[][variant7].platformSpecificData.altText[]string__109
body#1body.platforms[][variant8]object__8_extends:__110
body#1body.platforms[][variant8].platformstring__111Yeskind: ; value: "facebook"
body#1body.platforms[][variant8].accountIdstring__112YesIntegration._id — find yours via GET /connect/integrations
body#1body.platforms[][variant8].contentstring__113NoOptional 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__114NoSet 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__115NoWhen 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__116NoSelf-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__117NoWhen 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__118NoVideo 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__8_extends:__119
body#1body.platforms[][variant9].platformstring__120Yeskind: ; value: "threads"
body#1body.platforms[][variant9].accountIdstring__121YesIntegration._id — find yours via GET /connect/integrations
body#1body.platforms[][variant9].contentstring__122NoOptional 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__123NoWho 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>__124NoAlt text for each image, in the same order as mediaItems. Strongly encouraged for accessibility.
body#1body.platforms[][variant9].platformSpecificData.altText[]string__125
body#1body.platforms[][variant10]object__8_extends:__126
body#1body.platforms[][variant10].platformstring__127Yeskind: ; value: "googlebusiness"
body#1body.platforms[][variant10].accountIdstring__128YesIntegration._id — find yours via GET /connect/integrations
body#1body.platforms[][variant10].contentstring__129NoOptional 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__130NoPost 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__131NoCall-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__132NoURL for the call-to-action. Required for all CTA types except CALL.kind: ; value: uri
body#1body.platforms[][variant10].platformSpecificData.eventTitlestring__133NoEvent title. Required when topicType is EVENT.
body#1body.platforms[][variant10].platformSpecificData.eventStartDatestring__134NoEvent start date in YYYY-MM-DD format. Required when topicType is EVENT.
body#1body.platforms[][variant10].platformSpecificData.eventStartTimestring__135NoEvent start time in HH:MM (24-hour) format. Required when topicType is EVENT.
body#1body.platforms[][variant10].platformSpecificData.eventEndDatestring__136NoEvent end date in YYYY-MM-DD format. Required when topicType is EVENT.
body#1body.platforms[][variant10].platformSpecificData.eventEndTimestring__137NoEvent end time in HH:MM (24-hour) format. Required when topicType is EVENT.
body#1body.platforms[][variant10].platformSpecificData.offerCouponCodestring__138NoCoupon code for OFFER posts.
body#1body.platforms[][variant10].platformSpecificData.offerRedeemOnlineUrlstring__139NoOnline redemption URL for OFFER posts.kind: ; value: uri
body#1body.platforms[][variant10].platformSpecificData.offerTermsConditionsstring__140NoTerms and conditions text for OFFER posts.
body#1body.publishNowboolean__141NoPublish immediately. scheduledFor takes precedence when provided.
body#1body.saveAsDraftboolean__142NoSave without publishing or scheduling. Cannot be combined with publishNow=true or scheduledFor.
body#1body.scheduledForstring__143NoISO 8601 datetime to schedule the post for future publishingkind: ; value: date-time
body#1body.timezonestring__144NoIANA timezone for the scheduled time (e.g. America/New_York). Defaults to UTC.
body#1body.idempotencyKeystring__145NoOptional 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#/components/schemas/ErrorResponse
response#2response.successboolean__0Yes
response#2response.messagestring__1Yes