1. Users
  3. Api Documentation
  4. Update User

Update a User

Update details of a specific User

Request

Endpoint: /api/users/{user_id}
Example: /api/users/915
Method: PATCH
Headers: Accept: application/vnd.cloudlx.v1+json
Authorization: Bearer <access_token>

JSON Request

                                
    {
        "email": "j.smith@example.com",
        "first_name": "John",
        "last_name": "Smith",
        "phone": "+442071234567",
        "time_zone": "Europe/London"
    }

JSON Parameters

email Description The user's email
Type String
Example j.smith@example.com
first_name Description The user name
Type String
Example John
last_name Description The user's last name
Type String
Example Smith
phone Description The user's phone number
Type String
Example +442071234567
time_zone Description The user's default time_zone
Type String (any valid timezone available in the IANA timezone database).
Example Europe/London

Response

The user model is returned in it's modified state with a 200 HTTP response code.

Example:

                                
    {
        "id": 915,
        "email": "j.smith@example.com",
        "first_name": "John",
        "last_name": "Smith",
        "phone": "+442071234567",
        "time_zone": "Europe/London"
    }

Back to top