Relesys API Docs

v1.2

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

Users

Update User
PATCH /users/{userId}
https://api.relesysapp.net/api/v1.2/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":"248f420c-1dd7-4980-b91c-755a2425d9ca","url":null,"departmentUrl":null,"status":"Activated","creationDateTime":"2024-04-23T04:59:15.3664621Z","lastModifiedDateTime":"2024-04-23T04:59:15.3664621Z","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":"016c0776-868c-463d-8c98-7d4d1dd16ade","additionalDepartments":[{"id":"a5498a05-53d1-467f-98c8-79eb94b959b4","dataSource":"RelesysAPI"}],"userGroups":[{"id":"2f686b54-574a-4b4f-a1ab-17f7a28dbdb6","dataSource":"RelesysAPI"},{"id":"7a2ce8f3-2f71-44a2-8b38-c6bfd858c840","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