# Consultar canal por convite

`POST /newsletter/link`

Pasta: **Newsletters e Canais**

## Autenticação

```http
token: {{token}}
```

## Descrição

# Consultar canal por convite

Obtém as informações de um canal usando a chave ou o link de convite. É útil quando você ainda não conhece o JID do canal.

## Endpoint

`POST {{baseUrl}}/newsletter/link`

## Autenticação

Envie o token da instância no header `token: {{token}}`.

## Corpo da requisição

| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| `link` | string | Condicional | Link ou chave do convite. Obrigatório se `key` não for enviado. |
| `key` | string | Condicional | Alias de `link`; usado somente quando `link` está vazio. |

## Exemplo de Requisição

```bash
curl --request POST '{{baseUrl}}/newsletter/link' \
  --header 'token: {{token}}' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "link": "https://whatsapp.com/channel/AbCdEfGhIjKlMn"
}'
```

## Resposta de Sucesso

```json
{
  "success": true,
  "newsletter": {
    "jid": "120363123456789012@newsletter",
    "name": "Canal de Promoções"
  }
}
```

## Erros comuns

- `401 Unauthorized`: o header `token` não foi enviado ou é inválido.
- `400 Bad Request`: o JSON está malformado ou contém um identificador inválido.
- `500 Internal Server Error`: a conexão com o WhatsApp falhou ou a operação foi recusada.

## Observações

Envie `link` ou `key`. Se ambos forem enviados, `link` tem prioridade.

## Corpo (exemplo)

```json
{
  "link": "https://whatsapp.com/channel/AbCdEfGhIjKlMn"
}
```

## cURL

```bash
curl -X POST "{{baseUrl}}/newsletter/link" \
  -H "token: {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "link": "https://whatsapp.com/channel/AbCdEfGhIjKlMn"
}'
```

---

[Índice da pasta](./index.md) · [Índice geral](../index.md) · [UI](https://gozap.dev/docs?op=newsletters-e-canais/consultar-canal-por-convite)