Relesys API Docs

v1.3

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

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
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
JSON
{"data":{"id":"631b2a43-5413-4dc0-af31-233560750f4f","url":null,"departmentUrl":null,"status":"Activated","creationDateTime":"2025-06-06T20:36:12.1890361Z","lastModifiedDateTime":"2025-06-06T20:36:12.1890361Z","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":"c41dc0d4-27ed-4b0d-a128-2d035fdf57cf","additionalDepartments":[{"id":"799988ec-45f9-409e-b808-c31b997ab884","dataSource":"RelesysAPI"}],"userGroups":[{"id":"bb891506-a55f-44fe-b7ab-c897127bfeaa","dataSource":"RelesysAPI"},{"id":"47063f81-11bb-48dd-9ef5-63fe95777465","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