API reference
Customers
/contacts
A customer is the person who receives messages. Customers are subscribed to subscriptions through /links. In the Subscription business pack a customer is, for example, “Hawa Kollie”.
GET/contactsList · ?q ?phone_e164 ?external_refPOST/contactsCreateGET/contacts/{contact_id}ReadPATCH/contacts/{contact_id}Update · attributes replaced wholePOST/contacts/{contact_id}/deactivateDeactivate · no deleteshown →
POSTDeactivate a customer
Requires contacts:write. There is no delete: the messages sent to a customer are the record. None of the three states is ever written to.
Path parameters
contact_iduuid · required
The customer id.
Body parameters
statusinactive | blocked | opt_out · default inactive
inactive is reversible. blocked is you saying never write to this number. opt_out is the customer saying so.
reasonstring · optional · max 500
Kept on the record.
Returns
200 with the customer and its new status.
Response body
One customer: the same fields in every pack. Press Response on the sample to see one whole.
FieldTypeDescription
iduuid
tenant_iduuidThe instance.
external_refstring | nullYour own id, as you sent it. It is the only exact key a customer with no phone number has.
namestring
roleaudience | staffSet when the contact is made and never changed.
phone_e164string | nullNormalised to E.164, whatever shape it arrived in. null where the instance takes customers with no phone number: then the email is the address and external_ref is the key.
wa_phone_e164string | nullnull means WhatsApp goes to phone_e164, where there is one. It goes beside a phone number and never in place of one, so a customer with no phone number has no WhatsApp number either.
emailstring | nullLower-cased. Not unique: two people may share one. It is the one way to reach a customer with no phone number.
channel_prefsms | whatsapp | emailUsed where a send follows preferences. email means the email goes in place of the phone message, unless the instance keeps the phone for that kind of notice. With no phone number there is nothing else, so a customer without one is always email.
wa_reachableboolean | nullLearned, not set: null is untried, false is a send that came back unreachable, true is one that landed.
sms_reachableboolean | nullThe same, for SMS.
last_inbound_atdatetime | nullWhen this customer last wrote in. Anchors WhatsApp's 24-hour reply window.
wa_opt_out_atdatetime | nullWhen this customer wrote STOP on WhatsApp. WhatsApp is skipped from then on; SMS is not. START clears it.
languagestring
attributesobjectShaped by the Subscription business pack's contact_schema.Varies by pack
statusactive | inactive | blocked | opt_outOnly active contacts are ever messaged.
created_atdatetime
updated_atdatetime
On failure the body is { error, code } instead.