Relesys API Docs

v1.1

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

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.1/users/{userId}
Update a user based on the ID provided. Accepts a JsonPatch request in the body.
Scopes: relesys.api, relesys.api:write, relesys.api.users, relesys.api.users:write
URL Path
userId string / guid The user's unique identifier 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"}]
array[object]
  from string optional
  op string optional
  path string optional
  value object optional
Responses
application/json
200
Schema Example
JSON
{"data":{"id":"cc2d45e1-9040-4302-91da-778c14f71aed","url":null,"departmentUrl":null,"status":"Activated","creationDateTime":"2021-10-24T09:27:40.5553387+00:00","lastModifiedDateTime":"2021-10-24T09:27:40.5553387+00:00","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:00","primaryDepartmentId":"0a221924-719d-47ce-be85-fd2828fe18a9","additionalDepartments":[{"id":"4a0ba280-ed7c-45fc-bde9-2c1f4133be7f","dataSource":"RelesysAPI"}],"userGroups":[{"id":"0ac83db8-6a81-443c-b299-afc3ed8cec04","dataSource":"RelesysAPI"},{"id":"ac569259-503e-4a8f-968b-1ea9f943836a","dataSource":"RelesysAPI"}],"employmentDate":"2018-12-30T13:30:00","employmentEndDate":"2021-12-30T13:30:00"}}
object
  ⯈ data object      
   ⯈ additionalDepartments array[object]      
    dataSource string      
    id string / guid      
   birthDate datetime      
   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