postIdstringobligatoire
Post id (from list_posts or get_post). Accepts the database ID or public post- ID. IDs must belong to the authenticated agency and permitted client.
namestringfacultatif
Internal post name/label. Required, non-empty, ≤255 characters.
postType"announcement" | "event" | "offer"facultatif
Post type. `announcement` is supported by all platforms. `event` and `offer` are GOOGLE-ONLY — if any social platform (facebook, instagram, x, linkedin, pinterest, mastodon, bluesky, youtube) is selected, postType must be `announcement`.
platforms("google" | "facebook" | "instagram" | "x" | "linkedin" | "pinterest" | "mastodon" | "bluesky" | "youtube")[]facultatif
Target platforms. Valid values: google, facebook, instagram, x, linkedin, pinterest, mastodon, bluesky, youtube. Required unless you name exact accounts with `connectionIds` instead; unknown values are rejected. e.g. ["google","facebook","instagram"].
connectionIdsstring[]facultatif
Optional exact targets: the connection ids to publish to (from list_connected_accounts: a location-bound one, with a clientLocationId, or a brand-level page). When given, the post goes to exactly these and its platforms are theirs; otherwise each platform in `platforms` resolves to the location's connection.
messageGooglestringfacultatif
Caption for Google. Required when `google` is selected (unless draft). Max 1500 characters.
messageFacebookstringfacultatif
Shared social caption — used by facebook, instagram, x, linkedin, pinterest, mastodon, bluesky, youtube. Required when any of those is selected (not for a tiktok-only or youtube-only selection, where the caption is optional; Google uses messageGoogle instead) is selected, unless draft. It is validated against EACH selected platform's character limit: facebook 30000, instagram 2200, x 280 WEIGHTED characters rather than typed ones — Japanese/Chinese/Korean characters and emoji cost 2 each and any link costs a flat 23, so a non-Latin caption fits roughly 140 typed characters; setting linkUrl appends that link to the caption for a further 25 weighted (X thread mode is exempt from the limit entirely), linkedin 2000, pinterest 500, mastodon 500, bluesky 300, youtube 5000. The message must fit the smallest limit among the selected social platforms that don't have their own caption in captionOverrides (a platform with an override is checked against its override and its own limit instead).
ctaType"learn_more" | "sign_up" | "order_online" | "book" | "buy" | "call_now"facultatif
Call-to-action type. For a Google `offer`, ctaType AND ctaUrl are both required. learn_more/sign_up/order_online/book/buy all require ctaUrl; call_now does not.
ctaUrlstringfacultatif
Call-to-action URL. Required for a Google offer and for CTA types other than call_now.
mediaUrlsobject[]facultatif
Media items, one entry per platform attachment: [{ "url", "platform", "type": "image"|"video" }]. The `platform` on each item must be one of the target platforms and controls which per-platform media rules apply. Per-platform limits (violations are rejected): google = no media constraints enforced here; facebook = ≤10 images OR ≤1 video, no mix (carousel: 2–10 image cards, images only); instagram = requires ≥1 item, ≤10 images OR ≤1 video, images and video cannot be mixed; x = ≤4 images OR ≤1 video, no mix; linkedin = ≤5 images OR ≤1 video, no mix; pinterest = image only (no video), exactly 1 image, required; mastodon = ≤4 images OR ≤1 video, no mix; youtube = video only (no images), exactly 1 video, required; up to YouTube's own 256 GB / 12 h limit.
urlstringfacultatif
Publicly reachable media URL (http/https).
platform"google" | "facebook" | "instagram" | "x" | "linkedin" | "pinterest" | "mastodon" | "bluesky" | "youtube"facultatif
Which target platform this media attaches to.
type"image" | "video"facultatif
Media kind.
eventTitlestringfacultatif
Event/offer title. For a Google event or offer this is required (unless draft) and must be ≤58 characters.
eventStartAtstringfacultatif
Event/offer start (ISO timestamp). Required for Google event/offer posts (unless draft).
eventEndAtstringfacultatif
Event/offer end (ISO timestamp). Required for Google event/offer posts (unless draft); must be after the start.
offerTermsstringfacultatif
Offer terms (offer posts).
offerCouponCodestringfacultatif
Offer coupon code.
offerRedeemUrlstringfacultatif
Offer redemption URL.
scheduledForstringfacultatif
Schedule for this ISO timestamp (must be in the future; omit to publish now).
youtubeTitlestringfacultatif
YouTube only (ignored otherwise): video title, ≤100 characters, no < or >. Defaults to `name`. The shared social caption (messageFacebook) becomes the video description (≤5000 bytes, no < or >). YouTube is available only on accounts with YouTube enabled; otherwise a YouTube target is rejected.
youtubePrivacyStatus"private" | "unlisted" | "public"facultatif
YouTube only: visibility. Defaults to private.
youtubeMadeForKidsbooleanfacultatif
YouTube only: whether the video is made for kids (COPPA). Required to publish to YouTube.
youtubeCategoryIdstringfacultatif
YouTube only: numeric video category id, e.g. "22" (People & Blogs, the default).
youtubeTagsstring[]facultatif
YouTube only: tags, ≤500 characters in total (commas count; a tag with a space costs 2 more).
youtubeDefaultLanguagestringfacultatif
YouTube only: BCP-47 language of the title and description.
youtubeAudioLanguagestringfacultatif
YouTube only: BCP-47 language spoken in the video.
youtubeLocalizationsstringfacultatif
YouTube only: JSON object keyed by BCP-47 language, each with title and description. Requires youtubeDefaultLanguage.
youtubeRecordingDatestringfacultatif
YouTube only: ISO timestamp when the video was recorded.
youtubePublishAtstringfacultatif
YouTube only: future ISO timestamp for native YouTube scheduling. Requires private visibility; must follow the Synup upload time.
youtubePublicStatsViewablebooleanfacultatif
YouTube only: show extended video statistics publicly.
youtubeNotifySubscribersbooleanfacultatif
YouTube only: notify channel subscribers of the upload. Defaults to true.
youtubeEmbeddablebooleanfacultatif
YouTube only: allow embedding on other sites.
youtubeLicense"youtube" | "creativeCommon"facultatif
YouTube only: license.
youtubeSyntheticMediabooleanfacultatif
YouTube only: the video contains realistic altered or synthetic content.
youtubePaidPlacementbooleanfacultatif
YouTube only: the video contains paid product placement.
youtubeThumbnailUrlstringfacultatif
YouTube only: custom thumbnail image URL (JPEG/PNG), set after upload. The channel must be phone-verified for YouTube to accept it.
youtubePlaylistIdsstring[]facultatif
YouTube only: additional playlist ids; all selected memberships are synchronized after upload or edit.
youtubePlaylistIdstringfacultatif
YouTube only: id of one of the channel's own playlists; the video is added to it after upload.
youtubeCaptionsobject[]facultatif
YouTube only: caption tracks attached after upload, each { url (an .srt/.vtt file), language (e.g. "en"), name }. Each costs 400 YouTube quota units.
urlstringfacultatif
Caption file URL
languagestringfacultatif
Language code, e.g. en
namestringfacultatif
Track name shown to viewers
linkUrlstringfacultatif
Unified link for the post; each platform places it per its own rules (CTA button, in-caption link, pin link).
linkCtaKeystringfacultatif
Which call-to-action label the unified link uses (same keys as ctaType).
utmobjectfacultatif
UTM parameters appended to the unified link.
linkOverrideobjectfacultatif
Per-platform link overrides, keyed by platform.
linkAppendobjectfacultatif
Append the link to the caption on these platforms.
mastodonbooleanfacultatif
ctaUrlFacebookstringfacultatif
Facebook-only call-to-action URL (overrides ctaUrl on Facebook).
xThreadbooleanfacultatif
X only: split a long caption into a thread instead of rejecting it.
scheduleLocalTimestringfacultatif
Wall-clock schedule time (e.g. 2026-10-12T09:00) interpreted per scheduleZoneMode. Requires scheduleZoneMode.
scheduleZoneMode"target_local" | "fixed_zone"facultatif
How scheduleLocalTime is interpreted: in each target's local zone, or one fixed zone.
scheduleTimeZonestringfacultatif
IANA zone, required when scheduleZoneMode is fixed_zone (e.g. America/New_York).
timeZoneMode"target_local" | "fixed_zone"facultatif
Alias of scheduleZoneMode kept for the composer.
videoCoverUrlstringfacultatif
Video cover image URL (platforms that support covers).
videoCaptionsUrlstringfacultatif
Subtitle file URL (.srt/.vtt) for the video.
videoCaptionsLanguagestringfacultatif
Language code of the subtitle file, e.g. en.
captionOverridesfacultatif
Per-platform captions that replace the shared caption (messageFacebook) on that platform only, e.g. { "x": "Short version #sale", "linkedin": "Longer, professional version" }. Supported: facebook, instagram, linkedin, x, bluesky, mastodon, threads, pinterest, tiktok, youtube; other platforms (Google, Reddit, Medium, Substack, Vimeo, Dailymotion) are refused (they publish the shared caption). Each is checked against its own platform's limit. On update, only the platforms you name change; set one to null (or "") to go back to the shared caption, or pass null for the whole field to clear all. Shared messageFacebook stays the default for every platform without an entry.
facebookCaptionstringfacultatif
Facebook-only caption, used instead of the shared social caption. Prefer captionOverrides.facebook.
facebookCtaTypestringfacultatif
Facebook-only call-to-action button type.
facebookFirstCommentstringfacultatif
Facebook: text posted as the first comment.
facebookPublishAs"default" | "reel" | "carousel" | "suppress_link"facultatif
Facebook format.
facebookCarouselCardsobject[]facultatif
Facebook carousel cards (when facebookPublishAs is carousel), each { headline, description, link }.
descriptionstringfacultatif
facebookTargetCountrystringfacultatif
Facebook audience restriction: country code.
facebookTargetGenderstringfacultatif
Facebook audience restriction: gender.
facebookTargetAgeMinstringfacultatif
Facebook audience restriction: minimum age.
facebookTargetAgeMaxstringfacultatif
Facebook audience restriction: maximum age.
facebookTargetRelationshipstringfacultatif
Facebook audience restriction: relationship status.
instagramFirstCommentstringfacultatif
Instagram: text posted as the first comment.
instagramAltTextstringfacultatif
Instagram: alt text for the image.
xReplySettings"everyone" | "following" | "mentioned"facultatif
X: who can reply.
linkedinVisibility"anyone" | "connections" | "followers"facultatif
LinkedIn: who can see the post.
linkedinFirstCommentstringfacultatif
LinkedIn: text posted as the first comment.
pinterestTitlestringfacultatif
Pinterest: pin title.
pinterestBoardIdstringfacultatif
Pinterest: board to pin to (see list_pinterest_boards).
pinterestBoardNamestringfacultatif
Pinterest: board name, for display.
pinterestLinkstringfacultatif
Pinterest: destination link of the pin.
pinterestAltTextstringfacultatif
Pinterest: alt text for the pin image.
mastodonVisibility"public" | "unlisted" | "private" | "direct"facultatif
Mastodon: visibility.
mastodonSpoilerTextstringfacultatif
Mastodon: content-warning text.
mastodonSensitivebooleanfacultatif
Mastodon: mark media as sensitive.
blueskyLanguagestringfacultatif
Bluesky: language code of the post, e.g. en.
blueskyReplyGating"everyone" | "mentioned" | "following" | "nobody"facultatif
Bluesky: who can reply.
draftbooleanfacultatif
Save as draft without publishing. Drafts skip publish-gating 'required' checks (required message, required media, required event/offer fields) but STILL enforce structural checks: character limits, media counts, media mixing, valid enums, carousel bounds, and date ordering.