Set the account display name
PUT/api/sessions/:sessionId/profile/name
Set the account display name
Request
Responses
- 200
- 400
- 401
- 403
- 409
- 503
Profile name updated
Session is not started
The API key is missing, unknown, revoked, or expired
The whatsapp-web.js engine refused the name change. The Baileys engine has no acceptance signal and answers 200 for a rename WhatsApp declined. 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 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 for those few seconds the answer is a 409 naming the reload; retry shortly.
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.