Set who reads a brief

Sets a brief's audience: everyone at the organization (allCreators), or the campaigns it is linked to (campaignIds) plus the creators it is sent to directly (creatorIds). Omitted parts stay as they are. Everyone excludes campaigns and creators: turning it on while links exist needs campaignIds: [] and creatorIds: [] in the same call (409 otherwise). Every creator it newly reaches must read it on their next visit; with notify=true they are also notified. Removals are silent, and the version does not change.

put/briefs/{id}/audience

Request

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

Path parameters

idstring required

Campaign brief ID with orgbrief_ prefix

Example:orgbrief_RwmraAffhMt9

Request body

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.

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.

notifyboolean required

Example request

{
  "campaignIds": [
    "orgcamp_RwmraAffhMt9"
  ],
  "creatorIds": [
    "orgcre_A1b2C3d4E5f6"
  ]
}

Response

newlyReachedCountinteger required

Example response

{
  "audience": {
    "campaigns": [
      {
        "id": "orgcamp_RwmraAffhMt9",
        "status": "active"
      }
    ]
  }
}

Changes

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