Relesys API Docs

v1.3

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

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.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
201
Schema Example
JSON
{"data":{"id":"b8ff3b33-15fa-4735-97f2-b24f0ac28135","url":null,"departmentUrl":null,"status":"Activated","creationDateTime":"2024-11-21T06:29:48.4794762Z","lastModifiedDateTime":"2024-11-21T06:29:48.4794762Z","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":"6ee85563-e392-458a-ad8b-066f17acd382","additionalDepartments":[{"id":"e5fa44b8-c43c-4e33-99a8-d7041311e0f5","dataSource":"RelesysAPI"}],"userGroups":[{"id":"49890fac-46dc-4a21-988f-7d3cea921cd6","dataSource":"RelesysAPI"},{"id":"3b4d7fda-afdc-4d34-95ae-3541c030f2ff","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