> ## 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 do canal E-mail: enviar, consultar, cancelar agendamento e gerenciar domínios.

<Tip>
  Cada escopo é uma **porta** na sua chave: abra só as que a integração precisa, domínio, envio, leitura ou cancelamento.
</Tip>

Cada **escopo** libera um tipo de operação no E-mail. Use só o que sua integração precisa.

## Como enviar a chave

**Recomendado**

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

**Alternativo**

```http theme={null}
x-api-key: sk_live_sua_chave_aqui
```

<Info>
  A API Key pertence a **um** workspace. Você não acessa outro workspace com a mesma chave.
</Info>

## Combinações comuns

<CardGroup cols={2}>
  <Card title="Só enviar" icon="paper-plane">
    `email:send`
  </Card>

  <Card title="Enviar e consultar" icon="magnifying-glass">
    `email:send`, `email:read`
  </Card>

  <Card title="Com agendamento" icon="clock">
    `email:send`, `email:cancel`
  </Card>

  <Card title="Setup completo" icon="globe">
    `email:domains:create`, `email:domains:list`, `email:send`, `email:read`
  </Card>
</CardGroup>

<Warning>
  Lista de escopos **vazia** na criação = acesso **ADMIN**. Em produção, restrinja sempre.
</Warning>

## Escopos disponíveis

<AccordionGroup>
  <Accordion title="email:send">
    Enviar e-mail imediato ou agendado. O domínio do `from` deve estar **VERIFIED**.
  </Accordion>

  <Accordion title="email:read">
    * Listar enviados do workspace
    * Consultar um envio pelo id

    Com **domainIds** na chave, a listagem fica limitada a esses domínios.
  </Accordion>

  <Accordion title="email:cancel">
    Cancelar e-mail agendado. Só com status `SCHEDULED`. Créditos são devolvidos.
  </Accordion>

  <Accordion title="email:domains:list">
    Listar domínios, ver detalhe e verificar status no DNS.
  </Accordion>

  <Accordion title="email:domains:create">
    Registrar novo domínio para verificação DNS.
  </Accordion>
</AccordionGroup>

## Limite por domínio

Se a chave tiver **domainIds** configurados, ela só envia com remetentes (`from`) desses domínios. Domínio fora da lista retorna **403** (`DOMAIN_NOT_ALLOWED`).

Lista vazia = qualquer domínio **VERIFIED** do workspace.

## Erros comuns

<AccordionGroup>
  <Accordion title="401: chave ausente, inválida ou revogada">
    Confira `Authorization: Bearer sk_...` e se a chave não foi apagada no painel.
  </Accordion>

  <Accordion title="403: sem escopo, domínio não permitido ou limite do plano">
    Verifique escopo da rota, `domainIds` na chave e créditos (`PLAN_LIMIT_CREDITS`).
  </Accordion>

  <Accordion title="400: DOMAIN_NOT_VERIFIED">
    Verifique o domínio do `from` no painel antes de enviar.
  </Accordion>
</AccordionGroup>

## Próximos passos

* [Quick Start](/emails-api/como-funciona/quick-start)
* [Eventos dos webhooks](/emails-api/como-funciona/eventos-do-webhooks)
* [Chaves de API (guia)](/guides/api-key/index)