Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Users

Create a user

Create a new user (required scope users:write)

post/v1/users

Headers

Customer-Idinteger required

The customer identifier

Request body

namestring required

The name associated with the user

emailstring required

The email associated with the user

roleIdinteger required

The role ID associated with the user

defaultJobCategoryIdinteger nullable

The default job category ID associated with the user

positionstring nullable

The job position or title associated with the user

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

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

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

Created

idinteger

Identifier of the newly created record