Delete a Contact

Delete an existing contact from your address book. Once deleted, the contact can no longer be used for alias-based messaging or campaigns.

DELETE /addressbook/contacts/{msisdn}

Replace {msisdn} with the phone number of the contact you want to delete.

Required Permission

delete:Contacts

Your API key must have this permission enabled in order to use this endpoint.

Example Request

curl --request DELETE 'https://<hostname>/addressbook/contacts/55555555555' \
  --header 'Authorization: Bearer YOUR_API_KEY'

Replace YOUR_API_KEY with your API key.

All endpoints shown in this documentation use a sample base URL. The production API endpoint is provided by our team upon request.

Responses

Success (HTTP 200)

Returned when the contact has been successfully deleted.

{
  "success": true
}

Not Found (HTTP 404)

Returned when the specified contact does not exist.

{
  "success": false,
  "error": {
    "name": "NotFoundError",
    "statusCode": 404,
    "message": "Contact not found"
  }
}

Please remember that deleting a contact is permanent and cannot be undone. If you plan to re-add the contact later, you must create it again.