Add members to a group
Add one or more customers to an existing WhatsApp group conversation. Requires the `conversations:write` scope and the hosting number to be connected. WhatsApp will not directly add people whose privacy blocks it; those come back in `invited` and must join via `invite_link`. Set `sendInviteLink: true` to have the API DM the link to them.
Authorization
bearerAuth Workspace API key, e.g. rl_live_….
In: header
Path Parameters
The Relay conversation id of the group (returned by Create a group).
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Customer phone numbers to add (country code + number; punctuation ignored).
1 <= itemsDM the group invite link to participants WhatsApp wouldn't add directly. Unsolicited 1:1 message, so off by default.
falseResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/public/whatsapp/groups/497f6eca-6276-4993-bfeb-53cbbbba6f08/participants" \ -H "Content-Type: application/json" \ -d '{ "participants": [ "919876543210" ] }'{ "group_jid": "string", "invite_link": "string", "added": [ "string" ], "invited": [ "string" ], "invites_sent": [ "string" ], "not_on_whatsapp": [ "string" ]}{ "error": "string"}{ "error": "string"}{ "error": "string"}{ "error": "string"}{ "error": "string"}Create a store POST
Creates a store. Requires the `contacts:write` scope.
Create a group POST
Creates a WhatsApp group with one or more customers and starts a Relay conversation for it. Requires the `conversations:write` scope and a connected WhatsApp number. The hosting number is chosen by `integrationId`, then `from` (the connected number's phone), then — if the workspace has exactly one connected number — that one. WhatsApp will not silently add people who don't have your number saved or who restrict who can add them to groups; those come back in `invited` and must join via `invite_link`. Set `sendInviteLink: true` to have the API DM the link to them. Note: WhatsApp here is powered by an unofficial client, so high-volume group creation carries elevated account-ban risk. Each call creates a new group.