PATCH /users/{userId} – Updates an existing user.
Headers:
Authorization: Bearer <access_token>
Content-Type: application/json or application/x-www-form-urlencoded
Body:
userId
Path Parameters:
Query Parameters:
200 Updated
400
401
404
500
{ "error": "Detailed error message here"} Copy
{ "error": "Detailed error message here"}
PATCH /users/{userId}{ "provider": "auth0-user", // Optional, defaults to "auth0-user" if omitted "user": { "email": "newemail@domain.com", "givenName": "NewGiven", "familyName": "NewFamily", "password": "updatedPassword", "phoneNumber": "+1234567890", },} Copy
PATCH /users/{userId}{ "provider": "auth0-user", // Optional, defaults to "auth0-user" if omitted "user": { "email": "newemail@domain.com", "givenName": "NewGiven", "familyName": "NewFamily", "password": "updatedPassword", "phoneNumber": "+1234567890", },}
PATCH /users/{userId}{ "provider": "cognito-user", "user": { "email": "newemail@domain.com", "firstName": "NewFirst", "lastName": "NewLast", "password": "updatedPassword", "phoneNumber": "+1234567890", }, "userPoolId": "us-east-1_1234test"} Copy
PATCH /users/{userId}{ "provider": "cognito-user", "user": { "email": "newemail@domain.com", "firstName": "NewFirst", "lastName": "NewLast", "password": "updatedPassword", "phoneNumber": "+1234567890", }, "userPoolId": "us-east-1_1234test"}
{ "id": "user_123", "email": "newemail@domain.com", "name": "NewGiven NewFamily", "blocked": false, "emailVerified": true, "createdAt": "2025-09-12T12:00:00Z", "updatedAt": "2025-09-12T12:00:00Z", "appMetadata": { // ...app metadata fields... }, "userMetadata": { // ...user metadata fields... } // Additional user fields} Copy
{ "id": "user_123", "email": "newemail@domain.com", "name": "NewGiven NewFamily", "blocked": false, "emailVerified": true, "createdAt": "2025-09-12T12:00:00Z", "updatedAt": "2025-09-12T12:00:00Z", "appMetadata": { // ...app metadata fields... }, "userMetadata": { // ...user metadata fields... } // Additional user fields}
The API Gateway event containing the request.
A Promise resolving to an API Gateway-compatible response.
PATCH /users/{userId} – Updates an existing user.
📥 Request
Headers:
Authorization: Bearer <access_token>(required)Content-Type: application/json or application/x-www-form-urlencoded(required)Body:
userIdis path parameter (not in body).Path Parameters:
Query Parameters:
Remarks
Only provided fields will be updated; omitted fields remain unchanged.
📤 Response
200 Updated– Returns a JSON-stringified User object.❗ Errors
400401404500Error Response Format
📦 Examples
📥 Auth0 Request
📥 Cognito Request
📤 Response Example