Add sample videos to a brief

Appends videos to the end of a brief's sample list — the organization's tracked videos by platform and platform video id, or viral-library videos by libraryVideoId (tracked as reference-only samples, hidden from analytics and payouts) — each with an optional label creators see above it. Videos the brief already lists are skipped. Silent by default; with notify=true and at least one video appended, the brief is re-published (version bump) and every creator in its audience is notified.

post/briefs/{id}/samples

Request

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

Path parameters

idstring required

Campaign brief ID with orgbrief_ prefix

Example:orgbrief_RwmraAffhMt9

Request body

notifyboolean

Example request

{
  "videos": [
    {
      "platform": "facebook",
      "label": "Money-glitch hook"
    }
  ]
}

Response

idstring required

Campaign brief ID with orgbrief_ prefix

namestring required

addedCountinteger required

skippedCountinteger required

Example response

{
  "id": "orgbrief_RwmraAffhMt9"
}

Changes

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