API reference
Posts
Create, schedule, publish and follow posts, one target per connected account.
GET/posts
List posts
- Scope posts:read
Newest first. Filter by status, brandId, accountId, platform, source and a created time range.
curl https://api.relayport.dev/posts \
-H "Authorization: Bearer $RELAYPORT_API_KEY"Parameters
X-Api-VersionstringheaderThe API version. API keys answer in the version they were created with unless this header asks for another; the current version is 2026-12-01.
One of
2026-12-01X-Workspace-Idstring (uuid)headerThe workspace of the request. Required with a session; with an API key it may be left out and must match the key's workspace when sent.
cursorstringquerylimitintegerquerystatusstringqueryOne of
draftscheduledpublishingpublishedpartialfailedunconfirmedcancelledbrandIdstring (uuid)queryaccountIdstring (uuid)queryplatformstringquerysourcestringqueryOne of
dashboardapifromstring (date-time)querytostring (date-time)query
Responses
200OK
dataPost[]requiredidstring (uuid)requiredbrandIdstring (uuid)requiredstatusstringrequiredOne of
draftscheduledpublishingpublishedpartialfailedunconfirmedcancelledmodestringrequiredOne of
draftschedulepublish_nowqueuetextstringrequiredtitlestring | nullrequiredfirstCommentstring | nullrequiredscheduledAtstring (date-time) | nullrequiredqueueIdstring (uuid) | nullrequiredrevisionintegerrequiredsourcestringrequiredOne of
dashboardapimediaobject[]requiredmediaIdstring (uuid)requiredpositionintegerrequiredplatformDatamap of objectrequiredstaggerobject | nullrequiredminSecondsintegerrequiredmaxSecondsintegerrequiredmetadatamap of string | number | boolean | nullrequiredtargetsobject[]requiredidstring (uuid)requiredaccountIdstring (uuid)requiredplatformstringrequiredstatusstringrequiredOne of
draftscheduledpublishingpublishedfailedunconfirmedcancelleddueAtstring (date-time) | nullrequiredleadMsintegerrequiredplatformPostIdstring | nullrequiredpermalinkstring | nullrequiredpermalinkPendingbooleanrequiredpublishedAtstring (date-time) | nullrequiredpublishedLateMsinteger | nullrequirederrorobject | nullrequiredcodestringrequiredmessagestringrequiredactionstringrequiredretryByUserbooleanreconciliationobject | nullrequiredevidencestring[]requiredrevisionintegerrequiredwarningsIssue[]requiredseveritystringrequiredOne of
errorwarningtargetintegerrequiredplatformstringrequiredfieldstringrequiredrulestringrequiredmessagestringrequiredlimitnumberactualnumber | stringallowedstringcapabilitystringOne of
publishing.imagepublishing.carouselpublishing.reelpublishing.storypublishing.collaboratorspublishing.alt_textpublishing.user_tagspublishing.locationpublishing.trial_reelspublishing.ai_labelpublishing.first_commentpublishing.deletepublishing.resumable_uploadpublishing.partnership_labelpublishing.pollspublishing.audioinbox.comments.readinbox.mentionsinbox.dm.sendinbox.private_replyanalytics.post_metricsanalytics.account_metricsanalytics.story_insights_webhookads.booststatestringOne of
availablereconnect_requiredrequires_variantrequires_connectionplan_upgradecoming_soonunsupportedcreatedAtstring (date-time)requiredmetaPageMetarequirednext_cursorstring | nullrequiredper_pageintegerrequired
400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403ForbiddenModuleNotAvailableWorkspaceSuspended
404NotFound
422ValidationError
429RateLimited
503RateLimiterUnavailable
POST/posts
Create a post
- Scope posts:write
- Idempotency-Key
One post with 1 to 20 targets, one per connected account, all in one brand. mode is explicit: draft (saved, not scheduled), schedule (scheduledAt, or a scheduledAt on every target), publish_now (answers 202; the key also needs posts:publish) or queue (queueId, a queue id or default; the chosen slot comes back in scheduledAt). Post-level platformData is keyed by platform and carries each platform's contentType and options; a target's platformData is flat and wins. An identical post to the same account within 24 hours is 409 DuplicateContent unless allowDuplicate is true. A blocked workspace (unpaid) cannot create posts, drafts included.
curl -X POST https://api.relayport.dev/posts \
-H "Authorization: Bearer $RELAYPORT_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{ "mode": "draft", "targets": [{ "accountId": "<uuid>" }] }'Parameters
X-Api-VersionstringheaderThe API version. API keys answer in the version they were created with unless this header asks for another; the current version is 2026-12-01.
One of
2026-12-01X-Workspace-Idstring (uuid)headerThe workspace of the request. Required with a session; with an API key it may be left out and must match the key's workspace when sent.
Idempotency-KeystringheaderRepeating a request with the same key within 24 hours returns the first response (header Idempotent-Replayed: true) instead of running it again.
X-Requested-WithstringheaderRequired on every write made with a signed-in session; without it the request is 403 CsrfRejected. API keys do not send it.
One of
XMLHttpRequest
Request body
brandIdstring (uuid)modestringrequiredOne of
draftschedulepublish_nowqueuescheduledAtstring (date-time)queueId"default" | string (uuid)textstringtitlestringmediaobject[]mediaIdstring (uuid)requiredplatformDataobjectKeyed by platform: each platform's contentType and options
instagramobjectcontentTypestringrequiredOne of
imagecarouselreelcollaboratorsstring[]aiGeneratedbooleansandboxobjectcontentTypestringrequiredOne of
imagecarouseloutcomestringOne of
publishedfailedunconfirmedfailureCodestringfirstCommentstringtargetsobject[]requiredaccountIdstring (uuid)requiredscheduledAtstring (date-time)textstringtitlestringmediaobject[]mediaIdstring (uuid)requiredfirstCommentstringplatformDataobject | objectFlat: the options of the target's own platform, and its contentType when it differs from the post's
staggerobjectminSecondsintegerrequiredmaxSecondsintegerrequiredallowDuplicatebooleanmetadatamap of string | number | boolean | null
Responses
201Created. draft, schedule and queue
dataPostrequiredidstring (uuid)requiredbrandIdstring (uuid)requiredstatusstringrequiredOne of
draftscheduledpublishingpublishedpartialfailedunconfirmedcancelledmodestringrequiredOne of
draftschedulepublish_nowqueuetextstringrequiredtitlestring | nullrequiredfirstCommentstring | nullrequiredscheduledAtstring (date-time) | nullrequiredqueueIdstring (uuid) | nullrequiredrevisionintegerrequiredsourcestringrequiredOne of
dashboardapimediaobject[]requiredmediaIdstring (uuid)requiredpositionintegerrequiredplatformDatamap of objectrequiredstaggerobject | nullrequiredminSecondsintegerrequiredmaxSecondsintegerrequiredmetadatamap of string | number | boolean | nullrequiredtargetsobject[]requiredidstring (uuid)requiredaccountIdstring (uuid)requiredplatformstringrequiredstatusstringrequiredOne of
draftscheduledpublishingpublishedfailedunconfirmedcancelleddueAtstring (date-time) | nullrequiredleadMsintegerrequiredplatformPostIdstring | nullrequiredpermalinkstring | nullrequiredpermalinkPendingbooleanrequiredpublishedAtstring (date-time) | nullrequiredpublishedLateMsinteger | nullrequirederrorobject | nullrequiredcodestringrequiredmessagestringrequiredactionstringrequiredretryByUserbooleanreconciliationobject | nullrequiredevidencestring[]requiredrevisionintegerrequiredwarningsIssue[]requiredseveritystringrequiredOne of
errorwarningtargetintegerrequiredplatformstringrequiredfieldstringrequiredrulestringrequiredmessagestringrequiredlimitnumberactualnumber | stringallowedstringcapabilitystringOne of
publishing.imagepublishing.carouselpublishing.reelpublishing.storypublishing.collaboratorspublishing.alt_textpublishing.user_tagspublishing.locationpublishing.trial_reelspublishing.ai_labelpublishing.first_commentpublishing.deletepublishing.resumable_uploadpublishing.partnership_labelpublishing.pollspublishing.audioinbox.comments.readinbox.mentionsinbox.dm.sendinbox.private_replyanalytics.post_metricsanalytics.account_metricsanalytics.story_insights_webhookads.booststatestringOne of
availablereconnect_requiredrequires_variantrequires_connectionplan_upgradecoming_soonunsupportedcreatedAtstring (date-time)required
202Accepted. publish_now: the targets start publishing; follow them with GET /posts/{id} or the post.* events
dataPostrequiredidstring (uuid)requiredbrandIdstring (uuid)requiredstatusstringrequiredOne of
draftscheduledpublishingpublishedpartialfailedunconfirmedcancelledmodestringrequiredOne of
draftschedulepublish_nowqueuetextstringrequiredtitlestring | nullrequiredfirstCommentstring | nullrequiredscheduledAtstring (date-time) | nullrequiredqueueIdstring (uuid) | nullrequiredrevisionintegerrequiredsourcestringrequiredOne of
dashboardapimediaobject[]requiredmediaIdstring (uuid)requiredpositionintegerrequiredplatformDatamap of objectrequiredstaggerobject | nullrequiredminSecondsintegerrequiredmaxSecondsintegerrequiredmetadatamap of string | number | boolean | nullrequiredtargetsobject[]requiredidstring (uuid)requiredaccountIdstring (uuid)requiredplatformstringrequiredstatusstringrequiredOne of
draftscheduledpublishingpublishedfailedunconfirmedcancelleddueAtstring (date-time) | nullrequiredleadMsintegerrequiredplatformPostIdstring | nullrequiredpermalinkstring | nullrequiredpermalinkPendingbooleanrequiredpublishedAtstring (date-time) | nullrequiredpublishedLateMsinteger | nullrequirederrorobject | nullrequiredcodestringrequiredmessagestringrequiredactionstringrequiredretryByUserbooleanreconciliationobject | nullrequiredevidencestring[]requiredrevisionintegerrequiredwarningsIssue[]requiredseveritystringrequiredOne of
errorwarningtargetintegerrequiredplatformstringrequiredfieldstringrequiredrulestringrequiredmessagestringrequiredlimitnumberactualnumber | stringallowedstringcapabilitystringOne of
publishing.imagepublishing.carouselpublishing.reelpublishing.storypublishing.collaboratorspublishing.alt_textpublishing.user_tagspublishing.locationpublishing.trial_reelspublishing.ai_labelpublishing.first_commentpublishing.deletepublishing.resumable_uploadpublishing.partnership_labelpublishing.pollspublishing.audioinbox.comments.readinbox.mentionsinbox.dm.sendinbox.private_replyanalytics.post_metricsanalytics.account_metricsanalytics.story_insights_webhookads.booststatestringOne of
availablereconnect_requiredrequires_variantrequires_connectionplan_upgradecoming_soonunsupportedcreatedAtstring (date-time)required
400InvalidJsonWorkspaceRequired
401InvalidApiKeyUnauthenticated
402PaymentRequiredPlanLimitReached
403CsrfRejectedForbiddenModuleNotAvailableWorkspaceSuspended
404NotFound
409ConflictDuplicateContentIdempotencyInProgress
413PayloadTooLarge
422IdempotencyKeyReusedPostValidationFailedValidationError
429RateLimited
503RateLimiterUnavailable
GET/posts/{id}
Get a post with the state of every target
- Scope posts:read
Each target carries its status (draft, scheduled, publishing, published, failed, unconfirmed or cancelled), the platform post id and permalink once published, and the error with the action to take when it failed.
curl https://api.relayport.dev/posts/{id} \
-H "Authorization: Bearer $RELAYPORT_API_KEY"Parameters
X-Api-VersionstringheaderThe API version. API keys answer in the version they were created with unless this header asks for another; the current version is 2026-12-01.
One of
2026-12-01X-Workspace-Idstring (uuid)headerThe workspace of the request. Required with a session; with an API key it may be left out and must match the key's workspace when sent.
idstring (uuid)pathrequired
Responses
200OK
dataPostrequiredidstring (uuid)requiredbrandIdstring (uuid)requiredstatusstringrequiredOne of
draftscheduledpublishingpublishedpartialfailedunconfirmedcancelledmodestringrequiredOne of
draftschedulepublish_nowqueuetextstringrequiredtitlestring | nullrequiredfirstCommentstring | nullrequiredscheduledAtstring (date-time) | nullrequiredqueueIdstring (uuid) | nullrequiredrevisionintegerrequiredsourcestringrequiredOne of
dashboardapimediaobject[]requiredmediaIdstring (uuid)requiredpositionintegerrequiredplatformDatamap of objectrequiredstaggerobject | nullrequiredminSecondsintegerrequiredmaxSecondsintegerrequiredmetadatamap of string | number | boolean | nullrequiredtargetsobject[]requiredidstring (uuid)requiredaccountIdstring (uuid)requiredplatformstringrequiredstatusstringrequiredOne of
draftscheduledpublishingpublishedfailedunconfirmedcancelleddueAtstring (date-time) | nullrequiredleadMsintegerrequiredplatformPostIdstring | nullrequiredpermalinkstring | nullrequiredpermalinkPendingbooleanrequiredpublishedAtstring (date-time) | nullrequiredpublishedLateMsinteger | nullrequirederrorobject | nullrequiredcodestringrequiredmessagestringrequiredactionstringrequiredretryByUserbooleanreconciliationobject | nullrequiredevidencestring[]requiredrevisionintegerrequiredwarningsIssue[]requiredseveritystringrequiredOne of
errorwarningtargetintegerrequiredplatformstringrequiredfieldstringrequiredrulestringrequiredmessagestringrequiredlimitnumberactualnumber | stringallowedstringcapabilitystringOne of
publishing.imagepublishing.carouselpublishing.reelpublishing.storypublishing.collaboratorspublishing.alt_textpublishing.user_tagspublishing.locationpublishing.trial_reelspublishing.ai_labelpublishing.first_commentpublishing.deletepublishing.resumable_uploadpublishing.partnership_labelpublishing.pollspublishing.audioinbox.comments.readinbox.mentionsinbox.dm.sendinbox.private_replyanalytics.post_metricsanalytics.account_metricsanalytics.story_insights_webhookads.booststatestringOne of
availablereconnect_requiredrequires_variantrequires_connectionplan_upgradecoming_soonunsupportedcreatedAtstring (date-time)required
400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403ForbiddenModuleNotAvailableWorkspaceSuspended
404NotFound
422ValidationError
429RateLimited
503RateLimiterUnavailable
PATCH/posts/{id}
Update a draft or scheduled post
- Scope posts:write
A draft can be promoted by setting mode schedule or queue. A post whose targets already started publishing is 409 PostStateConflict; an edit never re-sends a target that may have been sent.
curl -X PATCH https://api.relayport.dev/posts/{id} \
-H "Authorization: Bearer $RELAYPORT_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'Parameters
X-Api-VersionstringheaderThe API version. API keys answer in the version they were created with unless this header asks for another; the current version is 2026-12-01.
One of
2026-12-01X-Workspace-Idstring (uuid)headerThe workspace of the request. Required with a session; with an API key it may be left out and must match the key's workspace when sent.
X-Requested-WithstringheaderRequired on every write made with a signed-in session; without it the request is 403 CsrfRejected. API keys do not send it.
One of
XMLHttpRequestidstring (uuid)pathrequired
Request body
modestringOne of
schedulequeuescheduledAtstring (date-time)queueId"default" | string (uuid)textstringtitlestring | nullmediaobject[]mediaIdstring (uuid)requiredplatformDataobjectKeyed by platform: each platform's contentType and options
instagramobjectcontentTypestringrequiredOne of
imagecarouselreelcollaboratorsstring[]aiGeneratedbooleansandboxobjectcontentTypestringrequiredOne of
imagecarouseloutcomestringOne of
publishedfailedunconfirmedfailureCodestringfirstCommentstring | nulltargetsobject[]accountIdstring (uuid)requiredscheduledAtstring (date-time)textstringtitlestringmediaobject[]mediaIdstring (uuid)requiredfirstCommentstringplatformDataobject | objectFlat: the options of the target's own platform, and its contentType when it differs from the post's
staggerobjectminSecondsintegerrequiredmaxSecondsintegerrequiredallowDuplicatebooleanmetadatamap of string | number | boolean | null
Responses
200OK
dataPostrequiredidstring (uuid)requiredbrandIdstring (uuid)requiredstatusstringrequiredOne of
draftscheduledpublishingpublishedpartialfailedunconfirmedcancelledmodestringrequiredOne of
draftschedulepublish_nowqueuetextstringrequiredtitlestring | nullrequiredfirstCommentstring | nullrequiredscheduledAtstring (date-time) | nullrequiredqueueIdstring (uuid) | nullrequiredrevisionintegerrequiredsourcestringrequiredOne of
dashboardapimediaobject[]requiredmediaIdstring (uuid)requiredpositionintegerrequiredplatformDatamap of objectrequiredstaggerobject | nullrequiredminSecondsintegerrequiredmaxSecondsintegerrequiredmetadatamap of string | number | boolean | nullrequiredtargetsobject[]requiredidstring (uuid)requiredaccountIdstring (uuid)requiredplatformstringrequiredstatusstringrequiredOne of
draftscheduledpublishingpublishedfailedunconfirmedcancelleddueAtstring (date-time) | nullrequiredleadMsintegerrequiredplatformPostIdstring | nullrequiredpermalinkstring | nullrequiredpermalinkPendingbooleanrequiredpublishedAtstring (date-time) | nullrequiredpublishedLateMsinteger | nullrequirederrorobject | nullrequiredcodestringrequiredmessagestringrequiredactionstringrequiredretryByUserbooleanreconciliationobject | nullrequiredevidencestring[]requiredrevisionintegerrequiredwarningsIssue[]requiredseveritystringrequiredOne of
errorwarningtargetintegerrequiredplatformstringrequiredfieldstringrequiredrulestringrequiredmessagestringrequiredlimitnumberactualnumber | stringallowedstringcapabilitystringOne of
publishing.imagepublishing.carouselpublishing.reelpublishing.storypublishing.collaboratorspublishing.alt_textpublishing.user_tagspublishing.locationpublishing.trial_reelspublishing.ai_labelpublishing.first_commentpublishing.deletepublishing.resumable_uploadpublishing.partnership_labelpublishing.pollspublishing.audioinbox.comments.readinbox.mentionsinbox.dm.sendinbox.private_replyanalytics.post_metricsanalytics.account_metricsanalytics.story_insights_webhookads.booststatestringOne of
availablereconnect_requiredrequires_variantrequires_connectionplan_upgradecoming_soonunsupportedcreatedAtstring (date-time)required
400InvalidJsonWorkspaceRequired
401InvalidApiKeyUnauthenticated
402PaymentRequiredPlanLimitReached
403CsrfRejectedForbiddenModuleNotAvailableWorkspaceSuspended
404NotFound
409ConflictDuplicateContentPostStateConflict
422PostValidationFailedValidationError
429RateLimited
503RateLimiterUnavailable
DELETE/posts/{id}
Cancel a draft or scheduled post
- Scope posts:write
Allowed until a target starts publishing; the post stays readable with status cancelled.
curl -X DELETE https://api.relayport.dev/posts/{id} \
-H "Authorization: Bearer $RELAYPORT_API_KEY"Parameters
X-Api-VersionstringheaderThe API version. API keys answer in the version they were created with unless this header asks for another; the current version is 2026-12-01.
One of
2026-12-01X-Workspace-Idstring (uuid)headerThe workspace of the request. Required with a session; with an API key it may be left out and must match the key's workspace when sent.
X-Requested-WithstringheaderRequired on every write made with a signed-in session; without it the request is 403 CsrfRejected. API keys do not send it.
One of
XMLHttpRequestidstring (uuid)pathrequired
Responses
200OK
dataPostrequiredidstring (uuid)requiredbrandIdstring (uuid)requiredstatusstringrequiredOne of
draftscheduledpublishingpublishedpartialfailedunconfirmedcancelledmodestringrequiredOne of
draftschedulepublish_nowqueuetextstringrequiredtitlestring | nullrequiredfirstCommentstring | nullrequiredscheduledAtstring (date-time) | nullrequiredqueueIdstring (uuid) | nullrequiredrevisionintegerrequiredsourcestringrequiredOne of
dashboardapimediaobject[]requiredmediaIdstring (uuid)requiredpositionintegerrequiredplatformDatamap of objectrequiredstaggerobject | nullrequiredminSecondsintegerrequiredmaxSecondsintegerrequiredmetadatamap of string | number | boolean | nullrequiredtargetsobject[]requiredidstring (uuid)requiredaccountIdstring (uuid)requiredplatformstringrequiredstatusstringrequiredOne of
draftscheduledpublishingpublishedfailedunconfirmedcancelleddueAtstring (date-time) | nullrequiredleadMsintegerrequiredplatformPostIdstring | nullrequiredpermalinkstring | nullrequiredpermalinkPendingbooleanrequiredpublishedAtstring (date-time) | nullrequiredpublishedLateMsinteger | nullrequirederrorobject | nullrequiredcodestringrequiredmessagestringrequiredactionstringrequiredretryByUserbooleanreconciliationobject | nullrequiredevidencestring[]requiredrevisionintegerrequiredwarningsIssue[]requiredseveritystringrequiredOne of
errorwarningtargetintegerrequiredplatformstringrequiredfieldstringrequiredrulestringrequiredmessagestringrequiredlimitnumberactualnumber | stringallowedstringcapabilitystringOne of
publishing.imagepublishing.carouselpublishing.reelpublishing.storypublishing.collaboratorspublishing.alt_textpublishing.user_tagspublishing.locationpublishing.trial_reelspublishing.ai_labelpublishing.first_commentpublishing.deletepublishing.resumable_uploadpublishing.partnership_labelpublishing.pollspublishing.audioinbox.comments.readinbox.mentionsinbox.dm.sendinbox.private_replyanalytics.post_metricsanalytics.account_metricsanalytics.story_insights_webhookads.booststatestringOne of
availablereconnect_requiredrequires_variantrequires_connectionplan_upgradecoming_soonunsupportedcreatedAtstring (date-time)required
400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403CsrfRejectedForbiddenModuleNotAvailableWorkspaceSuspended
404NotFound
409PostStateConflict
422ValidationError
429RateLimited
503RateLimiterUnavailable
GET/posts/{id}/events
List a post's publishing timeline
- Scope posts:read
Every step each target went through (prepare, send, reconcile ...), oldest first.
curl https://api.relayport.dev/posts/{id}/events \
-H "Authorization: Bearer $RELAYPORT_API_KEY"Parameters
X-Api-VersionstringheaderThe API version. API keys answer in the version they were created with unless this header asks for another; the current version is 2026-12-01.
One of
2026-12-01X-Workspace-Idstring (uuid)headerThe workspace of the request. Required with a session; with an API key it may be left out and must match the key's workspace when sent.
idstring (uuid)pathrequired
Responses
200OK
dataPostEvent[]requiredtargetIdstring (uuid)requiredstepstringrequiredlabelstringrequiredoutcomestringrequiredatstring (date-time)requireddetailmap of any | nullrequired
400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403ForbiddenModuleNotAvailableWorkspaceSuspended
404NotFound
422ValidationError
429RateLimited
503RateLimiterUnavailable
POST/posts/{id}/publish
Publish a draft or scheduled post now
- Scope posts:publish
- Idempotency-Key
curl -X POST https://api.relayport.dev/posts/{id}/publish \
-H "Authorization: Bearer $RELAYPORT_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{}'Parameters
X-Api-VersionstringheaderThe API version. API keys answer in the version they were created with unless this header asks for another; the current version is 2026-12-01.
One of
2026-12-01X-Workspace-Idstring (uuid)headerThe workspace of the request. Required with a session; with an API key it may be left out and must match the key's workspace when sent.
Idempotency-KeystringheaderRepeating a request with the same key within 24 hours returns the first response (header Idempotent-Replayed: true) instead of running it again.
X-Requested-WithstringheaderRequired on every write made with a signed-in session; without it the request is 403 CsrfRejected. API keys do not send it.
One of
XMLHttpRequestidstring (uuid)pathrequired
Request body
allowDuplicateboolean
Responses
202Accepted
dataPostrequiredidstring (uuid)requiredbrandIdstring (uuid)requiredstatusstringrequiredOne of
draftscheduledpublishingpublishedpartialfailedunconfirmedcancelledmodestringrequiredOne of
draftschedulepublish_nowqueuetextstringrequiredtitlestring | nullrequiredfirstCommentstring | nullrequiredscheduledAtstring (date-time) | nullrequiredqueueIdstring (uuid) | nullrequiredrevisionintegerrequiredsourcestringrequiredOne of
dashboardapimediaobject[]requiredmediaIdstring (uuid)requiredpositionintegerrequiredplatformDatamap of objectrequiredstaggerobject | nullrequiredminSecondsintegerrequiredmaxSecondsintegerrequiredmetadatamap of string | number | boolean | nullrequiredtargetsobject[]requiredidstring (uuid)requiredaccountIdstring (uuid)requiredplatformstringrequiredstatusstringrequiredOne of
draftscheduledpublishingpublishedfailedunconfirmedcancelleddueAtstring (date-time) | nullrequiredleadMsintegerrequiredplatformPostIdstring | nullrequiredpermalinkstring | nullrequiredpermalinkPendingbooleanrequiredpublishedAtstring (date-time) | nullrequiredpublishedLateMsinteger | nullrequirederrorobject | nullrequiredcodestringrequiredmessagestringrequiredactionstringrequiredretryByUserbooleanreconciliationobject | nullrequiredevidencestring[]requiredrevisionintegerrequiredwarningsIssue[]requiredseveritystringrequiredOne of
errorwarningtargetintegerrequiredplatformstringrequiredfieldstringrequiredrulestringrequiredmessagestringrequiredlimitnumberactualnumber | stringallowedstringcapabilitystringOne of
publishing.imagepublishing.carouselpublishing.reelpublishing.storypublishing.collaboratorspublishing.alt_textpublishing.user_tagspublishing.locationpublishing.trial_reelspublishing.ai_labelpublishing.first_commentpublishing.deletepublishing.resumable_uploadpublishing.partnership_labelpublishing.pollspublishing.audioinbox.comments.readinbox.mentionsinbox.dm.sendinbox.private_replyanalytics.post_metricsanalytics.account_metricsanalytics.story_insights_webhookads.booststatestringOne of
availablereconnect_requiredrequires_variantrequires_connectionplan_upgradecoming_soonunsupportedcreatedAtstring (date-time)required
400InvalidJsonWorkspaceRequired
401InvalidApiKeyUnauthenticated
402PaymentRequiredPlanLimitReached
403CsrfRejectedForbiddenModuleNotAvailableWorkspaceSuspended
404NotFound
409ConflictDuplicateContentIdempotencyInProgressPostStateConflict
413PayloadTooLarge
422IdempotencyKeyReusedPostValidationFailedValidationError
429RateLimited
503RateLimiterUnavailable
POST/posts/{id}/retry
Retry the failed targets of a post
- Scope posts:publish
- Idempotency-Key
Re-arms failed targets. An unconfirmed target may already be live on the platform, so it is retried only with includeUnconfirmed: true; check the account first.
curl -X POST https://api.relayport.dev/posts/{id}/retry \
-H "Authorization: Bearer $RELAYPORT_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{}'Parameters
X-Api-VersionstringheaderThe API version. API keys answer in the version they were created with unless this header asks for another; the current version is 2026-12-01.
One of
2026-12-01X-Workspace-Idstring (uuid)headerThe workspace of the request. Required with a session; with an API key it may be left out and must match the key's workspace when sent.
Idempotency-KeystringheaderRepeating a request with the same key within 24 hours returns the first response (header Idempotent-Replayed: true) instead of running it again.
X-Requested-WithstringheaderRequired on every write made with a signed-in session; without it the request is 403 CsrfRejected. API keys do not send it.
One of
XMLHttpRequestidstring (uuid)pathrequired
Request body
includeUnconfirmedboolean
Responses
200OK
dataPostrequiredidstring (uuid)requiredbrandIdstring (uuid)requiredstatusstringrequiredOne of
draftscheduledpublishingpublishedpartialfailedunconfirmedcancelledmodestringrequiredOne of
draftschedulepublish_nowqueuetextstringrequiredtitlestring | nullrequiredfirstCommentstring | nullrequiredscheduledAtstring (date-time) | nullrequiredqueueIdstring (uuid) | nullrequiredrevisionintegerrequiredsourcestringrequiredOne of
dashboardapimediaobject[]requiredmediaIdstring (uuid)requiredpositionintegerrequiredplatformDatamap of objectrequiredstaggerobject | nullrequiredminSecondsintegerrequiredmaxSecondsintegerrequiredmetadatamap of string | number | boolean | nullrequiredtargetsobject[]requiredidstring (uuid)requiredaccountIdstring (uuid)requiredplatformstringrequiredstatusstringrequiredOne of
draftscheduledpublishingpublishedfailedunconfirmedcancelleddueAtstring (date-time) | nullrequiredleadMsintegerrequiredplatformPostIdstring | nullrequiredpermalinkstring | nullrequiredpermalinkPendingbooleanrequiredpublishedAtstring (date-time) | nullrequiredpublishedLateMsinteger | nullrequirederrorobject | nullrequiredcodestringrequiredmessagestringrequiredactionstringrequiredretryByUserbooleanreconciliationobject | nullrequiredevidencestring[]requiredrevisionintegerrequiredwarningsIssue[]requiredseveritystringrequiredOne of
errorwarningtargetintegerrequiredplatformstringrequiredfieldstringrequiredrulestringrequiredmessagestringrequiredlimitnumberactualnumber | stringallowedstringcapabilitystringOne of
publishing.imagepublishing.carouselpublishing.reelpublishing.storypublishing.collaboratorspublishing.alt_textpublishing.user_tagspublishing.locationpublishing.trial_reelspublishing.ai_labelpublishing.first_commentpublishing.deletepublishing.resumable_uploadpublishing.partnership_labelpublishing.pollspublishing.audioinbox.comments.readinbox.mentionsinbox.dm.sendinbox.private_replyanalytics.post_metricsanalytics.account_metricsanalytics.story_insights_webhookads.booststatestringOne of
availablereconnect_requiredrequires_variantrequires_connectionplan_upgradecoming_soonunsupportedcreatedAtstring (date-time)required
400InvalidJsonWorkspaceRequired
401InvalidApiKeyUnauthenticated
402PaymentRequired
403CsrfRejectedForbiddenModuleNotAvailableWorkspaceSuspended
404NotFound
409IdempotencyInProgressPostStateConflict
413PayloadTooLarge
422IdempotencyKeyReusedValidationError
429RateLimited
503RateLimiterUnavailable
POST/posts/{id}/targets/{targetId}/resolve
Settle an unconfirmed target by hand
- Scope posts:publish
- Idempotency-Key
After checking the account on the platform, mark an unconfirmed target published (with its permalink when known) or failed.
curl -X POST https://api.relayport.dev/posts/{id}/targets/{targetId}/resolve \
-H "Authorization: Bearer $RELAYPORT_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{ "outcome": "published" }'Parameters
X-Api-VersionstringheaderThe API version. API keys answer in the version they were created with unless this header asks for another; the current version is 2026-12-01.
One of
2026-12-01X-Workspace-Idstring (uuid)headerThe workspace of the request. Required with a session; with an API key it may be left out and must match the key's workspace when sent.
Idempotency-KeystringheaderRepeating a request with the same key within 24 hours returns the first response (header Idempotent-Replayed: true) instead of running it again.
X-Requested-WithstringheaderRequired on every write made with a signed-in session; without it the request is 403 CsrfRejected. API keys do not send it.
One of
XMLHttpRequestidstring (uuid)pathrequiredtargetIdstring (uuid)pathrequired
Request body
Content types application/json
Responses
200OK
dataPostrequiredidstring (uuid)requiredbrandIdstring (uuid)requiredstatusstringrequiredOne of
draftscheduledpublishingpublishedpartialfailedunconfirmedcancelledmodestringrequiredOne of
draftschedulepublish_nowqueuetextstringrequiredtitlestring | nullrequiredfirstCommentstring | nullrequiredscheduledAtstring (date-time) | nullrequiredqueueIdstring (uuid) | nullrequiredrevisionintegerrequiredsourcestringrequiredOne of
dashboardapimediaobject[]requiredmediaIdstring (uuid)requiredpositionintegerrequiredplatformDatamap of objectrequiredstaggerobject | nullrequiredminSecondsintegerrequiredmaxSecondsintegerrequiredmetadatamap of string | number | boolean | nullrequiredtargetsobject[]requiredidstring (uuid)requiredaccountIdstring (uuid)requiredplatformstringrequiredstatusstringrequiredOne of
draftscheduledpublishingpublishedfailedunconfirmedcancelleddueAtstring (date-time) | nullrequiredleadMsintegerrequiredplatformPostIdstring | nullrequiredpermalinkstring | nullrequiredpermalinkPendingbooleanrequiredpublishedAtstring (date-time) | nullrequiredpublishedLateMsinteger | nullrequirederrorobject | nullrequiredcodestringrequiredmessagestringrequiredactionstringrequiredretryByUserbooleanreconciliationobject | nullrequiredevidencestring[]requiredrevisionintegerrequiredwarningsIssue[]requiredseveritystringrequiredOne of
errorwarningtargetintegerrequiredplatformstringrequiredfieldstringrequiredrulestringrequiredmessagestringrequiredlimitnumberactualnumber | stringallowedstringcapabilitystringOne of
publishing.imagepublishing.carouselpublishing.reelpublishing.storypublishing.collaboratorspublishing.alt_textpublishing.user_tagspublishing.locationpublishing.trial_reelspublishing.ai_labelpublishing.first_commentpublishing.deletepublishing.resumable_uploadpublishing.partnership_labelpublishing.pollspublishing.audioinbox.comments.readinbox.mentionsinbox.dm.sendinbox.private_replyanalytics.post_metricsanalytics.account_metricsanalytics.story_insights_webhookads.booststatestringOne of
availablereconnect_requiredrequires_variantrequires_connectionplan_upgradecoming_soonunsupportedcreatedAtstring (date-time)required
400InvalidJsonWorkspaceRequired
401InvalidApiKeyUnauthenticated
403CsrfRejectedForbiddenModuleNotAvailableWorkspaceSuspended
404NotFound
409IdempotencyInProgressPostStateConflict
413PayloadTooLarge
422IdempotencyKeyReusedValidationError
429RateLimited
503RateLimiterUnavailable
POST/posts/{id}/unpublish
Delete a published post from its platforms
- Scope posts:publish
- Idempotency-Key
No platform offers deletion yet, so this answers 501 NotSupported with details { capability: publishing.delete, targets: [{ targetId, accountId, platform, state, requiredVariant? }] } naming why each published target cannot be deleted. A post with no published target (a scheduled sandbox post included) is 409 PostStateConflict.
curl -X POST https://api.relayport.dev/posts/{id}/unpublish \
-H "Authorization: Bearer $RELAYPORT_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{}'Parameters
X-Api-VersionstringheaderThe API version. API keys answer in the version they were created with unless this header asks for another; the current version is 2026-12-01.
One of
2026-12-01X-Workspace-Idstring (uuid)headerThe workspace of the request. Required with a session; with an API key it may be left out and must match the key's workspace when sent.
Idempotency-KeystringheaderRepeating a request with the same key within 24 hours returns the first response (header Idempotent-Replayed: true) instead of running it again.
X-Requested-WithstringheaderRequired on every write made with a signed-in session; without it the request is 403 CsrfRejected. API keys do not send it.
One of
XMLHttpRequestidstring (uuid)pathrequired
Request body
Content types application/json
Responses
200OK. Not answered while no platform supports deletion
dataPostrequiredidstring (uuid)requiredbrandIdstring (uuid)requiredstatusstringrequiredOne of
draftscheduledpublishingpublishedpartialfailedunconfirmedcancelledmodestringrequiredOne of
draftschedulepublish_nowqueuetextstringrequiredtitlestring | nullrequiredfirstCommentstring | nullrequiredscheduledAtstring (date-time) | nullrequiredqueueIdstring (uuid) | nullrequiredrevisionintegerrequiredsourcestringrequiredOne of
dashboardapimediaobject[]requiredmediaIdstring (uuid)requiredpositionintegerrequiredplatformDatamap of objectrequiredstaggerobject | nullrequiredminSecondsintegerrequiredmaxSecondsintegerrequiredmetadatamap of string | number | boolean | nullrequiredtargetsobject[]requiredidstring (uuid)requiredaccountIdstring (uuid)requiredplatformstringrequiredstatusstringrequiredOne of
draftscheduledpublishingpublishedfailedunconfirmedcancelleddueAtstring (date-time) | nullrequiredleadMsintegerrequiredplatformPostIdstring | nullrequiredpermalinkstring | nullrequiredpermalinkPendingbooleanrequiredpublishedAtstring (date-time) | nullrequiredpublishedLateMsinteger | nullrequirederrorobject | nullrequiredcodestringrequiredmessagestringrequiredactionstringrequiredretryByUserbooleanreconciliationobject | nullrequiredevidencestring[]requiredrevisionintegerrequiredwarningsIssue[]requiredseveritystringrequiredOne of
errorwarningtargetintegerrequiredplatformstringrequiredfieldstringrequiredrulestringrequiredmessagestringrequiredlimitnumberactualnumber | stringallowedstringcapabilitystringOne of
publishing.imagepublishing.carouselpublishing.reelpublishing.storypublishing.collaboratorspublishing.alt_textpublishing.user_tagspublishing.locationpublishing.trial_reelspublishing.ai_labelpublishing.first_commentpublishing.deletepublishing.resumable_uploadpublishing.partnership_labelpublishing.pollspublishing.audioinbox.comments.readinbox.mentionsinbox.dm.sendinbox.private_replyanalytics.post_metricsanalytics.account_metricsanalytics.story_insights_webhookads.booststatestringOne of
availablereconnect_requiredrequires_variantrequires_connectionplan_upgradecoming_soonunsupportedcreatedAtstring (date-time)required
400InvalidJsonWorkspaceRequired
401InvalidApiKeyUnauthenticated
403CsrfRejectedForbiddenModuleNotAvailableWorkspaceSuspended
404NotFound
409IdempotencyInProgressPostStateConflict
413PayloadTooLarge
422IdempotencyKeyReusedValidationError
429RateLimited
501NotSupported
503RateLimiterUnavailable
POST/posts/validate
Check a post against its platforms' rules without saving it
- Scope posts:write
- Idempotency-Key
Takes the same body as POST /posts and answers the issues (errors) and warnings each target would get. Nothing is created.
curl -X POST https://api.relayport.dev/posts/validate \
-H "Authorization: Bearer $RELAYPORT_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{ "mode": "draft", "targets": [{ "accountId": "<uuid>" }] }'Parameters
X-Api-VersionstringheaderThe API version. API keys answer in the version they were created with unless this header asks for another; the current version is 2026-12-01.
One of
2026-12-01X-Workspace-Idstring (uuid)headerThe workspace of the request. Required with a session; with an API key it may be left out and must match the key's workspace when sent.
Idempotency-KeystringheaderRepeating a request with the same key within 24 hours returns the first response (header Idempotent-Replayed: true) instead of running it again.
X-Requested-WithstringheaderRequired on every write made with a signed-in session; without it the request is 403 CsrfRejected. API keys do not send it.
One of
XMLHttpRequest
Request body
brandIdstring (uuid)modestringrequiredOne of
draftschedulepublish_nowqueuescheduledAtstring (date-time)queueId"default" | string (uuid)textstringtitlestringmediaobject[]mediaIdstring (uuid)requiredplatformDataobjectKeyed by platform: each platform's contentType and options
instagramobjectcontentTypestringrequiredOne of
imagecarouselreelcollaboratorsstring[]aiGeneratedbooleansandboxobjectcontentTypestringrequiredOne of
imagecarouseloutcomestringOne of
publishedfailedunconfirmedfailureCodestringfirstCommentstringtargetsobject[]requiredaccountIdstring (uuid)requiredscheduledAtstring (date-time)textstringtitlestringmediaobject[]mediaIdstring (uuid)requiredfirstCommentstringplatformDataobject | objectFlat: the options of the target's own platform, and its contentType when it differs from the post's
staggerobjectminSecondsintegerrequiredmaxSecondsintegerrequiredallowDuplicatebooleanmetadatamap of string | number | boolean | null
Responses
200OK
dataPostCheckrequiredissuesIssue[]requiredseveritystringrequiredOne of
errorwarningtargetintegerrequiredplatformstringrequiredfieldstringrequiredrulestringrequiredmessagestringrequiredlimitnumberactualnumber | stringallowedstringcapabilitystringOne of
publishing.imagepublishing.carouselpublishing.reelpublishing.storypublishing.collaboratorspublishing.alt_textpublishing.user_tagspublishing.locationpublishing.trial_reelspublishing.ai_labelpublishing.first_commentpublishing.deletepublishing.resumable_uploadpublishing.partnership_labelpublishing.pollspublishing.audioinbox.comments.readinbox.mentionsinbox.dm.sendinbox.private_replyanalytics.post_metricsanalytics.account_metricsanalytics.story_insights_webhookads.booststatestringOne of
availablereconnect_requiredrequires_variantrequires_connectionplan_upgradecoming_soonunsupportedwarningsIssue[]requiredseveritystringrequiredOne of
errorwarningtargetintegerrequiredplatformstringrequiredfieldstringrequiredrulestringrequiredmessagestringrequiredlimitnumberactualnumber | stringallowedstringcapabilitystringOne of
publishing.imagepublishing.carouselpublishing.reelpublishing.storypublishing.collaboratorspublishing.alt_textpublishing.user_tagspublishing.locationpublishing.trial_reelspublishing.ai_labelpublishing.first_commentpublishing.deletepublishing.resumable_uploadpublishing.partnership_labelpublishing.pollspublishing.audioinbox.comments.readinbox.mentionsinbox.dm.sendinbox.private_replyanalytics.post_metricsanalytics.account_metricsanalytics.story_insights_webhookads.booststatestringOne of
availablereconnect_requiredrequires_variantrequires_connectionplan_upgradecoming_soonunsupported