For AI agents: the full index of these docs is at https://adaptlypost.com/docs/llms.txt. Every docs page is also available as Markdown: append .md to its URL or request it with the header Accept: text/markdown.
Platforms
Platform Configs
Platform-specific configuration options for fine-tuned posting to YouTube, TikTok, Pinterest, Instagram, Facebook, LinkedIn, X, Google Business Profile, Tumblr and WordPress.
Each platform has unique features and settings. Use the config objects below when creating posts to customize behavior per platform.
TikTok
Parameter
Type
Description
connectionIdREQUIRED
string
The account id from /social-accounts this config applies to
title
string
Photo posts: the title shown above the description. Video posts: sent as the caption only when caption is empty. Max 90 characters
caption
string
Photo posts: the description, up to 4000 characters. Video posts: the caption, up to 2200 characters. Falls back to title, then to the post text. A video sent with sendAsDraft can reach the TikTok inbox without it, because TikTok's inbox upload takes no caption
The account id from /social-accounts this config applies to
postType
string
VIDEO or SHORTS
videoTitle
string
Video title (max 100 characters)
tags
string[]
Video tags for discovery (max 20)
privacyStatus
string
public, unlisted or private
categoryId
string
YouTube category ID
playlistId
string
Add to playlist after upload
notifySubscribers
boolean
Notify subscribers (default true)
allowEmbedding
boolean
Allow embedding on other sites
madeForKids
boolean
Mark as made for kids
aiGenerated
boolean
Disclose altered or synthetic content, such as an AI voice, an AI avatar or realistic footage that was generated or edited. YouTube shows its "Altered or synthetic content" label on the video. Sets status.containsSyntheticMedia. Works on videos and Shorts. Omit it or send false for no label.
license
string
youtube or creativeCommon
defaultAudioLanguage
string | null
Language spoken in the video's original audio, as a BCP-47 tag such as en, pt-BR or es-419 (max 35 characters). Set it so YouTube stops treating, say, Portuguese audio as English. null clears a saved value. It does not turn off YouTube's automatic dubbing
scheduleOnYouTube
boolean
Upload the video as soon as the post is scheduled, as a private video that YouTube makes public at scheduledAt, so you can set up a thumbnail or title test in YouTube Studio first. Needs privacyStatus public: another privacyStatus returns 400 with YOUTUBE_SCHEDULE_REQUIRES_PUBLIC, and a recurring post returns 400 with YOUTUBE_SCHEDULE_NOT_RECURRING. With scheduledAt less than 15 minutes ahead, the video uploads at scheduledAt as usual. While the video waits on YouTube, updating or unscheduling the post returns 409 with SCHEDULED_ON_YOUTUBE. Deleting the post before scheduledAt also deletes the video from YouTube; if YouTube refuses, the post is kept and the delete returns 502 with SCHEDULED_VIDEO_DELETE_FAILED
Choose the board with boardId or boardName. GET /api/v1/social-accounts/:id/pinterest-boards (see Social Accounts) lists the id and name of every board. A board belongs to one Pinterest account, so list the boards of each account you post to. A boardName is looked up among the boards of that config's account when the request is handled, and the post stores the id of the board it matches; the name itself is not stored or returned. A name that matches no board, or more than one, returns a 400, and the pin never goes to another board instead. In a bulk request only that item fails. Without boardId or boardName the pin goes to a public board named AdaptlyPost, which AdaptlyPost creates on the Pinterest account the first time it is needed.
Parameter
Type
Description
connectionIdREQUIRED
string
The account id from /social-accounts this config applies to
boardId
string
Pinterest board ID to pin to. Pass boardId or boardName, not both. Leave both out to pin to a public board named AdaptlyPost
boardName
string
Name of the board to pin to, instead of boardId. Up to 180 characters. An exact match wins; without one, a single case-insensitive match is used. A name that matches no board or several boards returns a 400
The account id from /social-accounts this config applies to
postType
string
FEED, REEL or STORY. FEED works with every content type, REEL needs VIDEO, STORY needs IMAGE, VIDEO or CAROUSEL; a CAROUSEL story publishes each item as its own story, in order. Any other combination returns 400. Feed and Reel videos can run up to 15 minutes
shareToStory
boolean
Also publish the same media as a story next to the FEED or REEL post. The story is its own entry in platforms with postType STORY, so it succeeds, fails and retries on its own. It skips the caption, first comment, cover, collaborators, trial and audio, needs IMAGE, VIDEO or CAROUSEL, and a video can be at most 60 seconds. Ignored when postType is STORY
trialGraduation
string
Publish the reel as a trial reel, shown to non-followers first. MANUAL: you share it to followers in the Instagram app. SS_PERFORMANCE: Instagram shares it if it performs well. Video reels only; omit for a normal reel
collaborators
string[]
Up to 3 Instagram usernames invited as collaborators (Instagram Collab). A leading @ is removed. Works on feed images, carousels and reels, not on stories or trial reels. Each collaborator accepts the invite in Instagram before the post shows on their profile.
userTags
object[]
Up to 20 public Instagram accounts tagged in the media, each { username, x, y }. Works on a single image, a single video (Reel) or a single story, not on carousels. x and y run from 0 to 1 across the image, from the top left corner, and every tag on a feed image needs both. A story can leave them out, and a video ignores them because the person is tagged on the video as a whole. A leading @ is removed. If Instagram refuses a tag because the account is private or doesn't exist, the post goes out without its tags and instagramUntaggedUsernames lists the refused usernames.
aiGenerated
boolean
Disclose that the post was made or edited with AI. Instagram shows its "AI info" label on the post. Works on images, carousels, reels and stories, and a story made with shareToStory carries the label too.
audio
InstagramAudio
Music or an original sound added to the Reel. Needs contentType VIDEO, a postType other than STORY and an account with supportsInstagramAudio: true. See Instagram Audio below
Find an audioId with GET /api/v1/social-accounts/:id/instagram-audio (see Social Accounts), then pass it in instagramConfigs[].audio.
Parameter
Type
Description
audioIdREQUIRED
string
The audioId from the audio search
title
string
Track title, stored for display only (max 255 characters)
artist
string
Artist or creator, stored for display only (max 255 characters)
audioVolume
number
Volume of the added audio, 1 to 100 (default 100)
videoVolume
number
Volume of the video's own sound, 1 to 100 (default 100)
Facebook
Parameter
Type
Description
pageIdREQUIRED
string
The Facebook page this config applies to, as sent in pageIds
postType
string
FEED, REEL or STORY. FEED works with every content type, REEL needs VIDEO, STORY needs IMAGE, VIDEO or CAROUSEL; a CAROUSEL story publishes each item as its own story, in order. Any other combination returns 400. A Reel video can run up to 240 minutes
shareToStory
boolean
Also publish the same media as a story next to the FEED or REEL post. The story is its own entry in platforms with postType STORY, so it succeeds, fails and retries on its own. It skips the caption, video title and text background, needs IMAGE, VIDEO or CAROUSEL, and a video can be at most 60 seconds. Ignored when postType is STORY
aiGenerated
boolean
Disclose that the post was made or edited with AI. Facebook shows its "AI info" label on the post. Works on every VIDEO post, whatever its postType: Facebook publishes every video as a reel, and a video story carries the label too. Photos, carousels and text posts are rejected with a 400.
videoTitle
string
Title for video posts (max 255 characters)
textFormatPresetId
string
Facebook background for a text post, as Facebook's numeric id (106018623298955 is solid purple). TEXT posts only, no media, up to 130 characters; anything else returns 400. Links show without a preview, and if Facebook refuses the background the post goes out as plain text
imageLayout
string
GRID (default) shows several images as a photo grid. CAROUSEL shows them as swipeable cards, each with its own link. A carousel needs 2 to 5 images, no videos, postType FEED and one carouselCards entry per image; anything else returns 400
carouselCards
array
One card per image, in the same order as the media, used when imageLayout is CAROUSEL. Each card has link (required, http or https), title (up to 100 characters) and description (up to 200). Facebook shows your image and title only for links to a website the Page owns; for any other link the post fails and says why
LinkedIn
Parameter
Type
Description
connectionIdREQUIRED
string
The account id from /social-accounts this config applies to
documentTitle
string
Title shown on a DOCUMENT post (max 100 characters). Defaults to the file name; ignored for other content types
reshareOf
string
A LinkedIn post to reshare, with the post text as its commentary: a urn:li:share: or urn:li:ugcPost: URN, or a LinkedIn post URL that contains one, such as /feed/update/urn:li:share:7123/ or the post's Embed link (max 500 characters). Media is not attached on this account; other platforms in the post still get it. An activity URN or a /posts/...-activity-... URL returns 400
An X account can quote one of its own posts. X refuses a quote of another account's post, so quoteOf has to point to a post from the same account. The quoting account posts the text only, without media.
Parameter
Type
Description
connectionIdREQUIRED
string
The account id from /social-accounts this config applies to
quoteOf
string
The post to quote: its link, such as https://x.com/yourhandle/status/1234567890 (twitter.com, mobile and /i/web/status/ links work too), or its numeric ID (max 200 characters). A link to another account's post returns 400 with X_QUOTE_NOT_OWN_POST, anything that isn't an X post returns X_QUOTE_INVALID, and a quote without text returns X_QUOTE_TEXT_REQUIRED. Media is not attached on this account; other platforms in the post still get it, and thread replies still post under the quote
Example
{
"contentType": "TEXT",
"text": "A year later, still the best decision we made.",
"twitterConnectionIds": ["conn_x_001"],
"twitterConfigs": [{
"connectionId": "conn_x_001",
"quoteOf": "https://x.com/yourhandle/status/1234567890" }]
}
Google Business Profile
Google Business Profile takes TEXT or IMAGE posts with one JPEG or PNG image up to 5 MB and text up to 1500 characters. It has no alt text. A location without a config posts a STANDARD update.
Parameter
Type
Description
connectionIdREQUIRED
string
The account id from /social-accounts this config applies to
topicTypeREQUIRED
string
STANDARD, EVENT or OFFER. EVENT and OFFER need eventTitle, eventStart and eventEnd
callToActionType
string
BOOK, ORDER, SHOP, LEARN_MORE, SIGN_UP or CALL. CALL uses the phone number on the Business Profile
callToActionUrl
string
Where the button leads. Required for every button except CALL
eventTitle
string
Event or offer title
eventStart
string
Start in the business's local time, as YYYY-MM-DD or YYYY-MM-DDTHH:mm, with no timezone
eventEnd
string
End in the business's local time, as YYYY-MM-DD or YYYY-MM-DDTHH:mm, with no timezone
The post text becomes the body of a published blog post. Find category ids with GET /api/v1/social-accounts/:id/wordpress-categories (see Social Accounts). A site without a config gets the first line of the text as its title and files the post under its default category. Set status to DRAFT to leave a draft on the site that you finish and publish or schedule in WordPress, or PENDING to submit it for review.
Parameter
Type
Description
connectionIdREQUIRED
string
The account id from /social-accounts this config applies to
title
string
Post title, up to 300 characters. Leave it out to use the first line of the text, cut to 100 characters
excerpt
string
Summary WordPress shows in post lists and feeds, up to 1000 characters
categoryIds
number[]
Up to 50 category ids of the site. Leave it out to file the post under the site's default category
tags
string[]
Up to 50 tag names, each up to 100 characters. A tag the site does not have yet is created when the WordPress user may manage tags, and skipped otherwise
status
string
PUBLISH (default) publishes the post. DRAFT saves it as a draft on the site and PENDING submits it for review; for both, the post's platform URL opens it in the WordPress editor
Example
{
"wordpressConfigs": [{
"connectionId": "conn_wp_001",
"title": "What we shipped in October",
"excerpt": "Bulk scheduling, a new calendar view and faster uploads.",
"categoryIds": [12],
"tags": ["product updates", "release notes"],
"status": "DRAFT" }]
}