creatives

Create a creative

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.
post/v1/creatives

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/creatives
  • Auth: HTTP bearer

Request body

namestring required
backgroundUrlstring nullable

An unsafe URL scheme is stored as null.

boxesobject[]

The whole box list; each box is checked and filled out with defaults. Default [].

dataSourceIdstring nullable

A data source in this workspace.

stagestring nullable
stageWidthinteger nullable
stageHeightinteger nullable
scenesobject[]

Default [].

touchEnabledboolean nullable
pauseWhileUsedboolean nullable

Hold the playlist while something a tap opened is up. Null = true.

nodeIdstring nullable

Home location. Default: the caller's own location.

sourceSignageunknown
masterIdstring nullable

The master template it was made from (GET /v1/signage-master-templates).

shareLockDefaultunknown
shareEditsSkipApprovalboolean

Recipients' edits air without review. Needs creative.approve.

templateSourceobject nullable

The fill-in form behind a design made from a new template (template id, data, look). Editor state only. null clears it.

Response

Success.

Example response

{
  "data": {
    "id": "cr_4d5e6f7a8b9c0d1e"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.