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

# Newsletter info

> Returns a newsletter's details by its `id`.



## OpenAPI

````yaml /en/api-reference/openapi.json get /newsletters/info
openapi: 3.1.0
info:
  title: Zapfy API
  description: >-
    Multi-tenant WhatsApp API. Send messages and manage webhooks through a
    single surface.
  version: 1.0.0
servers:
  - url: https://api.zapfy.io/v1
security:
  - accountToken: []
paths:
  /newsletters/info:
    get:
      tags:
        - Newsletters
      summary: Newsletter info
      description: Returns a newsletter's details by its `id`.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/NewsletterId'
          description: Newsletter id.
          example: 120363012345678901@newsletter
      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:
    NewsletterId:
      type: string
      description: >-
        Newsletter id (WhatsApp Channel): the same opaque value returned by GET
        /newsletters (e.g. `...@newsletter`). Use it exactly as received.
      example: 120363012345678901@newsletter
    Newsletter:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/NewsletterId'
        state:
          type: object
          description: Channel state.
          properties:
            type:
              type: string
              enum:
                - ACTIVE
                - SUSPENDED
                - GEOSUSPENDED
              description: '`ACTIVE`, `SUSPENDED`, `GEOSUSPENDED` (region-suspended).'
              example: ACTIVE
        threadMetadata:
          type: object
          description: Facts about the channel itself (same for anyone who sees it).
          properties:
            creationTime:
              type: string
              description: When the channel was created (epoch).
              example: '1699999999'
            inviteCode:
              type: string
              description: Channel invite code.
              example: 0029Va...
            name:
              allOf:
                - $ref: '#/components/schemas/NewsletterText'
              description: Channel name.
            description:
              allOf:
                - $ref: '#/components/schemas/NewsletterText'
              description: Channel description.
            subscribersCount:
              type: integer
              description: Subscriber count.
              example: 1280
            verification:
              type: string
              enum:
                - VERIFIED
                - UNVERIFIED
              description: Channel verification badge.
              example: VERIFIED
            picture:
              type:
                - object
                - 'null'
              properties:
                url:
                  type: string
                  description: Image URL.
                  example: https://cdn.whatsapp.net/...
                id:
                  type: string
                  description: Image id.
                  example: pic-1
                type:
                  type: string
                  description: Image type (e.g. `image`, `preview`).
                  example: preview
                directPath:
                  type: string
                  description: WhatsApp internal direct path.
                  example: /v/t.jpg
                hash:
                  type: string
                  description: Image hash.
                  example: aGFzaA==
              description: Channel profile picture (`null` when absent).
            preview:
              type:
                - object
                - 'null'
              properties:
                url:
                  type: string
                  description: Image URL.
                  example: https://cdn.whatsapp.net/...
                id:
                  type: string
                  description: Image id.
                  example: pic-1
                type:
                  type: string
                  description: Image type (e.g. `image`, `preview`).
                  example: preview
                directPath:
                  type: string
                  description: WhatsApp internal direct path.
                  example: /v/t.jpg
                hash:
                  type: string
                  description: Image hash.
                  example: aGFzaA==
              description: Profile picture thumbnail (`null` when absent).
            settings:
              type: object
              description: Channel settings.
              properties:
                reactionCodes:
                  type: object
                  description: Reactions allowed in the channel.
                  properties:
                    value:
                      type: string
                      enum:
                        - ALL
                        - BASIC
                        - NONE
                        - BLOCKLIST
                      description: Reaction mode.
                      example: ALL
        viewerMetadata:
          type:
            - object
            - 'null'
          description: >-
            Your relationship with the channel (`null` when not applicable, e.g.
            a channel you don't follow).
          properties:
            mute:
              type: string
              enum:
                - 'ON'
                - 'OFF'
              description: Whether you muted the channel.
              example: 'OFF'
            role:
              type: string
              enum:
                - OWNER
                - ADMIN
                - SUBSCRIBER
                - GUEST
              description: Your role in the channel.
              example: SUBSCRIBER
    NewsletterText:
      type: object
      description: Versioned text (the channel keeps its edit history).
      properties:
        text:
          type: string
          description: Current text.
          example: Meu Canal
        id:
          type: string
          description: Id of this version of the text.
          example: n-1
        updateTime:
          type: string
          description: When the text was last updated (epoch).
          example: '1700000000'
  responses:
    NewsletterDetail:
      description: Newsletter.
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                $ref: '#/components/schemas/Newsletter'
    Error:
      description: Error.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: Instance not found
  securitySchemes:
    accountToken:
      type: http
      scheme: bearer
      description: Account token (`zpfy_acct_...`) — manages instances and webhooks.
    instanceToken:
      type: http
      scheme: bearer
      description: Instance token (`zpfy_inst_...`) — sends messages.

````