Briefs

Update a brief

Updates what is sent and leaves the rest: name, content (contentMarkdown or TipTap JSON content), the complete sample list, and the audience (campaignIds, creatorIds, allCreators). notify=true bumps the version and re-notifies every creator in the audience (sent alone, it re-publishes the current brief); notify=false saves silently in place.

put/briefs/{id}

Request

  • Base URL: https://viral.app/api/v1
  • URL: https://viral.app/api/v1/briefs/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Campaign brief ID with orgbrief_ prefix

Example:orgbrief_RwmraAffhMt9

Request body

namestring

Brief name (unique per organization)

contentMarkdownstring

The new content as markdown (replaces the old content). Send this or content, or neither to keep it.

campaignIdsstring[]
creatorIdsstring[]

Creators (org creator ids, from list_creators) who read the brief directly, outside any campaign. Not-joined creators are allowed: they read it once they join.

allCreatorsboolean

true = every creator at the organization reads the brief, including creators who join later. Such a brief has no campaign or creator links of its own: send campaignIds: [] and creatorIds: [] in the same call to clear existing ones.

notifyboolean required

Example request

{
  "name": "TikTok Hook Playbook",
  "sampleVideos": [
    {
      "platform": "facebook",
      "label": "Money-glitch hook"
    }
  ],
  "campaignIds": [
    "orgcamp_RwmraAffhMt9"
  ],
  "creatorIds": [
    "orgcre_A1b2C3d4E5f6"
  ]
}

Response

OK

idstring required

Campaign brief ID with orgbrief_ prefix

versioninteger required

Example response

{
  "id": "orgbrief_RwmraAffhMt9"
}

Changes

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