Create a post

Posts

Authorization

Bearer

AuthorizationBearer <token>

API key (rlay_live_* or rlay_test_*)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

content?string

Post text. Optional if target_options provide per-target content.

targets*array<>

Account IDs, platform names, or workspace IDs to publish to

Items1 <= items

scheduled_at*string

Publish intent. Use "now" to publish immediately, "draft" to save as draft, "auto" to auto-schedule to the best available slot, or an ISO 8601 timestamp to schedule (max 30 days ahead).

media?array<>

Media attachments

target_options?

Per-target customizations keyed by target value (account ID or platform name). Supports platform-specific features such as Twitter polls (poll.options, poll.duration_minutes), threads, reply_to, and reply_settings.

timezone?string

IANA timezone for scheduling

Default"UTC"

workspace_id?string

Workspace ID to scope this post to

recycling?

Recycling configuration for evergreen content (Pro plan only)

shorten_urls?boolean

Shorten URLs in post content. Only relevant when short link mode is 'ask'. Ignored when mode is 'always' or 'never'. (Pro plan only)

cross_post_actions?array<>

Cross-post actions to execute after publishing (e.g., repost from another account, comment from another account)

template_id?string

Content template ID. When provided, the template content is used as the base for the post. Explicit 'content' field takes precedence.

idea_id?string

Create post from an idea. Pre-fills content from the idea. Explicit 'content' field takes precedence.

template_variables?

Variables to interpolate in the template (e.g., { "promo_code": "SUMMER25" }). Built-in variables: {{date}}, {{account_name}}.

skip_signature?boolean

When true, the default signature is not auto-appended even if one is configured.

Response Body

`application/json`

curl -X POST "https://example.com/v1/posts" \  -H "Content-Type: application/json" \  -d '{    "targets": [      "string"    ],    "scheduled_at": "now"  }'

{  "id": "string",  "status": "draft",  "content": "string",  "scheduled_at": "string",  "published_at": "string",  "targets": {    "property1": {      "status": "draft",      "platform": "twitter",      "accounts": [        {          "id": "string",          "username": "string",          "display_name": "string",          "avatar_url": "string",          "url": "string",          "platform_post_id": "string",          "target_id": "string"        }      ],      "error": {        "code": "string",        "message": "string",        "detail": "string"      }    },    "property2": {      "status": "draft",      "platform": "twitter",      "accounts": [        {          "id": "string",          "username": "string",          "display_name": "string",          "avatar_url": "string",          "url": "string",          "platform_post_id": "string",          "target_id": "string"        }      ],      "error": {        "code": "string",        "message": "string",        "detail": "string"      }    }  },  "media": [    {      "url": "http://example.com",      "type": "image",      "thumbnail": "string"    }  ],  "target_options": {    "property1": {      "property1": null,      "property2": null    },    "property2": {      "property1": null,      "property2": null    }  },  "timezone": "string",  "metrics": {    "impressions": 0,    "reach": 0,    "likes": 0,    "comments": 0,    "shares": 0,    "saves": 0,    "clicks": 0,    "views": 0,    "engagement_rate": 0  },  "recycling": {    "id": "string",    "enabled": true,    "gap": 0,    "gap_freq": "day",    "start_date": "2019-08-24T14:15:22Z",    "expire_count": 0,    "expire_date": "2019-08-24T14:15:22Z",    "content_variations": [      "string"    ],    "recycle_count": 0,    "content_variation_index": 0,    "next_recycle_at": "2019-08-24T14:15:22Z",    "last_recycled_at": "2019-08-24T14:15:22Z",    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  },  "recycled_from_id": "string",  "thread_group_id": "string",  "thread_position": 0,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}

{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}

{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}

{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}

Found something wrong? Help us improve this page.

Report an issue Edit this page on GitHub

Bulk create posts from CSV POST

Upload a CSV file to create multiple posts. Use dry_run=true to validate without creating. CSV columns: content, targets (semicolon-separated), scheduled_at, media_urls (semicolon-separated), timezone, target_options (JSON string). Max 500 rows, max 1 MB file size.

Delete a post DELETE

Delete a post.

Create a post

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

409application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`