Briefs

Send a brief to creators

Sends a brief to creators directly, outside any campaign (add), or takes it away again (remove, silent). Idempotent. Creators the brief already reaches through a campaign keep it once that campaign ends, and are not notified twice. Every creator it newly reaches must read it on their next visit; with notify=true they are also notified. A brief is sent directly to at most 5,000 creators. Not available on a brief for everyone at the organization.

patch/briefs/{id}/creators

Request

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

Path parameters

idstring required

Campaign brief ID with orgbrief_ prefix

Example:orgbrief_RwmraAffhMt9

Request body

addstring[]

Creators (org creator ids, from list_creators), at most 500 per call.

removestring[]

Creators (org creator ids, from list_creators), at most 500 per call.

notifyboolean required

Example request

{
  "add": [
    "orgcre_A1b2C3d4E5f6"
  ],
  "remove": [
    "orgcre_A1b2C3d4E5f6"
  ]
}

Response

OK

newlyReachedCountinteger required
creatorCountinteger required

Changes

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