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

Update User
PATCH /users/{userId} 
https://api.relesysapp.net/api/v1.3/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":"7aea74f2-c0ef-4307-aa16-d1badbfc2dc0","url":null,"departmentUrl":null,"status":"Activated","creationDateTime":"2025-04-03T22:08:04.3486385Z","lastModifiedDateTime":"2025-04-03T22:08:04.3486385Z","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":"db25fa46-6212-456b-add8-944d0b3d2049","additionalDepartments":[{"id":"80e4d7fb-6c6b-4dd2-ad9b-e6f0d3b7483b","dataSource":"RelesysAPI"}],"userGroups":[{"id":"6a587d1b-cedf-4adf-bf84-7d4d17a0ac59","dataSource":"RelesysAPI"},{"id":"bab6408e-27e0-434c-8e06-cd338c2bfa55","dataSource":"RelesysAPI"}],"employmentDate":"2018-12-30T13:30:00Z","employmentEndDate":"2021-12-30T13:30:00Z","customFields":{"customfieldone":"Custom field 1"}}}
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