Create, schedule or publish a post

POST

workspaces

{workspace_id}

scheduled-posts

curl --request POST \
  --url https://api.usereplier.com/v1/workspaces/{workspace_id}/scheduled-posts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "channels": [
    {
      "account_id": "<string>"
    }
  ],
  "media_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "caption": "",
  "first_comment": "<string>",
  "cover_image_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "publish_at": "2023-11-07T05:31:56Z",
  "time_zone": "UTC",
  "automation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "move_automation": true
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    channels: [{account_id: '<string>'}],
    media_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    caption: '',
    first_comment: '<string>',
    cover_image_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    publish_at: '2023-11-07T05:31:56Z',
    time_zone: 'UTC',
    automation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    move_automation: true
  })
};

fetch('https://api.usereplier.com/v1/workspaces/{workspace_id}/scheduled-posts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.usereplier.com/v1/workspaces/{workspace_id}/scheduled-posts"

payload = {
    "channels": [{ "account_id": "<string>" }],
    "media_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "caption": "",
    "first_comment": "<string>",
    "cover_image_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "publish_at": "2023-11-07T05:31:56Z",
    "time_zone": "UTC",
    "automation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "move_automation": True
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "workspace": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "kind": "personal",
    "role": "owner"
  },
  "post": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "draft",
    "media_type": "image",
    "caption": "<string>",
    "first_comment": "<string>",
    "media": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "kind": "image",
        "url": "<string>",
        "width": 0,
        "height": 0,
        "bytes": 4503599627370495,
        "duration_ms": 0,
        "cover_image_id": "<string>"
      }
    ],
    "media_removed": true,
    "publish_at": "2023-11-07T05:31:56Z",
    "time_zone": "<string>",
    "automation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "channels": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "channel": "instagram",
        "account_id": "<string>",
        "account_name": "<string>",
        "account_connected": true,
        "status": "pending",
        "permalink": "<string>",
        "published_at": "2023-11-07T05:31:56Z",
        "publish_unconfirmed": true,
        "error_code": "<string>",
        "error_message": "<string>",
        "failed_at": "2023-11-07T05:31:56Z",
        "first_comment_error": "<string>",
        "automation_error": "<string>"
      }
    ],
    "published_at": "2023-11-07T05:31:56Z",
    "failed_at": "2023-11-07T05:31:56Z",
    "locked": true,
    "version": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

A Replier API key (rpl_...).

Headers

Idempotency-Key

string

required

A new value for each operation, and the same one when you retry, so the request runs once.

Required string length: 1 - 128

Path Parameters

workspace_id

string<uuid>

required

Workspace ID returned by GET /v1/workspaces

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

channels

object[]

required

Every Instagram account and Facebook Page the post goes to; each publishes on its own.

Required array length: 1 - 20 elements

Show child attributes

action

enum<string>

required

Available options:

draft,

schedule,

publish_now

media_ids

string<uuid>[]

required

They decide the kind of post: one photo, one video (a Reel), or 2-20 files (a carousel; Facebook takes photos only in one). A file belongs to one post.

Required array length: 1 - 20 elements

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

caption

string

default:""

Up to 2,200 characters, 30 hashtags and 20 @mentions. Empty for none.

first_comment

string | null

Commented on the post right after it publishes. Null for none.

Maximum string length: 2200

cover_image_id

string<uuid> | null

A Reel's cover: media.id of an image uploaded with purpose cover. Null shows the frame a second into the video.

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

publish_at

string<date-time> | null

When to publish, at least 3 minutes and at most a year ahead. Needed to schedule; a draft may keep one.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

time_zone

string

default:UTC

IANA time zone the user picked the time in, such as Asia/Taipei. Replier shows the post's time in it.

Required string length: 1 - 64

automation_id

string<uuid> | null

A comment automation from GET /v1/workspaces/{workspace_id}/automations that answers the post's comments from its first minute once it publishes, or null for none. Needs automations.update. An automation answers one waiting post.

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

move_automation

boolean

true moves automation_id here from another post it waits for (AUTOMATION_USED_BY_POST); ask the user first.

Response

workspace

object

required

Show child attributes

post

object

required

Show child attributes

Create, schedule or publish a post

curl --request POST \
  --url https://api.usereplier.com/v1/workspaces/{workspace_id}/scheduled-posts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "channels": [
    {
      "account_id": "<string>"
    }
  ],
  "media_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "caption": "",
  "first_comment": "<string>",
  "cover_image_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "publish_at": "2023-11-07T05:31:56Z",
  "time_zone": "UTC",
  "automation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "move_automation": true
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    channels: [{account_id: '<string>'}],
    media_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    caption: '',
    first_comment: '<string>',
    cover_image_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    publish_at: '2023-11-07T05:31:56Z',
    time_zone: 'UTC',
    automation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    move_automation: true
  })
};

fetch('https://api.usereplier.com/v1/workspaces/{workspace_id}/scheduled-posts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.usereplier.com/v1/workspaces/{workspace_id}/scheduled-posts"

payload = {
    "channels": [{ "account_id": "<string>" }],
    "media_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "caption": "",
    "first_comment": "<string>",
    "cover_image_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "publish_at": "2023-11-07T05:31:56Z",
    "time_zone": "UTC",
    "automation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "move_automation": True
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "workspace": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "kind": "personal",
    "role": "owner"
  },
  "post": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "draft",
    "media_type": "image",
    "caption": "<string>",
    "first_comment": "<string>",
    "media": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "kind": "image",
        "url": "<string>",
        "width": 0,
        "height": 0,
        "bytes": 4503599627370495,
        "duration_ms": 0,
        "cover_image_id": "<string>"
      }
    ],
    "media_removed": true,
    "publish_at": "2023-11-07T05:31:56Z",
    "time_zone": "<string>",
    "automation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "channels": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "channel": "instagram",
        "account_id": "<string>",
        "account_name": "<string>",
        "account_connected": true,
        "status": "pending",
        "permalink": "<string>",
        "published_at": "2023-11-07T05:31:56Z",
        "publish_unconfirmed": true,
        "error_code": "<string>",
        "error_message": "<string>",
        "failed_at": "2023-11-07T05:31:56Z",
        "first_comment_error": "<string>",
        "automation_error": "<string>"
      }
    ],
    "published_at": "2023-11-07T05:31:56Z",
    "failed_at": "2023-11-07T05:31:56Z",
    "locked": true,
    "version": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Get started

Automatic replies

Results

Teamwork

AI apps

API

Free tools

Your account

Help

Create, schedule or publish a post

Authorizations

Headers

Path Parameters

Body

Response