Updating Group Information

PATCH 
/api/v2/instance/:instanceId/group/:groupJid

This endpoint allows the updating of information for a specified WhatsApp group. The update can include changes to the group's profile picture URL, subject, and description. The update object is required, and additional attributes such as pictureUrl, subject, and description are optional.

Request

Path Parameters

instanceId stringrequired

ID of the instance.

groupJid stringrequired

The unique identifier of the group to be updated.

application/json

Body

required

• update (objeto, obrigatório): Um objeto contendo os atributos a serem atualizados.
• pictureUrl (string, opcional): A URL atualizada da imagem de perfil do grupo.
• subject (string, opcional): O assunto ou título atualizado do grupo.
• description (string, opcional): A descrição atualizada do grupo.

update object
subject Subject
Required to group created.
description Description
pictureUrl Picture Url

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