RelayAPI

Bulk create posts

Create multiple posts in a single request. Each item follows the same schema as single post creation.

POST
/v1/posts/bulk
AuthorizationBearer <token>

API key (rlay_live_* or rlay_test_). Invite redemption also accepts a server-derived rlay_session_ bearer for a current user session.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/posts/bulk" \  -H "Content-Type: application/json" \  -d '{    "posts": [      {        "scheduled_at": "string",        "targets": [          "string"        ]      }    ]  }'
{  "data": [    {      "content": "string",      "created_at": "2019-08-24T14:15:22Z",      "id": "string",      "media": [        {          "alt_text": "string",          "duration_ms": 0,          "height": 0,          "mime_type": "string",          "thumbnail": "string",          "type": "image",          "url": "http://example.com",          "width": 0        }      ],      "metrics": {        "clicks": 0,        "comments": 0,        "engagement_rate": 0,        "impressions": 0,        "likes": 0,        "reach": 0,        "saves": 0,        "shares": 0,        "views": 0      },      "published_at": "string",      "recycled_from_id": "string",      "recycling": {        "content_variation_index": 0,        "content_variations": [          "string"        ],        "created_at": "2019-08-24T14:15:22Z",        "enabled": true,        "expire_count": 0,        "expire_date": "2019-08-24T14:15:22Z",        "gap": 0,        "gap_freq": "day",        "id": "string",        "last_recycled_at": "2019-08-24T14:15:22Z",        "next_recycle_at": "2019-08-24T14:15:22Z",        "recycle_count": 0,        "start_date": "2019-08-24T14:15:22Z",        "updated_at": "2019-08-24T14:15:22Z"      },      "scheduled_at": "string",      "status": "draft",      "target_options": {        "beehiiv": {          "content": "string",          "content_html": "string",          "content_tags": [            "string"          ],          "media": [            {              "alt_text": "string",              "duration_ms": 0,              "height": 0,              "mime_type": "string",              "thumbnail": "string",              "type": "image",              "url": "http://example.com",              "width": 0            }          ],          "preview_text": "string",          "scheduled_at": "2019-08-24T14:15:22Z",          "subject": "string",          "thumbnail_image_url": "http://example.com",          "property1": null,          "property2": null        },        "bluesky": {          "aspectRatio": {            "height": 0,            "width": 0          },          "content": "string",          "languages": [            "string"          ],          "link_preview": true,          "media": [            {              "alt_text": "string",              "duration_ms": 0,              "height": 0,              "mime_type": "string",              "thumbnail": "string",              "type": "image",              "url": "http://example.com",              "width": 0            }          ],          "quote_cid": "string",          "quote_uri": "string",          "self_labels": [            "string"          ],          "thread": [            {              "content": "string",              "media": [                {                  "alt_text": "string",                  "duration_ms": 0,                  "height": 0,                  "mime_type": "string",                  "thumbnail": "string",                  "type": "image",                  "url": "http://example.com",                  "width": 0                }              ],              "property1": null,              "property2": null            }          ],          "property1": null,          "property2": null        },        "convertkit": {          "content": "string",          "content_html": "string",          "email_template_id": 0,          "media": [],          "preview_text": "string",          "public": true,          "published_at": "2019-08-24T14:15:22Z",          "send_at": "2019-08-24T14:15:22Z",          "subject": "string",          "property1": null,          "property2": null        },        "discord": {          "applied_tags": [            "string"          ],          "avatar_url": "http://example.com",          "content": "string",          "embeds": [            {              "property1": null,              "property2": null            }          ],          "media": [            {              "alt_text": "string",              "duration_ms": 0,              "height": 0,              "mime_type": "string",              "thumbnail": "string",              "type": "image",              "url": "http://example.com",              "width": 0            }          ],          "poll": {            "allow_multiselect": true,            "answers": [              {                "poll_media": {                  "emoji": {                    "id": "string",                    "name": "string"                  },                  "text": "string"                }              },              {                "poll_media": {                  "emoji": {                    "id": "string",                    "name": "string"                  },                  "text": "string"                }              }            ],            "duration": 1,            "layout_type": 1,            "question": {              "text": "string"            }          },          "thread_id": "string",          "thread_name": "string",          "tts": true,          "username": "string",          "property1": null,          "property2": null        },        "facebook": {          "content": "string",          "content_type": "feed",          "feed_targeting": {            "age_max": 13,            "age_min": 13,            "college_years": [              0            ],            "education_statuses": [              1            ],            "genders": [              1            ],            "geo_locations": {              "cities": [                {                  "distance_unit": "kilometer",                  "key": "string",                  "radius": 0                }              ],              "countries": [                "string"              ],              "country_groups": [                "string"              ],              "custom_locations": [                {                  "distance_unit": "kilometer",                  "latitude": -90,                  "longitude": -180,                  "radius": 0                }              ],              "electoral_districts": [                {                  "key": "string"                }              ],              "geo_markets": [                {                  "key": "string"                }              ],              "location_types": [                "home"              ],              "regions": [                {                  "key": "string"                }              ],              "zips": [                {                  "key": "string"                }              ]            },            "interests": [              0            ],            "locales": [              0            ],            "relationship_statuses": [              1            ]          },          "first_comment": "string",          "media": [            {              "alt_text": "string",              "duration_ms": 0,              "height": 0,              "mime_type": "string",              "thumbnail": "string",              "type": "image",              "url": "http://example.com",              "width": 0            }          ],          "place_id": "string",          "published": true,          "reel_scheduled_publish_time": "2019-08-24T14:15:22Z",          "reel_state": "DRAFT",          "targeting": {            "age_min": 13,            "geo_locations": {              "cities": [                {                  "distance_unit": "kilometer",                  "key": "string",                  "radius": 0                }              ],              "countries": [                "string"              ],              "country_groups": [                "string"              ],              "custom_locations": [                {                  "distance_unit": "kilometer",                  "latitude": -90,                  "longitude": -180,                  "radius": 0                }              ],              "electoral_districts": [                {                  "key": "string"                }              ],              "geo_markets": [                {                  "key": "string"                }              ],              "location_types": [                "home"              ],              "regions": [                {                  "key": "string"                }              ],              "zips": [                {                  "key": "string"                }              ]            }          },          "title": "string",          "property1": null,          "property2": null        },        "googlebusiness": {          "call_to_action": {            "type": "BOOK",            "url": "http://example.com"          },          "content": "string",          "event": {            "schedule": {              "endDate": {                "day": 0,                "month": 0,                "year": 0              },              "endTime": {                "hours": 0,                "minutes": 0,                "seconds": 0              },              "startDate": {                "day": 0,                "month": 0,                "year": 0              },              "startTime": {                "hours": 0,                "minutes": 0,                "seconds": 0              }            },            "title": "string"          },          "language_code": "string",          "media": [            {              "alt_text": "string",              "duration_ms": 0,              "height": 0,              "mime_type": "string",              "thumbnail": "string",              "type": "image",              "url": "http://example.com",              "width": 0            }          ],          "offer": {            "couponCode": "string",            "redeemOnlineUrl": "http://example.com",            "termsConditions": "string"          },          "topic_type": "STANDARD",          "property1": null,          "property2": null        },        "instagram": {          "collaborators": [            "string"          ],          "content": "string",          "content_type": "feed",          "cover_media_id": "string",          "cover_url": "http://example.com",          "cover_variant_id": "string",          "first_comment": "string",          "media": [            {              "alt_text": "string",              "duration_ms": 0,              "height": 0,              "mime_type": "string",              "thumbnail": "string",              "type": "image",              "url": "http://example.com",              "width": 0            }          ],          "share_to_feed": true,          "thumb_offset": 0,          "trial_params": {            "graduation_strategy": "MANUAL"          },          "user_tags": [            {              "media_index": 0,              "username": "string",              "x": 0,              "y": 0            }          ],          "property1": null,          "property2": null        },        "linkedin": {          "content": "string",          "disable_link_preview": true,          "document_title": "string",          "first_comment": "string",          "media": [            {              "alt_text": "string",              "duration_ms": 0,              "height": 0,              "mime_type": "string",              "thumbnail": "string",              "type": "image",              "url": "http://example.com",              "width": 0            }          ],          "property1": null,          "property2": null        },        "listmonk": {          "alt_body": "string",          "content": "string",          "content_html": "string",          "from_email": "string",          "headers": {            "property1": "string",            "property2": "string"          },          "list_id": 0,          "media": [],          "send_at": "2019-08-24T14:15:22Z",          "subject": "string",          "tags": [            "string"          ],          "template_id": 0,          "property1": null,          "property2": null        },        "mailchimp": {          "content": "string",          "content_html": "string",          "from_email": "user@example.com",          "from_name": "string",          "list_id": "string",          "media": [],          "preview_text": "string",          "reply_to": "user@example.com",          "schedule_time": "2019-08-24T14:15:22Z",          "subject": "string",          "property1": null,          "property2": null        },        "mastodon": {          "content": "string",          "in_reply_to_id": "string",          "language": "string",          "media": [            {              "alt_text": "string",              "duration_ms": 0,              "height": 0,              "mime_type": "string",              "thumbnail": "string",              "type": "image",              "url": "http://example.com",              "width": 0            }          ],          "poll": {            "expires_in": 0,            "hide_totals": true,            "multiple": true,            "options": [              "string",              "string"            ]          },          "quoted_status_id": "string",          "sensitive": true,          "spoiler_text": "string",          "visibility": "public",          "property1": null,          "property2": null        },        "pinterest": {          "alt_text": "string",          "board_id": "string",          "content": "string",          "cover_image_key_frame_time": 0,          "cover_image_url": "http://example.com",          "link": "http://example.com",          "media": [            {              "alt_text": "string",              "duration_ms": 0,              "height": 0,              "mime_type": "string",              "thumbnail": "string",              "type": "image",              "url": "http://example.com",              "width": 0            }          ],          "title": "string",          "property1": null,          "property2": null        },        "reddit": {          "content": "string",          "flair_id": "string",          "force_self": true,          "media": [            {              "alt_text": "string",              "duration_ms": 0,              "height": 0,              "mime_type": "string",              "thumbnail": "string",              "type": "image",              "url": "http://example.com",              "width": 0            }          ],          "nsfw": true,          "spoiler": true,          "subreddit": "string",          "title": "string",          "url": "http://example.com",          "property1": null,          "property2": null        },        "slack": {          "attachments": [            {              "property1": null,              "property2": null            }          ],          "blocks": [            {              "property1": null,              "property2": null            }          ],          "content": "string",          "media": [            {              "alt_text": "string",              "duration_ms": 0,              "height": 0,              "mime_type": "string",              "thumbnail": "string",              "type": "image",              "url": "http://example.com",              "width": 0            }          ],          "thread_ts": "string",          "unfurl_links": true,          "unfurl_media": true,          "property1": null,          "property2": null        },        "sms": {          "content": "string",          "from_number": "string",          "media": [            {              "alt_text": "string",              "duration_ms": 0,              "height": 0,              "mime_type": "string",              "thumbnail": "string",              "type": "image",              "url": "http://example.com",              "width": 0            }          ],          "phone_numbers": [            "string"          ],          "property1": null,          "property2": null        },        "snapchat": {          "content": "string",          "content_type": "spotlight",          "locale": "string",          "media": [            {              "alt_text": "string",              "duration_ms": 0,              "height": 0,              "mime_type": "string",              "thumbnail": "string",              "type": "image",              "url": "http://example.com",              "width": 0            }          ],          "property1": null,          "property2": null        },        "telegram": {          "content": "string",          "disable_preview": true,          "media": [            {              "alt_text": "string",              "duration_ms": 0,              "height": 0,              "mime_type": "string",              "thumbnail": "string",              "type": "image",              "url": "http://example.com",              "width": 0            }          ],          "parse_mode": "HTML",          "protect_content": true,          "silent": true,          "property1": null,          "property2": null        },        "threads": {          "content": "string",          "link_attachment": "http://example.com",          "location_id": "string",          "media": [            {              "alt_text": "string",              "duration_ms": 0,              "height": 0,              "mime_type": "string",              "thumbnail": "string",              "type": "image",              "url": "http://example.com",              "width": 0            }          ],          "poll": {            "options": [              "string",              "string"            ]          },          "quote_post_id": "string",          "reply_control": "everyone",          "thread": [            {              "content": "string",              "media": [                {                  "alt_text": "string",                  "duration_ms": 0,                  "height": 0,                  "mime_type": "string",                  "thumbnail": "string",                  "type": "image",                  "url": "http://example.com",                  "width": 0                }              ],              "property1": null,              "property2": null            }          ],          "topic_tag": "string",          "property1": null,          "property2": null        },        "tiktok": {          "allow_comment": true,          "allow_duet": true,          "allow_stitch": true,          "auto_add_music": true,          "brand_content_toggle": true,          "brand_organic_toggle": true,          "content": "string",          "content_preview_confirmed": true,          "description": "string",          "express_consent_given": true,          "media": [            {              "alt_text": "string",              "duration_ms": 0,              "height": 0,              "mime_type": "string",              "thumbnail": "string",              "type": "image",              "url": "http://example.com",              "width": 0            }          ],          "photo_cover_index": 0,          "privacy_level": "PUBLIC_TO_EVERYONE",          "publish_mode": "direct",          "source_mode": "file_upload",          "video_cover_timestamp_ms": 0,          "video_made_with_ai": true,          "property1": null,          "property2": null        },        "twitter": {          "community_id": "string",          "content": "string",          "made_with_ai": true,          "media": [            {              "alt_text": "string",              "duration_ms": 0,              "height": 0,              "mime_type": "string",              "thumbnail": "string",              "type": "image",              "url": "http://example.com",              "width": 0            }          ],          "paid_partnership": true,          "place_id": "string",          "poll": {            "duration_minutes": 5,            "options": [              "string",              "string"            ]          },          "reply_settings": "following",          "reply_to": "string",          "sensitive_media_warning": {            "adult_content": true,            "graphic_violence": true,            "other": true          },          "share_with_followers": true,          "tagged_user_ids": [            "string"          ],          "thread": [            {              "content": "string",              "media": [                {                  "alt_text": "string",                  "duration_ms": 0,                  "height": 0,                  "mime_type": "string",                  "thumbnail": "string",                  "type": "image",                  "url": "http://example.com",                  "width": 0                }              ],              "property1": null,              "property2": null            }          ],          "property1": null,          "property2": null        },        "whatsapp": {          "contacts": [            {              "property1": null,              "property2": null            }          ],          "content": "string",          "interactive": {            "property1": null,            "property2": null          },          "location": {            "address": "string",            "latitude": -90,            "longitude": -180,            "name": "string"          },          "media": [            {              "alt_text": "string",              "duration_ms": 0,              "height": 0,              "mime_type": "string",              "thumbnail": "string",              "type": "image",              "url": "http://example.com",              "width": 0            }          ],          "preview_url": true,          "reaction": {            "emoji": "string",            "message_id": "string"          },          "template_components": [            {              "property1": null,              "property2": null            }          ],          "template_language": "string",          "template_name": "string",          "to": "string",          "property1": null,          "property2": null        },        "youtube": {          "category_id": "string",          "contains_synthetic_media": true,          "content": "string",          "first_comment": "string",          "made_for_kids": true,          "media": [            {              "alt_text": "string",              "duration_ms": 0,              "height": 0,              "mime_type": "string",              "thumbnail": "string",              "type": "image",              "url": "http://example.com",              "width": 0            }          ],          "notify_subscribers": true,          "playlist_id": "string",          "publish_at": "2019-08-24T14:15:22Z",          "tags": [            "string"          ],          "title": "string",          "visibility": "public",          "property1": null,          "property2": null        },        "property1": {          "property1": null,          "property2": null        },        "property2": {          "property1": null,          "property2": null        }      },      "targets": {        "property1": {          "accounts": [            {              "avatar_url": "string",              "delivery_state": "queued",              "display_name": "string",              "id": "string",              "platform_post_id": "string",              "publish_operation_id": "string",              "target_id": "string",              "url": "string",              "username": "string"            }          ],          "error": {            "code": "string",            "detail": "string",            "message": "string"          },          "platform": "twitter",          "status": "draft"        },        "property2": {          "accounts": [            {              "avatar_url": "string",              "delivery_state": "queued",              "display_name": "string",              "id": "string",              "platform_post_id": "string",              "publish_operation_id": "string",              "target_id": "string",              "url": "string",              "username": "string"            }          ],          "error": {            "code": "string",            "detail": "string",            "message": "string"          },          "platform": "twitter",          "status": "draft"        }      },      "thread_group_id": "string",      "thread_position": 0,      "timezone": "string",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "summary": {    "failed": 0,    "succeeded": 0,    "total": 0  }}

Found something wrong? Help us improve this page.