Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Users

Update a user

Updates the details of a specific user (required scope users:write)

patch/v1/users/{userId}

Path parameters

userIdinteger required

Headers

Customer-Idinteger required

The customer identifier

Request body

namestring

The name associated with the user<br/><br/>Optional: Omit to retain current value

emailstring

The email associated with the user<br/><br/>Optional: Omit to retain current value

roleIdinteger

The role ID associated with the user<br/><br/>Optional: Omit to retain current value

defaultJobCategoryIdinteger nullable

The default job category ID associated with the user<br/><br/>Optional: Omit to retain current value or provide null to unset

positionstring nullable

The job position or title associated with the user<br/><br/>Optional: Omit to retain current value or provide null to unset

type'active' | 'inactive' | 'linkedResource'

Represents the type of licence assigned to a user<p>Possible values:</p><ul><li><b>active</b>: Indicates an active licence</li><li><b>inactive</b>: Indicates an inactive licence</li><li><b>linkedResource</b>: Indicates a licence associated with a linked resource</li></ul>

groupIdinteger nullable

The group identifier associated with the user<br/><br/>Optional: Omit to retain current value or provide null to unset

mobilestring nullable

The mobile phone number associated with the user. The phone number has to start with a + sign followed by the country code, followed by the number without the first zero<br/><br/>Optional: Omit to retain current value or provide null to unset

Example request

{
  "name": "John Doe",
  "email": "email@example.com",
  "roleId": 12345,
  "position": "Engineer",
  "type": "active",
  "groupId": 67890,
  "mobile": "+447700900123",
  "customFields": [
    {
      "definitionId": 5514123,
      "value": "High net worth"
    }
  ]
}

Response

No Content