Relesys API Docs

Users

Update User

PATCH /users/{userId}

https://api.relesysapp.net/api/v1/users/{userId}

Update a user based on the ID provided. Accepts a JsonPatch request in the body.

When patching the customFields array, the externalId (see the documentation for 'Get User Custom Fields') is used as the key reference.

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"},{"value":{"customfieldone":"Custom field 1","customfieldtwo":"Custom field 2"},"path":"/customFields","op":"add"},{"value":"Female","path":"/gender","op":"replace"},{"value":"NUA","path":"/initials","op":"add"},{"value":"R-12345","path":"/registerNumber","op":"add"},{"value":"D-67890","path":"/dutyPlanNumber","op":"add"},{"value":"2b1c8071-9814-4161-a6ab-ff0d7f8cdad1","path":"/imageId","op":"replace"},{"value":"cac4defc-3cbe-4563-857d-f500e2681f66","path":"/memberCardId","op":"replace"},{"value":"1234567890","path":"/cardNumber","op":"replace"}]

array[object]
from	string			optional
op	string			optional
path	string			optional
value	object			optional

Responses

application/json

Schema Example

JSON

{"data":{"id":"f814aa27-0dd2-4c70-9d21-1a25f2224555","url":null,"departmentUrl":null,"status":"Activated","creationDateTime":"2026-05-15T15:47:38.0609016Z","lastModifiedDateTime":"2026-05-15T15:47:38.0609016Z","image":{"id":"eabc1803-82fa-47a9-bf51-9d195b09a80b","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"image.png"},"memberCard":{"name":"Member Card Name","cardNumber":"1234567890","id":"3c47ca1b-440e-4c2c-9d42-4d33cfe3abbb","url":null},"externalId":"NUA","name":"New User A","initials":"NUA","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","gender":"Male","primaryDepartmentId":"f218b35b-3c4b-43b1-977c-a423204a78a1","additionalDepartments":[{"id":"a7bd1303-8f9e-4b76-a606-feb251e5775c","dataSource":"RelesysAPI"}],"userGroups":[{"id":"6a30a72f-9c36-408b-b211-79f6a48c10d9","dataSource":"RelesysAPI"},{"id":"66ccbc57-0899-412f-bf2e-d70bfb0301e6","dataSource":"RelesysAPI"}],"employmentDate":"2018-12-30T13:30:00Z","employmentEndDate":"2021-12-30T13:30:00Z","customFields":{"customfieldone":"Custom field 1"},"employmentType":"Full-time manager","registerNumber":"RN12345","dutyPlanNumber":"DP12345"}}

object
⯈ data	object
⯈ additionalDepartments	array[object]
dataSource	string
id	string / guid
birthDate	datetime
customFields	dictionary`2
dataSource	string
departmentUrl	string
dutyPlanNumber	string
email	string
employmentDate	datetime
employmentEndDate	datetime
employmentType	string
externalId	string
gender	string
id	string / guid
⯈ image	object
contentType	string
downloadUrl	string
fileName	string
id	string / guid
referenceUrl	string
initials	string
⯈ memberCard	object
cardNumber	string
id	string / guid
name	string
url	string
name	string
⯈ phoneNumber	object
countryCode	integer
number	string
primaryDepartmentId	string / guid
registerNumber	string
secondaryEmail	string
⯈ secondaryPhoneNumber	object
countryCode	integer
number	string
status	string
title	string
url	string
⯈ userGroups	array[object]
dataSource	string
id	string / guid
userName	string