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

# Resumen

> Administra canales de WhatsApp mediante /api/newsletter/*

**Auth:** `TokenAccount` o `TokenInstance` en cada ruta. Cada llamada valida la propiedad de la instancia.

Esta sección cubre las rutas `/api/newsletter/*` para crear canales, listar suscripciones, obtener detalles, seguir y dejar de seguir. Los canales tienen JIDs que terminan en `@newsletter` (diferentes de los JIDs `@g.us` de los grupos).

## Endpoints

| Método | Ruta                               | Función                                             |
| ------ | ---------------------------------- | --------------------------------------------------- |
| POST   | `/api/newsletter/create/:instance` | [Crear canal](/es/api/newsletter/create)            |
| GET    | `/api/newsletter/list/:instance`   | [Listar canales suscritos](/es/api/newsletter/list) |
| GET    | `/api/newsletter/info/:instance`   | [Información del canal](/es/api/newsletter/info)    |
| POST   | `/api/newsletter/join/:instance`   | [Suscribirse](/es/api/newsletter/join)              |
| DELETE | `/api/newsletter/leave/:instance`  | [Cancelar suscripción](/es/api/newsletter/leave)    |

## Identificadores aceptados

Los endpoints `info`, `join` y `leave` aceptan:

| Forma           | Ejemplo                                           |
| --------------- | ------------------------------------------------- |
| JID             | `120363422585881117@newsletter`                   |
| Enlace completo | `https://whatsapp.com/channel/120363422585881117` |
| Solo el código  | `120363422585881117`                              |

## Modelo `NewsletterChannel`

| Campo             | Tipo    | Descripción                                                          |
| ----------------- | ------- | -------------------------------------------------------------------- |
| `jid`             | string  | `<id>@newsletter`                                                    |
| `state`           | string  | `active`, `suspended`, `geosuspended`                                |
| `name`            | string  | Nombre del canal                                                     |
| `description`     | string  | Puede estar vacía                                                    |
| `inviteLink`      | string? | `https://whatsapp.com/channel/<id>` (solo administradores / creador) |
| `subscriberCount` | int     | Puede ser `0` si es desconocido                                      |
| `pictureUrl`      | string? | URL temporal del CDN de WhatsApp                                     |

## Estados del canal

| Estado         | Significado                                                             |
| -------------- | ----------------------------------------------------------------------- |
| `active`       | Canal operativo, aceptando publicaciones y nuevos seguidores            |
| `suspended`    | Canal suspendido (violación de políticas), visible pero sin interacción |
| `geosuspended` | Canal no disponible en tu región                                        |

## Envoltorio de error

```json theme={null}
{
  "success": false,
  "error": { "message": "newsletter not found" }
}
```

## Soporte del cliente WhatsMeow

<Warning>
  Algunas rutas dependen de funciones del cliente WhatsMeow que pueden no estar disponibles en ciertas builds. Cuando eso ocurre, el servidor devuelve **HTTP 501** con mensajes específicos:

  * `WhatsApp client does not support newsletter creation`
  * `WhatsApp client does not support listing newsletters`
  * `WhatsApp client does not support FollowNewsletter`
  * `WhatsApp client does not support UnfollowNewsletter`
</Warning>

## Referencia de errores (resumen)

| HTTP | Mensaje                                                                              |
| ---- | ------------------------------------------------------------------------------------ |
| 400  | `The 'name' field is required`                                                       |
| 400  | `The 'identifier' query parameter is required (JID @newsletter or invite link/code)` |
| 400  | `Invalid newsletter identifier (use JID @newsletter or invite link/code)`            |
| 400  | `Instance is not connected to WhatsApp`                                              |
| 404  | `newsletter not found`                                                               |
| 500  | `failed to create newsletter: <reason>`                                              |
| 500  | `failed to follow newsletter: <reason>`                                              |
| 500  | `failed to leave newsletter: <reason>`                                               |
| 501  | `WhatsApp client does not support <method>`                                          |

## Siguiente

<CardGroup cols={2}>
  <Card title="Crear canal" icon="bullhorn" href="/es/api/newsletter/create">
    Crea un nuevo canal vinculado a la cuenta.
  </Card>

  <Card title="Listar canales" icon="list" href="/es/api/newsletter/list">
    Devuelve los canales suscritos.
  </Card>
</CardGroup>