Update a campaign
Update a draft campaign’s name, group, audience (mailing list, segment, or filter), or scheduling.
name and campaignGroupId can be updated.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the campaign.
"clc4m6n8p0q2r4s6t8u0v2x4"
Body
At least one field must be provided.
The updated campaign name.
"Spring announcement"
The ID of the group to move this campaign to.
"clg7n5p3q1r9s7t5u3v1w9y7"
The ID of the mailing list to send to.
"clm2k8j4h6g0f8d6s4a2b0z8"
The ID of an audience segment. Setting this without also providing audienceFilter clears any existing audienceFilter. If both are provided, the filter is applied on top of the segment's filter.
"cls6e8g0i2k4m6o8q0s2u4w6"
A tree of audience conditions combined with match. Setting this without also providing audienceSegmentId clears any existing audienceSegmentId. When both are provided, this filter is applied on top of the segment's filter.
When the campaign should send. timestamp is required and must be in the future when method is schedule, and must be omitted when method is now.
Response
Campaign updated.
The ID of the campaign.
"clc4m6n8p0q2r4s6t8u0v2x4"
The name of the campaign.
"Spring announcement"
The status of the campaign.
Draft, Scheduled, Sending, Sent "Draft"
ISO 8601 timestamp for when the campaign was created.
"2025-06-29T07:47:39.370Z"
ISO 8601 timestamp for when the campaign was last updated.
"2025-06-29T07:47:39.370Z"
The associated email message ID.
"cle5f7g9h1i3j5k7l9m1n3p5"
The ID of the campaign group this campaign belongs to.
"clg7n5p3q1r9s7t5u3v1w9y7"
The ID of the mailing list this campaign sends to, if set.
"clm2k8j4h6g0f8d6s4a2b0z8"
The ID of the audience segment this campaign targets, if set.
"cls6e8g0i2k4m6o8q0s2u4w6"
The filter rules that define the audience for this campaign, if set.
When the campaign is scheduled to send.
Related topics
Update a campaign groupCampaign groupsCreate a campaignCampaigns API examplesAPI Introduction
