In brief
- Each
typehas simple formatting rules. - Comparisons, search, and removal always use the normalized value.
- The API does not create a contact on its own — it only links
contactIdif the contact already exists in the workspace.
Rules by type
Analogy: like standardizing a phone number before adding it to your address book —
(11) 99999-0000 and 5511999990000 become the same entry.
channel field (optional)
Use channel to document in which context the suppression was created (e.g. whatsapp, email). The global rule per identity still applies:
- Phone blocks all phone channels, regardless of the
channelprovided. - Email blocks email only.
Examples in practice
Phone with mask
Input:Email with uppercase
Input:cliente@empresa.com.br.
Telegram with @
Input:meubot (username) or numeric peer, depending on the value.
Invalid value
If the value fails type normalization, the API responds 400 withINVALID_SUPPRESSION_VALUE. See Troubleshooting.
Next steps
- Quick Start: add via API
- Introduction: when to use suppression