Sign in
Briefs

Update an image brief

Change a saved image brief. Only the fields you send are updated, so you can patch a single value; sending an explicit null clears a nullable field. Up to 3 products.

Idempotency-Key is optional (a patch is naturally repeatable); X-Dry-Run: true validates without writing.

put/image-briefs/{brief_id}

Path parameters

brief_idinteger required

Headers

Idempotency-Keystring nullable
X-Dry-Runstring nullable

Request body

product_idsstring[] nullable
template_idstring nullable
accent_colorstring nullable
main_header_backgroundstring nullable
namestring nullable
image_overridesobject nullable
status'draft' | 'published' | 'archived' nullable

New lifecycle state, or omit to leave unchanged.

Response

Successful Response

dry_runboolean

Changes

No recorded changes to this endpoint across all 5 revisions of this API.