Edit Scheduled Post API
The Edit Scheduled Post API replaces the editable fields of an existing scheduled post, including its content, media, target platforms, and scheduled time. This endpoint is deprecated in favor of PUT /v1/posts/:postId, but its exact contract is preserved here for parity: PUT /v1/posts/scheduled/{postId}. The request requires content and platforms, while scheduledFor and timezone are optional and, when omitted, keep the current scheduled time and timezone. The operation also reconciles credits, with no amounts, windows, or rules specified in the preserved contract.
Edit Scheduled Post API — deprecated status and exact endpoint
This endpoint is deprecated. The named replacement is PUT /v1/posts/:postId. The preserved contract for this page remains PUT /v1/posts/scheduled/{postId}, and it replaces the editable fields of a scheduled post and reconciles credits. Use the postId of the scheduled post you want to edit as the path parameter. Because content and platforms are required, an edit request must supply the full replacement text and the full replacement target list, not only the fields that changed. Optional fields control whether the schedule changes: omit scheduledFor to keep the current scheduled time, and omit timezone to keep the current timezone. Before sending, check that postId is the scheduled post identifier, that content is a string, and that platforms contains at least one target object with a platform value and an accountId.
Authorization and path parameter
Send the access key in the x-access-key header. The Authorization section names accessKey, the header name x-access-key, and the value placeholder <token>. The path parameter postId is a required string. The preserved contract specifies x-access-key as the header name, so use that name rather than a different header name. Keep the path exactly as /v1/posts/scheduled/{postId} with the method PUT, and substitute only the postId value and the origin placeholder {{API_BASE_URL}} in examples.
Request body field map
The request body is application/json. The required content field is a string containing the new post text body. The required platforms field is an array of objects with at least one item, representing the replacement target platform accounts to publish to. The optional mediaItems field is an array of objects representing replacement media attachments for images, videos, and GIFs; each item requires type and url, where type is one of image, video, gif, or document, and url is a URI. Optional altText on a media item is a string from 1 to 1000 characters, and optional thumbnail is a URI. The optional scheduledFor field is a string in ISO 8601 date-time format; omit it to keep the current scheduled time. The optional timezone field is a string naming an IANA timezone for the scheduled time; omit it to keep the current one. A common failure check is sending an empty platforms array, which violates the 1 <= items constraint, or sending scheduledFor in a non-date-time format. See the request body field map table for the complete field list.
Platform-specific replacement data
Each platforms item requires platform and accountId, and may include an optional per-platform content override and optional platformSpecificData. When the per-platform content is omitted, the top-level content is used. The accountId is the integration identifier, described as Integration._id and found via GET /connect/integrations. The platform value selects which platformSpecificData shape applies. For twitter, platformSpecificData may include communityId, shareWithFollowers, replyToTweetId, replySettings with values following, mentionedUsers, subscribers, or verified, threadItems, longPost, and poll. For instagram, it may include locationId, audioConfiguration, contentType story, isAiGenerated, shareToFeed, trialParams, coverUrl, thumbOffset, audioName, and collaborators. For youtube, it may include title, tags, visibility public, private, or unlisted, madeForKids, containsSyntheticMedia, categoryId, playlistId, and firstComment. For tiktok, it may include privacyLevel, disableComment, disableDuet, disableStitch, brandContentToggle, brandOrganicToggle, isAigc, videoCoverTimestampMs, autoAddMusic, photoCoverIndex, description, and draft. For pinterest, platformSpecificData requires boardId and may include title, link, altText, dominantColor, and coverImageUrl. For linkedin, it may include visibility PUBLIC or CONNECTIONS, mentions, articleUrl, articleTitle, articleDescription, and documentTitle. For bluesky, it may include langs and altText. For facebook, it may include contentType reel or story, link, isAiGenerated, published, and videoThumbnailUrl. For threads, it may include replyControl everyone, accounts_you_follow, or mentioned_only, and altText. For googlebusiness, it may include topicType STANDARD, EVENT, or OFFER, callToActionType, callToActionUrl, event fields, and offer fields. When replacing platforms, include the complete new target list and the platformSpecificData for each target in the same request, then verify the response postId matches the edited scheduled post.
Response body and status codes
A 200 response returns success as a required boolean, message as an optional string, postId as a required string, and scheduledFor as an optional date-time string. The 400, 402, 403, 404, 409, and 503 responses are each shown with the same generic shape of success and message, with success as a required boolean and message as a required string in the error contract. Do not infer specific error codes or meanings beyond the status and shape supplied. After a successful edit, compare the returned postId with the path postId and check scheduledFor when you changed the schedule. If you omitted scheduledFor, the current scheduled time is kept, so do not expect the response to prove a new time was set. See the response status map table and the request and response examples below for the exact origin-modular sample and the preserved response shapes.
| Field | Required | Type | Constraints and semantics |
|---|---|---|---|
| content | Required | string | New post text body |
| mediaItems | Optional | array<object> | Replacement media attachments (images, videos, GIFs) |
| mediaItems[].type | Required | string | "image" | "video" | "gif" | "document" |
| mediaItems[].url | Required | string | Format: uri |
| mediaItems[].altText | Optional | string | 1 <= length <= 1000 |
| mediaItems[].thumbnail | Optional | string | Format: uri |
| platforms | Required | array<object> | 1 <= items; replacement target platform accounts to publish to |
| platforms[].platform | Required | string | Per-variant enum, for example "twitter" |
| platforms[].accountId | Required | string | Integration._id — find yours via GET /connect/integrations |
| platforms[].content | Optional | string | Per-platform text override; top-level content is used when omitted |
| platforms[].platformSpecificData | Optional | object | Per-platform options for the selected platform variant |
| scheduledFor | Optional | string | Format: date-time; omit to keep the current scheduled time |
| timezone | Optional | string | IANA timezone for the scheduled time; omit to keep the current one |
Preserved source contract; omit scheduledFor to keep current time and omit timezone to keep current timezone.
| Status | success | message | postId | scheduledFor |
|---|---|---|---|---|
| 200 | Required boolean | Optional string | Required string | Optional string, format: date-time |
| 400 | Required boolean | Required string | Not in supplied error shape | Not in supplied error shape |
| 402 | Required boolean | Required string | Not in supplied error shape | Not in supplied error shape |
| 403 | Required boolean | Required string | Not in supplied error shape | Not in supplied error shape |
| 404 | Required boolean | Required string | Not in supplied error shape | Not in supplied error shape |
| 409 | Required boolean | Required string | Not in supplied error shape | Not in supplied error shape |
| 503 | Required boolean | Required string | Not in supplied error shape | Not in supplied error shape |
Error meanings are not supplied in the source and are not invented here.
curl -X PUT "{{API_BASE_URL}}/v1/posts/scheduled/string" \
-H "Content-Type: application/json" \
-H "x-access-key: <token>" \
-d '{
"content": "string",
"platforms": [
{
"platform": "twitter",
"accountId": "string"
}
]
}'{
"success": true,
"message": "string",
"postId": "string",
"scheduledFor": "2019-08-24T14:15:22Z"
}{
"success": true,
"message": "string"
}| Scope | Field | Type | Type reference | Required | Description | Constraints |
|---|---|---|---|---|---|---|
| body#1 | body | object | __0 | Yes | ||
| body#1 | body.content | string | __1 | Yes | New post text body | |
| body#1 | body.mediaItems | array<object> | __2 | No | Replacement media attachments (images, videos, GIFs) | |
| body#1 | body.mediaItems[] | object | __3 | |||
| body#1 | body.mediaItems[].type | string | __4 | Yes | kind: schemaValueIn; value: "image" | "video" | "gif" | "document" | |
| body#1 | body.mediaItems[].url | string | __5 | Yes | Publicly 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#1 | body.mediaItems[].altText | string | __6 | No | Accessibility 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#1 | body.mediaItems[].thumbnail | string | __7 | No | Thumbnail 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#1 | body.platforms | array<object> | __8 | Yes | Replacement target platform accounts to publish to | kind: schemaItems; value: 1 <= items |
| body#1 | body.platforms[] | object | __9 | |||
| body#1 | body.platforms[][variant1] | object | __9_extends:__10 | |||
| body#1 | body.platforms[][variant1].platform | string | __11 | Yes | kind: schemaValueIn; value: "twitter" | |
| body#1 | body.platforms[][variant1].accountId | string | __12 | Yes | Integration._id — find yours via GET /connect/integrations | |
| body#1 | body.platforms[][variant1].content | string | __13 | No | Optional 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#1 | body.platforms[][variant1].platformSpecificData | object | #/components/schemas/TwitterConfigurations | No | Pass this object in platformSpecificData when posting to Twitter/X, including Community post options. | |
| body#1 | body.platforms[][variant1].platformSpecificData.communityId | string | __14 | No | Community ID to publish this post into. | |
| body#1 | body.platforms[][variant1].platformSpecificData.shareWithFollowers | boolean | __15 | No | When posting to a Community, also share the post with followers. | |
| body#1 | body.platforms[][variant1].platformSpecificData.replyToTweetId | string | __16 | No | Tweet ID to reply to. | |
| body#1 | body.platforms[][variant1].platformSpecificData.replySettings | string | __17 | No | kind: schemaValueIn; value: "following" | "mentionedUsers" | "subscribers" | "verified" | |
| body#1 | body.platforms[][variant1].platformSpecificData.threadItems | array<object> | __18 | No | Additional tweets to chain as a thread. The root tweet uses post.content. | |
| body#1 | body.platforms[][variant1].platformSpecificData.threadItems[] | object | __19 | |||
| body#1 | body.platforms[][variant1].platformSpecificData.threadItems[].content | string | __20 | Yes | Text of this thread tweet (max 280 chars) | |
| body#1 | body.platforms[][variant1].platformSpecificData.threadItems[].mediaItems | array<object> | __21 | No | ||
| body#1 | body.platforms[][variant1].platformSpecificData.threadItems[].mediaItems[] | object | __22 | |||
| body#1 | body.platforms[][variant1].platformSpecificData.threadItems[].mediaItems[].type | string | __23 | Yes | kind: ; value: "image" | "video" | "gif" | "document" | |
| body#1 | body.platforms[][variant1].platformSpecificData.threadItems[].mediaItems[].url | string | __24 | Yes | Publicly accessible URL for the media file. the service or the platform provider must be able to fetch it without authentication. | kind: ; value: uri |
| body#1 | body.platforms[][variant1].platformSpecificData.threadItems[].mediaItems[].altText | string | __25 | No | Accessibility 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#1 | body.platforms[][variant1].platformSpecificData.threadItems[].mediaItems[].thumbnail | string | __26 | No | Thumbnail 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#1 | body.platforms[][variant1].platformSpecificData.longPost | boolean | __27 | No | Opt 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#1 | body.platforms[][variant1].platformSpecificData.poll | object | __28 | No | Cannot be combined with media or threadItems. | |
| body#1 | body.platforms[][variant1].platformSpecificData.poll.options | array<string> | __29 | Yes | 2–4 poll options. | kind: ; value: 2 <= items <= 4 |
| body#1 | body.platforms[][variant1].platformSpecificData.poll.options[] | string | __30 | |||
| body#1 | body.platforms[][variant1].platformSpecificData.poll.durationMinutes | number | __31 | Yes | Poll duration in minutes (5 min – 7 days). | kind: ; value: 5 <= value <= 10080 |
| body#1 | body.platforms[][variant2] | object | __9_extends:__32 | |||
| body#1 | body.platforms[][variant2].platform | string | __33 | Yes | kind: ; value: "instagram" | |
| body#1 | body.platforms[][variant2].accountId | string | __34 | Yes | Integration._id — find yours via GET /connect/integrations | |
| body#1 | body.platforms[][variant2].content | string | __35 | No | Optional 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#1 | body.platforms[][variant2].platformSpecificData | object | #/components/schemas/InstagramConfigurations | No | Pass this object in platformSpecificData when posting to Instagram. Use contentType to publish Stories; the remaining fields customize feed posts and Reels. | |
| body#1 | body.platforms[][variant2].platformSpecificData.locationId | string | __36 | No | Numeric Facebook Page ID with location data. Feed posts, Reels and whole carousels only; not Stories. | kind: ; value: ^\d+$ |
| body#1 | body.platforms[][variant2].platformSpecificData.audioConfiguration | object | __37 | No | Catalog audio for single-video Reels, requires Facebook Login. Volumes default to 100. Audio must remain available at publish time. | |
| body#1 | body.platforms[][variant2].platformSpecificData.audioConfiguration.audioId | string | __38 | Yes | kind: ; value: ^\d+$ | |
| body#1 | body.platforms[][variant2].platformSpecificData.audioConfiguration.audioVolume | integer | __39 | No | kind: ; value: 1 <= value <= 100 | |
| body#1 | body.platforms[][variant2].platformSpecificData.audioConfiguration.videoVolume | integer | __40 | No | kind: ; value: 1 <= value <= 100 | |
| body#1 | body.platforms[][variant2].platformSpecificData.contentType | string | __41 | No | Set 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#1 | body.platforms[][variant2].platformSpecificData.isAiGenerated | boolean | __42 | No | Self-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#1 | body.platforms[][variant2].platformSpecificData.shareToFeed | boolean | __43 | No | Reels-only. When true (default), the Reel also appears in the account's main feed grid. Set false to publish to Reels only. | |
| body#1 | body.platforms[][variant2].platformSpecificData.trialParams | object | __44 | No | Reels-only. Publishes a single video as a Trial Reel, initially shown to non-followers. | |
| body#1 | body.platforms[][variant2].platformSpecificData.trialParams.graduationStrategy | string | __45 | Yes | Controls 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#1 | body.platforms[][variant2].platformSpecificData.coverUrl | string | __46 | No | Video-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#1 | body.platforms[][variant2].platformSpecificData.thumbOffset | integer | __47 | No | Video-only. Timestamp in milliseconds Instagram extracts as the cover frame. Ignored when coverUrl is set or for image posts. | kind: ; value: 0 <= value |
| body#1 | body.platforms[][variant2].platformSpecificData.audioName | string | __48 | No | Reels-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#1 | body.platforms[][variant2].platformSpecificData.collaborators | array<string> | __49 | No | Feed 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#1 | body.platforms[][variant2].platformSpecificData.collaborators[] | string | __50 | Instagram username without the leading @. | kind: ; value: ^[A-Za-z0-9._]+$ | kind: ; value: 1 <= length <= 30 | |
| body#1 | body.platforms[][variant3] | object | __9_extends:__51 | |||
| body#1 | body.platforms[][variant3].platform | string | __52 | Yes | kind: ; value: "youtube" | |
| body#1 | body.platforms[][variant3].accountId | string | __53 | Yes | Integration._id — find yours via GET /connect/integrations | |
| body#1 | body.platforms[][variant3].content | string | __54 | No | Optional 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#1 | body.platforms[][variant3].platformSpecificData | object | #/components/schemas/YouTubeConfigurations | No | Pass this object in platformSpecificData when posting to YouTube. | |
| body#1 | body.platforms[][variant3].platformSpecificData.title | string | __55 | No | Video title (max 100 chars, no < or >). Defaults to first 100 chars of content, or "Untitled Video". | kind: ; value: length <= 100 |
| body#1 | body.platforms[][variant3].platformSpecificData.tags | array<string> | __56 | No | Video tags. Total characters across all tags must be ≤500. | |
| body#1 | body.platforms[][variant3].platformSpecificData.tags[] | string | __57 | |||
| body#1 | body.platforms[][variant3].platformSpecificData.visibility | string | __58 | No | Who 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#1 | body.platforms[][variant3].platformSpecificData.madeForKids | boolean | __59 | No | COPPA compliance flag. Setting to true permanently disables comments, notification bell, personalized ads, end screens, and cards on the video. Defaults to false. | |
| body#1 | body.platforms[][variant3].platformSpecificData.containsSyntheticMedia | boolean | __60 | No | AI-generated content disclosure. YouTube is increasingly enforcing this requirement. Defaults to false. | |
| body#1 | body.platforms[][variant3].platformSpecificData.categoryId | string | __61 | No | YouTube 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#1 | body.platforms[][variant3].platformSpecificData.playlistId | string | __62 | No | Playlist to add the uploaded video to. Retrieve available IDs from the YouTube playlists endpoint. | kind: ; value: 1 <= length |
| body#1 | body.platforms[][variant3].platformSpecificData.firstComment | string | __63 | No | Auto-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#1 | body.platforms[][variant4] | object | __9_extends:__64 | |||
| body#1 | body.platforms[][variant4].platform | string | __65 | Yes | kind: ; value: "tiktok" | |
| body#1 | body.platforms[][variant4].accountId | string | __66 | Yes | Integration._id — find yours via GET /connect/integrations | |
| body#1 | body.platforms[][variant4].content | string | __67 | No | Optional 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#1 | body.platforms[][variant4].platformSpecificData | object | #/components/schemas/TikTokConfigurations | No | Pass this object in platformSpecificData when posting to TikTok. | |
| body#1 | body.platforms[][variant4].platformSpecificData.privacyLevel | string | __68 | No | Who can see this post. Defaults to "PUBLIC_TO_EVERYONE". | kind: ; value: "PUBLIC_TO_EVERYONE" | "MUTUAL_FOLLOW_FRIENDS" | "FOLLOWER_OF_CREATOR" | "SELF_ONLY" |
| body#1 | body.platforms[][variant4].platformSpecificData.disableComment | boolean | __69 | No | Disable comments on this post. Defaults to false. | |
| body#1 | body.platforms[][variant4].platformSpecificData.disableDuet | boolean | __70 | No | Disable duet for this video. Videos only. Defaults to false. | |
| body#1 | body.platforms[][variant4].platformSpecificData.disableStitch | boolean | __71 | No | Disable stitch for this video. Videos only. Defaults to false. | |
| body#1 | body.platforms[][variant4].platformSpecificData.brandContentToggle | boolean | __72 | No | Mark as branded content (paid partnership). Defaults to false. | |
| body#1 | body.platforms[][variant4].platformSpecificData.brandOrganicToggle | boolean | __73 | No | Mark as organic brand promotion. Defaults to false. | |
| body#1 | body.platforms[][variant4].platformSpecificData.isAigc | boolean | __74 | No | AI-generated content disclosure for photo and video posts. Defaults to false. | |
| body#1 | body.platforms[][variant4].platformSpecificData.videoCoverTimestampMs | number | __75 | No | Timestamp in milliseconds to use as the video cover frame. Videos only. | kind: ; value: 0 <= value |
| body#1 | body.platforms[][variant4].platformSpecificData.autoAddMusic | boolean | __76 | No | Automatically add background music to photo carousels. Photo posts only. Defaults to true. | |
| body#1 | body.platforms[][variant4].platformSpecificData.photoCoverIndex | number | __77 | No | 0-indexed position of the cover image in a photo carousel. Photo posts only. Defaults to 0. | kind: ; value: 0 <= value |
| body#1 | body.platforms[][variant4].platformSpecificData.description | string | __78 | No | Separate 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#1 | body.platforms[][variant4].platformSpecificData.draft | boolean | __79 | No | When true, sends content to the creator's TikTok inbox as a draft. Defaults to false (publishes immediately via DIRECT_POST). | |
| body#1 | body.platforms[][variant5] | object | __9_extends:__80 | |||
| body#1 | body.platforms[][variant5].platform | string | __81 | Yes | kind: ; value: "pinterest" | |
| body#1 | body.platforms[][variant5].accountId | string | __82 | Yes | Integration._id — find yours via GET /connect/integrations | |
| body#1 | body.platforms[][variant5].content | string | __83 | No | Optional 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#1 | body.platforms[][variant5].platformSpecificData | object | #/components/schemas/PinterestConfigurations | No | Pass this object in platformSpecificData when posting to Pinterest. | |
| body#1 | body.platforms[][variant5].platformSpecificData.boardId | string | __84 | Yes | Target board ID. Retrieve available boards via GET /v1/pinterest/boards. | |
| body#1 | body.platforms[][variant5].platformSpecificData.title | string | __85 | No | Pin title. Max 100 characters. Defaults to first line of content. | kind: ; value: length <= 100 |
| body#1 | body.platforms[][variant5].platformSpecificData.link | string | __86 | No | HTTPS destination URL when the pin is clicked. Important for driving traffic. | kind: ; value: uri |
| body#1 | body.platforms[][variant5].platformSpecificData.altText | string | __87 | No | Accessible image description. Max 500 characters. | kind: ; value: length <= 500 |
| body#1 | body.platforms[][variant5].platformSpecificData.dominantColor | string | __88 | No | Hex color for the loading placeholder (e.g. "#6E7874"). | |
| body#1 | body.platforms[][variant5].platformSpecificData.coverImageUrl | string | __89 | No | Custom cover image URL for video pins. | kind: ; value: uri |
| body#1 | body.platforms[][variant6] | object | __9_extends:__90 | |||
| body#1 | body.platforms[][variant6].platform | string | __91 | Yes | kind: ; value: "linkedin" | |
| body#1 | body.platforms[][variant6].accountId | string | __92 | Yes | Integration._id — find yours via GET /connect/integrations | |
| body#1 | body.platforms[][variant6].content | string | __93 | No | Optional 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#1 | body.platforms[][variant6].platformSpecificData | object | #/components/schemas/LinkedInConfigurations | No | Pass this object in platformSpecificData when posting to LinkedIn. | |
| body#1 | body.platforms[][variant6].platformSpecificData.visibility | string | __94 | No | Post visibility. "PUBLIC" = visible to everyone, "CONNECTIONS" = visible to connections only. Defaults to "PUBLIC". | kind: ; value: "PUBLIC" | "CONNECTIONS" |
| body#1 | body.platforms[][variant6].platformSpecificData.mentions | array<object> | __95 | No | Tag 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#1 | body.platforms[][variant6].platformSpecificData.mentions[] | object | __96 | |||
| body#1 | body.platforms[][variant6].platformSpecificData.mentions[].text | string | __97 | Yes | Exact 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#1 | body.platforms[][variant6].platformSpecificData.mentions[].urn | string | __98 | Yes | LinkedIn 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#1 | body.platforms[][variant6].platformSpecificData.articleUrl | string | __99 | No | URL for an article/link post. When provided, the post becomes a link share with a preview card. | kind: ; value: uri |
| body#1 | body.platforms[][variant6].platformSpecificData.articleTitle | string | __100 | No | Title for the article preview card. Max 400 characters. | kind: ; value: length <= 400 |
| body#1 | body.platforms[][variant6].platformSpecificData.articleDescription | string | __101 | No | Description for the article preview card. Max 400 characters. | kind: ; value: length <= 400 |
| body#1 | body.platforms[][variant6].platformSpecificData.documentTitle | string | __102 | No | Title shown on the document card when posting a PDF. Required by LinkedIn when a document media item is included. | kind: ; value: length <= 200 |
| body#1 | body.platforms[][variant7] | object | __9_extends:__103 | |||
| body#1 | body.platforms[][variant7].platform | string | __104 | Yes | kind: ; value: "bluesky" | |
| body#1 | body.platforms[][variant7].accountId | string | __105 | Yes | Integration._id — find yours via GET /connect/integrations | |
| body#1 | body.platforms[][variant7].content | string | __106 | No | Optional 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#1 | body.platforms[][variant7].platformSpecificData | object | #/components/schemas/BlueskyConfigurations | No | Pass this object in platformSpecificData when posting to Bluesky. | |
| body#1 | body.platforms[][variant7].platformSpecificData.langs | array<string> | __107 | No | BCP-47 language tags for the post (e.g. ["en"], ["en-US", "es"]). Defaults to ["en"]. | |
| body#1 | body.platforms[][variant7].platformSpecificData.langs[] | string | __108 | |||
| body#1 | body.platforms[][variant7].platformSpecificData.altText | array<string> | __109 | No | Alt text for each image, in the same order as mediaItems. Strongly encouraged for accessibility. | |
| body#1 | body.platforms[][variant7].platformSpecificData.altText[] | string | __110 | |||
| body#1 | body.platforms[][variant8] | object | __9_extends:__111 | |||
| body#1 | body.platforms[][variant8].platform | string | __112 | Yes | kind: ; value: "facebook" | |
| body#1 | body.platforms[][variant8].accountId | string | __113 | Yes | Integration._id — find yours via GET /connect/integrations | |
| body#1 | body.platforms[][variant8].content | string | __114 | No | Optional 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#1 | body.platforms[][variant8].platformSpecificData | object | #/components/schemas/FacebookConfigurations | No | Pass this object in platformSpecificData when posting to Facebook Pages. | |
| body#1 | body.platforms[][variant8].platformSpecificData.contentType | string | __115 | No | Set 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#1 | body.platforms[][variant8].platformSpecificData.link | string | __116 | No | When 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#1 | body.platforms[][variant8].platformSpecificData.isAiGenerated | boolean | __117 | No | Self-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#1 | body.platforms[][variant8].platformSpecificData.published | boolean | __118 | No | When 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#1 | body.platforms[][variant8].platformSpecificData.videoThumbnailUrl | string | __119 | No | Video 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#1 | body.platforms[][variant9] | object | __9_extends:__120 | |||
| body#1 | body.platforms[][variant9].platform | string | __121 | Yes | kind: ; value: "threads" | |
| body#1 | body.platforms[][variant9].accountId | string | __122 | Yes | Integration._id — find yours via GET /connect/integrations | |
| body#1 | body.platforms[][variant9].content | string | __123 | No | Optional 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#1 | body.platforms[][variant9].platformSpecificData | object | #/components/schemas/ThreadsConfigurations | No | Pass this object in platformSpecificData when posting to Threads. | |
| body#1 | body.platforms[][variant9].platformSpecificData.replyControl | string | __124 | No | Who can reply to this thread. Defaults to "everyone" when omitted. | kind: ; value: "everyone" | "accounts_you_follow" | "mentioned_only" |
| body#1 | body.platforms[][variant9].platformSpecificData.altText | array<string> | __125 | No | Alt text for each image, in the same order as mediaItems. Strongly encouraged for accessibility. | |
| body#1 | body.platforms[][variant9].platformSpecificData.altText[] | string | __126 | |||
| body#1 | body.platforms[][variant10] | object | __9_extends:__127 | |||
| body#1 | body.platforms[][variant10].platform | string | __128 | Yes | kind: ; value: "googlebusiness" | |
| body#1 | body.platforms[][variant10].accountId | string | __129 | Yes | Integration._id — find yours via GET /connect/integrations | |
| body#1 | body.platforms[][variant10].content | string | __130 | No | Optional 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#1 | body.platforms[][variant10].platformSpecificData | object | #/components/schemas/GoogleBusinessConfigurations | No | Pass this object in platformSpecificData when posting to Google Business Profile. Posts appear on Google Search and Maps. | |
| body#1 | body.platforms[][variant10].platformSpecificData.topicType | string | __131 | No | Post type. Defaults to STANDARD. Use EVENT for event posts, OFFER for promotional offer posts. | kind: ; value: "STANDARD" | "EVENT" | "OFFER" |
| body#1 | body.platforms[][variant10].platformSpecificData.callToActionType | string | __132 | No | Call-to-action button shown on the post. | kind: ; value: "BOOK" | "ORDER" | "SHOP" | "LEARN_MORE" | "SIGN_UP" | "CALL" | "GET_OFFER" |
| body#1 | body.platforms[][variant10].platformSpecificData.callToActionUrl | string | __133 | No | URL for the call-to-action. Required for all CTA types except CALL. | kind: ; value: uri |
| body#1 | body.platforms[][variant10].platformSpecificData.eventTitle | string | __134 | No | Event title. Required when topicType is EVENT. | |
| body#1 | body.platforms[][variant10].platformSpecificData.eventStartDate | string | __135 | No | Event start date in YYYY-MM-DD format. Required when topicType is EVENT. | |
| body#1 | body.platforms[][variant10].platformSpecificData.eventStartTime | string | __136 | No | Event start time in HH:MM (24-hour) format. Required when topicType is EVENT. | |
| body#1 | body.platforms[][variant10].platformSpecificData.eventEndDate | string | __137 | No | Event end date in YYYY-MM-DD format. Required when topicType is EVENT. | |
| body#1 | body.platforms[][variant10].platformSpecificData.eventEndTime | string | __138 | No | Event end time in HH:MM (24-hour) format. Required when topicType is EVENT. | |
| body#1 | body.platforms[][variant10].platformSpecificData.offerCouponCode | string | __139 | No | Coupon code for OFFER posts. | |
| body#1 | body.platforms[][variant10].platformSpecificData.offerRedeemOnlineUrl | string | __140 | No | Online redemption URL for OFFER posts. | kind: ; value: uri |
| body#1 | body.platforms[][variant10].platformSpecificData.offerTermsConditions | string | __141 | No | Terms and conditions text for OFFER posts. | |
| body#1 | body.scheduledFor | string | __142 | No | New ISO 8601 datetime. Omit to keep the current scheduled time. | kind: ; value: date-time |
| body#1 | body.timezone | string | __143 | No | IANA timezone for the scheduled time. Omit to keep the current one. | |
| response#2 | response | object | __0 | |||
| response#2 | response.success | boolean | __1 | Yes | ||
| response#2 | response.message | string | __2 | No | ||
| response#2 | response.postId | string | __3 | Yes | ||
| response#2 | response.scheduledFor | string | __4 | No | kind: schemaFormat; value: date-time | |
| response#3 | response | object | __0 | |||
| response#3 | response.success | boolean | __1 | Yes | ||
| response#3 | response.message | string | __2 | Yes |