Sign in

v1

latestOpenAPI 3.0.02026-07-2411724301.7 KB
Groups

Create Group

The Create Group API allows you to create WhatsApp groups under a given WhatsApp Business number. The API supports both auto_approval and approval_required modes for adding participants to the created WhatsApp group.

post/v2/{sid}/whatsapp/{fromNumber}/groups

Path parameters

sidstring required

Account SID (Security Identifier).

fromNumberstring required

WhatsApp business number in format 91xxxxxxxxxx

Request body

messaging_productstring required

To be passed as whatsapp

subjectstring required

Group Name of the WhatsApp Group being created

descriptionstring required

Description of the WhatsApp Group being created

join_approval_mode'auto_approve' | 'approval_required' required

Approval Mode of the end user trying to join the WhatsApp Group. By default, taken as auto_approve and the end user will be able to join the WhatsApp group without any permission from the business. If passed as approval_required, the end user will only be able to request to join the WhatsApp Group. The business has to use Approve/Reject join requests API to allow/disallow the end users to join the WhatsApp Group.

Example request

{
  "messaging_product": "whatsapp"
}

Response

Group created successfully

codestring
messagestring
errorobject

Example response

{
  "code": "WA200",
  "message": "Request Processed Successfully",
  "data": {
    "messaging_product": "whatsapp",
    "request_id": "string"
  },
  "error": {}
}