> ## 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.

# Criar canal

> Cria um novo canal (newsletter) vinculado à conta conectada

**Auth:** `TokenAccount` ou `TokenInstance` • **Rate-limit:** `Global` (100/min) • **Idempotente:** não (cada chamada cria um canal novo)

## Descrição

Cria um novo canal. A conta criadora torna-se automaticamente admin / dono. O serviço aceita os termos de uso (TOS) automaticamente quando o WhatsApp os exigir, fazendo um retry transparente após `AcceptTOSNotice`.

## Exemplos

### Mínimo

Cria um canal apenas com o `name` obrigatório. O canal nasce sem descrição nem foto, mas já recebe um `jid` permanente e um `inviteLink` no response.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/newsletter/create/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "Notícias Importantes"
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/newsletter/create/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      name: "Notícias Importantes"
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/newsletter/create/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "name": "Notícias Importantes"
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
      "strings"
  )

  func main() {
      body := strings.NewReader(`{
          "name": "Notícias Importantes"
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/newsletter/create/"+os.Getenv("Instance_Name"), body)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      req.Header.Set("Content-Type", "application/json")
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

### Completo

Cria o canal já com `description` e `picture` (URL pública). O servidor baixa a imagem, converte para JPEG 640x640 e define como foto inicial do canal.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/newsletter/create/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "Notícias Importantes",
      "description": "Atualizações diárias",
      "picture": "https://exemplo.com/logo.png"
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/newsletter/create/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      name:        "Notícias Importantes",
      description: "Atualizações diárias",
      picture:     "https://exemplo.com/logo.png"
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/newsletter/create/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "name":        "Notícias Importantes",
          "description": "Atualizações diárias",
          "picture":     "https://exemplo.com/logo.png"
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
      "strings"
  )

  func main() {
      body := strings.NewReader(`{
          "name":        "Notícias Importantes",
          "description": "Atualizações diárias",
          "picture":     "https://exemplo.com/logo.png"
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/newsletter/create/"+os.Getenv("Instance_Name"), body)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      req.Header.Set("Content-Type", "application/json")
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

### Com foto base64

Mesmo fluxo, mas a foto vai inline como `data:` URL com base64 em vez de URL externa. Útil quando a imagem é gerada localmente ou está atrás de autenticação.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/newsletter/create/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "Canal de Testes",
      "picture": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg=="
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/newsletter/create/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      name:    "Canal de Testes",
      picture: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg=="
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/newsletter/create/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "name":    "Canal de Testes",
          "picture": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg=="
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
      "strings"
  )

  func main() {
      body := strings.NewReader(`{
          "name":    "Canal de Testes",
          "picture": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg=="
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/newsletter/create/"+os.Getenv("Instance_Name"), body)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      req.Header.Set("Content-Type", "application/json")
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

## Resposta de sucesso

A resposta inclui o `channel.jid` permanente do canal recém-criado (use-o como `identifier` nas chamadas subsequentes), o `inviteLink` pronto para compartilhar e o `state` atual. `subscriberCount` começa em `0` e `pictureUrl` vem `null` quando a foto ainda não foi processada ou não foi enviada.

```json 200 OK theme={null}
{
  "success": true,
  "message": "Newsletter created successfully",
  "channel": {
    "jid": "120363422585881117@newsletter",
    "state": "active",
    "name": "Notícias Importantes",
    "description": "Atualizações diárias",
    "inviteLink": "https://whatsapp.com/channel/120363422585881117",
    "subscriberCount": 0,
    "pictureUrl": null
  }
}
```

## Parâmetros de rota

<ParamField path="instance" type="string" required>
  Nome da instância.
</ParamField>

## Headers

<ParamField header="token" type="string" required>
  `TokenAccount` ou `TokenInstance`.
</ParamField>

<ParamField header="Content-Type" type="string" required>
  `application/json`
</ParamField>

## Request body

<ParamField body="name" type="string" required>
  Nome do canal. Não pode ser vazio.
</ParamField>

<ParamField body="description" type="string">
  Descrição / bio do canal.
</ParamField>

<ParamField body="picture" type="string">
  URL ou base64. Convertida para JPEG (máx 640×640). Falha apenas loga warning, o canal é criado sem foto.
</ParamField>

## Notas

<Note>
  * Em alguns países, criar canal exige **conta WhatsApp Business verificada**. Se o servidor rejeitar, o erro do WhatsMeow é propagado.
  * Guarde o `channel.jid` retornado, links de convite podem ser revogados, mas o JID é permanente.
  * A criação **não é idempotente**: retry automático em timeout de rede pode duplicar o canal.
  * A foto é redimensionada para 640x640 mantendo aspect ratio (formatos aceitos: JPEG, PNG, WebP, GIF).
</Note>

## Erros

| HTTP | Mensagem                                                                                |
| ---- | --------------------------------------------------------------------------------------- |
| 400  | `The 'name' field is required`                                                          |
| 400  | `Instance is not connected to WhatsApp`                                                 |
| 500  | `failed to create newsletter: <reason>`                                                 |
| 501  | `WhatsApp client does not support newsletter creation (CreateNewsletter not available)` |
| 501  | `failed to create newsletter (terms may need acceptance)`                               |

Envelope:

```json theme={null}
{
  "success": false,
  "error": { "message": "The 'name' field is required" }
}
```

## Próximo

<CardGroup cols={2}>
  <Card title="Info do canal" icon="circle-info" href="/pt/api/newsletter/info">
    Confirmar dados após a criação.
  </Card>

  <Card title="Listar canais" icon="list" href="/pt/api/newsletter/list">
    Ver os canais inscritos.
  </Card>
</CardGroup>