Channel metadata

curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/newsletter/metadata/{newsletterId} \
  --header 'Client-Token: <api-key>'

import requests

url = "https://api.z-api.io/instances/{instanceId}/token/{token}/newsletter/metadata/{newsletterId}"

headers = {"Client-Token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'Client-Token': '<api-key>'}};

fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/newsletter/metadata/{newsletterId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.z-api.io/instances/{instanceId}/token/{token}/newsletter/metadata/{newsletterId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Client-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.z-api.io/instances/{instanceId}/token/{token}/newsletter/metadata/{newsletterId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Client-Token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/newsletter/metadata/{newsletterId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Client-Token"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "creationTime": 123,
  "state": "<string>",
  "name": "<string>",
  "description": "<string>",
  "subscribersCount": "<string>",
  "inviteLink": "<string>",
  "verification": "<string>",
  "picture": "<string>",
  "preview": "<string>",
  "viewMetadata": {
    "mute": "<string>",
    "role": "<string>"
  },
  "subscribers": [
    {
      "id": "<string>",
      "phoneNumber": "<string>",
      "displayName": "<string>",
      "username": "<string>",
      "role": "<string>",
      "followTime": 123,
      "adminProfile": {
        "id": "<string>",
        "name": "<string>",
        "pictureDirectPath": "<string>"
      }
    }
  ]
}

GET

instances

{instanceId}

token

{token}

newsletter

metadata

{newsletterId}

Channel metadata

curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/newsletter/metadata/{newsletterId} \
  --header 'Client-Token: <api-key>'

import requests

url = "https://api.z-api.io/instances/{instanceId}/token/{token}/newsletter/metadata/{newsletterId}"

headers = {"Client-Token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'Client-Token': '<api-key>'}};

fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/newsletter/metadata/{newsletterId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.z-api.io/instances/{instanceId}/token/{token}/newsletter/metadata/{newsletterId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Client-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.z-api.io/instances/{instanceId}/token/{token}/newsletter/metadata/{newsletterId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Client-Token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/newsletter/metadata/{newsletterId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Client-Token"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "creationTime": 123,
  "state": "<string>",
  "name": "<string>",
  "description": "<string>",
  "subscribersCount": "<string>",
  "inviteLink": "<string>",
  "verification": "<string>",
  "picture": "<string>",
  "preview": "<string>",
  "viewMetadata": {
    "mute": "<string>",
    "role": "<string>"
  },
  "subscribers": [
    {
      "id": "<string>",
      "phoneNumber": "<string>",
      "displayName": "<string>",
      "username": "<string>",
      "role": "<string>",
      "followTime": 123,
      "adminProfile": {
        "id": "<string>",
        "name": "<string>",
        "pictureDirectPath": "<string>"
      }
    }
  ]
}

Overview

This method returns the channel metadata with all the channel information and its view settings.

Attributes

string

required

Your instance ID. Available in the Z-API panel under Instances.

string

required

Your Z-API instance token.

Path

Channel ID

Query Parameters

boolean

When sent as true, includes the subscribers field in the response with the channel’s list of subscribers. Default value is false.

Response

200

string

Channel ID

number

Channel creation timestamp

string

Channel state (ACTIVE or NON_EXISTING)

string

Channel name

string

Channel description

string

Number of channel subscribers

string

Channel invite link

string

Verification status (VERIFIED or UNVERIFIED)

string

Channel image URL

string

Channel preview image URL

object

Channel view information

Show Properties

string

Channel mute status (ON or OFF)

string

User role in the channel (OWNER or SUBSCRIBER)

array

List with up to 9 channel subscribers. Only returned when the mustGetSubscribers parameter is sent as true.

Show Properties

string

Subscriber ID (can be a phone number or a @lid)

string

Subscriber’s phone number, when available

string

Subscriber’s display name, when available

string

Subscriber’s username, when available

string

Subscriber’s role in the channel (OWNER, ADMIN or SUBSCRIBER)

number

Timestamp of when the user started following the channel, when available

object

Subscriber’s admin profile information, when they are an admin of the channel

Show Properties

string

Admin ID

string

Admin name

string

Admin’s profile picture path, when available

{
  "id": "999999999999999999@newsletter",
  "creationTime": 1695124988,
  "state": "ACTIVE",
  "name": "Channel name",
  "description": "Description",
  "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
    }
  ]
}

The channel ID must always contain the @newsletter suffix, as this is the standard used by WhatsApp.

WhatsApp only returns subscribers who are in the requester’s contact list, and the requester must be an admin of the channel. In addition, this list returns at most 9 subscribers, the same limit shown on the channel info screen in WhatsApp Web. To get the complete list of subscribers, use the List channel subscribers endpoint.

405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.

​Overview

​Attributes

​Header

​Path

​Query Parameters

​Response

​200

​405

​415

Overview

Attributes

Header

Path

Query Parameters

Response

200

405

415