Update an existing campaign. Note that attempting to update a completed campaign will result in an error.
Response format | JSON |
---|---|
Requires authentication? | Yes |
name optional | Updated campaign name, which must be unique to the channel. |
---|---|
body optional | The message body for the campaign. |
external_ref_id optional | Updated string to help correlate campaigns with other systems. |
tag_expression optional | Updated tag expression. See the documentation for tag_expressions here. |
media_urls optional | Collection of URLs pointing to media. These will be sent with the campaign message. |
send_at optional | Updated time at which campaign should be sent. |
send_to_inboxed optional | Optional flag indicating whether campaign messages should be sent to subscribers in the support queue ( |
curl -X PUT \
-u '[SID]:[TOKEN]' \
-H 'Content-Type: application/json' \
'https://api.essential.to/v2/account/campaigns/XIoAc9B2eV_L0gOz8uz--w' \
-d '{"name":"New Campaign Name", "body": "This is the updated body of the test campaign"}'
# Sample response
{
"name": "New Campaign Name",
"external_ref_id": null,
"send_at": null,
"status": "unscheduled",
"body": "This is the updated body of the test campaign",
"media_urls": null,
"created_at": "2017-02-21T21:00:00.145Z",
"updated_at": "2017-02-21T22:00:00.145Z",
"sid": "YIoAc9B2eV_L0gOz8uz--w",
"account_sid": "XsbrYCSo2m0sShMLOlZqtw",
"channel_sid": "sRhvpNDGZwyDeH-YRZIr9A",
"tag_expression": {
"tag_sids": null,
"left": null,
"operator": "UNION",
"right": null
}
"results": [
]
}
Python coming soon.
Node coming soon.