Briefs

Get a brief

Retrieves a brief with its content (as TipTap JSON and as markdown), its audience, read progress, ordered sample videos, and how many creators a notify would reach right now.

get/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

Response

OK

idstring required

Campaign brief ID with orgbrief_ prefix

namestring required
contentMarkdownstring required

The same content as markdown

versioninteger required
lastNotifiedAtstring date-time nullable required
notifiableCreatorCountinteger required

Example response

{
  "id": "orgbrief_RwmraAffhMt9",
  "campaigns": [
    {
      "id": "orgcamp_RwmraAffhMt9",
      "status": "active"
    }
  ],
  "audience": {
    "campaigns": [
      {
        "id": "orgcamp_RwmraAffhMt9",
        "status": "active"
      }
    ]
  },
  "sampleVideos": [
    {
      "platform": "facebook"
    }
  ]
}

Changes

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