DELETE /api/campaigns/{id} Permanently delete a campaign and all associated recipient records.

Headers

appid
string
required
Your CometChat App ID.
apikey
string
required
Your CometChat API Key.

Path parameters

id
string
required
The campaign ID to delete.

Example request

curl -X DELETE https://{appId}.api-{region}.cometchat.io/v3/business-messaging/api/campaigns/666c3d4e5f6a7b8c9d0e1f2a \
  -H "appid: YOUR_APP_ID" \
  -H "apikey: YOUR_API_KEY"

Example response

{
  "success": true
}
Deleting a campaign is permanent and also removes all recipient records associated with it. This action cannot be undone.