Skip to main content
PATCH
Update a content brief

Authorizations

Authorization
string
header
required

Send your API key in the Authorization header as Bearer API_KEY. Account API keys work in every workspace you belong to: send X-Notra-Organization-Id with the workspace id or slug to choose one. Workspace endpoints require it when you belong to more than one workspace; GET /v1/me/workspaces works without it. Organization keys only accept their own workspace there.

Path Parameters

projectId
string
required
Minimum string length: 1
Pattern: ^[A-Za-z0-9_-]{1,100}$
Example:

"b1f2c3d4-0000-4000-8000-000000000000"

briefId
string
required
Minimum string length: 1
Pattern: ^[A-Za-z0-9_-]{1,100}$

Body

application/json
expectedUpdatedAt
string<date-time>

The brief's updatedAt from your last read. When set, the update fails with 409 if the brief changed since. Omit to overwrite the latest version.

workingTitle
string
Required string length: 1 - 120
Pattern: ^[^\r\n]*$
targetPrompt
string
Minimum string length: 1
Pattern: ^[^\r\n]*$
intent
string
Minimum string length: 1
Pattern: ^[^\r\n]*$
audience
string
Minimum string length: 1
Pattern: ^[^\r\n]*$
jobToBeDone
string
Minimum string length: 1
Pattern: ^[^\r\n]*$
sections
object[]

The outline. Replaces every section; send the full list in order.

Required array length: 3 - 8 elements
questionsToAnswer
string[]

FAQ questions. Replaces the whole list.

Maximum array length: 8
Minimum string length: 1
Pattern: ^[^\r\n]*$

Replaces the whole list.

Maximum array length: 6
acceptanceChecklist
string[]

Replaces the whole list.

Maximum array length: 8
Minimum string length: 1
Pattern: ^[^\r\n]*$

Response

Brief updated successfully

brief
object
required
organization
object
required