POST - Update In-App campaign
The update endpoint allows you to update In-App campaigns created from the API.
Request structure
Route
The campaigns API exposes a POST endpoint at:
https://api.batch.com/1.1/BATCH_API_KEY/in-app-campaigns/update/CAMPAIGN_TOKEN
Here are examples of valid cURL, PHP or Python requests syntax:
- Bash
- PHP
- Python
curl -X POST "https://api.batch.com/1.1/BATCH_API_KEY/in-app-campaigns/update/CAMPAIGN_TOKEN" \
-H "Content-Type: application/json" \
-H "X-Authorization: BATCH_REST_API_KEY" \
-d '{
"name": "Updated Test Campaign Name",
"live": true
}'The CAMPAIGN_TOKEN value is the token you receive when you successfully create an In-App campaign using the API.
Headers
In order to authenticate with the API, you need to provide your company REST API Key as the value of the X-Authorization header. You can find it in ⚙ Settings → General.
Post data
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:
- Parameters added after an update cannot be removed.
Responses
Success
If the POST to the API endpoint is successfull you will receive an HTTP 200 confirmation.
Failure
If the POST data does not meet the API requirements you will receive an actionable error message. Contact us at support@batch.com if you need further support.
AUTHENTICATION_INVALID(Http status code: 401, Error code: 10)API_MISUSE(Http status code: 403, Error code: 12)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)TOO_MANY_REQUESTS(Http status code: 429, Error code: 60)
If you get a "too many requests" response, please wait for at least 5 seconds before trying again. Further requests might still return this error.