Creatives API

GET/v1/creatives

Return the workspace's canvas creatives, including each one's name, stage size, location, and sharing state. The full layout of shapes is not included; use the get-creative operation to retrieve that.

curl "https://api.brixsignage.com/v1/creatives" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 5XX Server error. The body carries a `requestId` to quote to support.

POST/v1/creatives

Create a canvas creative. Accepts name and optional boxes, scenes, stageWidth, stageHeight, backgroundUrl, dataSourceId, touchEnabled, nodeId, and masterId. Safe to retry with the same Idempotency-Key header without creating duplicates. **Notes.** - The 201 body is the row as written, not re-read from the database, so columns the create does not set (for example lastSnapshotAt) are absent rather than null. GET returns every column. - Send an Idempotency-Key header to make a retry safe.

Request body application/json

curl -X POST "https://api.brixsignage.com/v1/creatives" \
  -H "Authorization: Bearer $BRIX_API_KEY" \
  -H "Content-Type: application/json"

Response 201 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 Setting `shareEditsSkipApproval` without `creative.approve`.

Response 404 `dataSourceId` names no data source in this workspace.

Response 422 Missing name, invalid JSON, malformed boxes, scenes or look, or a location outside this workspace.

Response 5XX Server error. The body carries a `requestId` to quote to support.

GET/v1/creatives/{id}

Return one creative in full, including its boxes, scenes, background, any linked data source, and stage dimensions.

curl "https://api.brixsignage.com/v1/creatives/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No such creative in this workspace.

Response 5XX Server error. The body carries a `requestId` to quote to support.

PATCH/v1/creatives/{id}

Edit a creative. The boxes and scenes fields each replace the entire existing list, so retrieve the creative first and send back the complete array with changes included. If the location requires approval before content goes live, updating the creative resets that approval. **Notes.** - The response is the stored row: it has no requiresApproval, canEditBase or canWaiveApproval (GET has them).

Request body application/json

curl -X PATCH "https://api.brixsignage.com/v1/creatives/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY" \
  -H "Content-Type: application/json"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 Moving it to a location where you lack creative.edit, or changing `shareEditsSkipApproval` without `creative.approve`.

Response 404 No such creative (or `dataSourceId`) in this workspace.

Response 409 `conflict`: the row changed since `baseUpdatedAt`; the body carries `current`.

Response 422 Invalid JSON or malformed boxes, scenes or look.

Response 5XX Server error. The body carries a `requestId` to quote to support.

DELETE/v1/creatives/{id}

Move a creative to the recycle bin. If the creative is shared into other locations, the request fails with a 409 error unless the deletion is explicitly confirmed, since deleting a shared creative removes it everywhere it is shared.

curl -X DELETE "https://api.brixsignage.com/v1/creatives/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No such creative in this workspace.

Response 409 `content_shared`: it is shared into other places; `shareCount`, `crossSpaceShares`, `contentShares` say where. Repeat with `?force=true` to delete it and those shares.

Response 5XX Server error. The body carries a `requestId` to quote to support.

POST/v1/creatives/{id}/restore

Bring back a deleted creative so it returns to the library. The shares removed by the delete come back with it.

curl -X POST "https://api.brixsignage.com/v1/creatives/{id}/restore" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No such creative in this workspace, or it was purged.

Response 409 `not_deleted`: the creative is not in the recycle bin.

Response 5XX Server error. The body carries a `requestId` to quote to support.

GET/v1/creatives/{id}/thumbnail

Return an image of the creative, showing its shapes and pictures along with a representative preview of each content slot, such as a file's poster image, a playlist's first item, or an app's most recent snapshot. Text boxes are not drawn. The image is cached; add ?fresh=1 to bypass the cache after making an edit.

curl "https://api.brixsignage.com/v1/creatives/{id}/thumbnail" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No such creative in this workspace.

Response 5XX Server error. The body carries a `requestId` to quote to support.