Skip to main content

​
WhatsApp Business Cloud API - Groups Participants API

Copy for LLM View as Markdown Version v23.0 The Groups API gives you simple functions to control groups through their lifecycle. When you create a new group, an invite link is created for inviting participants to the group. Since you cannot manually add participants to the group, simply send a message with your invite link to WhatsApp users who you would like to join the group.

​
Base URL

| https://graph.facebook.com |

​
Endpoints

| POST | ///participants | | DELETE | ///participants |

​
POST ///participants

Add participants to group

​
Request Syntax

POST///participants Select language cURLJavaScriptPython 
curl --request POST \
  --url 'https://graph.facebook.com/{Version}/{group_id}/participants' \
  --header 'Authorization: Bearer <Token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
Header Parameters
User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Content-TypeOne of “application/json”, “application/x-www-form-urlencoded”, “multipart/form-data”·required Media type of the request body Path Parameters
Versionstring·required group_idstring·required Group ID Request BodyRequired
Content Type: application/json Schema: object Show child attributes
messaging_product”whatsapp”·required
participantsarray of object·required Array of phone numbers or WhatsApp IDs to remove (max 8 participants) Show child attributes
participants[]object Show child attributes
userstring·required WhatsApp user phone number or WhatsApp user ID Responses
Add participants to group 200 Participants addition request processed Select language cURLJavaScriptPython 
curl --request POST \
  --url 'https://graph.facebook.com/{Version}/{group_id}/participants' \
  --header 'Authorization: Bearer <Token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

​
DELETE ///participants

Remove participants from group

​
Request Syntax

DELETE///participants Select language cURLJavaScriptPython 
curl --request DELETE \
  --url 'https://graph.facebook.com/{Version}/{group_id}/participants' \
  --header 'Authorization: Bearer <Token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
Header Parameters
User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Content-TypeOne of “application/json”, “application/x-www-form-urlencoded”, “multipart/form-data”·required Media type of the request body Path Parameters
Versionstring·required group_idstring·required Group ID Request BodyRequired
Content Type: application/json Schema: object Show child attributes
messaging_product”whatsapp”·required
participantsarray of object·required Array of phone numbers or WhatsApp IDs to remove (max 8 participants) Show child attributes
participants[]object Show child attributes
userstring·required WhatsApp user phone number or WhatsApp user ID Responses
Remove participants from group 200 Participants removal request processed Select language cURLJavaScriptPython 
curl --request DELETE \
  --url 'https://graph.facebook.com/{Version}/{group_id}/participants' \
  --header 'Authorization: Bearer <Token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

​
Authentication

| Scheme | Type | Location | | bearerAuth | HTTP Bearer | Header: Authorization |

​
Usage Examples

bearerAuth: Include Authorization: Bearer your-token-here in request headers

​
Global Authentication Requirements

All endpoints require: bearerAuth Did you find this page helpful? Thumbs up icon Thumbs down icon