Relesys API Docs

Users

Update User

PATCH /users/{userId}

https://api.relesysapp.net/api/v1.4/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":"3dec0025-c645-40b3-a7b7-2c9a099d3a8b","path":"/imageId","op":"replace"},{"value":"626642d5-d8a6-422a-8e33-403b66126c71","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":"e05dee76-9962-4b21-9b3b-b85dd517f235","url":null,"departmentUrl":null,"status":"Activated","creationDateTime":"2026-06-12T17:44:47.0296199Z","lastModifiedDateTime":"2026-06-12T17:44:47.0296199Z","image":{"id":"244d95c8-eebd-445e-8dcb-f4c4105b2cbe","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"image.png"},"memberCard":{"name":"Member Card Name","cardNumber":"1234567890","id":"18191a48-baa2-4b69-b7d0-f68c32c5961f","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":"75178fa7-23cf-47eb-81f6-17576a65a083","additionalDepartments":[{"id":"616f747d-5df6-4fd4-ac31-db97f6b48ee6","dataSource":"RelesysAPI"}],"userGroups":[{"id":"6ba9e7ec-98c7-422b-89a5-bb0df271ce9b","dataSource":"RelesysAPI"},{"id":"7bf7e890-6913-42d1-b3a8-4f3aaffbbb2e","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

Relesys API Docs

v1.4

Welcome

Concepts

Endpoints

Users

URL Path

Request Body

Responses