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

# Get newsletter (channel) metadata

> Returns the channel metadata (name, description, subscribers count,
verification, picture, invite code, state). Provide exactly one of
`newsletter_id` or `invite`. Neither requires following the channel;
`viewer_metadata` is null when WhatsApp does not return viewer-specific metadata.




## OpenAPI

````yaml /openapi.yml get /newsletter/info
openapi: 3.0.0
info:
  title: WhatsApp API MultiDevice
  version: 9.7.0
  description: |
    This API is used for sending whatsapp via API.

    The web dashboard is a separate project (gowa-ui); the server downloads its
    latest release asset and serves it at `/` (or returns a JSON banner when
    APP_UI_ENABLED=false).

    Device scoping:
    - Send `X-Device-Id` on all device-scoped REST calls.
    - WebSocket: connect to `/ws?device_id=<id>`.
    - WebSocket auth (when basic auth is enabled): browsers cannot set an
      Authorization header on WebSocket connections, so also pass
      `&authorization=<base64(user:pass)>` in the query string. Use TLS in
      production since the credential is visible in the URL.
servers:
  - url: http://localhost:3000
security:
  - basicAuth: []
tags:
  - name: app
    description: Initial Connection to Whatsapp server
  - name: device
    description: Device management for multi-device support
  - name: user
    description: Getting information
  - name: send
    description: Send Message (Text/Image/File/Video).
  - name: message
    description: Message manipulation (revoke/react/update).
  - name: call
    description: Call management (reject incoming calls)
  - name: chat
    description: Chat conversations and messaging
  - name: group
    description: Group setting
  - name: newsletter
    description: newsletter setting
  - name: chatwoot
    description: Chatwoot integration for customer support
paths:
  /newsletter/info:
    get:
      tags:
        - newsletter
      summary: Get newsletter (channel) metadata
      description: >
        Returns the channel metadata (name, description, subscribers count,

        verification, picture, invite code, state). Provide exactly one of

        `newsletter_id` or `invite`. Neither requires following the channel;

        `viewer_metadata` is null when WhatsApp does not return viewer-specific
        metadata.
      operationId: getNewsletterInfo
      parameters:
        - $ref: '#/components/parameters/DeviceIdHeader'
        - name: newsletter_id
          in: query
          required: false
          schema:
            type: string
          example: 120363024512399999@newsletter
        - name: invite
          in: query
          required: false
          description: >-
            Channel invite link (https://whatsapp.com/channel/...) or just the
            code
          schema:
            type: string
          example: https://whatsapp.com/channel/0029Va4K0PZ5a245NkngBA2M
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NewsletterInfoResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInternalServer'
components:
  parameters:
    DeviceIdHeader:
      name: X-Device-Id
      in: header
      required: false
      description: >
        Device identifier for multi-device support. Required when multiple
        devices are registered.

        If only one device is registered, it will be used as the default.

        Can also be provided as `device_id` query parameter.
      schema:
        type: string
        example: my-device-id
  schemas:
    NewsletterInfoResponse:
      type: object
      properties:
        code:
          type: string
          example: SUCCESS
        message:
          type: string
          example: Success get newsletter info
        results:
          $ref: '#/components/schemas/Newsletter'
    ErrorBadRequest:
      type: object
      properties:
        code:
          type: string
          example: 400
          description: HTTP Status Code
        message:
          type: string
          example: field cannot be blank
          description: Detail error message
        results:
          type: object
          example: null
          description: additional data
    ErrorInternalServer:
      type: object
      properties:
        code:
          type: string
          example: INTERNAL_SERVER_ERROR
          description: SYSTEM_CODE_ERROR
        message:
          type: string
          example: you are not loggin
          description: Detail error message
        results:
          type: object
          example: null
          description: additional data
    Newsletter:
      type: object
      properties:
        id:
          type: string
          example: 120363144038483540@newsletter
        state:
          type: object
          properties:
            type:
              type: string
              example: active
        thread_metadata:
          type: object
          properties:
            creation_time:
              type: string
              example: '1688746895'
            invite:
              type: string
              example: 0029Va4K0PZ5a245NkngBA2M
            name:
              type: object
              properties:
                text:
                  type: string
                  example: WhatsApp
                id:
                  type: string
                  example: '1688746895480511'
                update_time:
                  type: string
                  example: '1688746895480511'
            description:
              type: object
              properties:
                text:
                  type: string
                  example: >-
                    WhatsApp's official channel. Follow for our latest feature
                    launches, updates, exclusive drops and more.
                id:
                  type: string
                  example: '1689653839450668'
                update_time:
                  type: string
                  example: '1689653839450668'
            subscribers_count:
              type: string
              example: '0'
            verification:
              type: string
              example: verified
            picture:
              type: object
              properties:
                url:
                  type: string
                  example: ''
                id:
                  type: string
                  example: '1707950960975554'
                type:
                  type: string
                  example: IMAGE
                direct_path:
                  type: string
                  example: >-
                    /v/t61.24694-24/416962407_970228831134395_8869146381947923973_n.jpg?ccb=11-4&oh=01_Q5AaIIvOIeu3l0HCZWILrmr-dGR_vXFqnhUeytw0-ojPc4hL&oe=670D95B1&_nc_sid=5e03e0&_nc_cat=110
            preview:
              type: object
              properties:
                url:
                  type: string
                  example: ''
                id:
                  type: string
                  example: '1707950960975554'
                type:
                  type: string
                  example: PREVIEW
                direct_path:
                  type: string
                  example: >-
                    /v/t61.24694-24/416962407_970228831134395_8869146381947923973_n.jpg?stp=dst-jpg_s192x192&ccb=11-4&oh=01_Q5AaIHO-DQklqm3q3awF7xwji_WAn9DkgZASQA0B2Ct0qbSa&oe=670D95B1&_nc_sid=5e03e0&_nc_cat=110
            settings:
              type: object
              properties:
                reaction_codes:
                  type: object
                  properties:
                    value:
                      type: string
                      example: ALL
        viewer_metadata:
          type: object
          nullable: true
          description: Null when viewer-specific metadata is unavailable.
          properties:
            mute:
              type: string
              example: 'off'
            role:
              type: string
              example: subscriber
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.