Channel metadata
Newsletter
Channel metadata
Returns the channel metadata with all information
GET
Channel metadata
Overview
This method returns the channel metadata with all the channel information and its view settings.Attributes
Header
string
required
Your instance ID. Available in the Z-API panel under Instances.
string
required
Your Z-API instance token.
Path
string
required
Channel ID
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
The channel ID must always contain the @newsletter suffix, as this is the standard used by WhatsApp.