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

# Inscrever na newsletter

> Inscreve a instância em uma newsletter pelo seu `id`.



## OpenAPI

````yaml /pt-br/api-reference/openapi.json post /newsletters/subscribe
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/subscribe:
    post:
      tags:
        - Newsletters
      summary: Inscrever na newsletter
      description: Inscreve a instância em uma newsletter pelo seu `id`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscribeNewsletterBody'
      responses:
        '200':
          $ref: '#/components/responses/ActionDone'
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '502':
          $ref: '#/components/responses/Error'
      security:
        - instanceToken: []
components:
  schemas:
    SubscribeNewsletterBody:
      type: object
      required:
        - id
      properties:
        id:
          $ref: '#/components/schemas/NewsletterId'
    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
    SuccessResult:
      type: object
      properties:
        success:
          type: boolean
          example: true
          description: Sempre `true` quando a ação foi concluída.
  responses:
    ActionDone:
      description: Ação executada.
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                $ref: '#/components/schemas/SuccessResult'
    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.

````