Skip to main content
DELETE
Erase a contact's data

Authorizations

Authorization
string
header
required

Authorization: Bearer hmok_... API key or a dashboard session token

Path Parameters

ch
string
required

ch_ channel id

Pattern: ^ch_[A-Za-z0-9]{8}$
contactId
string
required

The end customer: WhatsApp number in digits with country code (e.g. 972541234567), or the Instagram/Messenger user id.

Pattern: ^\+?[0-9]{5,20}$

Response

Erased

channelId
string
required

ch_ channel id

contactId
string
required

The contact id that was erased, digits only

deleted
object
required
anonymizedUsageRecords
integer
required

Usage records kept with the identifying id removed

retained
object
required