Skip to main content
PUT
Update a campaign

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

publicAPI.v2.all

Public API v2

Path Parameters

id
integer
required

Numeric campaign ID.

Body

application/json
name
string

New campaign name.

isPublic
boolean

Whether the campaign is shared with the organization.

emailAccountIds
(string | integer)[]

Sending inboxes to link, as emailAccountId values from GET /email-accounts. A non-empty list replaces the linked inboxes; an empty list leaves them unchanged. Unknown IDs return 400.

dailyTaskLimits
object[] | null

Task limit per cadence day. Each dueDay must match an existing step. Requires the campaign send limits feature (campaignSendLimits on GET /features); otherwise 403 with code noFeatureAccess.

isDailyTaskLimitEnabled
boolean | null

Whether dailyTaskLimits are enforced. Null leaves it unchanged. When false, no step has a daily task cap, email steps still follow their inbox send limits, and the stored dailyTaskLimits are kept. A change re-balances an active campaign at once. Requires the campaign send limits feature; otherwise 403 with code noFeatureAccess.

dailySendLimits
object[] | null

This campaign's daily send limit per linked inbox. Inboxes not listed keep their limit. An account that is not linked, after emailAccountIds is applied, returns 400. Requires the campaign send limits feature; otherwise 403 with code noFeatureAccess.

Response

The updated campaign.

success
boolean
Example:

true

data
object