Sign in

v1

latestOpenAPI 3.1.02026-07-2466150275.0 KB
Users

Update Company-specific details

Update user information that is specific to the current company.

All fields will be updated, even if the new value is empty.

put/v1/user/{user_id}/company/

Path parameters

user_idinteger required

Request body

isActiveboolean required

Indicates that this user is active in the company.

editTimerboolean required

Indicates if a user can edit timers that they have created.

createTimerboolean required

Indicates if a user can create a time and log time.

documentAccess'none' | 'read' | 'write' required

Company user access type enumeration.

feedAccess'none' | 'read' | 'write' required

Company user access type enumeration.

positionstring nullable required

Optionally, specify the users position in the company.

employeeIdstring nullable required

Optionally, specify an external employee ID so that it can be correlated with an external system.

Example request

{
  "isActive": true,
  "editTimer": true,
  "createTimer": true,
  "position": "Office Manager",
  "employeeId": "EM00123"
}

Response

Successful Response

errorboolean

A boolean error indicator.

messagestring nullable

Optional message.

Example response

{
  "data": {
    "id": 1275,
    "role": {
      "id": 4,
      "name": "Foreman",
      "slug": "foreman"
    },
    "isActive": true,
    "employeeId": "EM00123",
    "position": "Office Manager",
    "editTimer": true,
    "createTimer": true,
    "userId": 2,
    "companyId": 1
  }
}