Skip to content

Create Campaign Document

POST
/campaigns/{campaign_id}/documents

Create a campaign document with content stored in metadata.

meta_data shape mirrors what the Celery doc-generator writes so the FE renders MCP-created docs identically: content (markdown body), completed (mirrors status==‘completed’ so launch checklist counts it), and optional structured_data (parsed payload, e.g. sequence step list).

Authorizations

Parameters

Path Parameters

campaign_id
required

Campaign ID

string

Campaign ID

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
content

Document content

string
""
display_name
required

Human-readable document name

string
file_type
required

Document type, for example campaign_brief or sequence

string
folder_path
Any of:
string
status

Document status — ‘draft’ (default) or ‘completed’

string
default: draft
structured_data
Any of:
object
key
additional properties
any

Responses

201

Successful Response

object
data
required
object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string