Update WhatsApp group settings

Updates the subject, description, profile picture or groupId of an existing WhatsApp group.

Before you call

  • Pass the group's current groupId in the query, and a connected wabaNumber of your organization in the body.
  • The API key's user needs permission to modify WhatsApp groups on the group's number.
  • Send at least one of subject (≤128 chars), description (≤2048 chars), a profile picture, or a new groupId (≤50 chars).
  • subject and description cannot be blank.
  • For a profile picture, either send multipart/form-data with the image in profile_picture_file, or pass a public image URL in profilePictureUrl (JSON or form data), not both.
  • The image must be JPEG, square, at least 192x192 pixels and at most 1MB; a profilePictureUrl must be publicly reachable.
  • The group must have finished creating on WhatsApp.

How it works

  • Applies subject, description and picture changes on WhatsApp, then renames the groupId if you sent a new one; returns success.
  • After a rename, use the new groupId in every later call.
  • Returns 409 if the new groupId is already used in your organization, including by a deleted group.
  • Profile pictures are not supported for ValueFirst numbers, which get a 422.
  • Returns 404 if the group is not found or its creation is still pending.

Rate limit

  • 30 requests per minute.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Unique identifier of the group to update

Body Params
string
required

WABA number associated with the group

string
length ≤ 128

New group subject/name

string
length ≤ 2048

New group description

string
length ≤ 50

New groupId to assign

uri
length ≤ 2048

Public http(s) URL of the new group profile picture. It is downloaded and must meet the same rules as profile_picture_file: JPEG only, at most 1MB, square, at least 192x192 pixels. Send either this or profile_picture_file, not both. Not supported for ValueFirst numbers, which get a 422.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

400

Invalid fields or no integration found for the given WABA number

404

Group not found or group creation is still pending

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json