Relesys API Docs

v1.3

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

Welcome

Introduction Getting access

Concepts

Scopes HTTP Status Codes Request Throttling Pagination Filtering Sorting Patch Requests Permissions Notifications Markdown Syntax Module Settings Recurrence Rules

Endpoints

Users

Create User
POST /users 
https://api.relesystest.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
  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
201
Schema Example
JSON
{"data":{"id":"e73e26ec-5f1c-44de-b277-c3412d4e6414","url":null,"departmentUrl":null,"status":"Activated","creationDateTime":"2026-04-16T10:43:13.4087523Z","lastModifiedDateTime":"2026-04-16T10:43:13.4087523Z","image":{"id":"cbbb7f69-aafd-4470-8b47-623e05c709eb","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"image.png"},"memberCard":{"name":"Member Card Name","cardNumber":"1234567890","id":"f7804f7d-cda4-46f4-9538-b2ef560e8d44","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":"92b67e8b-9139-42b8-9307-776add57b517","additionalDepartments":[{"id":"c99965ea-29b1-4ccd-8e6f-82f335187ea4","dataSource":"RelesysAPI"}],"userGroups":[{"id":"366ce2b3-5fd1-4f24-ae7a-c0d0fac08e48","dataSource":"RelesysAPI"},{"id":"a36cc629-f205-4589-be2a-d11439042ac5","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"},"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