Create a new group
POST/api/sessions/:sessionId/groups
Create a new group
Request
Responses
- 201
- 400
- 401
- 403
- 409
- 501
- 503
Group created
A participant does not name an individual. Pass a phone number, <phone>@c.us or <lid>@lid; a group id or free text is rejected. With send pacing on, also answered (without retryAfterSeconds) when the request names more new contacts than the whole day's cold-reachout allowance; split it into smaller batches.
The API key is missing, unknown, revoked, or expired
WhatsApp refused the operation. The request was well formed — the refusal happened WhatsApp-side, most often because the account lacks the admin rights the operation requires. Also returned when the API key's role, session or chat scope, or IP allow-list does not allow this operation.
The session is not connected: an engine exists for it but is not ready, meaning disconnected, reconnecting, or still initializing, so the request never reached WhatsApp. Wait for ready and retry. A send whose first attempt had already run when the session left ready (or WhatsApp Web reloaded its page) is the exception: it answers a 409 with no code that says the message may or may not have been sent, so check the chat before sending it again (a retry with the same Idempotency-Key answers IDEMPOTENCY_OUTCOME_UNKNOWN). A session that was never started answers 400 instead, and the session lifecycle routes answer 409 for a conflicting state rather than this. One window answers this while the session still reads ready: WhatsApp Web periodically reloads its own page and the engine re-injects into it, and until it has the answer is a 409 naming the reload, with code ENGINE_PAGE_RELOADING and retryAfterSeconds. That takes seconds on most reloads and can take a few minutes, and no event marks its end: ask again at that interval.
Not supported by the active engine: whatsapp-web.js reaches a WhatsApp Web internal that no longer exists, so group creation is Baileys-only.
WhatsApp rate-limited the create (code 429); nothing was created, so retrying after a pause is safe. A timed-out create is not answered 503, because the group may have been created.