Relesys API Docs

Users

Update User

PATCH /users/{userId}

https://api.relesystest.net/api/v1.3/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"}]

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

Responses

application/json

Schema Example

JSON

{"data":{"id":"8aafef4d-c268-4382-9765-c5a64901fd74","url":null,"departmentUrl":null,"status":"Activated","creationDateTime":"2026-04-16T10:50:08.62269Z","lastModifiedDateTime":"2026-04-16T10:50:08.62269Z","image":{"id":"b9ca245d-68df-45f9-9fdf-95e1e1069795","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"image.png"},"memberCard":{"name":"Member Card Name","cardNumber":"1234567890","id":"eb5e3ec8-0f08-4888-80ee-438671cc1737","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":"129f1468-a91b-4d73-a179-cebf6a894d60","additionalDepartments":[{"id":"7057be57-166c-4e93-a0fd-f6f60e472242","dataSource":"RelesysAPI"}],"userGroups":[{"id":"a1b0c813-523f-4021-a9fc-033b4ebf4368","dataSource":"RelesysAPI"},{"id":"32b2ac4f-2a55-4f97-baa1-632a91086abc","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.3

Welcome

Concepts

Endpoints

Users

URL Path

Request Body

Responses