Skip to main content
Every operation works over REST and the CLI, and all but the group photo work over MCP.
REST calls use your hmok_ API key and need the scope channel.manage to change things, or channel.read to read.
CLI commands start with hookmyapp whatsapp and take --channel and --json.
Full request and response details are in the API reference.
Make sure the number can use groups first.

Async changes

Creating a group, changing it, setting the photo, removing members, and deleting it finish a moment after the call.
The call returns 202 with a requestId. The result arrives as a whatsapp.group.updated event with the same requestId.
Send an Idempotency-Key header on writes so a retry never runs twice.

Create a group

joinApprovalMode is auto_approve (anyone with the link joins) or approval_required (you approve each person). The CLI takes --approval auto or --approval required. The answer is { "channelId": "ch_AbCdEf12", "requestId": "..." }. The group id arrives in the created event with the same requestId, or find the new group in the list.

List and read groups

The list returns groups (each with groupId, subject, createdAt) and nextCursor. Pass nextCursor as cursor for the next page. limit is 1 to 1024.
A single group also returns description, joinApprovalMode, suspended, participantCount, and participants. Each participant has waId (the phone number) or userId (when the member has hidden their phone number).

Change a group

Send subject, description, or both.

Set the photo

Send one JPEG as multipart/form-data, in a part named file. It must be square, at least 192 px, and up to 5 MB.
Your AI agent can’t set the photo over MCP. Use REST or the CLI.

Delete a group

Deleting a group removes its members.
The call returns 202 with a requestId. The result arrives as a deleted event with the same requestId. succeeded says whether it worked. The answer holds inviteLink. It is null after a revoke.

Remove members

Remove up to 8 members per call. Each is a phone number (waId) or a userId, as listed on the group.
Each removal sends a member_removed event.

Join requests

On an approval_required group, people who tap the invite link wait for you to approve them.
Approve and reject work on several requests at once. The answer lists succeeded ids and failed requests with a reason each. You get a join_requested event for every new request.

Errors