Delete contact(s)

This request/endpoint is platform-agnostic (e.g., WhatsApp, Website) and allows you to delete a contact or contacts (bulk deletion).

PUT https://api-v7.express-chat.com/inbox/users/status-update

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>
authtype	Key

Request Body

The request body consists of a JavaScript Object Notation (JSON) object containing the fields described in the table below. Examples of the request body can be found in the Sample Requests section.

Field	Type	Description
whatsappSubscriberIds	Array	An array of contact IDs that you intend to delete, associated with a WhatsApp bot.
facebookSubscriberIds	Array	An array of contact IDs that you intend to delete, associated with a Facebook bot.
telegramSubscriberIds	Array	An array of contact IDs that you intend to delete, associated with a Telegram bot.
websiteSubscriberIds	Array	An array of contact IDs that you intend to delete, associated with a Website bot.
messagingSubscriberIds	Array
ids	Array	An array of contact IDs that you intend to delete, associated with any platform.
status	String	The new status for the specified contact(s) (e.g., "DELETED")

Responses

200 - Contact(s) was deleted successfully.

{
  "success": true,
  "message": "",
  "code": 200
}

400 - Bad Request

The <token> being used is incorrect.

{
  "success": false,
  "message": "Argument passed in must be a single String of 12 bytes or a string of 24 hex characters",
  "code": 400
}

401 - Unauthorized

Your request is missing the authtype: Key header

{
  "success": false,
  "message": "jwt malformed",
  "code": 401
}

Sample Requests

The example requests below illustrates how to delete a WhatsApp contact. Ensure you replace <token> with your valid Bearer token before sending the request.

curl

curl 'https://api-v7.express.com/inbox/users' \
  -X 'POST' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -H 'authtype: Key' \
  -d '{
    "whatsappSubscriberIds":["698c4445f98046b014053e5c"],
    "status":"DELETED"
  }' \
  --compressed

❓ Got any questions?

If you have any questions, you can look into our repository of FAQs, most likely, you will find your answer here, If not, write us at [email protected].