The update endpoint allows you to update campaigns created from the API.
The campaigns API exposes a POST endpoint at:
Here is an example of a valid CURL CLI request syntax:
curl -H "Content-Type: application/json" -H "X-Authorization: BATCH_REST_API_KEY" -X POST -d "@payload.json" "https://api.batch.com/1.1/BATCH_API_KEY/campaigns/update/CAMPAIGN_TOKEN"
CAMPAIGN_TOKEN value is the token you receive when you successfully create a push campaign using the API.
In order to authenticate with the API, you need to provide your company REST API Key as the value of the
The body of the request must contain a valid JSON payload containing at least the same number of parameters you used when you first created your campaign or more.
Please note that:
- Complete campaigns cannot be set live again.
- Parameters added after an update cannot be removed.
- You cannot switch back to a one-time campaign after chosing a recurring campaign.
If the POST to the API endpoint is successfull you will receive an HTTP 200 confirmation.
If the POST data does not meet the API requirements you will receive an actionable error message. Contact us at email@example.com if you need further support.
AUTHENTICATION_INVALID(Http status code: 401, Error code: 10)
ROUTE_NOT_FOUND(Http status code: 404, Error code: 20)
MISSING_PARAMETER(Http status code: 400, Error code: 30)
MALFORMED_PARAMETER(Http status code: 400, Error code: 31)
MALFORMED_JSON_BODY(Http status code: 400, Error code: 32)
SERVER_ERROR(Http status code: 500, Error code: 1)
MAINTENANCE_ERROR(Http status code: 503, Error code: 2)