Update broadcast campaign
Description
Updates campaign details, changes an existing campaign settings.
Request URL
Method: POST
https://example.com/api/v1.1/campaigns/broadcasts/update
Request parameters
Parameter | Type | Example | Required | Description |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Yes | API token |
id | int | 1 | Yes | Campaign ID |
format | string | "json" | No | Response data format. By default – json |
name | string | "Broadcast campaign name" | Yes | Campaign name |
is_active | bool | true | No | Activate or deactivate campaign |
data_type | string | "list" | Yes | Audience source type |
data_id | int | 12 | Yes | Audience source ID |
resource_id | int | 24 | No | Resource ID |
content | JSON array | Yes | Message template object | |
subid | string | "Adv_1" | No | Campaign SubID |
start_schedule | JSON object | No | Start schedule object | |
limit | int | 0 | No | Campaign cycle limitation |
aglimit_count | int | 0 | No | Increase limit each cycle — number |
agllimit_percent | float | 99.0 | No | Increase limit each cycle — percent |
policy_id | int | 1 | No | Sending policy ID |
push_sending_mode | string | "fanout" (default) "last" | No | Push notification sending mode (push channels only) |
Smart settings | ||||
virtual_sender_id | int | 12 | No | Virtual sender ID (Smart accounts) |
is_random_tracking_prefix | bool | false | No | Random tracking domain prefix (Smart accounts) |
custom_tracking_domains | JSON array | ["trk.example.com", "trk2.example.com"] | No | Tracking domains list (Smart accounts) |
blind_carbon_copy | JSON array | ["john@example.com", "george@example.com"] | No | Hidden copy email addresses (Smart accounts) |
unconditional_sending | bool | true | No | Send messages regardless of subscription status (Smart accounts) |
watched_list_id | int | 12 | No | Campaign watchers database ID (Smart accounts) |
watcher_limit | int | 100 | No | Watchers limit (Smart accounts) |
info
You cannot change the channel in a saved campaign. When passing such parameters as send_channel, content_type, send_email_content, send_sms_content, send_push_content, the request will not return an error, but it will not update the sending channel either.