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

​
Overview

This method is responsible for updating the company description on the WhatsApp Business profile.

​
Attributes

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

​
Required

​
value
string
required
Description text. Send empty to remove

​
Request Body

{
  "value": "Texto da descrição"
}

​
Response

​
201

​
success
boolean
true if successful, false if it failed
{
  "success": true
}

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