Patch Campaign Full

PATCH

/campaigns/{campaign_id}/full

• Production
• QA

Apply a deep-update to a campaign in one round trip.

Behavior: - Campaign fields (name/brief/hook/etc.) update the row when present. - audience_list_id attaches; detach_audience=true clears it. - documents[*] either updates an existing doc by id, or creates a new doc when id is omitted (file_type + display_name required). - sequence_steps replaces the sequence ordering verbatim (same semantics as PUT /sequence).

Returns the full kitchen-sink payload (same shape as GET /full). Backwards-compat: omitting any field is a no-op. Existing single-purpose endpoints (PATCH /campaigns/{id}, PUT /audience, PUT /sequence, etc.) keep working unchanged.

Authorizations

• BearerAuth

Parameters

Path Parameters

campaign_id

required

Campaign ID

string

Campaign ID

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

Deep-update payload for PATCH /campaigns/{id}/full.

Every field is optional. Each non-null section is applied in the same transaction — campaign fields → audience → documents → sequence — so a single call can re-shape the whole campaign without ping-pong.

object

audience_list_id

Any of:

string

string

null

null

brief

Any of:

string

string

null

null

category

Any of:

string

string

<= 100 characters

null

null

core_concept

Any of:

string

string

null

null

detach_audience

Set true to explicitly DETACH the audience (audience_list_id=NULL). Required because JSON null in audience_list_id is ambiguous (could mean ‘no change’).

boolean

documents

Any of:

Array<object>

Array<object>

A single-document patch for PATCH /campaigns/{id}/full.

object

content

Any of:

string

string

null

null

display_name

Any of:

string

string

null

null

file_type

Any of:

string

string

null

null

folder_path

Any of:

string

string

null

null

id

Any of:

string

string

null

null

status

Any of:

string

string

null

null

structured_data

Any of:

object

object

key

additional properties

any

null

null

null

null

goal

Any of:

string

string

<= 255 characters

null

null

linked_sequence_ids

Any of:

Array<string>

Array<string>

null

null

name

Any of:

string

string

<= 255 characters

null

null

primary_hook

Any of:

string

string

null

null

sequence_steps

Any of:

Array<object>

Array<object>

object

condition

Any of:

string

string

null

null

day

required

integer

step_id

required

string

stop_on_reply

boolean

default: true

null

null

target_persona

Any of:

string

string

<= 200 characters

null

null

unlink_sequence_ids

Any of:

Array<string>

Array<string>

null

null

Responses

200

Successful Response

object

data

required

object

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string