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

# Criar newsletter

> Cria uma nova newsletter (canal) com um nome e uma descrição opcional.



## OpenAPI

````yaml openapi.evolution-go.pt.json POST /newsletter/create
openapi: 3.1.0
info:
  title: Evolution GO Layer
  version: 1.0.0
  description: >-
    Camada de API do Pilot Status — Evolution GO. Base URL
    `https://pilotstatus.com.br/api/layer/evolution-go`. Autentique com o header
    `apikey` (sua chave `ps_` do Pilot Status) ou `Authorization: Bearer`.
    Endpoints de instância/sessão NÃO estão disponíveis na camada.
servers:
  - url: https://pilotstatus.com.br/api/layer/evolution-go
security:
  - apiKey: []
tags:
  - name: Chamada (voz)
  - name: Chat
  - name: Comunidade
  - name: Grupo
  - name: Etiqueta (label)
  - name: Mensagem
  - name: Newsletter / Canais
  - name: Envio (balanceado)
  - name: Usuário / Contatos
paths:
  /newsletter/create:
    post:
      tags:
        - Newsletter / Canais
      summary: Criar newsletter
      description: Cria uma nova newsletter (canal) com um nome e uma descrição opcional.
      operationId: post__newsletter_create
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Nome de exibição da newsletter (canal).
                  example: Pilot Status Updates
                description:
                  type: string
                  description: Descrição da newsletter exibida aos inscritos.
                  example: Official channel for product news and status.
              required:
                - name
      responses:
        '200':
          description: Sucesso — corpo de resposta nativo do provedor.
          content:
            application/json:
              schema:
                type: object
                description: >-
                  Handler wraps the whatsmeow types.NewsletterMetadata result in
                  a { message, data } envelope.
                properties:
                  message:
                    type: string
                    description: Always "success" on HTTP 200.
                  data:
                    type: object
                    description: >-
                      Newsletter (WhatsApp channel) metadata returned by
                      whatsmeow CreateNewsletter.
                    properties:
                      id:
                        type: string
                        description: Newsletter JID (server "newsletter").
                      state:
                        type: object
                        description: Wrapped newsletter state.
                        properties:
                          type:
                            type: string
                            description: >-
                              Newsletter state: active | suspended |
                              geosuspended.
                      thread_metadata:
                        type: object
                        description: Thread-level metadata for the newsletter.
                        properties:
                          creation_time:
                            type: string
                            description: >-
                              Creation time as Unix seconds (marshaled as
                              string).
                          invite:
                            type: string
                            description: Invite code for the newsletter link.
                          name:
                            type: object
                            description: Newsletter display name.
                            properties:
                              text:
                                type: string
                              id:
                                type: string
                                description: Server-side revision id of this field.
                              update_time:
                                type: string
                                description: >-
                                  Last update time as Unix microseconds
                                  (marshaled as string).
                          description:
                            type: object
                            description: Newsletter description.
                            properties:
                              text:
                                type: string
                              id:
                                type: string
                              update_time:
                                type: string
                                description: Unix microseconds as string.
                          subscribers_count:
                            type: string
                            description: Subscriber count (integer marshaled as string).
                          verification:
                            type: string
                            description: verified | unverified.
                          picture:
                            type: object
                            description: >-
                              Full-resolution profile picture info (null when no
                              picture set).
                            properties:
                              url:
                                type: string
                              id:
                                type: string
                              type:
                                type: string
                                description: e.g. "image" (full) or "preview" (thumbnail).
                              direct_path:
                                type: string
                              hash:
                                type: string
                                description: Base64-encoded hash bytes (null if absent).
                          preview:
                            type: object
                            description: Thumbnail profile picture info.
                            properties:
                              url:
                                type: string
                              id:
                                type: string
                              type:
                                type: string
                              direct_path:
                                type: string
                              hash:
                                type: string
                          settings:
                            type: object
                            properties:
                              reaction_codes:
                                type: object
                                properties:
                                  value:
                                    type: string
                                    description: >-
                                      Reactions mode: all | basic | none |
                                      blocklist.
                      viewer_metadata:
                        type: object
                        description: >-
                          This account's relationship to the newsletter (null if
                          not applicable).
                        properties:
                          mute:
                            type: string
                            description: on | off.
                          role:
                            type: string
                            description: subscriber | guest | admin | owner.
              example:
                message: success
                data:
                  id: 120363313361893999@newsletter
                  state:
                    type: active
                  thread_metadata:
                    creation_time: '1720526400'
                    invite: 0029Va8ZfkL1234567890abcd
                    name:
                      text: Pilot Status Updates
                      id: '1720526400123456'
                      update_time: '1720526400123456'
                    description:
                      text: Product news and status announcements.
                      id: '1720526400123457'
                      update_time: '1720526400123457'
                    subscribers_count: '0'
                    verification: unverified
                    picture: null
                    preview:
                      url: ''
                      id: ''
                      type: preview
                      direct_path: ''
                      hash: null
                    settings:
                      reaction_codes:
                        value: all
                  viewer_metadata:
                    mute: 'off'
                    role: owner
        default:
          description: Erro — erro do provedor ou da camada.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                  response:
                    type: object
              example:
                status: 400
                error: Bad Request
                message: Invalid payload
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: apikey
      description: >-
        Your Pilot Status API key (ps_...). Evolution GO also accepts
        `Authorization: Bearer <key>`.

````