Skip to Content
TurbineWhats.app
TurbineWhats.app
API schemaPricingWorkspaceOverview
WhatsApp sessionsText messagesImages and PDFsContacts, chats, and groupsWebhooksGroupsGroup operationsMessage operationsChat operationsContact operationsPresence operationsProfile operationsLabel operationsWhatsApp channel operationsStatus operationsBusiness catalog operationsCall operations
API guides

Groups

Create groups, manage participants, share invite links, and send messages to a group you are authorized to use.

Read as MarkdownOpenAPI specification

Group permissions#

Use a paid account and a connected, ready session. A manage-scoped token can create or administer a group; send-scoped tokens can queue messages. Each request is bound to a session belonging to the authenticated account. Group administrator rights come from WhatsApp, not the API key.

Group operations are subject to WhatsApp restrictions and participant consent. Adding participants may return individual refusal results; check each result rather than assuming everyone joined. Advanced features can return an engine-specific unsupported response.

Create a group#

POST /api/v1/channels/{channel_id}/groups. Include an Idempotency-Key and a JSON body containing name and participants. Participants are individual WhatsApp IDs ending in @c.us or @lid, with at most 100 entries per operation. Keep group creation deliberate: management is capped at 10 requests per minute, 100 per UTC day and three new groups per UTC day across the account.

Create a group
curl --request POST 'https://turbinewhats.app/api/v1/channels/CHANNEL_ID/groups' \
  --header "Authorization: Bearer $TURBINEWHATS_TOKEN" \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: group-project-launch' \
  --data '{"name":"Project launch","participants":["[email protected]"]}'

Message a group#

Use the returned group ID, ending in @g.us, as to on the existing /messages/text, /messages/image and /messages/document endpoints. For polls, mentions, replies, reactions and additional media formats, use /channels/{channel_id}/messages/send-poll and the other documented message operations with chatId. Every advanced message mutation enters the durable sending queue and counts toward account message limits. HTTP 202 is queue acceptance, not delivery.

Group text
{
  "channel_id": "CHANNEL_ID",
  "to": "[email protected]",
  "body": "The release is ready for review."
}

Manage the group#

Read group details and settings, change the subject or description, add or remove participants, promote or demote administrators, handle membership requests, update a picture, retrieve or revoke an invite code, and leave. Use the Group operations reference for exact request schemas.

Management writes return an operation ID with completed or uncertain status. Retrieve /api/v1/operations/{id} to inspect it. Reusing the original idempotency key returns the recorded outcome. An operation that times out or is interrupted is never repeated automatically. Check WhatsApp before creating a different request.

Group operations

Webhooks

Previous Page

Group operations

Next Page

On this page

Group permissionsCreate a groupMessage a groupManage the group