Promote or demote a group admin
Promote a group member to admin (or demote them). Requires the `conversations:write` scope, and the connected number must itself be a group admin (WhatsApp returns 403 otherwise).
Authorization
bearerAuth Workspace API key, e.g. rl_live_….
In: header
Path Parameters
The Relay conversation id of the group.
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
The member's phone number (country code + number).
true to promote to admin, false to demote.
Response 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/admins" \ -H "Content-Type: application/json" \ -d '{ "phone": "919876543210", "admin": true }'{ "group_jid": "string", "phone": "string", "is_admin": true}{ "error": "string"}{ "error": "string"}{ "error": "string"}{ "error": "string"}{ "error": "string"}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. Send a stable `Idempotency-Key` when retrying the same logical operation. Requests with the same key in a workspace return the already-created group instead of creating a duplicate. Without this header, each call creates a new group. Note: WhatsApp here is powered by an unofficial client, so high-volume group creation carries elevated account-ban risk.
Get a store GET
Fetches a store, including how many contacts link to it. Requires the `contacts:read` scope. Deprecated alias of `/companies` (same fields, same ids). Keeps working until 16 February 2027 — the `Sunset` header — with `Deprecation` and `Link` headers on every response.