Skip to main content

Updating group name

Method#

/update-group-name#

POST https://api.z-api.io/instances/YOUR_INSTANCE/token/YOUR_TOKEN/update-group-name

Header#

KeyValue
Client-TokenACCOUNT SECURITY TOKEN

Concept#

This method is responsible for change the name of a group that already exists

Attention

On November 4, 2021 whatsapp changed the format of creating new groups. before: "phone": "5511999999999-1623281429" now: "phone": "120363019502650977-group"


Attributes#

Required#

AttributesTypeDescription
groupIdstringGroup ID/phone
groupNamestringName of group to be created

Optionals#

AttributesTypeDescription

Request Body#

URL#

POST https://api.z-api.io/instances/YOUR_INSTANCE/token/YOUR_TOKEN/update-group-name

Body#

Old way -
{
"groupId": "5511999999999-1623281429",
"groupName": "Changed the name of My group in Z-API"
}
-----------------------------------------------
New way -
{
"groupId": "120363019502650977-group",
"groupName": "Changed the name of My group in Z-API"
}

Response#

200#

AttributesTypeDescription
valuebooleantrue if it worked and false if it failed

Example

{
"value": true
}

405#

In this case certify that you are sending the correct specification of the method. This means, verify if you sent a POST or GET as specified at the beginning of this topic.

415#

In case you receive 415 error, make sure to add the “Content-Type” of the object you are sending in the request headers, mostly “application/json”


Webhook Response#

Link to webhook response (on receipt)

Webhook


Code#