Skip to main content
DELETE
Unblock an address

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

identity_type
enum<string>
required

What kind of address this is. "phone" is stored in international format, "email" is lowercased, and "whatsapp_user_id" is the WhatsApp id of a contact whose phone number is hidden.

Available options:
phone,
email,
whatsapp_user_id
identity_value
string
required

The address itself — e.g. "+962790007001" or "[email protected]".

Required string length: 1 - 320
include_provider_entries
string

Send "true" to also remove entries recorded when the person opted out themselves, and entries scoped to a single channel. Accepts "true" or "false"; defaults to "false".

Response

Default Response

removed
number
required

How many entries were removed.

skipped
number
required

How many matching entries were left in place because they were not added through this API. When this is above zero the address is still blocked — retry with include_provider_entries=true if you intend to remove those too.