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

# Metadata do canal

> Retorna o metadata do canal com todas as informações

## Conceituação

Este método retorna o metadata do canal com todas as informações do canal e de sua visualização.

***

## Atributos

### Header

<ParamField path="instanceId" type="string" required>
  ID da sua instância. Disponível no painel Z-API em **Instâncias**.
</ParamField>

<ParamField path="token" type="string" required>
  Token da sua instância Z-API.
</ParamField>

### Path

<ParamField path="newsletterId" type="string" required>
  ID do canal
</ParamField>

### Query Parameters

<ParamField query="mustGetSubscribers" type="boolean">
  Quando enviado como `true`, inclui na resposta o campo `subscribers` com a lista de seguidores do canal. O valor padrão é `false`.
</ParamField>

***

## Response

### 200

<ResponseField name="id" type="string">
  ID do canal
</ResponseField>

<ResponseField name="creationTime" type="number">
  Timestamp de criação do canal
</ResponseField>

<ResponseField name="state" type="string">
  Estado do canal (ACTIVE ou NON\_EXISTING)
</ResponseField>

<ResponseField name="name" type="string">
  Nome do canal
</ResponseField>

<ResponseField name="description" type="string">
  Descrição do canal
</ResponseField>

<ResponseField name="subscribersCount" type="string">
  Número de inscritos do canal
</ResponseField>

<ResponseField name="inviteLink" type="string">
  Link de convite do canal
</ResponseField>

<ResponseField name="verification" type="string">
  Status de verificação (VERIFIED ou UNVERIFIED)
</ResponseField>

<ResponseField name="picture" type="string">
  URL da imagem do canal
</ResponseField>

<ResponseField name="preview" type="string">
  URL da imagem de preview do canal
</ResponseField>

<ResponseField name="viewMetadata" type="object">
  Informações de visualização do canal

  <Expandable title="Propriedades">
    <ResponseField name="mute" type="string">
      Status de mute do canal (ON ou OFF)
    </ResponseField>

    <ResponseField name="role" type="string">
      Papel do usuário no canal (OWNER ou SUBSCRIBER)
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="subscribers" type="array">
  Lista com até 9 seguidores do canal. Só é retornada quando o parâmetro `mustGetSubscribers` é enviado como `true`.

  <Expandable title="Propriedades">
    <ResponseField name="id" type="string">
      ID do seguidor (pode ser um número de telefone ou um `@lid`)
    </ResponseField>

    <ResponseField name="phoneNumber" type="string">
      Número de telefone do seguidor, quando disponível
    </ResponseField>

    <ResponseField name="displayName" type="string">
      Nome de exibição do seguidor, quando disponível
    </ResponseField>

    <ResponseField name="username" type="string">
      Nome de usuário do seguidor, quando disponível
    </ResponseField>

    <ResponseField name="role" type="string">
      Papel do seguidor no canal (OWNER, ADMIN ou SUBSCRIBER)
    </ResponseField>

    <ResponseField name="followTime" type="number">
      Timestamp de quando o usuário começou a seguir o canal, quando disponível
    </ResponseField>

    <ResponseField name="adminProfile" type="object">
      Informações do perfil de admin do seguidor, quando ele for admin do canal

      <Expandable title="Propriedades">
        <ResponseField name="id" type="string">
          ID do admin
        </ResponseField>

        <ResponseField name="name" type="string">
          Nome do admin
        </ResponseField>

        <ResponseField name="pictureDirectPath" type="string">
          Caminho da imagem de perfil do admin, quando disponível
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
  "id": "999999999999999999@newsletter",
  "creationTime": 1695124988,
  "state": "ACTIVE",
  "name": "Nome do canal",
  "description": "Descrição",
  "subscribersCount": "150",
  "inviteLink": "https://whatsapp.com/channel/...",
  "verification": "VERIFIED",
  "picture": "https://...",
  "preview": "https://...",
  "viewMetadata": {
    "mute": "OFF",
    "role": "OWNER"
  },
  "subscribers": [
    {
      "id": "199690293383294@lid",
      "phoneNumber": null,
      "displayName": null,
      "username": null,
      "role": "SUBSCRIBER",
      "followTime": null,
      "adminProfile": null
    }
  ]
}
```

<Info>
  O ID do canal sempre deve conter o sufixo **@newsletter**, pois esse é o padrão utilizado pelo próprio WhatsApp.
</Info>

<Info>
  O WhatsApp só retorna os seguidores que estiverem na lista de contatos de quem realizou a requisição, e é necessário que quem realiza a requisição seja admin do canal. Além disso, essa listagem retorna no máximo 9 seguidores, o mesmo limite exibido na tela de informações do canal no WhatsApp Web. Para obter a listagem completa de seguidores, utilize o endpoint [Listar seguidores do canal](/newsletter/newsletter-subscribers).
</Info>

### 405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

### 415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o "Content-Type" do objeto que você está enviando, em sua grande maioria "application/json".