Skip to content
Relay Port

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.

Request
curl https://api.relayport.dev/brands \
  -H "Authorization: Bearer $RELAYPORT_API_KEY"

Parameters

  • X-Api-Versionstringheader

    The 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-01

  • X-Workspace-Idstring (uuid)header

    The 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.

  • limitintegerquery

  • cursorstringquery

  • externalRefstringquery

Responses

200OK
  • dataBrand[]required

  • idstring (uuid)required

  • namestringrequired

  • externalRefstring | nullrequired

  • brandingobjectrequired

  • displayNamestring | nullrequired

  • logoUrlstring | nullrequired

  • accentColorstring | nullrequired

  • isDefaultbooleanrequired

  • accountCountintegerrequired

  • createdAtstring (date-time)required

  • metaPageMetarequired

  • next_cursorstring | nullrequired

  • per_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).

Request
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-Versionstringheader

    The 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-01

  • X-Workspace-Idstring (uuid)header

    The 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-Keystringheader

    Repeating a request with the same key within 24 hours returns the first response (header Idempotent-Replayed: true) instead of running it again.

  • X-Requested-Withstringheader

    Required 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

  • namestringrequired

  • externalRefstring | null

  • brandingobject

  • displayNamestring | null

  • logoUrlstring | null

  • accentColorstring | null

Responses

201Created
  • dataBrandrequired

  • idstring (uuid)required

  • namestringrequired

  • externalRefstring | nullrequired

  • brandingobjectrequired

  • displayNamestring | nullrequired

  • logoUrlstring | nullrequired

  • accentColorstring | nullrequired

  • isDefaultbooleanrequired

  • accountCountintegerrequired

  • createdAtstring (date-time)required

400InvalidJsonWorkspaceRequired
401InvalidApiKeyUnauthenticated
403CsrfRejectedForbiddenWorkspaceSuspended
404NotFound
409ConflictIdempotencyInProgress
413PayloadTooLarge
422IdempotencyKeyReusedValidationError
429RateLimited
503RateLimiterUnavailable

GET/brands/{id}

Get a brand

  • Scope accounts:read
Request
curl https://api.relayport.dev/brands/{id} \
  -H "Authorization: Bearer $RELAYPORT_API_KEY"

Parameters

  • X-Api-Versionstringheader

    The 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-01

  • X-Workspace-Idstring (uuid)header

    The 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
  • dataBrandrequired

  • idstring (uuid)required

  • namestringrequired

  • externalRefstring | nullrequired

  • brandingobjectrequired

  • displayNamestring | nullrequired

  • logoUrlstring | nullrequired

  • accentColorstring | nullrequired

  • isDefaultbooleanrequired

  • accountCountintegerrequired

  • createdAtstring (date-time)required

400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403ForbiddenWorkspaceSuspended
404NotFound
422ValidationError
429RateLimited
503RateLimiterUnavailable

PATCH/brands/{id}

Update a brand

  • Scope accounts:manage
Request
curl -X PATCH https://api.relayport.dev/brands/{id} \
  -H "Authorization: Bearer $RELAYPORT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Parameters

  • X-Api-Versionstringheader

    The 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-01

  • X-Workspace-Idstring (uuid)header

    The 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-Withstringheader

    Required 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

  • idstring (uuid)pathrequired

Request body

  • namestring

  • externalRefstring | null

  • brandingobject

  • displayNamestring | null

  • logoUrlstring | null

  • accentColorstring | null

Responses

200OK
  • dataBrandrequired

  • idstring (uuid)required

  • namestringrequired

  • externalRefstring | nullrequired

  • brandingobjectrequired

  • displayNamestring | nullrequired

  • logoUrlstring | nullrequired

  • accentColorstring | nullrequired

  • isDefaultbooleanrequired

  • accountCountintegerrequired

  • createdAtstring (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.

Request
curl -X DELETE https://api.relayport.dev/brands/{id} \
  -H "Authorization: Bearer $RELAYPORT_API_KEY"

Parameters

  • X-Api-Versionstringheader

    The 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-01

  • X-Workspace-Idstring (uuid)header

    The 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-Withstringheader

    Required 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

  • idstring (uuid)pathrequired

Responses

200OK
  • datanullrequired

400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403CsrfRejectedForbiddenWorkspaceSuspended
404NotFound
409Conflict
422ValidationError
429RateLimited
503RateLimiterUnavailable