You can use this API to delete existing items in a given catalog. Only 50 items are allowed to be deleted in a single request.

API Endpoint

POST https://api-0X.moengage.com/v1/catalog/{{Catalog_id}}/items/bulk-delete

Each customer is hosted on a different data center; you can find your data center number (value of X) by checking the data center and API endpoint mapping page.

Authentication

The API request will be authenticated through Basic Authentication. Basic Authentication sends a Base64-encoded string containing your username and password with every API request. It encodes a 'username: password' string in Base64 and appends the encoded string with 'Basic '. This string is included in the authorization header as shown below:

{"Authorization": "Basic bmF2ZWVua3VtYXI6bW9lbmdhZ2U="}

You can obtain the username and password details from the MoEngage Dashboard.

1. Navigate to Settings > Account > APIs.
2. Copy the following details:
   • Username: Under Workspace ID (earlier App ID), click the copy icon to copy the username.
   • Password: In the API keys section, click the copy icon in the Campaign report/Business events/Custom templates/Catalog API tile to copy the API key.
3. Use these details to authenticate the API requests.

Request Headers

Request Body

The request body consists of an object "items" within which you can pass an array of max 50 item IDs to be deleted.

Response

Response Codes

Error Messages

Rate Limit

With the current implementation of a Platform based rate limiter, we support the following:

• Request limit - 100/min OR 1000/hr.
• Payload size limit - 5MB only when Content-Length header is provided.

Sample cURL Request

curl --location --globoff 'https://api-{{0X}}.moengage.com/v1/catalog/{{catalog_ID}}/items/bulk-delete' \
--header 'MOE-APPKEY: {{DATA_APP_ID}}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: [[Authorization-masked-secret]]' \
--data '{
    "items": ["{{item_ID}}"]
}'

Sample Response

{
    "message": {
        "valid": {
            "count": 0
        },
        "invalid": {
            "count": 10
        }
    }
}

{
  "error-code": "invalid-request",
  "message": "Bad request, update failed"
}

{
  "error-code": "request-unauthenticated",
  "message": "Your request is unauthorized. Please verify your credentials and try again."
}

{
  "error-code": "request-denied",
  "message": "Your account does not have access to the Recommendations and Catalogs features. Please contact the MoEngage team for further assistance."
}

{
    "error-code": "catalog-not-found",
    "message": "Catalog not found for the given id"
}

{
    "error-code": "payload-size-too-large",
    "message": "The payload size is too large. Maximum allowed size is 5MB."
}

    The following headers are returned in case of rate-limit breach:

    x-ratelimit-limit (integer)- The maximum number of requests that the consumer is permitted to make in a given time window.
    x-ratelimit-remaining (integer)- The number of requests remaining in the current rate limit window.
    x-ratelimit-reset (integer)- The time at which the current rate limit window resets in UTC epoch seconds.

Postman Collections

We have made it easy for you to test the APIs. Click here to view it in Postman.

FAQs