Relesys API Docs

v1.3

https://api.relesysapp.net/api/v1.3

Users

Create User
POST /users
https://api.relesysapp.net/api/v1.3/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
  customFields dictionary`2 optional
  dataSource string optional
  email string optional
  employmentDate datetime optional
  employmentEndDate datetime optional
  externalId string optional
  name string required
  password string optional
  phoneNumber object optional
   countryCode integer optional
   number string optional
  primaryDepartmentId string / guid required
  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
JSON
{"data":{"id":"09ea3d61-7c3e-4a84-920c-1084d53976ff","url":null,"departmentUrl":null,"status":"Activated","creationDateTime":"2024-12-02T10:28:00.5224251Z","lastModifiedDateTime":"2024-12-02T10:28:00.5224251Z","externalId":"NUA","name":"New User A","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","primaryDepartmentId":"27d5f6f4-9ae5-42db-a33e-080952b62089","additionalDepartments":[{"id":"443213b3-686f-4095-b23e-0d60cf983b61","dataSource":"RelesysAPI"}],"userGroups":[{"id":"db2401e6-1a34-4526-be51-1e3cebcf0fec","dataSource":"RelesysAPI"},{"id":"4efc3afe-6ef3-4f34-aceb-77815f986b69","dataSource":"RelesysAPI"}],"employmentDate":"2018-12-30T13:30:00Z","employmentEndDate":"2021-12-30T13:30:00Z","customFields":{"customfieldone":"Custom field 1","customfieldtwo":"Custom field 2","customfieldthree":"Custom field 3"}}}
object
  data object      
   additionalDepartments array[object]      
    dataSource string      
    id string / guid      
   birthDate datetime      
   customFields dictionary`2      
   dataSource string      
   departmentUrl string      
   email string      
   employmentDate datetime      
   employmentEndDate datetime      
   externalId string      
   id string / guid      
   name string      
   phoneNumber object      
    countryCode integer      
    number string      
   primaryDepartmentId string / guid      
   secondaryEmail string      
   secondaryPhoneNumber object      
    countryCode integer      
    number string      
   status string      
   title string      
   url string      
   userGroups array[object]      
    dataSource string      
    id string / guid      
   userName string