Skip to main content
PATCH
Update a campaign

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Optional. A unique key you generate (max 255 chars, such as a UUID) that makes this request safe to retry. Retrying with the same key replays the original response instead of repeating the operation. Reusing a key with a different body returns 422.

Maximum string length: 255
Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Path Parameters

id
string<uuid>
required
Example:

"a7d4e2f1-08b3-4c65-9e7a-1b2c3d4e5f60"

Body

application/json
name
string
Maximum string length: 255
Example:

"Q4 Launch (revised)"

schedule
object
settings
object
sequence
object[]

When supplied, REPLACES the full sequence with these steps (at least one). Omit to leave the sequence unchanged. An active campaign's sequence cannot be replaced - pause it first (400, nothing is written).

Minimum array length: 1
accounts
string<uuid>[]

When supplied, REPLACES the attached SMTP account set — the mailboxes the campaign sends from when settings.useAllAccounts is false. While useAllAccounts is true the campaign sends from every connected mailbox and this list does not limit it.

Maximum array length: 100
Example:
tags
string<uuid>[]

When supplied, REPLACES the campaign's tags ([] removes them all). Campaign tag ids to put on the campaign. Read the ids from tags[] on any campaign; tags themselves are created in the dashboard. Mailbox tag ids are a different dictionary and are rejected.

Maximum array length: 50
Example:

Response

id
string<uuid>
required
Example:

"123e4567-e89b-12d3-a456-426614174000"

name
string
required
Example:

"Q4 Product Launch Outreach"

status
enum<string>
required
Available options:
draft,
scheduled,
active,
paused,
completed,
failed
Example:

"draft"

schedule
object
required
settings
object
required
metrics
object
required
tags
object[]
required

Tags on this campaign - the same ones the list returns, and the same ids ?tags= filters by. Create and delete them in the dashboard. Campaign tags are a separate dictionary from mailbox tags, so the ids do not cross over.

subsequences
object[]
required

Subsequences of this campaign (follow-up flows that start on a status, reply, open, click or a finished sequence), in position order. Empty when it has none. Manage them under /v1/subsequences.

createdAt
string<date-time>
required
Example:

"2026-07-11T08:00:00.000Z"

updatedAt
string<date-time>
required
Example:

"2026-07-11T10:30:00.000Z"

sequence
object[]

The email sequence steps - included on the detail view (GET /v1/campaigns/:id).

accounts
string[]

Attached SMTP account ids - included on the detail view. The campaign sends only from these when settings.useAllAccounts is false; while it is true, from every connected mailbox of the workspace.

Example: