creatives

Update a creative

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).
patch/v1/creatives/{id}

Request

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

Path parameters

idstring required

Creative id.

Request body

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

baseUpdatedAtstring

Optimistic concurrency: the updatedAt you read. A stale value is refused with 409 conflict and the current row.

Response

Success.

Example response

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

Changes

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