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

# Visão geral do envio

> O envelope do POST /gw/email: campos de nível superior, canais e a resposta com idEmail.

Todo envio na AR Online parte de uma única requisição para o endpoint `POST /gw/email`. O nome do endpoint é histórico: a requisição é um **envelope** que pode acionar de um a cinco canais — o e-mail (AR-Email) é apenas um deles, e cada bloco (`sms`, `whatsapp`, `voz`, `carta`) ativa o seu canal.

<Note>
  Os campos `nameTo`, `subject` e `content` são sempre obrigatórios. O `to` (destinatário do e-mail) é exigido **apenas** no envio somente e-mail.
</Note>

## Endpoint

* **Método e URL:** `POST https://api.ar-online.com.br/gw/email`
* **Autenticação:** envie o token JWT no header `Authorization`, **sem** o prefixo `Bearer`.
* **Content-Type:** `application/json`.

<Note>
  O envio é **assíncrono**: a resposta HTTP 200 com `{ idEmail }` significa "aceito para processamento", não "entregue". Use o `idEmail` para [consultar o status](/acompanhando/consultar-status) de cada canal. O token de produção é solicitado ao suporte em [suporte@ar-online.com.br](mailto:suporte@ar-online.com.br).
</Note>

## Campos de nível superior

<ParamField path="nameTo" type="string" required>
  Nome do destinatário da mensagem.
</ParamField>

<ParamField path="to" type="string">
  E-mail do destinatário. **Obrigatório apenas quando o envio é somente e-mail**, ou seja, quando não há nenhum bloco de outro canal (`sms`, `whatsapp` etc.) na requisição.
</ParamField>

<ParamField path="subject" type="string" required>
  Assunto da mensagem.
</ParamField>

<ParamField path="content" type="string" required>
  Conteúdo da mensagem em **HTML**.
</ParamField>

<ParamField path="customID" type="string">
  Referência externa do envio, útil para correlacionar com seus próprios registros. Opcional.
</ParamField>

<ParamField path="attachments" type="array">
  Lista de anexos. Cada item é um objeto com `name` (nome do arquivo) e `base64` (conteúdo do arquivo em base64). Opcional.
</ParamField>

<ParamField path="validation" type="object">
  Protege o acesso ao link público do AR-Portal com uma pergunta e resposta de segurança. Contém `validation.question` (pergunta exibida) e `validation.reply` (resposta solicitada). **Requer habilitação prévia** da conta.
</ParamField>

<Warning>
  O recurso `validation` é opcional e sujeito à **habilitação prévia**. Sem a ativação, uma requisição com `validation` retorna erro **400**. Solicite a ativação ao suporte ([suporte@ar-online.com.br](mailto:suporte@ar-online.com.br)) antes de utilizá-lo.
</Warning>

## Ativando outros canais

Incluir um bloco no corpo da requisição ativa o canal correspondente no mesmo envio:

* **`sms`** — envia também por SMS. Veja [Canal SMS](/enviando/sms).
* **`whatsapp`** — envia também por WhatsApp. Veja [Canal WhatsApp](/enviando/whatsapp).
* **`voz`** — dispara uma chamada de voz automatizada. Veja [Canal Voz](/enviando/voz).
* **`carta`** — envia uma carta física registrada. Veja [Canal Carta](/enviando/carta).

Você pode combinar quantos canais quiser numa só requisição. Veja [Multicanal](/enviando/multicanal).

## Resposta

```json theme={null}
{
  "idEmail": "8c4813f5-8430-4ad4-ab72-19d7eed39731"
}
```

<ResponseField name="idEmail" type="string">
  Identificador único do envio. Use-o para consultar o status de cada canal.
</ResponseField>

## Próximos passos

<CardGroup cols={2}>
  <Card title="E-mail" href="/enviando/email" icon="envelope">
    Campos do e-mail, anexos e validação de segurança.
  </Card>

  <Card title="SMS" href="/enviando/sms" icon="comment-sms">
    Mensagem de texto (SMS) com link encurtado.
  </Card>

  <Card title="WhatsApp" href="/enviando/whatsapp" icon="whatsapp">
    Notificação por WhatsApp com template personalizado.
  </Card>

  <Card title="Voz" href="/enviando/voz" icon="phone">
    Chamada de voz automatizada.
  </Card>

  <Card title="Carta" href="/enviando/carta" icon="envelope-open-text">
    Carta física registrada via Correios.
  </Card>

  <Card title="Multicanal" href="/enviando/multicanal" icon="layer-group">
    Combine vários canais em uma única requisição.
  </Card>
</CardGroup>