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

# Escopos da API Key

> Permissões para consultar e alterar a lista de não contatar.

<Tip>
  A **API Key** é o cartão de acesso: cada **escopo** abre uma porta. Para supressões, existem só duas — leitura e escrita.
</Tip>

## Em poucas palavras

* **`suppressions:read`** — listar e consultar entradas.
* **`suppressions:write`** — adicionar, importar e remover.
* Escrita **não exige** leitura na mesma chave, mas integrações de administração costumam usar as duas.

Guia geral: [Chaves de API](/guides/api-key/index). Primeiro uso: [Quick Start](/suppressions-api/como-funciona/quick-start).

***

## Como enviar a chave

```http theme={null}
Authorization: Bearer sk_live_xxxxx
```

Alternativa: `x-api-key: sk_live_xxxxx`.

<Warning>
  Escopos **vazios** na criação = acesso **ADMIN** (tudo). Em produção, restrinja sempre.
</Warning>

***

## Combinações prontas

<CardGroup cols={2}>
  <Card title="Só consultar" icon="magnifying-glass">
    `suppressions:read`
  </Card>

  <Card title="Só alterar" icon="pen">
    `suppressions:write`
  </Card>

  <Card title="Administração completa" icon="list-check">
    `suppressions:read`, `suppressions:write`
  </Card>

  <Card title="CRM + supressões" icon="address-book">
    `contacts:read`, `suppressions:read`, `suppressions:write`
  </Card>
</CardGroup>

***

## Escopos disponíveis

<AccordionGroup>
  <Accordion title="suppressions:read">
    Listar supressões (`GET /v1/suppressions`) e consultar por ID (`GET /v1/suppressions/{id}`).
  </Accordion>

  <Accordion title="suppressions:write">
    Adicionar (`POST /v1/suppressions`), lote (`POST /v1/suppressions/batch/add`), remover por ID, por identidade e lote de remoção.
  </Accordion>
</AccordionGroup>

***

## Erros comuns

| HTTP / `code`          | O que fazer                                                 |
| ---------------------- | ----------------------------------------------------------- |
| **401** `UNAUTHORIZED` | Confira `Authorization: Bearer sk_...`                      |
| **403** `FORBIDDEN`    | Inclua `suppressions:read` ou `suppressions:write` na chave |
| **403** outro          | Chave sem acesso ao workspace                               |

Catálogo completo: [Respostas de erro](/guides/conceitos/resposta-de-erros).

***

## Próximos passos

* [Quick Start](/suppressions-api/como-funciona/quick-start)
* [Eventos dos webhooks](/suppressions-api/como-funciona/eventos-do-webhooks)
* [Introdução](/suppressions-api/como-funciona/introducao)