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

# Resolve invite

> Resolves newsletter metadata from an invite key (the code portion of a channel invite link).



## OpenAPI

````yaml openapi.evolution-go.json POST /newsletter/link
openapi: 3.1.0
info:
  title: Evolution GO Layer
  version: 1.0.0
  description: >-
    Pilot Status API Layer — Evolution GO. Base URL
    `https://pilotstatus.com.br/api/layer/evolution-go`. Authenticate with the
    `apikey` header (your Pilot Status `ps_` key) or `Authorization: Bearer`.
    Instance/session endpoints are NOT available through the layer.
servers:
  - url: https://pilotstatus.com.br/api/layer/evolution-go
security:
  - apiKey: []
tags:
  - name: Call (voice)
  - name: Chat
  - name: Community
  - name: Group
  - name: Label
  - name: Message
  - name: Newsletter / Channels
  - name: Send (load-balanced)
  - name: User / Contacts
paths:
  /newsletter/link:
    post:
      tags:
        - Newsletter / Channels
      summary: Resolve invite
      description: >-
        Resolves newsletter metadata from an invite key (the code portion of a
        channel invite link).
      operationId: post__newsletter_link
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                key:
                  type: string
                  description: >-
                    Invite key from the channel link (e.g. the part after
                    `whatsapp.com/channel/`).
                  example: 0029VaAbCdEfGhIjKlMnOpQr
              required:
                - key
      responses:
        '200':
          description: Success — provider-native response body.
          content:
            application/json:
              schema:
                type: object
                description: >-
                  Handler wraps the types.NewsletterMetadata resolved from an
                  invite key in a { message, data } envelope.
                properties:
                  message:
                    type: string
                    description: Always "success" on HTTP 200.
                  data:
                    type: object
                    description: Newsletter metadata resolved from the invite key/link.
                    properties:
                      id:
                        type: string
                        description: Newsletter JID.
                      state:
                        type: object
                        properties:
                          type:
                            type: string
                            description: active | suspended | geosuspended.
                      thread_metadata:
                        type: object
                        properties:
                          creation_time:
                            type: string
                            description: Unix seconds as string.
                          invite:
                            type: string
                          name:
                            type: object
                            properties:
                              text:
                                type: string
                              id:
                                type: string
                              update_time:
                                type: string
                                description: Unix microseconds as string.
                          description:
                            type: object
                            properties:
                              text:
                                type: string
                              id:
                                type: string
                              update_time:
                                type: string
                          subscribers_count:
                            type: string
                            description: Integer as string.
                          verification:
                            type: string
                            description: verified | unverified.
                          picture:
                            type: object
                            description: Full-res picture info (nullable).
                            properties:
                              url:
                                type: string
                              id:
                                type: string
                              type:
                                type: string
                              direct_path:
                                type: string
                              hash:
                                type: string
                          preview:
                            type: object
                            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: all | basic | none | blocklist.
                      viewer_metadata:
                        type: object
                        description: >-
                          This account's mute/role for the newsletter (nullable;
                          typically null before joining).
                        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: '1718000000'
                    invite: 0029Va8ZfkL1234567890abcd
                    name:
                      text: WhatsApp Channel Demo
                      id: '1718000000111222'
                      update_time: '1718000000111222'
                    description:
                      text: Official demo channel.
                      id: '1718000000111223'
                      update_time: '1718000000111223'
                    subscribers_count: '15320'
                    verification: verified
                    picture:
                      url: >-
                        https://pps.whatsapp.net/v/t61.24694-24/newsletter_pic.jpg
                      id: '1718000000'
                      type: image
                      direct_path: /v/t61.24694-24/newsletter_pic.jpg
                      hash: q1w2e3r4t5y6u7i8o9p0YWJjZGU=
                    preview:
                      url: >-
                        https://pps.whatsapp.net/v/t61.24694-24/newsletter_preview.jpg
                      id: '1718000000'
                      type: preview
                      direct_path: /v/t61.24694-24/newsletter_preview.jpg
                      hash: q1w2e3r4t5y6u7i8o9p0YWJjZGU=
                    settings:
                      reaction_codes:
                        value: all
                  viewer_metadata: null
        default:
          description: Error — provider or layer error.
          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>`.

````