Create or update a label
PUT/api/sessions/:sessionId/labels/:labelId
Baileys only. PUT rather than POST because the label id is chosen by the caller: WhatsApp carries one label_edit write keyed on that id, so whether this creates or updates depends purely on whether the id already exists, and there is no server-assigned id to return.
Choose an unused id to create. Reusing one silently rewrites that label rather than failing, because the protocol has no create-only form. The write replaces the whole label, so send every field it should keep: an omitted name or colour is not preserved.
whatsapp-web.js can read and assign labels but cannot edit one, and answers 501.
Request
Responses
- 200
- 400
- 401
- 403
- 409
- 501
- 503
Label created or updated
Session not started, or validation failed
The API key is missing, unknown, revoked, or expired
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.
The active engine cannot edit labels (whatsapp-web.js)
WhatsApp did not answer within the request budget. The change may or may not have been applied — the gateway stopped waiting for a confirmation that never came.