v1

latestOpenAPI 3.1.02026-07-2466150275.0 KB

Users

Update Role

Update a user's role

put/v1/user/{user_id}/role/{role_id}/

Path parameters

user_idinteger required

role_idinteger required

Response

Successful Response

errorboolean

A boolean error indicator.

messagestring nullable

Optional message.

Example response

{
  "data": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "email": "j.doe@example.com",
    "phone": "6045551234",
    "phoneCell": "6045551234",
    "phoneWork": "6045554321",
    "address": "#22 - 321 Someplace St",
    "city": "Burnaby",
    "postalCode": "V3V2X2",
    "country": "Canada",
    "timezone": "America/Vancouver",
    "birthDate": "1980-01-23",
    "industryId": 1,
    "tradeId": 12,
    "emergencyContact": "John Smith",
    "emergencyContactPhone": "6045551234",
    "companyUser": {
      "id": 1275,
      "role": {
        "id": 4,
        "name": "Foreman",
        "slug": "foreman"
      },
      "isActive": true,
      "employeeId": "EM00123",
      "position": "Office Manager",
      "editTimer": true,
      "createTimer": true,
      "userId": 2,
      "companyId": 1
    }
  }
}