Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
update-newsletter-description
Update channel description
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/update-newsletter-description \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "description": "<string>"
}
'
{
  "value": true
}

​
Overview

This method is responsible for changing the description of an existing channel.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Body

​
id
string
required
Channel ID with @newsletter suffix
​
description
string
required
New channel description

​
Request Body

{
  "id": "999999999999999999@newsletter",
  "description": "New channel description"
}

​
Response

​
201

​
value
boolean
true if successful, false if it failed
{
  "value": true
}
The channel ID must always contain the @newsletter suffix, as this is the standard used by WhatsApp.

​
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”.