POST - Delete campaign

It allows the deletion of a campaign.

API Description

This API schema is available in the OpenAPI 3.1 format: View it online.

Request structure

Route

The Campaign API exposes a POST endpoint that allows to delete a campaign:

https://api.batch.com/2.1/campaigns/delete

Headers and authentification

See Overview → Using Project APIs.

Post data

IdDescription
idString - Required
The campaign id of the campaign to delete.
E.g.{"id":"orchestration_0664hyh918hr1gnzka9py5t62nrc0e1q"}

Responses

Success

If the POST to the API endpoint is successfull you will receive an HTTP 204 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)
  • 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.