Update group profile

Updates the subject, description, and optional profile picture of a WhatsApp group by group id.

Request parameters

Path parameters

KeyDescriptionValuesData TypeRequired/Optional
appIdIdentifier of the WhatsApp app the call acts on.6f414190-d45c-4671-bca1-fb6c3018cb13StringRequired
groupIdIdentifier of the WhatsApp group.120363021051234567StringRequired

Query parameters

KeyDescriptionValuesData TypeRequired/Optional
messaging_productMessaging product the group belongs to.whatsappStringOptional
subjectGroup subject (its display name).Acme supportStringOptional
descriptionGroup description shown to participants.—StringOptional
file_typeMedia type of the group profile image.image/jpegStringOptional

Body

KeyDescriptionValuesData TypeRequired/Optional
messaging_productMessaging product identifierwhatsapp—Optional
subjectGroup subject / nameMy WhatsApp Group—Optional
descriptionGroup descriptionThis is a group description—Optional
file_typeFile MIME type for the group iconimage/jpeg—Optional
fileGroup icon image file—StringOptional

Sample cURL — Update group profile.

curl --request PUT \
  --url 'https://partner.gupshup.io/partner/bizgate/app/6f414190-d45c-4671-bca1-fb6c3018cb13/group/120363021051234567?messaging_product=whatsapp&subject=Acme%20support&file_type=image/jpeg' \
  --header 'Authorization: Bearer <UT>' \
  --header 'Accept: application/json' \
  --form 'messaging_product=whatsapp' \
  --form 'subject=My WhatsApp Group' \
  --form 'description=This is a group description' \
  --form 'file_type=image/jpeg' \
  --form 'file=@/path/to/file'

Sample success response (200)

{
  "status": "success",
  "data": {
    "messaging_product": "whatsapp",
    "request_id": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6"
  }
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifier of the WhatsApp app the call acts on.

string
required

Identifier of the WhatsApp group.

Query Params
string

Messaging product the group belongs to.

string

Group subject (its display name).

string

Group description shown to participants.

string

Media type of the group profile image.

Body Params

Group profile update (multipart/form-data)

string

Messaging product identifier

string

Group subject / name

string

Group description

string

File MIME type for the group icon

file

Group icon image file

Responses

Language
Credentials
Bearer
Universal Token (UT)
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json