Update Group Profile Picture

PATCH 
/api/v2/instance/:instanceId/group/:groupJid/profile-picture/file

This endpoint allows admins of a specific WhatsApp group to update the group's profile picture. The new profile image is sent as part of the request in a supported image file format. The group_id parameter identifies the group whose profile picture will be updated.

Request

Path Parameters

instanceId stringrequired

ID of the instance.

groupJid stringrequired

The unique identifier of the group whose profile picture will be updated.

multipart/form-data

Body

required

An image file (eg JPEG, PNG) that will be used as the new group profile picture. The maximum file format and size must comply with WhatsApp restrictions.

attachment binaryrequired

Load the media file.

Responses

200

Update Successful

application/json

Schema

Schema

updated boolean
groupJid string

Example (from schema)

{
  "updated": true,
  "groupJid": "string"
}

400

BadRequestException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

401

UnauthorizedException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

500

InternalServerErrorException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

Loading...