Remove catalog
Use /catalogs/remove to remove an existing catalog.
Remove a catalog.
API Key Authentication
Authentication is required in order to interact with Batch's APIs.
Batch implements authentication using API Keys, that we call the "REST API Key". You can find it on your dashboard.
Please make sure that you keep this key secret. You should never use it in client apps to call APIs from there as it would easily be extractable.
How to authenticate
In order to authenticate your requests, add your REST API Key in the Authorization header and prefix it by Bearer. Example: Authorization: Bearer bcd38d9rfb38ra28.
The unique project key, identifying a project on the Batch platform
project_0664hxvwffvbpn278gxdyhsadddqgna6Identifier of the catalog to remove.
productsRequest accepted for asynchronous processing
The Rest API Key is not valid for this project
Not found
Unexpected error
Batch's services are under maintenance. Please try again later
POST /2.8/catalogs/remove HTTP/1.1
Host: api.batch.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-Batch-Project: text
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"name": "products"
}{}Request structure
Route
The Catalog API exposes a POST endpoint that allows to remove an existing catalog:
/catalogs/remove
Headers and authentication
See Overview → Using Project APIs.
Post data
The body of the request must contain a valid JSON payload describing the operations to be executed on the audience.
Here is a how a complete JSON payload looks like:
{
"name": "MOVIES"
}Responses
Success
If the call to the API endpoint is successful you will receive an HTTP 202 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.
Last updated