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

​
Overview

This method is responsible for transferring the ownership of a channel to another user, who must be an administrator of the channel.

​
Attributes

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

​
Path

​
newsletterId
string
required
Channel ID

​
Body

​
phone
string
required
New owner’s phone number
​
quitAdmin
boolean
Defines whether you will stop being an admin after the transfer

​
Request Body

{
  "phone": "5511999999999",
  "quitAdmin": true
}

​
Response

​
200

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