Delete Items

This API deletes existing items in a given catalog.

POST /catalog/{catalog_id}/items/bulk-delete

Delete Items

cURL

curl --request POST \
  --url https://api-{dc}.moengage.com/v1/catalog/{catalog_id}/items/bulk-delete \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'MOE-APPKEY: <moe-appkey>' \
  --data '
{
  "items": [
    "{{item_ID}}"
  ]
}
'

202

Example

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

Rate Limit

• Request limit: You can delete 100 items per minute OR 1000 items per hour. You can delete up to 50 items per request.

• Payload size limit: 5 MB only when Content-Length header is provided.

Authorizations

Authorization · string · header · required

Authentication is done via Basic Auth. This requires a base64-encoded string of your credentials in the format 'username:password'.

• Username: Use your MoEngage workspace ID (also known as the App ID). You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).
• Password: Use your API Key, which you can find within the Campaign report/Business events/Custom templates/Catalog API/Inform Report tile.

For more information on authentication and getting your credentials, refer here.

Headers

MOE-APPKEY · string · required

This is the Workspace ID of your MoEngage account that must be passed with the request. You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).

Path Parameters

catalog_id · string · required

The unique identifier for the catalog, obtained during catalog creation.

Body

application/json

items · string[] · required

An array of item IDs to delete from the catalog.

Maximum array length: 50

Response

202

application/json

Accepted. The bulk delete request was processed successfully.

message · object

Show child attributes