> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ycloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Gerenciar cancelamentos de inscrição

> Registre e aplique os cancelamentos de inscrição (opt-outs) dos clientes por canal.

## O que é

Um registro de cancelamento de inscrição indica que um cliente optou por não receber mensagens da sua empresa em um canal específico. O cliente e o canal juntos formam o registro exclusivo.

## Antes de começar

* Defina como o seu produto coleta e registra o consentimento.
* Normalize os números de telefone para o formato E.164.
* Escolha o tipo correto de identificador do cliente e o canal.
* Decida como os opt-outs serão sincronizados com os seus sistemas de origem.

## Como funciona

1. Crie um registro de cancelamento quando um cliente optar por não receber mensagens (opt-out).
2. Verifique ou liste os registros antes do envio quando o seu fluxo de trabalho ainda não aplicar
   a supressão.
3. Exclua o registro apenas quando o cliente fizer novamente a adesão válida (opt-in).
4. Processe eventos de Webhook de cancelamento de inscrição para sincronizar sistemas externos.

Não interprete a exclusão como prova automática de consentimento. O seu aplicativo deve manter as evidências e a base de políticas para a nova assinatura.

## Requisição

### Criar um cancelamento de inscrição

`POST /unsubscribers`

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl --request POST https://api.ycloud.com/v2/unsubscribers \
  --header "X-API-Key: $YCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "type": "PHONE_NUMBER",
    "customer": "+16315551111",
    "channel": "whatsapp",
    "regionCode": "US"
  }'
```

### Remover um cancelamento de inscrição após o opt-in

`DELETE /unsubscribers/{customer}/{channel}`

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl --request DELETE \
  https://api.ycloud.com/v2/unsubscribers/+16315551111/whatsapp \
  --header "X-API-Key: $YCLOUD_API_KEY"
```

Codifique o valor do caminho do cliente em formato URL (URL-encode) quando exigido pelo seu cliente HTTP.

## Resposta

A criação retorna o registro salvo.

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "type": "PHONE_NUMBER",
  "customer": "+16315551111",
  "channel": "whatsapp",
  "regionCode": "US"
}
```

A recuperação e a exclusão retornam o recurso de cancelamento de inscrição correspondente. A ausência de um registro retorna um erro em vez de um status de opt-out.

## Aplicação

Trate a supressão como um limite de segurança. Aplique-a de forma consistente em envios em massa, fluxos de trabalho transacionais em que a política o exija, tentativas de reenvio e operações manuais.

Use eventos de Webhook para sincronizar novos opt-outs e registros de opt-out excluídos.

## Limites e solução de problemas

* O mesmo cliente pode ter registros separados para canais diferentes.
* Use o `type` correto para o identificador do cliente.
* Não exclua um registro silenciosamente sem um evento de opt-in válido.
* Os endpoints de listagem suportam paginação por cursor; siga `cursor.after`.
* Projete o processamento concorrente de opt-in e opt-out para que a decisão válida mais recente do cliente
  prevaleça.

<CardGroup cols={2}>
  <Card title="Criar um cancelamento de inscrição" icon="user-slash" href="/api-reference/unsubscribers/create-an-unsubscriber">
    Inspecione os tipos de identificadores e canais suportados.
  </Card>

  <Card title="Webhooks de cancelamento de inscrição" icon="webhook" href="/pt/api-reference/guides/examples/webhook-examples/contact-unsubscribe-created-webhook-examples">
    Sincronize eventos de cancelamento (opt-out) e reinscrição (opt-in).
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.