Skip to main content

Update group image

Method#

/update-group-photo#

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

Header#

KeyValue
Client-TokenACCOUNT SECURITY TOKEN

Concept#

This method is reponsibible for changing a group image that already exists

Attention

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


Atributes#

Required#

AttributesTypeDescription
groupIdstringGroup ID/phone
groupPhotostringImage’s url or base64

Optionals#

AttributesTypeDescription

Request Body#

URL#

Method

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

Body#

{
"groupId": "string",
"groupPhoto": "https://www.z-api.io/wp-content/themes/z-api/dist/images/logo.svg"
}
Send Base64 image

If you have doubts about how to send a Base64 image, access the "Send Image" message topic, there you will find everything you need to know about sending in this format.


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#