Briefs

Set the campaigns a brief is linked to

Reconciles the brief's non-ended campaign links to the given set: removed links are deleted, added links steal any existing brief on the target campaign (a campaign holds one brief). With notify=true, creators on newly linked campaigns are notified. PUT /briefs/{id}/audience sets campaigns, creators and everyone in one call.

put/briefs/{id}/campaigns

Request

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

Path parameters

idstring required

Campaign brief ID with orgbrief_ prefix

Example:orgbrief_RwmraAffhMt9

Request body

campaignIdsstring[] required
notifyboolean required

Example request

{
  "campaignIds": [
    "orgcamp_RwmraAffhMt9"
  ]
}

Response

OK

Example response

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

Changes

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