Skip to main content
DELETE
Delete Contact Data
Use this endpoint when the state stored against a caller’s phone number is no longer needed. Deletion removes the current value from reads while keeping the contact itself and its revision history. Deletion is idempotent. If no current data exists, the endpoint still returns success with "deleted": false. Data is scoped to your organization. US numbers can be formatted or sent as digits. Non-US numbers must include the + country code. URL-encode the + when it appears in the path. Callers that do not have a phone number can be keyed by any other identifier, such as a chat or SIP identifier, of up to 128 characters. Simple stores those identifiers as provided and returns them unchanged in phoneNumber.
The response confirms the normalized phone number and whether a current value was deleted:
The endpoint returns 401 when authentication fails and 422 when the caller identifier is invalid.

Authorizations

Authorization
string
header
required

Path Parameters

phoneNumber
string
required

The caller's phone number or other caller identifier. US numbers may be formatted or sent as digits; non-US numbers must include the + country code. Non-phone identifiers (for example chat or SIP identifiers) are accepted verbatim, up to 128 characters.

Response

Contact data deletion result.

phoneNumber
string
required

The normalized phone number in E.164 format, or the caller identifier as provided when it is not a phone number.

deleted
boolean
required

Whether a current value was deleted.