Relesys API Docs

v1

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

Welcome

Introduction Getting access

Concepts

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

Endpoints

Users

Update User
PATCH /users/{userId} 
https://api.relesysapp.net/api/v1/users/{userId}
Scopes: relesys.api, relesys.api:write, relesys.api.users, relesys.api.users:write
URL Path
userId string / guid required
Request Body
application/json-patch+json
Schema Example
JSON
[{"value":"My patched name","path":"/name","op":"add"},{"value":{"countryCode":45,"number":"11223344"},"path":"/phoneNumber","op":"replace"},{"path":"/title","op":"remove"},{"value":{"customfieldone":"Custom field 1","customfieldtwo":"Custom field 2"},"path":"/customFields","op":"add"}]
array[object]
  from string optional
  op string optional
  path string optional
  value object optional
Responses
application/json
Unknown
Schema Example
JSON
{"data":{"id":"96e238cb-c7b4-443a-87c2-f10fe82ee3c2","url":null,"departmentUrl":null,"status":"Activated","creationDateTime":"2025-12-14T06:14:52.2563105Z","lastModifiedDateTime":"2025-12-14T06:14:52.2563105Z","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":"66b58073-52df-4987-bd33-a90a2b6e0036","additionalDepartments":[{"id":"f88b03f0-8912-4c72-a73a-42af004cabf0","dataSource":"RelesysAPI"}],"userGroups":[{"id":"6c56ecad-bdfb-4447-809e-df1a0229c344","dataSource":"RelesysAPI"},{"id":"73d78011-9391-456a-b279-521a9f4f585d","dataSource":"RelesysAPI"}],"employmentDate":"2018-12-30T13:30:00Z","employmentEndDate":"2021-12-30T13:30:00Z","customFields":{"customfieldone":"Custom field 1"},"employmentType":"Full-time manager"}}
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      
   employmentType string      
   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