Create or Update a Campaign
Creates a new campaign, or updates an existing campaign when campaignId is provided. When the posted status differs from the stored status, the campaign transitions to the new status (for example, Active → Paused). See the campaign object reference for field descriptions.
HTTP Request Examples
Create a new campaign
{
"name": "Spring Sale 2025 Launch",
"description": "Don’t Miss Our Exclusive Spring Sale!",
"campaignType": "Conversion",
"status": "Active",
"allow_autopause": true,
"workflowBehavior": "All",
"isNotifyNewLead": false,
"conversionGoals": {
"enabled": false,
"suspects": 0,
"mcls": 0,
"mqls": 0,
"sqls": 0
}
}
Update an existing campaign (transition to Paused)
{
"campaignId": 24109,
"name": "Spring Sale 2025 Launch",
"status": "Paused"
}
HTTP Request Parameters
campaignIdnumber
Id of the campaign to update. Omit when creating a new campaign.
namestring
Display name of the campaign. Required when creating.
descriptionstring
Free-form description shown in the campaign list.
campaignTypestring
Campaign type. One of: Conversion, Transactional, Nurture, Broadcast.
statusstring
Campaign status. One of: Active, Paused, Archived, Deleted. When this differs from the stored status, the campaign is transitioned.
utmCampaignstring
UTM campaign value appended to outbound tracking links. Auto-derived from name if omitted.
segmentsarray
Array of segment ids associated with the campaign.
subscriber_preferencesarray
Array of subscription preference ids that contacts in this campaign can opt into/out of independently.
allow_autopauseboolean
When true, the campaign auto-pauses after extended inactivity.
workflowBehaviorstring
How this campaign interacts with automations. One of: All, Match, None.
cost, costPeriodnumber, string
Optional cost tracking. costPeriod is one of None, OneTime, Daily, Weekly, Monthly, Yearly.
isNotifyNewLeadboolean
When true, emails in notificationRecipients receive a notification for each new lead.
notificationRecipientsarray
Array of user ids (as strings) that receive new-lead notifications when isNotifyNewLead is true.
isAutoQualifyNewLeadboolean
When true, new leads are auto-promoted to Qualified status on entry.
conversionGoalsobject
Funnel goals object with fields enabled, suspects, mcls, mqls, sqls. Used by the campaign funnel report.
HTTP Response Examples
200
{
"Status": true,
"Message": "",
"Response": {
"id": 24109
}
}
HTTP Response Parameters
idnumber
The id of the campaign that was created or updated.