The delete endpoint allows you to remove a campaign using its token number.
The campaigns API exposes a POST endpoint at: https://api.batch.com/1.1/BATCH_API_KEY/campaigns/delete/CAMPAIGN_TOKEN
Here are examples of valid cURL, PHP or Python requests syntax:
The BATCH_API_KEY value is either your Live, Dev or SDK Batch API key from the settings page of your app within the dashboard (Settings → General).
The CAMPAIGN_TOKEN value is the token you receive when you 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 X-Authorization header. You can find it in ⚙ Settings → General.
If the POST to the API endpoint is successfull you will receive an HTTP 200 confirmation.
If the GET data does not meet the API requirements you will receive an actionable error message. Contact us at 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)
SERVER_ERROR (Http status code: 500, Error code: 0)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.
curl -X POST "https://api.batch.com/1.1/BATCH_API_KEY/campaigns/delete/CAMPAIGN_TOKEN" \
-H "Content-Type: application/json" \
-H "X-Authorization: BATCH_REST_API_KEY"import requests, json
response = requests.request("POST", "https://api.batch.com/1.1/BATCH_API_KEY/campaigns/delete/CAMPAIGN_TOKEN",
headers={
'Content-Type': 'application/json'
'X-Authorization': 'BATCH_REST_API_KEY'
}
)use GuzzleHttp\Client;
$client = new Client();
$response = $client->request("POST", "https://api.batch.com/1.1/BATCH_API_KEY/campaigns/delete/CAMPAIGN_TOKEN", [
"headers" => [
"Content-Type" => "application/json",
"X-Authorization" => "BATCH_REST_API_KEY"
]
]);