---
title: "Send a brief to creators"
method: PATCH
path: "/briefs/{id}/creators"
tags: ["Briefs"]
---

# Send a brief to creators

`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`

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.

## Path parameters

- `id` string, required: Campaign brief ID with orgbrief_ prefix

## Request body

- object: Sends a brief to creators directly, outside any campaign, or takes it away again. Idempotent (a call with neither add nor remove changes nothing); removals are silent. Not available on a brief for everyone at the organization.
  - `add` string[]: Creators (org creator ids, from list_creators), at most 500 per call.
  - `remove` string[]: Creators (org creator ids, from list_creators), at most 500 per call.
  - `notify` boolean, required

## Response `200`

OK

- object
  - `newlyReachedCount` integer, required
  - `creatorCount` integer, required

## Other responses

- `400`: 400
- `401`: 401
- `402`: 402
- `404`: 404
- `408`: 408
- `409`: 409
- `429`: 429
- `500`: 500

---

[API](https://skmtc.dev/viral/apis/viral-app-api.md) · [All operations](https://skmtc.dev/viral/apis/viral-app-api/llms.txt) · [OpenAPI document](https://skmtc.dev/viral/apis/viral-app-api/revisions/31e97fa79ef1?raw)