API reference
Brands
Brands group accounts, posts, queues and media. A brand-restricted key sees only its brands.
GET/brands
List brands
- Scope accounts:read
Brands group accounts, posts, queues and media; filter by your own externalRef. A brand-restricted key sees only its brands.
curl https://api.relayport.dev/brands \
-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.
limitintegerquerycursorstringqueryexternalRefstringquery
Responses
200OK
dataBrand[]requiredidstring (uuid)requirednamestringrequiredexternalRefstring | nullrequiredbrandingobjectrequireddisplayNamestring | nullrequiredlogoUrlstring | nullrequiredaccentColorstring | nullrequiredisDefaultbooleanrequiredaccountCountintegerrequiredcreatedAtstring (date-time)requiredmetaPageMetarequirednext_cursorstring | nullrequiredper_pageintegerrequired
400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403ForbiddenWorkspaceSuspended
404NotFound
422ValidationError
429RateLimited
503RateLimiterUnavailable
POST/brands
Create a brand
- Scope accounts:manage
- Idempotency-Key
A brand-restricted key cannot create brands (403 Forbidden).
curl -X POST https://api.relayport.dev/brands \
-H "Authorization: Bearer $RELAYPORT_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{ "name": "<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
namestringrequiredexternalRefstring | nullbrandingobjectdisplayNamestring | nulllogoUrlstring | nullaccentColorstring | null
Responses
201Created
dataBrandrequiredidstring (uuid)requirednamestringrequiredexternalRefstring | nullrequiredbrandingobjectrequireddisplayNamestring | nullrequiredlogoUrlstring | nullrequiredaccentColorstring | nullrequiredisDefaultbooleanrequiredaccountCountintegerrequiredcreatedAtstring (date-time)required
400InvalidJsonWorkspaceRequired
401InvalidApiKeyUnauthenticated
403CsrfRejectedForbiddenWorkspaceSuspended
404NotFound
409ConflictIdempotencyInProgress
413PayloadTooLarge
422IdempotencyKeyReusedValidationError
429RateLimited
503RateLimiterUnavailable
GET/brands/{id}
Get a brand
- Scope accounts:read
curl https://api.relayport.dev/brands/{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
dataBrandrequiredidstring (uuid)requirednamestringrequiredexternalRefstring | nullrequiredbrandingobjectrequireddisplayNamestring | nullrequiredlogoUrlstring | nullrequiredaccentColorstring | nullrequiredisDefaultbooleanrequiredaccountCountintegerrequiredcreatedAtstring (date-time)required
400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403ForbiddenWorkspaceSuspended
404NotFound
422ValidationError
429RateLimited
503RateLimiterUnavailable
PATCH/brands/{id}
Update a brand
- Scope accounts:manage
curl -X PATCH https://api.relayport.dev/brands/{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
namestringexternalRefstring | nullbrandingobjectdisplayNamestring | nulllogoUrlstring | nullaccentColorstring | null
Responses
200OK
dataBrandrequiredidstring (uuid)requirednamestringrequiredexternalRefstring | nullrequiredbrandingobjectrequireddisplayNamestring | nullrequiredlogoUrlstring | nullrequiredaccentColorstring | nullrequiredisDefaultbooleanrequiredaccountCountintegerrequiredcreatedAtstring (date-time)required
400InvalidJsonWorkspaceRequired
401InvalidApiKeyUnauthenticated
403CsrfRejectedForbiddenWorkspaceSuspended
404NotFound
409Conflict
422ValidationError
429RateLimited
503RateLimiterUnavailable
DELETE/brands/{id}
Delete a brand
- Scope accounts:manage
Refused with 409 Conflict (details.reason default_brand, has_accounts or has_scheduled_posts) while the brand is the default, still holds accounts or has scheduled posts.
curl -X DELETE https://api.relayport.dev/brands/{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