Relesys API Docs

Users

Create User

POST /users

https://api.uat.relesystest.net/api/v1.4/users

Create a user if the model is valid.

customFields is an array of key-value-pairs referencing the externalId (see the documentation for 'Get User Custom Fields') as the key, and a string input as the value.

Scopes: relesys.api, relesys.api:write, relesys.api.users, relesys.api.users:write

Request Body

application/json

object
⯈ additionalDepartments	array[object]		optional
dataSource	string		optional
id	string / guid		optional
birthDate	datetime		optional
cardNumber	string		optional
customFields	dictionary`2		optional
dataSource	string		optional
dutyPlanNumber	string		optional
email	string		optional
employmentDate	datetime		optional
employmentEndDate	datetime		optional
employmentType	string		optional
externalId	string		optional
gender	string	Possible values: Male Female	optional
imageId	string / guid		optional
initials	string		optional
memberCardId	string / guid		optional
name	string		required
password	string		optional
⯈ phoneNumber	object		optional
countryCode	integer		optional
number	string		optional
primaryDepartmentId	string / guid		required
registerNumber	string		optional
secondaryEmail	string		optional
⯈ secondaryPhoneNumber	object		optional
countryCode	integer		optional
number	string		optional
title	string		optional
⯈ userGroups	array[object]		required
dataSource	string		optional
id	string / guid		optional
userName	string		optional

Responses

application/json

Schema Example

JSON

{"data":{"id":"02ebeb16-294b-43a5-ba33-b6768e091177","url":null,"departmentUrl":null,"status":"Activated","creationDateTime":"2026-10-26T06:16:40.7888608Z","lastModifiedDateTime":"2026-10-26T06:16:40.7888608Z","image":{"id":"56cc270e-ac00-44e8-aacc-d4c14c847600","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"image.png"},"memberCard":{"name":"Member Card Name","cardNumber":"1234567890","id":"9374e04a-1f23-42f6-8f02-070134b03002","url":null},"externalId":"NUA","name":"New User A","initials":"NUA","userName":"UserNameA","title":"User Title A","dataSource":"RelesysAPI","email":"personalmaila@testmail.com","secondaryEmail":"businessmaila@testmail.com","phoneNumber":{"countryCode":45,"number":"12345678"},"secondaryPhoneNumber":{"countryCode":45,"number":"12345679"},"birthDate":"2002-12-30T00:00:00Z","gender":"Male","primaryDepartmentId":"e219e026-5155-4607-bb1f-29a10bf3a350","additionalDepartments":[{"id":"ac566a18-a7f9-4e52-9e2c-279988c26360","dataSource":"RelesysAPI"}],"userGroups":[{"id":"fad3f371-4330-44e3-b009-41a196f5fd36","dataSource":"RelesysAPI"},{"id":"5478e374-64bd-446f-94db-f75e053d980f","dataSource":"RelesysAPI"}],"employmentDate":"2018-12-30T13:30:00Z","employmentEndDate":"2021-12-30T13:30:00Z","customFields":{"customfieldone":"Custom field 1","customfieldtwo":"Custom field 2","birthday":"2002-12-30","skills":["Marketing","Design"]},"employmentType":"Full-time employee","registerNumber":"RN12345","dutyPlanNumber":"DP12345"}}

object
⯈ data	object
⯈ additionalDepartments	array[object]
dataSource	string
id	string / guid
birthDate	datetime
customFields	dictionary`2
dataSource	string
departmentUrl	string
dutyPlanNumber	string
email	string
employmentDate	datetime
employmentEndDate	datetime
employmentType	string
externalId	string
gender	string
id	string / guid
⯈ image	object
contentType	string
downloadUrl	string
fileName	string
id	string / guid
referenceUrl	string
initials	string
⯈ memberCard	object
cardNumber	string
id	string / guid
name	string
url	string
name	string
⯈ phoneNumber	object
countryCode	integer
number	string
primaryDepartmentId	string / guid
registerNumber	string
secondaryEmail	string
⯈ secondaryPhoneNumber	object
countryCode	integer
number	string
status	string
title	string
url	string
⯈ userGroups	array[object]
dataSource	string
id	string / guid
userName	string

Relesys API Docs

v1.4

Welcome

Concepts

Endpoints

Users

Request Body

Responses