Create a User

This endpoint creates a User for either a Partner, a KIF, or a Client. To create a User for a KIF, a reference to the KIF must be included in the API call, to create a user for a Client, both the Partner and Client references must be included.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

User to be created.

string
required
length ≤ 255

The User's unique username.

string
required
length ≤ 255

The User's name.

string
required
length ≤ 255

The User's Surname.

string
required
length ≤ 255

The User's email address.

string
required
length ≤ 255

The User's phone number without dashes, spaces, or brackets.

partner
object

Reference to the associated Partner. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls, both properties are populated.

client
object

Reference to the associated Client resource. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls, both properties are populated.

kif
object

Reference to the associated KIF resource. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls, both properties are populated.

userRole
object
required

Reference to the associated User Role.

boolean
required

This property indicates if the User account is active or disabled. Once a user has logged into the system, their account cannot be deleted. As an alternative, their account can be set to inactive.

boolean

If this property is set to 'true' the newly created user will be sent a welcome email.

Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json