Manage groups

Create group

Only eligible phone numbers can create groups (see the requirements in Groups).

Request

Create group request:

Headers

Create group headers:

Parameters

Create group parameters:

Body

Create group body fields:

Example

Complete Create group example:

💾
curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/group/{{waba_id}}/{{business_phone_number}}' \
--header 'Authorization: Bearer {{admin-token}}' \
--header 'Content-Type: application/json' \
--data '{
    "subject": "Support Team",
    "description": "Group for customer support coordination",
    "join_approval_mode": "approval_required"
}'

Response

Create group response:

Group creation is asynchronous: the response only confirms that the request was accepted. The actual result (the created group with its invite_link, or an error) arrives by webhook.

💾
{
  "request_id": "384EE736D97215A005AF71B3482C5DB5"
}

Get active groups

Returns the list of active groups associated with a phone number, paginated with after/before cursors.

Request

Get active groups request:

Headers

Get active groups headers:

Parameters

Get active groups parameters:

Example

Complete Get active groups example:

💾
curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/group/{{waba_id}}/{{business_phone_number}}/groups?limit=25' \
--header 'Authorization: Bearer {{admin-token}}'

Response

Get active groups response:

💾
{
  "data": [
    { "id": "{{group_id}}", "subject": "Support Team", "created_at": "683731200" }
  ],
  "paging": {
    "cursors": {
      "after": "MTAxNTExOTQ1MjAwNzI5NDE=",
      "before": "NDMyNzQyODI3OTQw"
    }
  }
}

Get group info

Returns the group information for the fields requested in the fields parameter. If you don't specify any fields, the response includes id, subject, description, and join_approval_mode by default.

Request

Get group info request:

Headers

Get group info headers:

Parameters

Get group info parameters:

Example

Complete Get group info example:

💾
curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/group/{{waba_id}}/{{group_id}}?fields=subject,description,participants,join_approval_mode' \
--header 'Authorization: Bearer {{admin-token}}'

Response

Get group info response:

💾
{
  "id": "{{group_id}}",
  "subject": "Artificial Intelligence Insights",
  "creation_timestamp": "683731200",
  "suspended": false,
  "description": "Explore AI developments and discuss the future of AI.",
  "total_participant_count": 6,
  "participants": [
    { "wa_id": "2228675309" },
    { "wa_id": "7693349922" }
  ],
  "join_approval_mode": "auto_approve"
}

Update group settings

Updates the group subject and/or description. The operation is asynchronous: the request returns a request_id, and the result (success, partial success, or an error for each field) is confirmed by webhook.

Request

Update group settings request:

Headers

Update group settings headers:

Parameters

Update group settings parameters:

Body

Update group settings body fields:

Example

Complete Update group settings example:

💾
curl --location --request PUT 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/group/{{waba_id}}/{{group_id}}' \
--header 'Authorization: Bearer {{admin-token}}' \
--header 'Content-Type: application/json' \
--data '{
    "subject": "Watch Enthusiasts",
    "description": "Join our community to discuss the latest timepieces."
}'

Response

Update group settings response:

💾
{
  "request_id": "384EE736D97215A005AF71B3482C5DB5"
}

Update group profile picture

Updates the group's profile picture. The image must be image/jpeg, square (height = width), at least 192x192 px, and no larger than 5MB. The operation is asynchronous: the request returns a request_id, and the result is confirmed by webhook (profile_picture field).

Request

Update group profile picture request:

Headers

Update group profile picture headers:

Parameters

Update group profile picture parameters:

Body

Update group profile picture body fields:

Example

Complete Update group profile picture example:

💾
curl --location --request PUT 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/group/{{waba_id}}/{{group_id}}' \
--header 'Authorization: Bearer {{admin-token}}' \
--form 'file=@"/local/path/image.jpg"'

Response

Update group profile picture response:

💾
{
  "request_id": "384EE736D97215A005AF71B3482C5DB5"
}

Delete group

Request

Delete group request:

Headers

Delete group headers:

Parameters

Delete group parameters:

Example

Complete Delete group example:

💾
curl --location --request DELETE 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/group/{{waba_id}}/{{group_id}}' \
--header 'Authorization: Bearer {{admin-token}}'

Response

Delete group response:

💾
{
  "request_id": "384EE736D97215A005AF71B3482C5DB5"
}