API Reference

Create a WhatsApp group

post
https://example.com/api/ext/v3/conversations/groups

Creates a new WhatsApp group. Optionally specify a channel; when omitted, the default channel is used.
Operators are identified by email, contacts by phone number or target format.
Only available on the Business plan.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for creating a WhatsApp group.

string | null

Channel name or phone number to create the group on (optional, uses default channel if omitted).

string
required

Group name (max 128 characters).

string | null

Group description (max 2048 characters).

string
required

Email of the operator who will own the group.

operator_emails
array of strings | null

Emails of additional operators to add as moderators.

operator_emails
contact_targets
array of strings | null

Contact phone numbers or targets to invite (max 7).
Accepts phone number (e.g. "14155551234"), contactId.

contact_targets
string | null

Join approval mode: "auto_approve" (default) or "approval_required".

Headers
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

401

The request is unauthorized.

429

Too many requests. Either the rate limit has been exceeded or usage limits have been reached.

Updated about 6 hours ago

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

Updated about 6 hours ago