Posts

Publish now, schedule, queue or save drafts to one or many accounts.

Create a post

POST/v1/posts

Publishes now unless you send scheduledFor, queue: true or draft: true. Each target is one account and can carry its own text, media and network options (instagram, youtube, tiktok…). TikTok targets always need tiktok options.

Body

contentstringrequired
Text posted to every target that has no content of its own.
max 10,000
mediaobject[]
Images, videos or documents. Upload them first with POST /v1/media/upload-url.
max 35 items
media
- typestringrequired
  Values: image · video · gif · document
- urlstring (uri)required
- altTextstring
  max 1,000
targetsobject[]required
max 50 items
targets
- accountIdstringrequired
  A connected account (GET /v1/accounts).
- contentstring
  Replaces the post text on this network.
  max 10,000
- mediaobject[]
  max 35 items
  media
  - typestringrequired
    Values: image · video · gif · document
  - urlstring (uri)required
  - altTextstring
    max 1,000
- youtubeobject
  youtube
  - titlestring
    Video title (up to 100 characters).
    max 100
  - visibilitystring
    public, unlisted or private.
    Values: public · unlisted · private
  - madeForKidsboolean
    COPPA flag. YouTube may limit videos that do not set it.
  - categoryIdstring
    Numeric YouTube category id.
  - playlistIdstring
    Add it to this playlist.
    max 100
  - tagsstring[]
    Tags (500 characters in total).
    max 50 items
  - firstCommentstring
    Comment posted right after.
    max 10,000
  - thumbnailUrlstring (uri)
    Custom thumbnail.
  - containsSyntheticMediaboolean
    Contains realistic AI-generated or altered content.
  - notifySubscribersboolean
    false uploads it without notifying subscribers.
- tiktokobject
  tiktok
  - privacystringrequired
    Who sees it: public, friends, followers or private.
    Values: public · friends · followers · private
  - allowCommentsbooleanrequired
    Allow comments.
  - allowDuetboolean
    Allow duets.
    Default: false
  - allowStitchboolean
    Allow stitches.
    Default: false
  - commercialContentstring
    own_brand when it promotes your business, paid_partnership when sponsored. Not with private privacy.
    Values: own_brand · paid_partnership
  - autoAddMusicboolean
    Photos only: TikTok may add recommended music.
  - consenttruerequired
    Always true: the user saw the preview and agreed to post.
- instagramobject
  instagram
  - formatstring
    feed, reel or story. By default images go to the feed and a video is a Reel.
    Values: feed · reel · story
  - shareToFeedboolean
    Reels only: false keeps it out of the profile grid.
  - collaboratorsstring[]
    Up to 3 business or creator usernames invited as collaborators. Not for Stories.
    max 3 items
  - firstCommentstring
    Comment posted right after. Not for Stories.
    max 2,200
  - coverUrlstring (uri)
    Reels only: cover image.
- facebookobject
  facebook
  - formatstring
    feed, reel or story.
    Values: feed · reel · story
  - reelTitlestring
    Reels only: a title separate from the text.
    max 255
  - firstCommentstring
    Comment posted right after. Not for Stories.
    max 10,000
- linkedinobject
  linkedin
  - firstCommentstring
    Comment posted right after.
    max 10,000
  - disableLinkPreviewboolean
    Hide the link preview.
  - documentTitlestring
    Title of document (PDF) posts.
    max 400
- xobject
  x
  - threadstring[]
    Thread replies, in order. The post’s text is the first tweet.
    max 25 items
  - replySettingsstring
    Who can reply: following, mentionedUsers, subscribers or verified.
    Values: following · mentionedUsers · subscribers · verified
- threadsobject
  threads
  - threadstring[]
    Thread replies, in order.
    max 25 items
  - topicTagstring
    Topic of the post.
    max 50
  - firstCommentstring
    Comment posted right after.
    max 10,000
- blueskyobject
  bluesky
  - threadstring[]
    Thread replies, in order.
    max 25 items
- pinterestobject
  pinterest
  - titlestring
    Pin title.
    max 100
  - linkstring (uri)
    Where the Pin leads.
  - boardIdstring
    Board. Defaults to the one picked when connecting.
    max 100
- googleBusinessobject
  googleBusiness
  - callToActionobject
    The post’s button.
    callToAction
    typestringrequired
    learn_more, book, order, shop, sign_up or call.
    Values: learn_more · book · order · shop · sign_up · call
    urlstring (uri)
    Where the button leads. Required except for call.
- telegramobject
  telegram
  - parseModestring
    Text format: html or markdown.
    Values: html · markdown
  - disableLinkPreviewboolean
    Hide the link preview.
  - silentboolean
    Send without sound.
  - protectContentboolean
    Prevent forwarding or saving it.
- snapchatobject
  snapchat
  - formatstring
    story (gone after 24 h), saved_story (stays on the profile) or spotlight.
    Values: story · saved_story · spotlight
- redditobject
  reddit
  - subredditstring
    Subreddit without r/.
  - titlestring
    Post title.
    max 300
  - linkstring (uri)
    Makes it a link post.
  - flairIdstring
    Subreddit flair.
    max 100
  - nsfwboolean
    Mark it NSFW.
  - spoilerboolean
    Mark it as a spoiler.
scheduledForstring (date-time)
When to publish (ISO 8601 with offset). Omit to publish now.
timezonestring
IANA timezone that scheduledFor refers to.
max 64
queueboolean
Take the next free slot of the profile's queue.
draftboolean
Save without publishing or scheduling.
requiresApprovalboolean
Hold it as pending_approval until an owner or admin approves it. Members of a workspace that requires approval always get it.

Response 201

data

idstringrequired
contentstringrequired
mediaobject[]required
media
- typestringrequired
  Values: image · video · gif · document
- urlstring (uri)required
- altTextstring
  max 1,000
targetsobject[]required
targets
- accountIdstringrequired
- platformstringrequired
- contentstring
- mediaobject[]
  media
  - typestringrequired
    Values: image · video · gif · document
  - urlstring (uri)required
  - altTextstring
    max 1,000
- statusstringrequired
  Values: pending · published · failed · removed
- urlstring (uri)
  The live post, once published.
- errorstring
statusstringrequired
Values: draft · pending_approval · scheduled · publishing · published · partial · failed · cancelled
scheduledForstring (date-time)
approvalobject
Present once the post went through review.
approval
- requestedBystring
  User who asked for it; absent when an API key did.
- requestedAtstring (date-time)required
- queueboolean
  Approving puts it in the profile’s queue.
- decisionstring
  Values: approved · rejected
- decidedBystring
- decidedAtstring (date-time)
- notestring
  Why it was rejected.
recyclingobject
Present once recycling was turned on.
recycling
- activebooleanrequired
- everyintegerrequired
  max 9,007,199,254,740,991
- unitstringrequired
  Values: week · month
- startAtstring (date-time)
- maxCopiesinteger
  max 9,007,199,254,740,991
- untilstring (date-time)
- variationsstring[]
- timezonestring
- copiesintegerrequired
  Copies created so far.
  max 9,007,199,254,740,991
- nextAtstring (date-time)
  When the next copy goes out; absent once it stopped.
- lastCopyIdstring
  The latest copy, a post of its own.
recycledFromstring
On a recycled copy: the original post.
createdAtstring (date-time)required
updatedAtstring (date-time)required

curl -X POST "https://api.usecrier.com/v1/posts" \
  -H "Authorization: Bearer $CRIER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "Our autumn collection is here 🍂",
    "media": [
      {
        "type": "image",
        "url": "https://cdn.acme.com/autumn.jpg"
      }
    ],
    "targets": [
      {
        "accountId": "acc_3k9x2m"
      },
      {
        "accountId": "acc_9z8y7x",
        "youtube": {
          "title": "Autumn collection"
        }
      }
    ],
    "scheduledFor": "2026-10-30T09:00:00+01:00"
  }'

const res = await fetch('https://api.usecrier.com/v1/posts', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "content": "Our autumn collection is here 🍂",
    "media": [
      {
        "type": "image",
        "url": "https://cdn.acme.com/autumn.jpg"
      }
    ],
    "targets": [
      {
        "accountId": "acc_3k9x2m"
      },
      {
        "accountId": "acc_9z8y7x",
        "youtube": {
          "title": "Autumn collection"
        }
      }
    ],
    "scheduledFor": "2026-10-30T09:00:00+01:00"
  }),
});
const { data } = await res.json();

import os, requests

res = requests.post(
    "https://api.usecrier.com/v1/posts",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
    json={
        "content": "Our autumn collection is here 🍂",
        "media": [
            {
                "type": "image",
                "url": "https://cdn.acme.com/autumn.jpg"
            }
        ],
        "targets": [
            {
                "accountId": "acc_3k9x2m"
            },
            {
                "accountId": "acc_9z8y7x",
                "youtube": {
                    "title": "Autumn collection"
                }
            }
        ],
        "scheduledFor": "2026-10-30T09:00:00+01:00"
    },
)
data = res.json()["data"]

List posts

GET/v1/posts

Newest first.

Parameters

limitinteger
max 100

Response 200

data []

idstringrequired
contentstringrequired
mediaobject[]required
media
- typestringrequired
  Values: image · video · gif · document
- urlstring (uri)required
- altTextstring
  max 1,000
targetsobject[]required
targets
- accountIdstringrequired
- platformstringrequired
- contentstring
- mediaobject[]
  media
  - typestringrequired
    Values: image · video · gif · document
  - urlstring (uri)required
  - altTextstring
    max 1,000
- statusstringrequired
  Values: pending · published · failed · removed
- urlstring (uri)
  The live post, once published.
- errorstring
statusstringrequired
Values: draft · pending_approval · scheduled · publishing · published · partial · failed · cancelled
scheduledForstring (date-time)
approvalobject
Present once the post went through review.
approval
- requestedBystring
  User who asked for it; absent when an API key did.
- requestedAtstring (date-time)required
- queueboolean
  Approving puts it in the profile’s queue.
- decisionstring
  Values: approved · rejected
- decidedBystring
- decidedAtstring (date-time)
- notestring
  Why it was rejected.
recyclingobject
Present once recycling was turned on.
recycling
- activebooleanrequired
- everyintegerrequired
  max 9,007,199,254,740,991
- unitstringrequired
  Values: week · month
- startAtstring (date-time)
- maxCopiesinteger
  max 9,007,199,254,740,991
- untilstring (date-time)
- variationsstring[]
- timezonestring
- copiesintegerrequired
  Copies created so far.
  max 9,007,199,254,740,991
- nextAtstring (date-time)
  When the next copy goes out; absent once it stopped.
- lastCopyIdstring
  The latest copy, a post of its own.
recycledFromstring
On a recycled copy: the original post.
createdAtstring (date-time)required
updatedAtstring (date-time)required

curl "https://api.usecrier.com/v1/posts?limit=20" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/posts?limit=20', {
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.get(
    "https://api.usecrier.com/v1/posts?limit=20",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Import posts from a CSV

POST/v1/posts/import

One post per row, up to 50 rows. Columns: content, accounts (ids separated by |) or group, schedule_time, timezone, queue, draft, media_urls and per-network columns (see the CSV import guide). Send dryRun: true first to check every row without posting.

Body

csvstringrequired
The CSV text, header row first.
max 1,000,000
dryRunboolean
Check every row without posting.

Response 200

data

totalintegerrequired
max 9,007,199,254,740,991
validintegerrequired
max 9,007,199,254,740,991
invalidintegerrequired
max 9,007,199,254,740,991
dryRunbooleanrequired
unknownColumnsstring[]required
Columns that were ignored.
rowsobject[]required
rows
- rowintegerrequired
  1-based, header excluded.
  max 9,007,199,254,740,991
- okbooleanrequired
- postIdstring
- errorstring

curl -X POST "https://api.usecrier.com/v1/posts/import" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/posts/import', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.post(
    "https://api.usecrier.com/v1/posts/import",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Change a post that is not live

PATCH/v1/posts/{id}

Drafts, scheduled, failed and cancelled posts. Fields you leave out keep their value; targets replaces the whole list. draft: false publishes a draft now, or at scheduledFor, or in the queue.

Parameters

idstringrequired

Body

contentstring
Text posted to every target that has no content of its own.
max 10,000
mediaobject[]
Images, videos or documents. Upload them first with POST /v1/media/upload-url.
max 35 items
media
- typestringrequired
  Values: image · video · gif · document
- urlstring (uri)required
- altTextstring
  max 1,000
targetsobject[]
max 50 items
targets
- accountIdstringrequired
  A connected account (GET /v1/accounts).
- contentstring
  Replaces the post text on this network.
  max 10,000
- mediaobject[]
  max 35 items
  media
  - typestringrequired
    Values: image · video · gif · document
  - urlstring (uri)required
  - altTextstring
    max 1,000
- youtubeobject
  youtube
  - titlestring
    Video title (up to 100 characters).
    max 100
  - visibilitystring
    public, unlisted or private.
    Values: public · unlisted · private
  - madeForKidsboolean
    COPPA flag. YouTube may limit videos that do not set it.
  - categoryIdstring
    Numeric YouTube category id.
  - playlistIdstring
    Add it to this playlist.
    max 100
  - tagsstring[]
    Tags (500 characters in total).
    max 50 items
  - firstCommentstring
    Comment posted right after.
    max 10,000
  - thumbnailUrlstring (uri)
    Custom thumbnail.
  - containsSyntheticMediaboolean
    Contains realistic AI-generated or altered content.
  - notifySubscribersboolean
    false uploads it without notifying subscribers.
- tiktokobject
  tiktok
  - privacystringrequired
    Who sees it: public, friends, followers or private.
    Values: public · friends · followers · private
  - allowCommentsbooleanrequired
    Allow comments.
  - allowDuetboolean
    Allow duets.
    Default: false
  - allowStitchboolean
    Allow stitches.
    Default: false
  - commercialContentstring
    own_brand when it promotes your business, paid_partnership when sponsored. Not with private privacy.
    Values: own_brand · paid_partnership
  - autoAddMusicboolean
    Photos only: TikTok may add recommended music.
  - consenttruerequired
    Always true: the user saw the preview and agreed to post.
- instagramobject
  instagram
  - formatstring
    feed, reel or story. By default images go to the feed and a video is a Reel.
    Values: feed · reel · story
  - shareToFeedboolean
    Reels only: false keeps it out of the profile grid.
  - collaboratorsstring[]
    Up to 3 business or creator usernames invited as collaborators. Not for Stories.
    max 3 items
  - firstCommentstring
    Comment posted right after. Not for Stories.
    max 2,200
  - coverUrlstring (uri)
    Reels only: cover image.
- facebookobject
  facebook
  - formatstring
    feed, reel or story.
    Values: feed · reel · story
  - reelTitlestring
    Reels only: a title separate from the text.
    max 255
  - firstCommentstring
    Comment posted right after. Not for Stories.
    max 10,000
- linkedinobject
  linkedin
  - firstCommentstring
    Comment posted right after.
    max 10,000
  - disableLinkPreviewboolean
    Hide the link preview.
  - documentTitlestring
    Title of document (PDF) posts.
    max 400
- xobject
  x
  - threadstring[]
    Thread replies, in order. The post’s text is the first tweet.
    max 25 items
  - replySettingsstring
    Who can reply: following, mentionedUsers, subscribers or verified.
    Values: following · mentionedUsers · subscribers · verified
- threadsobject
  threads
  - threadstring[]
    Thread replies, in order.
    max 25 items
  - topicTagstring
    Topic of the post.
    max 50
  - firstCommentstring
    Comment posted right after.
    max 10,000
- blueskyobject
  bluesky
  - threadstring[]
    Thread replies, in order.
    max 25 items
- pinterestobject
  pinterest
  - titlestring
    Pin title.
    max 100
  - linkstring (uri)
    Where the Pin leads.
  - boardIdstring
    Board. Defaults to the one picked when connecting.
    max 100
- googleBusinessobject
  googleBusiness
  - callToActionobject
    The post’s button.
    callToAction
    typestringrequired
    learn_more, book, order, shop, sign_up or call.
    Values: learn_more · book · order · shop · sign_up · call
    urlstring (uri)
    Where the button leads. Required except for call.
- telegramobject
  telegram
  - parseModestring
    Text format: html or markdown.
    Values: html · markdown
  - disableLinkPreviewboolean
    Hide the link preview.
  - silentboolean
    Send without sound.
  - protectContentboolean
    Prevent forwarding or saving it.
- snapchatobject
  snapchat
  - formatstring
    story (gone after 24 h), saved_story (stays on the profile) or spotlight.
    Values: story · saved_story · spotlight
- redditobject
  reddit
  - subredditstring
    Subreddit without r/.
  - titlestring
    Post title.
    max 300
  - linkstring (uri)
    Makes it a link post.
  - flairIdstring
    Subreddit flair.
    max 100
  - nsfwboolean
    Mark it NSFW.
  - spoilerboolean
    Mark it as a spoiler.
scheduledForstring (date-time)
When to publish (ISO 8601 with offset). Omit to publish now.
timezonestring
IANA timezone that scheduledFor refers to.
max 64
queueboolean
Take the next free slot of the profile's queue.
draftboolean
Save without publishing or scheduling.
requiresApprovalboolean
Hold it as pending_approval until an owner or admin approves it. Members of a workspace that requires approval always get it.

Response 200

data

idstringrequired
contentstringrequired
mediaobject[]required
media
- typestringrequired
  Values: image · video · gif · document
- urlstring (uri)required
- altTextstring
  max 1,000
targetsobject[]required
targets
- accountIdstringrequired
- platformstringrequired
- contentstring
- mediaobject[]
  media
  - typestringrequired
    Values: image · video · gif · document
  - urlstring (uri)required
  - altTextstring
    max 1,000
- statusstringrequired
  Values: pending · published · failed · removed
- urlstring (uri)
  The live post, once published.
- errorstring
statusstringrequired
Values: draft · pending_approval · scheduled · publishing · published · partial · failed · cancelled
scheduledForstring (date-time)
approvalobject
Present once the post went through review.
approval
- requestedBystring
  User who asked for it; absent when an API key did.
- requestedAtstring (date-time)required
- queueboolean
  Approving puts it in the profile’s queue.
- decisionstring
  Values: approved · rejected
- decidedBystring
- decidedAtstring (date-time)
- notestring
  Why it was rejected.
recyclingobject
Present once recycling was turned on.
recycling
- activebooleanrequired
- everyintegerrequired
  max 9,007,199,254,740,991
- unitstringrequired
  Values: week · month
- startAtstring (date-time)
- maxCopiesinteger
  max 9,007,199,254,740,991
- untilstring (date-time)
- variationsstring[]
- timezonestring
- copiesintegerrequired
  Copies created so far.
  max 9,007,199,254,740,991
- nextAtstring (date-time)
  When the next copy goes out; absent once it stopped.
- lastCopyIdstring
  The latest copy, a post of its own.
recycledFromstring
On a recycled copy: the original post.
createdAtstring (date-time)required
updatedAtstring (date-time)required

curl -X PATCH "https://api.usecrier.com/v1/posts/pst_7q1w0e" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/posts/pst_7q1w0e', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.patch(
    "https://api.usecrier.com/v1/posts/pst_7q1w0e",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Get a post

GET/v1/posts/{id}

Parameters

idstringrequired

Response 200

data

idstringrequired
contentstringrequired
mediaobject[]required
media
- typestringrequired
  Values: image · video · gif · document
- urlstring (uri)required
- altTextstring
  max 1,000
targetsobject[]required
targets
- accountIdstringrequired
- platformstringrequired
- contentstring
- mediaobject[]
  media
  - typestringrequired
    Values: image · video · gif · document
  - urlstring (uri)required
  - altTextstring
    max 1,000
- statusstringrequired
  Values: pending · published · failed · removed
- urlstring (uri)
  The live post, once published.
- errorstring
statusstringrequired
Values: draft · pending_approval · scheduled · publishing · published · partial · failed · cancelled
scheduledForstring (date-time)
approvalobject
Present once the post went through review.
approval
- requestedBystring
  User who asked for it; absent when an API key did.
- requestedAtstring (date-time)required
- queueboolean
  Approving puts it in the profile’s queue.
- decisionstring
  Values: approved · rejected
- decidedBystring
- decidedAtstring (date-time)
- notestring
  Why it was rejected.
recyclingobject
Present once recycling was turned on.
recycling
- activebooleanrequired
- everyintegerrequired
  max 9,007,199,254,740,991
- unitstringrequired
  Values: week · month
- startAtstring (date-time)
- maxCopiesinteger
  max 9,007,199,254,740,991
- untilstring (date-time)
- variationsstring[]
- timezonestring
- copiesintegerrequired
  Copies created so far.
  max 9,007,199,254,740,991
- nextAtstring (date-time)
  When the next copy goes out; absent once it stopped.
- lastCopyIdstring
  The latest copy, a post of its own.
recycledFromstring
On a recycled copy: the original post.
createdAtstring (date-time)required
updatedAtstring (date-time)required

curl "https://api.usecrier.com/v1/posts/pst_7q1w0e" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/posts/pst_7q1w0e', {
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.get(
    "https://api.usecrier.com/v1/posts/pst_7q1w0e",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Delete a post

DELETE/v1/posts/{id}

Removes it from Crier. A post that is still live must be unpublished first.

Parameters

idstringrequired

Response 204

No content

curl -X DELETE "https://api.usecrier.com/v1/posts/pst_7q1w0e" \
  -H "Authorization: Bearer $CRIER_API_KEY"

await fetch('https://api.usecrier.com/v1/posts/pst_7q1w0e', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});

import os, requests

requests.delete(
    "https://api.usecrier.com/v1/posts/pst_7q1w0e",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)

Edit the text of a live post

POST/v1/posts/{id}/edit

On X (Premium accounts, within 1 hour), Facebook, LinkedIn, YouTube, Pinterest, Google Business, Telegram, Discord and Reddit. Media cannot change.

Parameters

idstringrequired

Body

contentstringrequired
The new text of the live post.
max 10,000
accountIdstring
Edit only this account’s copy; every live copy otherwise.

Response 200

data

idstringrequired
contentstringrequired
mediaobject[]required
media
- typestringrequired
  Values: image · video · gif · document
- urlstring (uri)required
- altTextstring
  max 1,000
targetsobject[]required
targets
- accountIdstringrequired
- platformstringrequired
- contentstring
- mediaobject[]
  media
  - typestringrequired
    Values: image · video · gif · document
  - urlstring (uri)required
  - altTextstring
    max 1,000
- statusstringrequired
  Values: pending · published · failed · removed
- urlstring (uri)
  The live post, once published.
- errorstring
statusstringrequired
Values: draft · pending_approval · scheduled · publishing · published · partial · failed · cancelled
scheduledForstring (date-time)
approvalobject
Present once the post went through review.
approval
- requestedBystring
  User who asked for it; absent when an API key did.
- requestedAtstring (date-time)required
- queueboolean
  Approving puts it in the profile’s queue.
- decisionstring
  Values: approved · rejected
- decidedBystring
- decidedAtstring (date-time)
- notestring
  Why it was rejected.
recyclingobject
Present once recycling was turned on.
recycling
- activebooleanrequired
- everyintegerrequired
  max 9,007,199,254,740,991
- unitstringrequired
  Values: week · month
- startAtstring (date-time)
- maxCopiesinteger
  max 9,007,199,254,740,991
- untilstring (date-time)
- variationsstring[]
- timezonestring
- copiesintegerrequired
  Copies created so far.
  max 9,007,199,254,740,991
- nextAtstring (date-time)
  When the next copy goes out; absent once it stopped.
- lastCopyIdstring
  The latest copy, a post of its own.
recycledFromstring
On a recycled copy: the original post.
createdAtstring (date-time)required
updatedAtstring (date-time)required

curl -X POST "https://api.usecrier.com/v1/posts/pst_7q1w0e/edit" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/posts/pst_7q1w0e/edit', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.post(
    "https://api.usecrier.com/v1/posts/pst_7q1w0e/edit",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Get the metrics of a post

GET/v1/posts/{id}/metrics

Impressions, reach, views, likes, comments, shares, saves and clicks, in total and per account. Each network reports its own subset.

Parameters

idstringrequired

Response 200

data

totalobjectrequired
total
- impressionsintegerrequired
  max 9,007,199,254,740,991
- reachintegerrequired
  max 9,007,199,254,740,991
- viewsintegerrequired
  max 9,007,199,254,740,991
- likesintegerrequired
  max 9,007,199,254,740,991
- commentsintegerrequired
  max 9,007,199,254,740,991
- sharesintegerrequired
  max 9,007,199,254,740,991
- savesintegerrequired
  max 9,007,199,254,740,991
- clicksintegerrequired
  max 9,007,199,254,740,991
- engagementRatenumberrequired
  Percentage: interactions over impressions (or reach).
targetsobject[]required
targets
- accountIdstringrequired
- platformstringrequired
- metricsobjectrequired
  metrics
  - impressionsintegerrequired
    max 9,007,199,254,740,991
  - reachintegerrequired
    max 9,007,199,254,740,991
  - viewsintegerrequired
    max 9,007,199,254,740,991
  - likesintegerrequired
    max 9,007,199,254,740,991
  - commentsintegerrequired
    max 9,007,199,254,740,991
  - sharesintegerrequired
    max 9,007,199,254,740,991
  - savesintegerrequired
    max 9,007,199,254,740,991
  - clicksintegerrequired
    max 9,007,199,254,740,991
  - engagementRatenumberrequired
    Percentage: interactions over impressions (or reach).
updatedAtstring (date-time)

curl "https://api.usecrier.com/v1/posts/pst_7q1w0e/metrics" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/posts/pst_7q1w0e/metrics', {
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.get(
    "https://api.usecrier.com/v1/posts/pst_7q1w0e/metrics",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Cancel a scheduled post, draft or post waiting for approval

POST/v1/posts/{id}/cancel

Parameters

idstringrequired

Response 200

data

idstringrequired
contentstringrequired
mediaobject[]required
media
- typestringrequired
  Values: image · video · gif · document
- urlstring (uri)required
- altTextstring
  max 1,000
targetsobject[]required
targets
- accountIdstringrequired
- platformstringrequired
- contentstring
- mediaobject[]
  media
  - typestringrequired
    Values: image · video · gif · document
  - urlstring (uri)required
  - altTextstring
    max 1,000
- statusstringrequired
  Values: pending · published · failed · removed
- urlstring (uri)
  The live post, once published.
- errorstring
statusstringrequired
Values: draft · pending_approval · scheduled · publishing · published · partial · failed · cancelled
scheduledForstring (date-time)
approvalobject
Present once the post went through review.
approval
- requestedBystring
  User who asked for it; absent when an API key did.
- requestedAtstring (date-time)required
- queueboolean
  Approving puts it in the profile’s queue.
- decisionstring
  Values: approved · rejected
- decidedBystring
- decidedAtstring (date-time)
- notestring
  Why it was rejected.
recyclingobject
Present once recycling was turned on.
recycling
- activebooleanrequired
- everyintegerrequired
  max 9,007,199,254,740,991
- unitstringrequired
  Values: week · month
- startAtstring (date-time)
- maxCopiesinteger
  max 9,007,199,254,740,991
- untilstring (date-time)
- variationsstring[]
- timezonestring
- copiesintegerrequired
  Copies created so far.
  max 9,007,199,254,740,991
- nextAtstring (date-time)
  When the next copy goes out; absent once it stopped.
- lastCopyIdstring
  The latest copy, a post of its own.
recycledFromstring
On a recycled copy: the original post.
createdAtstring (date-time)required
updatedAtstring (date-time)required

curl -X POST "https://api.usecrier.com/v1/posts/pst_7q1w0e/cancel" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/posts/pst_7q1w0e/cancel', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.post(
    "https://api.usecrier.com/v1/posts/pst_7q1w0e/cancel",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Approve or reject a post

POST/v1/posts/{id}/review

Only for posts in pending_approval, by owners, admins or an API key. Approving schedules it for its date, puts it in the queue if it asked for one, or publishes it now if its date already passed. Rejecting returns it to draft with the note and sends post.rejected.

Parameters

idstringrequired

Body

decisionstringrequired
approve schedules it (or publishes it now if its date passed); reject returns it to draft.
Values: approve · reject
notestring
Why, for whoever wrote it. Shown with the draft after a rejection.
max 1,000

Response 200

data

idstringrequired
contentstringrequired
mediaobject[]required
media
- typestringrequired
  Values: image · video · gif · document
- urlstring (uri)required
- altTextstring
  max 1,000
targetsobject[]required
targets
- accountIdstringrequired
- platformstringrequired
- contentstring
- mediaobject[]
  media
  - typestringrequired
    Values: image · video · gif · document
  - urlstring (uri)required
  - altTextstring
    max 1,000
- statusstringrequired
  Values: pending · published · failed · removed
- urlstring (uri)
  The live post, once published.
- errorstring
statusstringrequired
Values: draft · pending_approval · scheduled · publishing · published · partial · failed · cancelled
scheduledForstring (date-time)
approvalobject
Present once the post went through review.
approval
- requestedBystring
  User who asked for it; absent when an API key did.
- requestedAtstring (date-time)required
- queueboolean
  Approving puts it in the profile’s queue.
- decisionstring
  Values: approved · rejected
- decidedBystring
- decidedAtstring (date-time)
- notestring
  Why it was rejected.
recyclingobject
Present once recycling was turned on.
recycling
- activebooleanrequired
- everyintegerrequired
  max 9,007,199,254,740,991
- unitstringrequired
  Values: week · month
- startAtstring (date-time)
- maxCopiesinteger
  max 9,007,199,254,740,991
- untilstring (date-time)
- variationsstring[]
- timezonestring
- copiesintegerrequired
  Copies created so far.
  max 9,007,199,254,740,991
- nextAtstring (date-time)
  When the next copy goes out; absent once it stopped.
- lastCopyIdstring
  The latest copy, a post of its own.
recycledFromstring
On a recycled copy: the original post.
createdAtstring (date-time)required
updatedAtstring (date-time)required

curl -X POST "https://api.usecrier.com/v1/posts/pst_7q1w0e/review" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/posts/pst_7q1w0e/review', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.post(
    "https://api.usecrier.com/v1/posts/pst_7q1w0e/review",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Recycle a post

PUT/v1/posts/{id}/recycling

Posts it again every every weeks or months as a new post (recycledFrom points back), until maxCopies or until. YouTube and TikTok targets are left out of the copies, and each account can have up to 10 posts recycling. Sending it again changes the rule and keeps the count.

Parameters

idstringrequired

Body

everyintegerrequired
How many units between copies.
max 52
unitstringrequired
week or month.
Values: week · month
startAtstring (date-time)
When the first copy goes out. Defaults to one interval after the post’s date; for an old post, the next date of that series, at the same time of day.
maxCopiesinteger
Stop after this many copies.
max 100
untilstring (date-time)
Stop after this date.
variationsstring[]
Texts used in turn instead of the post’s text. A target’s own text still wins. Recommended for X and Pinterest, which flag repeats.
min 2max 20 items
timezonestring
IANA time zone (e.g. Europe/Madrid) the interval is counted in, so copies keep their local time when the clocks change. UTC by default.
max 64

Response 200

data

idstringrequired
contentstringrequired
mediaobject[]required
media
- typestringrequired
  Values: image · video · gif · document
- urlstring (uri)required
- altTextstring
  max 1,000
targetsobject[]required
targets
- accountIdstringrequired
- platformstringrequired
- contentstring
- mediaobject[]
  media
  - typestringrequired
    Values: image · video · gif · document
  - urlstring (uri)required
  - altTextstring
    max 1,000
- statusstringrequired
  Values: pending · published · failed · removed
- urlstring (uri)
  The live post, once published.
- errorstring
statusstringrequired
Values: draft · pending_approval · scheduled · publishing · published · partial · failed · cancelled
scheduledForstring (date-time)
approvalobject
Present once the post went through review.
approval
- requestedBystring
  User who asked for it; absent when an API key did.
- requestedAtstring (date-time)required
- queueboolean
  Approving puts it in the profile’s queue.
- decisionstring
  Values: approved · rejected
- decidedBystring
- decidedAtstring (date-time)
- notestring
  Why it was rejected.
recyclingobject
Present once recycling was turned on.
recycling
- activebooleanrequired
- everyintegerrequired
  max 9,007,199,254,740,991
- unitstringrequired
  Values: week · month
- startAtstring (date-time)
- maxCopiesinteger
  max 9,007,199,254,740,991
- untilstring (date-time)
- variationsstring[]
- timezonestring
- copiesintegerrequired
  Copies created so far.
  max 9,007,199,254,740,991
- nextAtstring (date-time)
  When the next copy goes out; absent once it stopped.
- lastCopyIdstring
  The latest copy, a post of its own.
recycledFromstring
On a recycled copy: the original post.
createdAtstring (date-time)required
updatedAtstring (date-time)required

curl -X PUT "https://api.usecrier.com/v1/posts/pst_7q1w0e/recycling" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/posts/pst_7q1w0e/recycling', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.put(
    "https://api.usecrier.com/v1/posts/pst_7q1w0e/recycling",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Stop recycling a post

DELETE/v1/posts/{id}/recycling

Copies already created stay as they are.

Parameters

idstringrequired

Response 200

data

idstringrequired
contentstringrequired
mediaobject[]required
media
- typestringrequired
  Values: image · video · gif · document
- urlstring (uri)required
- altTextstring
  max 1,000
targetsobject[]required
targets
- accountIdstringrequired
- platformstringrequired
- contentstring
- mediaobject[]
  media
  - typestringrequired
    Values: image · video · gif · document
  - urlstring (uri)required
  - altTextstring
    max 1,000
- statusstringrequired
  Values: pending · published · failed · removed
- urlstring (uri)
  The live post, once published.
- errorstring
statusstringrequired
Values: draft · pending_approval · scheduled · publishing · published · partial · failed · cancelled
scheduledForstring (date-time)
approvalobject
Present once the post went through review.
approval
- requestedBystring
  User who asked for it; absent when an API key did.
- requestedAtstring (date-time)required
- queueboolean
  Approving puts it in the profile’s queue.
- decisionstring
  Values: approved · rejected
- decidedBystring
- decidedAtstring (date-time)
- notestring
  Why it was rejected.
recyclingobject
Present once recycling was turned on.
recycling
- activebooleanrequired
- everyintegerrequired
  max 9,007,199,254,740,991
- unitstringrequired
  Values: week · month
- startAtstring (date-time)
- maxCopiesinteger
  max 9,007,199,254,740,991
- untilstring (date-time)
- variationsstring[]
- timezonestring
- copiesintegerrequired
  Copies created so far.
  max 9,007,199,254,740,991
- nextAtstring (date-time)
  When the next copy goes out; absent once it stopped.
- lastCopyIdstring
  The latest copy, a post of its own.
recycledFromstring
On a recycled copy: the original post.
createdAtstring (date-time)required
updatedAtstring (date-time)required

curl -X DELETE "https://api.usecrier.com/v1/posts/pst_7q1w0e/recycling" \
  -H "Authorization: Bearer $CRIER_API_KEY"

await fetch('https://api.usecrier.com/v1/posts/pst_7q1w0e/recycling', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});

import os, requests

requests.delete(
    "https://api.usecrier.com/v1/posts/pst_7q1w0e/recycling",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)

Retry the failed targets

POST/v1/posts/{id}/retry

Parameters

idstringrequired

Response 200

data

idstringrequired
contentstringrequired
mediaobject[]required
media
- typestringrequired
  Values: image · video · gif · document
- urlstring (uri)required
- altTextstring
  max 1,000
targetsobject[]required
targets
- accountIdstringrequired
- platformstringrequired
- contentstring
- mediaobject[]
  media
  - typestringrequired
    Values: image · video · gif · document
  - urlstring (uri)required
  - altTextstring
    max 1,000
- statusstringrequired
  Values: pending · published · failed · removed
- urlstring (uri)
  The live post, once published.
- errorstring
statusstringrequired
Values: draft · pending_approval · scheduled · publishing · published · partial · failed · cancelled
scheduledForstring (date-time)
approvalobject
Present once the post went through review.
approval
- requestedBystring
  User who asked for it; absent when an API key did.
- requestedAtstring (date-time)required
- queueboolean
  Approving puts it in the profile’s queue.
- decisionstring
  Values: approved · rejected
- decidedBystring
- decidedAtstring (date-time)
- notestring
  Why it was rejected.
recyclingobject
Present once recycling was turned on.
recycling
- activebooleanrequired
- everyintegerrequired
  max 9,007,199,254,740,991
- unitstringrequired
  Values: week · month
- startAtstring (date-time)
- maxCopiesinteger
  max 9,007,199,254,740,991
- untilstring (date-time)
- variationsstring[]
- timezonestring
- copiesintegerrequired
  Copies created so far.
  max 9,007,199,254,740,991
- nextAtstring (date-time)
  When the next copy goes out; absent once it stopped.
- lastCopyIdstring
  The latest copy, a post of its own.
recycledFromstring
On a recycled copy: the original post.
createdAtstring (date-time)required
updatedAtstring (date-time)required

curl -X POST "https://api.usecrier.com/v1/posts/pst_7q1w0e/retry" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/posts/pst_7q1w0e/retry', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.post(
    "https://api.usecrier.com/v1/posts/pst_7q1w0e/retry",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Take a published post down

POST/v1/posts/{id}/unpublish

From every network, or only from accountId.

Parameters

idstringrequired

Body

accountIdstring

Response 200

data

idstringrequired
contentstringrequired
mediaobject[]required
media
- typestringrequired
  Values: image · video · gif · document
- urlstring (uri)required
- altTextstring
  max 1,000
targetsobject[]required
targets
- accountIdstringrequired
- platformstringrequired
- contentstring
- mediaobject[]
  media
  - typestringrequired
    Values: image · video · gif · document
  - urlstring (uri)required
  - altTextstring
    max 1,000
- statusstringrequired
  Values: pending · published · failed · removed
- urlstring (uri)
  The live post, once published.
- errorstring
statusstringrequired
Values: draft · pending_approval · scheduled · publishing · published · partial · failed · cancelled
scheduledForstring (date-time)
approvalobject
Present once the post went through review.
approval
- requestedBystring
  User who asked for it; absent when an API key did.
- requestedAtstring (date-time)required
- queueboolean
  Approving puts it in the profile’s queue.
- decisionstring
  Values: approved · rejected
- decidedBystring
- decidedAtstring (date-time)
- notestring
  Why it was rejected.
recyclingobject
Present once recycling was turned on.
recycling
- activebooleanrequired
- everyintegerrequired
  max 9,007,199,254,740,991
- unitstringrequired
  Values: week · month
- startAtstring (date-time)
- maxCopiesinteger
  max 9,007,199,254,740,991
- untilstring (date-time)
- variationsstring[]
- timezonestring
- copiesintegerrequired
  Copies created so far.
  max 9,007,199,254,740,991
- nextAtstring (date-time)
  When the next copy goes out; absent once it stopped.
- lastCopyIdstring
  The latest copy, a post of its own.
recycledFromstring
On a recycled copy: the original post.
createdAtstring (date-time)required
updatedAtstring (date-time)required

curl -X POST "https://api.usecrier.com/v1/posts/pst_7q1w0e/unpublish" \
  -H "Authorization: Bearer $CRIER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "accountId": "acc_3k9x2m"
  }'

const res = await fetch('https://api.usecrier.com/v1/posts/pst_7q1w0e/unpublish', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "accountId": "acc_3k9x2m"
  }),
});
const { data } = await res.json();

import os, requests

res = requests.post(
    "https://api.usecrier.com/v1/posts/pst_7q1w0e/unpublish",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
    json={
        "accountId": "acc_3k9x2m"
    },
)
data = res.json()["data"]