Skip to main content

Update user

This endpoint allows you to update a specific user information.

Endpoint

PATCH /user/v1/users/{id}

Parameters

NameLocationRequiredTypeDefault valueDescription
idURLYesIntegerThe user identifier
firstnameBodyNoStringUser firstname
lastnameBodyNoStringUser lastname
emailBodyNoStringUser email
expires_atBodyNoDatetimeUser expiration datetime
phoneBodyNoStringUser phone number
languageBodyNoStringUser language.
Allowed values : en, fr, de

All parameters are optional.
Only specified parameters will be modified.

Response

A User object.

Example Request

PATCH /user/v1/users/c0b48140-34cb-4187-acd7-aaa830dc97f9
Body
{
"email": "john.doe@new-company.fr",
"language": "en"
}

Example Response

{
"message": "OK",
"data": {
"id": "c0b48140-34cb-4187-acd7-aaa830dc97f9",
"firstname": "John",
"lastname": "Doe",
"email": "john.doe@new-company.fr",
"language": "en",
"phone": "+33612345678",
"customer_id": 1234,
"expires_at": "2050-12-25T12:00:00+01:00",
"last_login_at": null,
"created_at": "2023-01-01T00:00:00+01:00",
"created_by": {
"id": "7a1506b9-9ce4-43f9-a6f0-e94ef4252277",
"firstname": "Company",
"lastname": "Administrator"
},
"updated_at": "2023-06-01T12:30:00+01:00",
"updated_by": {
"id": "7a1506b9-9ce4-43f9-a6f0-e94ef4252277",
"firstname": "Company",
"lastname": "Administrator"
}
}
}