Relesys API Docs

v1.2

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

Welcome

Introduction Getting access

Concepts

Scopes HTTP Status Codes Request Throttling Pagination Filtering Sorting Patch Requests

Endpoints

Users

Create User
POST /users 
https://api.relesysapp.net/api/v1.2/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
201
Schema Example
JSON
{"data":{"id":"0cbf5b8b-e0ae-4cb7-9439-49fe3ae9e383","url":null,"departmentUrl":null,"status":"Activated","creationDateTime":"2024-04-19T08:45:39.0528634Z","lastModifiedDateTime":"2024-04-19T08:45:39.0528634Z","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":"05913f22-c500-4321-9a01-2ce7a19812fa","additionalDepartments":[{"id":"b0dfb381-80ca-4d5b-b76f-54402b5fa991","dataSource":"RelesysAPI"}],"userGroups":[{"id":"a355024a-ab12-407c-a887-02a37566517c","dataSource":"RelesysAPI"},{"id":"ca304c2b-7699-4646-9bf3-78853df2c469","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