HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Update Campaign

Update a campaign with the given campaign ID.

Rate limits:
Burst: 10/s
Steady: 150/m

Scopes:
campaigns:write

Path Params
string
required

The campaign ID to be retrieved

Body Params

Update a campaign and return it

object
required
string
required
string
required

The campaign ID to be retrieved

object
required
string

The campaign name

object

The audiences to be included and/or excluded from the campaign

array of strings

An optional list of included audiences, will override existing included audiences

included
array of strings

An optional list of excluded audiences, will override exising excluded audiences

excluded

Options to use when sending a campaign

boolean
Defaults to true

Use smart sending.

The tracking options associated with the campaign

boolean
required
array of objects
required
utm_params*
string
required
string
required

The send strategy the campaign will send with

string
required
date
required

The day to send on

Headers
string
required
Defaults to 2025-01-15

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses

Language
Credentials