Change a campaign
PATCH
/api/v1/campaigns/{uid}
Send only what changes. mail_list_uid replaces the typed addresses; addresses
replaces them too. custom_headers left out keeps the current headers; sent empty,
it removes them all.
Parameters
uid
string
required
path
The campaign's uid.
Request body application/x-www-form-urlencoded
mail_list_uid
string
addresses
array of string (email)
name
string
subject
string
from_email
string (email)
from_name
string
reply_to
string (email)
preheader
string
track_open
boolean
track_click
boolean
sign_dkim
boolean
skip_failed_message
boolean
custom_headers
array of object
Responses
200
The campaign was changed.
401
The token is missing or wrong (
Unauthenticated.), or its user may not act on
this object (Unauthorized). Without the Accept: application/json header, a
missing or wrong token answers with a redirect to the sign-in page instead.
403
custom_headers is wrong (its messages), or the campaign is not the token's ({"status": 0, "message": "Unauthorized"}).
422
Both a list and addresses were sent, or the addresses were refused.
Change a campaign
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
curl -X PATCH 'https://your-domain/api/v1/campaigns/6adaabd2b4753' \
-H "Accept: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
--data-urlencode 'mail_list_uid=6adaabbf98847' \
--data-urlencode 'addresses[]=anna@example.com' \
--data-urlencode 'name=November newsletter' \
--data-urlencode 'subject=What'\''s new this month' \
--data-urlencode 'from_email=hello@example.com' \
--data-urlencode 'from_name=Example Team' \
--data-urlencode 'reply_to=hello@example.com' \
--data-urlencode 'preheader=Three changes worth knowing about' \
--data-urlencode 'track_open=1' \
--data-urlencode 'track_click=1' \
--data-urlencode 'sign_dkim=1' \
--data-urlencode 'skip_failed_message=0'
1
2
3
4
$client = new Acelle\Client('https://your-domain/api/v1', 'YOUR_API_TOKEN');
$client->campaign()->update('6adaabd2b4753', [
'subject' => 'Three changes this month',
]);
Response
{
"status": 1,
"message": "A new campaign was updated!",
"attributes": {
"uid": "6adaabd2b4753",
"name": "November newsletter",
"status": "new",
"updated_at": "2026-11-14 10:05:00"
}
}