Network options

What each network can be told, beyond the text and the media.

View as Markdown OpenAPIBase URL https://postwire.io

Send them in options, keyed by network, on POST /api/post and POST /api/schedule (or inside a per_platform draft). A network ignores the options of the others.

Example

JSON

{
  "platforms": [
    "tiktok",
    "youtube",
    "instagram"
  ],
  "video_url": "https://example.com/clip.mp4",
  "text": "Proofing, 36 hours in 30 seconds",
  "options": {
    "tiktok": {
      "privacy_level": "PUBLIC_TO_EVERYONE",
      "ai_generated": false
    },
    "youtube": {
      "privacy": "public",
      "tags": [
        "sourdough",
        "baking"
      ]
    },
    "instagram": {
      "post_type": "reels"
    }
  }
}

TikTok

Field	Type	Description
`options.tiktok.privacy_level`	string	Who sees the post. Words also work: public, followers, friends, private. When TikTok does not allow the value for this creator, the closest allowed level that is not more open is used and the result says so. Default SELF_ONLY. One of: PUBLIC_TO_EVERYONE, FOLLOWER_OF_CREATOR, MUTUAL_FOLLOW_FRIENDS, SELF_ONLY.
`options.tiktok.disable_comment`	boolean	Default false.
`options.tiktok.disable_duet`	boolean	Videos only. Default false.
`options.tiktok.disable_stitch`	boolean	Videos only. Default false.
`options.tiktok.brand_organic_toggle`	boolean	Discloses that the post promotes the creator's own business. Default false.
`options.tiktok.branded_content_toggle`	boolean	Discloses a paid partnership with a third party. Cannot be private. Default false.
`options.tiktok.ai_generated`	boolean	Adds TikTok's AI-generated content label (post_info.is_aigc). Default false.
`options.tiktok.auto_add_music`	boolean	Photo posts: let TikTok add music. Default true.
`options.tiktok.photo_cover_index`	integer	Photo posts: which image is the cover. Default 0.

YouTube

Field	Type	Description
`options.youtube.privacy`	string	Default: the privacy saved for the connection (`POST /api/connect/youtube/settings`), else private. One of: public, unlisted, private.
`options.youtube.title`	string	Defaults to the first line of the text; cut at 100 characters. Up to 100 characters.
`options.youtube.tags`	array of string	Trimmed to YouTube's 500-character budget across all tags.
`options.youtube.thumbnail_url`	string (uri)	Custom thumbnail (the channel must be allowed to set custom thumbnails).
`options.youtube.ai_generated`	boolean	Declares altered or synthetic content (status.containsSyntheticMedia). Default false.

Instagram

Field	Type	Description
`options.instagram.post_type`	string	feed (default: a photo is an image post, a video is a Reel), reels (needs a video) or story. One of: feed, reels, story.
`options.instagram.trial_reel`	boolean	Publish a Reel as a trial reel (shown to non-followers first). Falls back to a normal Reel when the account cannot use trial reels. Default false.

Facebook

Field	Type	Description
`options.facebook.post_type`	string	feed (default), reels (needs a video) or story (photo or video). One of: feed, reels, story.

Field	Type	Description
`options.linkedin.first_comment`	string	Posted as the author's first comment right after the post (where a link goes without hurting reach). A failed comment is retried later; the post is never re-sent.
`options.linkedin.document_url`	string (uri)	A PDF, PPT or DOC published as a document (carousel) post.
`options.linkedin.document_title`	string

Bluesky

Field	Type	Description
`options.bluesky.alt_text`	string	Alt text for photo_url (with media, each item has its own alt).

Mastodon

Field	Type	Description
`options.mastodon.alt_text`	string	Alt text for photo_url or video_url (with media, each item has its own alt).

x

Field	Type	Description
`options.x.reply`	string	One more X post published as a reply under the last post of the chain: under the main post, or under the last post of per_platform.x.thread when there is one (the usual place for a link). At most 280 characters as X counts them (a link counts 23, an emoji 2); longer is refused with code bad_x_thread before anything goes out. It is an X post: 1 X credit, 10 with a link, and it counts toward the daily X limit. Also accepted as per_platform.x.reply.

Before you choose a TikTok privacy level, GET /api/tiktok/creator-info returns the levels TikTok allows for the connected creator.