Create Group

post

https://api.in.kaleyra.io/v2/{sid}/whatsapp/{fromNumber}/groups

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

sid

string

required

Account SID (Security Identifier).

fromNumber

string

required

WhatsApp business number in format 91xxxxxxxxxx

Body Params

messaging_product

string

required

To be passed as whatsapp

subject

string

required

Group Name of the WhatsApp Group being created

description

string

required

Description of the WhatsApp Group being created

join_approval_mode

string

enum

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.

Allowed:

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Group created successfully

400Phone number validation error

401Incorrect SID or API key

500Meta eligibility error