API reference
Queues
Weekly posting times in one time zone; mode queue takes the earliest free slot.
GET/queues
List queues
- Scope posts:read
A queue is a weekly list of posting times in one time zone; mode queue on POST /posts takes its earliest free slot.
curl https://api.relayport.dev/queues \
-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.
limitintegerquerycursorstringquerybrandIdstring (uuid)query
Responses
200OK
dataQueue[]requiredidstring (uuid)requiredbrandIdstring (uuid)requirednamestringrequiredtimezonestringrequiredslotsobject[]requireddaystringrequiredOne of
montuewedthufrisatsuntimestringrequiredisDefaultbooleanrequiredactivebooleanrequiredcreatedAtstring (date-time)requiredmetaPageMetarequirednext_cursorstring | nullrequiredper_pageintegerrequired
400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403ForbiddenModuleNotAvailableWorkspaceSuspended
404NotFound
422ValidationError
429RateLimited
503RateLimiterUnavailable
POST/queues
Create a queue
- Scope posts:write
- Idempotency-Key
curl -X POST https://api.relayport.dev/queues \
-H "Authorization: Bearer $RELAYPORT_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "<string>",
"slots": [{ "day": "mon", "time": "<string>" }]
}'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)namestringrequiredtimezonestringslotsobject[]requireddaystringrequiredOne of
montuewedthufrisatsuntimestringrequiredisDefaultbooleanactiveboolean
Responses
201Created
dataQueuerequiredidstring (uuid)requiredbrandIdstring (uuid)requirednamestringrequiredtimezonestringrequiredslotsobject[]requireddaystringrequiredOne of
montuewedthufrisatsuntimestringrequiredisDefaultbooleanrequiredactivebooleanrequiredcreatedAtstring (date-time)required
400InvalidJsonWorkspaceRequired
401InvalidApiKeyUnauthenticated
403CsrfRejectedForbiddenModuleNotAvailableWorkspaceSuspended
404NotFound
409ConflictIdempotencyInProgress
413PayloadTooLarge
422IdempotencyKeyReusedValidationError
429RateLimited
503RateLimiterUnavailable
GET/queues/{id}
Get a queue
- Scope posts:read
curl https://api.relayport.dev/queues/{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
dataQueuerequiredidstring (uuid)requiredbrandIdstring (uuid)requirednamestringrequiredtimezonestringrequiredslotsobject[]requireddaystringrequiredOne of
montuewedthufrisatsuntimestringrequiredisDefaultbooleanrequiredactivebooleanrequiredcreatedAtstring (date-time)required
400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403ForbiddenModuleNotAvailableWorkspaceSuspended
404NotFound
422ValidationError
429RateLimited
503RateLimiterUnavailable
PATCH/queues/{id}
Update a queue
- Scope posts:write
Set active false to pause it: queued posts keep their times and new posts cannot take its slots.
curl -X PATCH https://api.relayport.dev/queues/{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
namestringtimezonestringslotsobject[]daystringrequiredOne of
montuewedthufrisatsuntimestringrequiredisDefaultbooleanactiveboolean
Responses
200OK
dataQueuerequiredidstring (uuid)requiredbrandIdstring (uuid)requirednamestringrequiredtimezonestringrequiredslotsobject[]requireddaystringrequiredOne of
montuewedthufrisatsuntimestringrequiredisDefaultbooleanrequiredactivebooleanrequiredcreatedAtstring (date-time)required
400InvalidJsonWorkspaceRequired
401InvalidApiKeyUnauthenticated
403CsrfRejectedForbiddenModuleNotAvailableWorkspaceSuspended
404NotFound
409Conflict
422ValidationError
429RateLimited
503RateLimiterUnavailable
DELETE/queues/{id}
Delete a queue
- Scope posts:write
Refused with 409 Conflict while posts of the caller's mode are scheduled in it.
curl -X DELETE https://api.relayport.dev/queues/{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
datanullrequired
400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403CsrfRejectedForbiddenModuleNotAvailableWorkspaceSuspended
404NotFound
409Conflict
422ValidationError
429RateLimited
503RateLimiterUnavailable
GET/queues/{id}/preview
Forecast the next free slots
- Scope posts:read
A forecast, not a reservation: another post may take a slot first.
curl https://api.relayport.dev/queues/{id}/preview \
-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)pathrequiredcountintegerquery
Responses
200OK
dataQueuePreviewrequiredslots(string (date-time))[]required
400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403ForbiddenModuleNotAvailableWorkspaceSuspended
404NotFound
422ValidationError
429RateLimited
503RateLimiterUnavailable
POST/queues/{id}/reshuffle
Move the queue's scheduled posts onto its current slots
- Scope posts:write
- Idempotency-Key
After editing the slots, moves the posts already queued (in the caller's brands and mode) onto the earliest free slots, in order; posts that started publishing stay where they are.
curl -X POST https://api.relayport.dev/queues/{id}/reshuffle \
-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
dataQueueReshufflerequiredmovedintegerrequired