Create WhatsApp Group

Create a WhatsApp group on one of your WHATSAPP_OFFICIAL channels.

Creation is asynchronous. This call returns a requestId immediately; WhatsApp then creates the group and notifies us, typically within a few seconds. To obtain the group's chatId:

  1. Poll GET /api/wp-crm/groups/:orgId/creation-status/:requestId until status is created, or
  2. Subscribe to the group.created webhook — its payload carries the same request_id plus the chat_id.

The returned chatId is a normal chat id — use it to send messages (POST /api/wp-crm/messaging/send-message), assign users/teams (POST /api/wp-crm/chat-assignments/...), and read the conversation (GET /api/wp-crm/chats/...).

A new group contains only your business number. Add members with the participants endpoint or share the invite link.

Security:

  • The organisationId in the URL must match the organisation your JWT was issued for — requests for a different organisation fail with 401.
  • Requires CRM_ADMIN, ACCOUNT_OWNER, or CRM_BOT role; other roles receive 403.
  • Groups are only supported on WHATSAPP_OFFICIAL channels whose number is an Official Business Account (OBA); ineligible numbers receive 422.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Your organisation UUID (returned as org from the /token endpoint).

Body Params
string
required

The WHATSAPP_OFFICIAL channel to create the group on (channelId from GET /api/wp-crm/channels/:orgId).

string
required
length between 1 and 128

Group subject/name

string
length ≤ 2048

Group description

boolean
Defaults to true

Require admin approval before members can join via the invite link. Defaults to true; when left on, approve joiners via the join-requests endpoints.

Responses

400

Bad request — invalid body

401

Unauthorized

403

Forbidden — role not permitted

404

Channel not found in your organisation

422

The channel number is not eligible for groups (requires an Official Business Account)

429

Too many requests

500

Internal server error

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