Pular para o conteúdo

POST /v1/contacts/block

POST
/v1/contacts/block
curl --request POST \
--url https://seu-endereco-da-api/v1/contacts/block \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "contactIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "reason": "spam", "note": "example" }'

Permissão que a Chave de acesso precisa: Bloquear contato (contacts:block).

Media typeapplication/json
object
contactIds
required
Array<string>
>= 1 items <= 500 items
reason
required
string
Allowed values: spam engano sem_interesse duplicado outro
note
string
<= 2000 characters
Media typeapplication/json
object
blocked
required

Contacts blocked by this call

number
skipped
required

Contacts left untouched: unknown, already blocked or anonymized

number

Example generated

{
"blocked": 1,
"skipped": 1
}