# Canais similares

`POST /newsletter/similar`

Pasta: **Newsletters e Canais**

## Autenticação

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

## Descrição

# Canais similares

Lista canais semelhantes a um canal de referência. Use em telas de “canais relacionados” ou recomendações a partir de um canal que o usuário já segue.

## Endpoint

`POST {{baseUrl}}/newsletter/similar`

## Autenticação

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

## Corpo da requisição

| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| `jid` | string | Sim | JID do canal de referência (`...@newsletter`). |
| `limit` | integer | Não | Quantidade máxima de canais similares. |
| `country_codes` | array<string> | Não | Filtro de países ISO-2 (ex.: `BR`). |

## Exemplo de Requisição

```bash
curl --request POST '{{baseUrl}}/newsletter/similar' \
  --header 'token: {{token}}' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "jid": "123456789012345@newsletter",
  "limit": 20,
  "country_codes": ["BR"]
}'
```

## Resposta de Sucesso

```json
{
  "success": true,
  "newsletters": [],
  "page_info": {
    "has_next_page": false,
    "end_cursor": ""
  }
}
```

## 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.
- `501 Not Implemented`: recurso exclusivo de instâncias **mobile** (`connection_mode=mobile`); a instância atual está em modo companion.

## Corpo (exemplo)

```json
{
  "jid": "123456789012345@newsletter",
  "limit": 20,
  "country_codes": ["BR"]
}
```

## cURL

```bash
curl -X POST "{{baseUrl}}/newsletter/similar" \
  -H "token: {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "jid": "123456789012345@newsletter",
  "limit": 20,
  "country_codes": ["BR"]
}'
```

---

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