Delete a contact

DELETE/v1/contacts/{identifier}

Permanently deletes a contact identified by ULID, email address, or E.164 phone number. A successful response includes a confirmation message and echoes the requested identifier. Subsequent requests for the same contact return 404.

Path Parameters

identifierstring required

Contact ULID, email address, or E.164 phone number. Email addresses in paths should be URL-encoded (%40 for @).

Example:ulid: 01kptye62pxs8pp0xkh6d5vxz2email: [email protected]encodedEmail: encoded%40example.comphone: +201288899999

Responses

Body

success_codeenum: 200 | 201•Numeric success code matching the HTTP response status. required

Example:200

messagestring required

Example:Contact deleted successfully

detailsobject required

dataobject (GeneralContactDeletedData) required

identifierstring•Raw path parameter value echoed back to the client required

Example:01kptye62pxs8pp0xkh6d5vxz2

metaobject

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

Request Sample:Shell / cURL

1
2
3
4

curl --request DELETE \
  --url "https://api-stg.bevatelcloud.com/v1/contacts/{identifier}" \
  --header "Authorization: Bearer <YOUR_API_KEY>" \
  --header "Content-Type: application/json"

Response Example

1
2
3
4
5
6
7
8
9

{
  "success_code": 200,
  "message": "Contact deleted successfully",
  "details": {},
  "data": {
    "identifier": "01kptye62pxs8pp0xkh6d5vxz2"
  },
  "meta": {}
}