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

# Criar newsletter

> Cria uma newsletter com nome e descrição opcional.



## OpenAPI

````yaml /pt-br/api-reference/openapi.json post /newsletters/create
openapi: 3.1.0
info:
  title: Zapfy API
  description: >-
    API de WhatsApp multi-tenant. Envie mensagens e gerencie webhooks por uma
    superfície única.
  version: 1.0.0
servers:
  - url: https://api.zapfy.io/v1
security:
  - accountToken: []
paths:
  /newsletters/create:
    post:
      tags:
        - Newsletters
      summary: Criar newsletter
      description: Cria uma newsletter com nome e descrição opcional.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateNewsletterBody'
      responses:
        '200':
          $ref: '#/components/responses/NewsletterDetail'
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '502':
          $ref: '#/components/responses/Error'
      security:
        - instanceToken: []
components:
  schemas:
    CreateNewsletterBody:
      type: object
      required:
        - name
      properties:
        name:
          type: string
          description: Nome da newsletter.
          example: Meu Canal
        description:
          type: string
          description: Descrição da newsletter (opcional).
          example: Avisos
    Newsletter:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/NewsletterId'
        state:
          type: object
          description: Estado do canal.
          properties:
            type:
              type: string
              enum:
                - ACTIVE
                - SUSPENDED
                - GEOSUSPENDED
              description: >-
                `ACTIVE` = ativo, `SUSPENDED` = suspenso, `GEOSUSPENDED` =
                suspenso por região.
              example: ACTIVE
        threadMetadata:
          type: object
          description: Dados do canal em si (iguais para qualquer um que veja).
          properties:
            creationTime:
              type: string
              description: Quando o canal foi criado (epoch).
              example: '1699999999'
            inviteCode:
              type: string
              description: Código de convite do canal.
              example: 0029Va...
            name:
              allOf:
                - $ref: '#/components/schemas/NewsletterText'
              description: Nome do canal.
            description:
              allOf:
                - $ref: '#/components/schemas/NewsletterText'
              description: Descrição do canal.
            subscribersCount:
              type: integer
              description: Número de inscritos.
              example: 1280
            verification:
              type: string
              enum:
                - VERIFIED
                - UNVERIFIED
              description: Selo de verificação do canal.
              example: VERIFIED
            picture:
              type:
                - object
                - 'null'
              properties:
                url:
                  type: string
                  description: URL da imagem.
                  example: https://cdn.whatsapp.net/...
                id:
                  type: string
                  description: Id da imagem.
                  example: pic-1
                type:
                  type: string
                  description: 'Tipo da imagem (ex: `image`, `preview`).'
                  example: preview
                directPath:
                  type: string
                  description: Caminho direto interno do WhatsApp.
                  example: /v/t.jpg
                hash:
                  type: string
                  description: Hash da imagem.
                  example: aGFzaA==
              description: Imagem de perfil do canal (`null` quando não há).
            preview:
              type:
                - object
                - 'null'
              properties:
                url:
                  type: string
                  description: URL da imagem.
                  example: https://cdn.whatsapp.net/...
                id:
                  type: string
                  description: Id da imagem.
                  example: pic-1
                type:
                  type: string
                  description: 'Tipo da imagem (ex: `image`, `preview`).'
                  example: preview
                directPath:
                  type: string
                  description: Caminho direto interno do WhatsApp.
                  example: /v/t.jpg
                hash:
                  type: string
                  description: Hash da imagem.
                  example: aGFzaA==
              description: Miniatura da imagem de perfil (`null` quando não há).
            settings:
              type: object
              description: Configurações do canal.
              properties:
                reactionCodes:
                  type: object
                  description: Reações permitidas no canal.
                  properties:
                    value:
                      type: string
                      enum:
                        - ALL
                        - BASIC
                        - NONE
                        - BLOCKLIST
                      description: Modo de reações.
                      example: ALL
        viewerMetadata:
          type:
            - object
            - 'null'
          description: >-
            Sua relação com o canal (`null` quando não aplicável, ex: canal que
            você não segue).
          properties:
            mute:
              type: string
              enum:
                - 'ON'
                - 'OFF'
              description: Se você silenciou o canal.
              example: 'OFF'
            role:
              type: string
              enum:
                - OWNER
                - ADMIN
                - SUBSCRIBER
                - GUEST
              description: Seu papel no canal.
              example: SUBSCRIBER
    NewsletterId:
      type: string
      description: >-
        id da newsletter (canal do WhatsApp): o MESMO valor opaco devolvido por
        GET /newsletters (ex.: `...@newsletter`). Use exatamente como recebido.
      example: 120363012345678901@newsletter
    NewsletterText:
      type: object
      description: Texto versionado (o canal guarda o histórico de alterações).
      properties:
        text:
          type: string
          description: Texto atual.
          example: Meu Canal
        id:
          type: string
          description: Id desta versão do texto.
          example: n-1
        updateTime:
          type: string
          description: Quando o texto foi atualizado (epoch).
          example: '1700000000'
  responses:
    NewsletterDetail:
      description: Newsletter.
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                $ref: '#/components/schemas/Newsletter'
    Error:
      description: Erro.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: Instance not found
  securitySchemes:
    accountToken:
      type: http
      scheme: bearer
      description: Token de conta (`zpfy_acct_...`) — gerencia instâncias e webhooks.
    instanceToken:
      type: http
      scheme: bearer
      description: Token de instância (`zpfy_inst_...`) — envia mensagens.

````