Briefs

Update a creative brief

Replace this brief's editable content — name, description, angles, USPs, filming recommendations, dos/don'ts, inspiration videos — and its status. Set status: published to make it shareable (its URL is then available from GET /creative-briefs/published-url), or archived to retire it.

This is a replace: the stored document is rebuilt from the body, so send the whole brief back with your edits, not just changed fields.

Two things happen automatically on save: inspiration videos missing key_points get them AI-generated from that video's analysis, and videos missing an orders count have it filled from our attribution data. Idempotency-Key is optional here (a replace is naturally repeatable); X-Dry-Run: true validates without writing.

put/creative-briefs/{brief_id}

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/creative-briefs/{brief_id}
  • Auth
    API key in header x-api-key and API key in header x-shop-id

Path parameters

brief_idinteger required

Headers

Idempotency-Keystring nullable
X-Dry-Runstring nullable

Request body

brief_namestring nullable
product_descriptionstring nullable
when_to_usestring
image_urlsstring[]
filming_recommendationsobject
dos_and_dontsobject
statusstring

Response

Successful Response

dataobject required
dry_runboolean

Changes

No operation changes recorded.