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

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.

​
Overview

This method is responsible for changing your WhatsApp profile description.

​
Attributes

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

​
Body

​
value
string
required
Profile description

​
Request Body

{
  "value": "Profile description"
}

​
Response

​
200

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

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or PUT 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”.