Update user entities
curl --request PATCH \
--url https://staging.api.us.aptlydone.com/auth/v1/user/update-entities/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tenantId": "40c1d320-3048-4e61-9faa-7f73d6886616",
"managerId": "066804be-6469-48ff-a787-12794368b6ea",
"roleIds": [
"b27ff533-f174-4daf-833e-37745fa25647",
"df01a489-fc3b-429c-9bee-e8f9c2985733"
],
"positionIds": [
"cd72f6c0-866a-47d7-a529-18effdf40d35",
"4c385a1d-c1c6-42a2-a9aa-f3db5b1ba360"
],
"groups": [
{
"groupId": "f9ba0493-da6f-44bc-998c-ec417c6a0807",
"isPrimaryOrg": true
}
],
"email": "[email protected]",
"name": "Eula Cummerata",
"displayName": "Carroll Osinski",
"firstName": "Ora",
"lastName": "Spinka",
"accountType": "k",
"userType": "X",
"employeeId": "O",
"employeeNumber": "p",
"employeeType": "NRluvYCyZe",
"employmentType": "NMlYVixcbD",
"mobilePhone": "+1 (555) 123-4567",
"profileImageUrl": "https://picsum.photos/seed/jGHXAfjJ7/3232/1932",
"currencyCode": "USD",
"currencyName": "US Dollars",
"status": "ACTIVE",
"dateFormat": "MM/DD/YYYY",
"sourceId": "2nFu2AI5LqVDHijIv3fR",
"actorType": "eCMJYkjHwy",
"aiAgentType": "bPoBClRbegbntvb",
"startDate": "2025-10-14T14:16:32.154Z",
"terminationDate": "2026-12-14T14:15:37.653Z",
"customAttributes": {
"department": "Engineering",
"level": "Senior"
}
}
'import requests
url = "https://staging.api.us.aptlydone.com/auth/v1/user/update-entities/{id}"
payload = {
"tenantId": "40c1d320-3048-4e61-9faa-7f73d6886616",
"managerId": "066804be-6469-48ff-a787-12794368b6ea",
"roleIds": ["b27ff533-f174-4daf-833e-37745fa25647", "df01a489-fc3b-429c-9bee-e8f9c2985733"],
"positionIds": ["cd72f6c0-866a-47d7-a529-18effdf40d35", "4c385a1d-c1c6-42a2-a9aa-f3db5b1ba360"],
"groups": [
{
"groupId": "f9ba0493-da6f-44bc-998c-ec417c6a0807",
"isPrimaryOrg": True
}
],
"email": "[email protected]",
"name": "Eula Cummerata",
"displayName": "Carroll Osinski",
"firstName": "Ora",
"lastName": "Spinka",
"accountType": "k",
"userType": "X",
"employeeId": "O",
"employeeNumber": "p",
"employeeType": "NRluvYCyZe",
"employmentType": "NMlYVixcbD",
"mobilePhone": "+1 (555) 123-4567",
"profileImageUrl": "https://picsum.photos/seed/jGHXAfjJ7/3232/1932",
"currencyCode": "USD",
"currencyName": "US Dollars",
"status": "ACTIVE",
"dateFormat": "MM/DD/YYYY",
"sourceId": "2nFu2AI5LqVDHijIv3fR",
"actorType": "eCMJYkjHwy",
"aiAgentType": "bPoBClRbegbntvb",
"startDate": "2025-10-14T14:16:32.154Z",
"terminationDate": "2026-12-14T14:15:37.653Z",
"customAttributes": {
"department": "Engineering",
"level": "Senior"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tenantId: '40c1d320-3048-4e61-9faa-7f73d6886616',
managerId: '066804be-6469-48ff-a787-12794368b6ea',
roleIds: ['b27ff533-f174-4daf-833e-37745fa25647', 'df01a489-fc3b-429c-9bee-e8f9c2985733'],
positionIds: ['cd72f6c0-866a-47d7-a529-18effdf40d35', '4c385a1d-c1c6-42a2-a9aa-f3db5b1ba360'],
groups: [{groupId: 'f9ba0493-da6f-44bc-998c-ec417c6a0807', isPrimaryOrg: true}],
email: '[email protected]',
name: 'Eula Cummerata',
displayName: 'Carroll Osinski',
firstName: 'Ora',
lastName: 'Spinka',
accountType: 'k',
userType: 'X',
employeeId: 'O',
employeeNumber: 'p',
employeeType: 'NRluvYCyZe',
employmentType: 'NMlYVixcbD',
mobilePhone: '+1 (555) 123-4567',
profileImageUrl: 'https://picsum.photos/seed/jGHXAfjJ7/3232/1932',
currencyCode: 'USD',
currencyName: 'US Dollars',
status: 'ACTIVE',
dateFormat: 'MM/DD/YYYY',
sourceId: '2nFu2AI5LqVDHijIv3fR',
actorType: 'eCMJYkjHwy',
aiAgentType: 'bPoBClRbegbntvb',
startDate: '2025-10-14T14:16:32.154Z',
terminationDate: '2026-12-14T14:15:37.653Z',
customAttributes: {department: 'Engineering', level: 'Senior'}
})
};
fetch('https://staging.api.us.aptlydone.com/auth/v1/user/update-entities/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging.api.us.aptlydone.com/auth/v1/user/update-entities/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'tenantId' => '40c1d320-3048-4e61-9faa-7f73d6886616',
'managerId' => '066804be-6469-48ff-a787-12794368b6ea',
'roleIds' => [
'b27ff533-f174-4daf-833e-37745fa25647',
'df01a489-fc3b-429c-9bee-e8f9c2985733'
],
'positionIds' => [
'cd72f6c0-866a-47d7-a529-18effdf40d35',
'4c385a1d-c1c6-42a2-a9aa-f3db5b1ba360'
],
'groups' => [
[
'groupId' => 'f9ba0493-da6f-44bc-998c-ec417c6a0807',
'isPrimaryOrg' => true
]
],
'email' => '[email protected]',
'name' => 'Eula Cummerata',
'displayName' => 'Carroll Osinski',
'firstName' => 'Ora',
'lastName' => 'Spinka',
'accountType' => 'k',
'userType' => 'X',
'employeeId' => 'O',
'employeeNumber' => 'p',
'employeeType' => 'NRluvYCyZe',
'employmentType' => 'NMlYVixcbD',
'mobilePhone' => '+1 (555) 123-4567',
'profileImageUrl' => 'https://picsum.photos/seed/jGHXAfjJ7/3232/1932',
'currencyCode' => 'USD',
'currencyName' => 'US Dollars',
'status' => 'ACTIVE',
'dateFormat' => 'MM/DD/YYYY',
'sourceId' => '2nFu2AI5LqVDHijIv3fR',
'actorType' => 'eCMJYkjHwy',
'aiAgentType' => 'bPoBClRbegbntvb',
'startDate' => '2025-10-14T14:16:32.154Z',
'terminationDate' => '2026-12-14T14:15:37.653Z',
'customAttributes' => [
'department' => 'Engineering',
'level' => 'Senior'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://staging.api.us.aptlydone.com/auth/v1/user/update-entities/{id}"
payload := strings.NewReader("{\n \"tenantId\": \"40c1d320-3048-4e61-9faa-7f73d6886616\",\n \"managerId\": \"066804be-6469-48ff-a787-12794368b6ea\",\n \"roleIds\": [\n \"b27ff533-f174-4daf-833e-37745fa25647\",\n \"df01a489-fc3b-429c-9bee-e8f9c2985733\"\n ],\n \"positionIds\": [\n \"cd72f6c0-866a-47d7-a529-18effdf40d35\",\n \"4c385a1d-c1c6-42a2-a9aa-f3db5b1ba360\"\n ],\n \"groups\": [\n {\n \"groupId\": \"f9ba0493-da6f-44bc-998c-ec417c6a0807\",\n \"isPrimaryOrg\": true\n }\n ],\n \"email\": \"[email protected]\",\n \"name\": \"Eula Cummerata\",\n \"displayName\": \"Carroll Osinski\",\n \"firstName\": \"Ora\",\n \"lastName\": \"Spinka\",\n \"accountType\": \"k\",\n \"userType\": \"X\",\n \"employeeId\": \"O\",\n \"employeeNumber\": \"p\",\n \"employeeType\": \"NRluvYCyZe\",\n \"employmentType\": \"NMlYVixcbD\",\n \"mobilePhone\": \"+1 (555) 123-4567\",\n \"profileImageUrl\": \"https://picsum.photos/seed/jGHXAfjJ7/3232/1932\",\n \"currencyCode\": \"USD\",\n \"currencyName\": \"US Dollars\",\n \"status\": \"ACTIVE\",\n \"dateFormat\": \"MM/DD/YYYY\",\n \"sourceId\": \"2nFu2AI5LqVDHijIv3fR\",\n \"actorType\": \"eCMJYkjHwy\",\n \"aiAgentType\": \"bPoBClRbegbntvb\",\n \"startDate\": \"2025-10-14T14:16:32.154Z\",\n \"terminationDate\": \"2026-12-14T14:15:37.653Z\",\n \"customAttributes\": {\n \"department\": \"Engineering\",\n \"level\": \"Senior\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://staging.api.us.aptlydone.com/auth/v1/user/update-entities/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"tenantId\": \"40c1d320-3048-4e61-9faa-7f73d6886616\",\n \"managerId\": \"066804be-6469-48ff-a787-12794368b6ea\",\n \"roleIds\": [\n \"b27ff533-f174-4daf-833e-37745fa25647\",\n \"df01a489-fc3b-429c-9bee-e8f9c2985733\"\n ],\n \"positionIds\": [\n \"cd72f6c0-866a-47d7-a529-18effdf40d35\",\n \"4c385a1d-c1c6-42a2-a9aa-f3db5b1ba360\"\n ],\n \"groups\": [\n {\n \"groupId\": \"f9ba0493-da6f-44bc-998c-ec417c6a0807\",\n \"isPrimaryOrg\": true\n }\n ],\n \"email\": \"[email protected]\",\n \"name\": \"Eula Cummerata\",\n \"displayName\": \"Carroll Osinski\",\n \"firstName\": \"Ora\",\n \"lastName\": \"Spinka\",\n \"accountType\": \"k\",\n \"userType\": \"X\",\n \"employeeId\": \"O\",\n \"employeeNumber\": \"p\",\n \"employeeType\": \"NRluvYCyZe\",\n \"employmentType\": \"NMlYVixcbD\",\n \"mobilePhone\": \"+1 (555) 123-4567\",\n \"profileImageUrl\": \"https://picsum.photos/seed/jGHXAfjJ7/3232/1932\",\n \"currencyCode\": \"USD\",\n \"currencyName\": \"US Dollars\",\n \"status\": \"ACTIVE\",\n \"dateFormat\": \"MM/DD/YYYY\",\n \"sourceId\": \"2nFu2AI5LqVDHijIv3fR\",\n \"actorType\": \"eCMJYkjHwy\",\n \"aiAgentType\": \"bPoBClRbegbntvb\",\n \"startDate\": \"2025-10-14T14:16:32.154Z\",\n \"terminationDate\": \"2026-12-14T14:15:37.653Z\",\n \"customAttributes\": {\n \"department\": \"Engineering\",\n \"level\": \"Senior\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.us.aptlydone.com/auth/v1/user/update-entities/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tenantId\": \"40c1d320-3048-4e61-9faa-7f73d6886616\",\n \"managerId\": \"066804be-6469-48ff-a787-12794368b6ea\",\n \"roleIds\": [\n \"b27ff533-f174-4daf-833e-37745fa25647\",\n \"df01a489-fc3b-429c-9bee-e8f9c2985733\"\n ],\n \"positionIds\": [\n \"cd72f6c0-866a-47d7-a529-18effdf40d35\",\n \"4c385a1d-c1c6-42a2-a9aa-f3db5b1ba360\"\n ],\n \"groups\": [\n {\n \"groupId\": \"f9ba0493-da6f-44bc-998c-ec417c6a0807\",\n \"isPrimaryOrg\": true\n }\n ],\n \"email\": \"[email protected]\",\n \"name\": \"Eula Cummerata\",\n \"displayName\": \"Carroll Osinski\",\n \"firstName\": \"Ora\",\n \"lastName\": \"Spinka\",\n \"accountType\": \"k\",\n \"userType\": \"X\",\n \"employeeId\": \"O\",\n \"employeeNumber\": \"p\",\n \"employeeType\": \"NRluvYCyZe\",\n \"employmentType\": \"NMlYVixcbD\",\n \"mobilePhone\": \"+1 (555) 123-4567\",\n \"profileImageUrl\": \"https://picsum.photos/seed/jGHXAfjJ7/3232/1932\",\n \"currencyCode\": \"USD\",\n \"currencyName\": \"US Dollars\",\n \"status\": \"ACTIVE\",\n \"dateFormat\": \"MM/DD/YYYY\",\n \"sourceId\": \"2nFu2AI5LqVDHijIv3fR\",\n \"actorType\": \"eCMJYkjHwy\",\n \"aiAgentType\": \"bPoBClRbegbntvb\",\n \"startDate\": \"2025-10-14T14:16:32.154Z\",\n \"terminationDate\": \"2026-12-14T14:15:37.653Z\",\n \"customAttributes\": {\n \"department\": \"Engineering\",\n \"level\": \"Senior\"\n }\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 200,
"timestamp": "2026-01-12T09:10:12.337Z",
"message": "Success",
"data": {
"id": "d4b8eae5-02dc-4a9a-9afe-b2f72e006ebb",
"userId": "10001",
"loginId": "[email protected]",
"descopeUserId": "7eOCsfn938mPjGwc5IZu4m5QAQWZS0xy",
"activeTenantId": "3d4c3b64-f52d-4890-aa26-ea2e52eb5a4d",
"email": "[email protected]",
"name": "Vera Wolf",
"displayName": "Brooke Rohan",
"isSAML": false,
"mobilePhone": "1-491-503-1712 x7659",
"firstName": "Jolie",
"lastName": "Morissette-Spencer",
"profileImageUrl": "https://loremflickr.com/807/3278?lock=727001695474930",
"currencyName": "Euro",
"currencyCode": "EUR",
"accountType": "h",
"autoProvisioned": false,
"employeeId": "f",
"employeeNumber": "h",
"employeeType": "D",
"employmentType": "j",
"userType": "z",
"sourceId": "LaTdLstQ4lRlowebEqMq",
"actorType": "khOhlolFNb",
"aiAgentType": "XwUPLzjRvaLBsCG",
"startDate": "2025-11-19T05:27:09.941Z",
"terminationDate": "2026-10-16T18:32:34.796Z",
"customAttributes": {
"department": "Engineering",
"level": "Senior"
},
"externalId": "EXT12345",
"instanceId": "6a5dd288-ec68-44ff-a1ce-b0128347b3b6",
"systemIntegrationId": "6e94c7f7-576d-48ed-8cc0-b8b09f56cba8",
"displayLanguage": "en-US",
"columnViewSettings": {
"columns": [
"name",
"email",
"status"
]
},
"searchData": [
"Directives",
"Liaison"
],
"managerSync": true,
"manager": {
"id": "f99a50c1-f10a-47ee-a20d-8792e1a41be8",
"userId": "10001",
"descopeUserId": "NAe2gVjONZqYRgtvliF3pyKmPchGcHXg",
"name": "Mr. Ivan Thiel",
"email": "[email protected]",
"firstName": "Adan",
"lastName": "Johnston",
"displayName": "Lucia Mayert",
"mobilePhone": "(270) 663-0245 x3376",
"profileImageUrl": "https://picsum.photos/seed/46GUUknbGJ/2329/2262",
"createdOn": "2026-01-12T05:07:05.101Z",
"updatedOn": "2026-01-12T03:30:03.871Z",
"userPositions": [
{
"id": "64648e27-e093-44c3-b5a1-49154a0a1660",
"userId": "898bf847-18c5-4022-b4be-6035aa06877f",
"tenantId": "4f1cd86e-c077-4acc-b242-09478ad3ec79",
"positionsId": "d2e8b360-686c-4e2c-a788-5ca9d7fc3daa",
"autoProvisioned": true,
"instanceId": "14120202-09d5-4b50-b522-b41d0821f7d0",
"isEditable": false,
"isDeleted": true,
"deletedOn": "2025-08-19T23:46:35.207Z",
"createdOn": "2026-01-11T12:03:07.517Z",
"updatedOn": "2026-01-11T19:28:18.878Z",
"positionName": "Senior Developer",
"isSCIMProvisioned": false,
"externalId": "f143825c-798e-43bb-8f88-da1ff0d8b399"
}
],
"primaryOrganization": {
"groupName": "Aplty Inc.",
"displayName": "Aplty Incorporated",
"tenantGroupTypeId": "03cf8779-7be8-4ea9-a02e-99aa4454e94a",
"tenantGroupTypeName": "Organization"
},
"managerName": "Doris Brakus",
"managerProfileImageUrl": "https://loremflickr.com/567/2473?lock=5385426157985712"
},
"isDeleted": true,
"isExpirePassword": true,
"createdOn": "2026-01-12T04:59:38.064Z",
"lastLoginDate": "2026-01-11T09:45:20.832Z",
"createdBy": "56dbdb67-fdb4-478c-bb02-cea7b3e899ec",
"updatedOn": "2026-01-11T11:57:54.376Z",
"updatedBy": "f6267b64-ddad-4db5-ab64-b587d49af1b6",
"deletedOn": "2025-01-27T10:51:41.196Z",
"delegationsReceived": 1,
"delegationsIssued": 1,
"dashboardData": [
{
"x": 0,
"y": 0,
"w": 2,
"h": 1,
"i": "0"
},
{
"x": 0,
"y": 1,
"w": 2,
"h": 4,
"i": "1"
},
{
"x": 0,
"y": 5,
"w": 1,
"h": 4,
"i": "2"
},
{
"x": 1,
"y": 5,
"w": 1,
"h": 4,
"i": "3"
}
],
"userRoles": [
{
"id": "320bf21d-7b31-4b31-93ef-1a2e9f93f8a9",
"tenantId": "8fcca66f-5b95-4f54-a8fd-b1c27dd092ef",
"tenantRoleId": "9c9bd186-23f1-4f5f-877f-b25aad685652",
"roleName": "pine begonia",
"autoProvisioned": false,
"instanceId": "5863ab84-7099-4ac2-8b48-f24f1b21b4a3",
"createdOn": "2026-01-11T22:33:40.204Z",
"deletedOn": "2025-05-31T10:27:33.998Z",
"updatedOn": "2026-01-12T03:25:36.185Z"
}
],
"userPositions": [
{
"id": "64648e27-e093-44c3-b5a1-49154a0a1660",
"userId": "898bf847-18c5-4022-b4be-6035aa06877f",
"tenantId": "4f1cd86e-c077-4acc-b242-09478ad3ec79",
"positionsId": "d2e8b360-686c-4e2c-a788-5ca9d7fc3daa",
"autoProvisioned": true,
"instanceId": "14120202-09d5-4b50-b522-b41d0821f7d0",
"isEditable": false,
"isDeleted": true,
"deletedOn": "2025-08-19T23:46:35.207Z",
"createdOn": "2026-01-11T12:03:07.517Z",
"updatedOn": "2026-01-11T19:28:18.878Z",
"positionName": "Senior Developer",
"isSCIMProvisioned": false,
"externalId": "f143825c-798e-43bb-8f88-da1ff0d8b399"
}
],
"userGroups": [
{
"id": "77827dfa-cf21-4fec-a5bd-c568d9583431",
"tenantId": "277ab493-cb1d-40f3-8d61-6432cc78df9a",
"userId": "0e2a3c9d-3210-4e98-9dcc-67e8f63305c1",
"groupId": "2b0e14b4-2d70-4517-afc3-9ba10bb890c2",
"groupTypeId": "40471fbe-5866-486d-9f76-c96482e42277",
"groupName": "Engineering Team",
"groupTypeName": "Department",
"displayName": "Engineering Department",
"isPrimaryOrg": false,
"externalId": "0802fdf7-09f2-4445-9e7c-3fc145cbf544",
"instanceId": "c024da14-f39b-4aa5-9be8-6003132f6c71",
"primaryOrgSetOn": "2026-01-11T23:45:02.944Z",
"autoProvisioned": true,
"isDeleted": true,
"deletedOn": "2025-06-16T09:06:25.957Z",
"createdOn": "2026-01-11T10:22:54.670Z",
"updatedOn": "2026-01-11T18:31:52.005Z"
}
],
"status": "ACTIVE",
"dateFormat": "MM/DD/YYYY",
"isImpersonated": true
}
}Users
Update user entities
PATCH
/
v1
/
user
/
update-entities
/
{id}
Update user entities
curl --request PATCH \
--url https://staging.api.us.aptlydone.com/auth/v1/user/update-entities/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tenantId": "40c1d320-3048-4e61-9faa-7f73d6886616",
"managerId": "066804be-6469-48ff-a787-12794368b6ea",
"roleIds": [
"b27ff533-f174-4daf-833e-37745fa25647",
"df01a489-fc3b-429c-9bee-e8f9c2985733"
],
"positionIds": [
"cd72f6c0-866a-47d7-a529-18effdf40d35",
"4c385a1d-c1c6-42a2-a9aa-f3db5b1ba360"
],
"groups": [
{
"groupId": "f9ba0493-da6f-44bc-998c-ec417c6a0807",
"isPrimaryOrg": true
}
],
"email": "[email protected]",
"name": "Eula Cummerata",
"displayName": "Carroll Osinski",
"firstName": "Ora",
"lastName": "Spinka",
"accountType": "k",
"userType": "X",
"employeeId": "O",
"employeeNumber": "p",
"employeeType": "NRluvYCyZe",
"employmentType": "NMlYVixcbD",
"mobilePhone": "+1 (555) 123-4567",
"profileImageUrl": "https://picsum.photos/seed/jGHXAfjJ7/3232/1932",
"currencyCode": "USD",
"currencyName": "US Dollars",
"status": "ACTIVE",
"dateFormat": "MM/DD/YYYY",
"sourceId": "2nFu2AI5LqVDHijIv3fR",
"actorType": "eCMJYkjHwy",
"aiAgentType": "bPoBClRbegbntvb",
"startDate": "2025-10-14T14:16:32.154Z",
"terminationDate": "2026-12-14T14:15:37.653Z",
"customAttributes": {
"department": "Engineering",
"level": "Senior"
}
}
'import requests
url = "https://staging.api.us.aptlydone.com/auth/v1/user/update-entities/{id}"
payload = {
"tenantId": "40c1d320-3048-4e61-9faa-7f73d6886616",
"managerId": "066804be-6469-48ff-a787-12794368b6ea",
"roleIds": ["b27ff533-f174-4daf-833e-37745fa25647", "df01a489-fc3b-429c-9bee-e8f9c2985733"],
"positionIds": ["cd72f6c0-866a-47d7-a529-18effdf40d35", "4c385a1d-c1c6-42a2-a9aa-f3db5b1ba360"],
"groups": [
{
"groupId": "f9ba0493-da6f-44bc-998c-ec417c6a0807",
"isPrimaryOrg": True
}
],
"email": "[email protected]",
"name": "Eula Cummerata",
"displayName": "Carroll Osinski",
"firstName": "Ora",
"lastName": "Spinka",
"accountType": "k",
"userType": "X",
"employeeId": "O",
"employeeNumber": "p",
"employeeType": "NRluvYCyZe",
"employmentType": "NMlYVixcbD",
"mobilePhone": "+1 (555) 123-4567",
"profileImageUrl": "https://picsum.photos/seed/jGHXAfjJ7/3232/1932",
"currencyCode": "USD",
"currencyName": "US Dollars",
"status": "ACTIVE",
"dateFormat": "MM/DD/YYYY",
"sourceId": "2nFu2AI5LqVDHijIv3fR",
"actorType": "eCMJYkjHwy",
"aiAgentType": "bPoBClRbegbntvb",
"startDate": "2025-10-14T14:16:32.154Z",
"terminationDate": "2026-12-14T14:15:37.653Z",
"customAttributes": {
"department": "Engineering",
"level": "Senior"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tenantId: '40c1d320-3048-4e61-9faa-7f73d6886616',
managerId: '066804be-6469-48ff-a787-12794368b6ea',
roleIds: ['b27ff533-f174-4daf-833e-37745fa25647', 'df01a489-fc3b-429c-9bee-e8f9c2985733'],
positionIds: ['cd72f6c0-866a-47d7-a529-18effdf40d35', '4c385a1d-c1c6-42a2-a9aa-f3db5b1ba360'],
groups: [{groupId: 'f9ba0493-da6f-44bc-998c-ec417c6a0807', isPrimaryOrg: true}],
email: '[email protected]',
name: 'Eula Cummerata',
displayName: 'Carroll Osinski',
firstName: 'Ora',
lastName: 'Spinka',
accountType: 'k',
userType: 'X',
employeeId: 'O',
employeeNumber: 'p',
employeeType: 'NRluvYCyZe',
employmentType: 'NMlYVixcbD',
mobilePhone: '+1 (555) 123-4567',
profileImageUrl: 'https://picsum.photos/seed/jGHXAfjJ7/3232/1932',
currencyCode: 'USD',
currencyName: 'US Dollars',
status: 'ACTIVE',
dateFormat: 'MM/DD/YYYY',
sourceId: '2nFu2AI5LqVDHijIv3fR',
actorType: 'eCMJYkjHwy',
aiAgentType: 'bPoBClRbegbntvb',
startDate: '2025-10-14T14:16:32.154Z',
terminationDate: '2026-12-14T14:15:37.653Z',
customAttributes: {department: 'Engineering', level: 'Senior'}
})
};
fetch('https://staging.api.us.aptlydone.com/auth/v1/user/update-entities/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging.api.us.aptlydone.com/auth/v1/user/update-entities/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'tenantId' => '40c1d320-3048-4e61-9faa-7f73d6886616',
'managerId' => '066804be-6469-48ff-a787-12794368b6ea',
'roleIds' => [
'b27ff533-f174-4daf-833e-37745fa25647',
'df01a489-fc3b-429c-9bee-e8f9c2985733'
],
'positionIds' => [
'cd72f6c0-866a-47d7-a529-18effdf40d35',
'4c385a1d-c1c6-42a2-a9aa-f3db5b1ba360'
],
'groups' => [
[
'groupId' => 'f9ba0493-da6f-44bc-998c-ec417c6a0807',
'isPrimaryOrg' => true
]
],
'email' => '[email protected]',
'name' => 'Eula Cummerata',
'displayName' => 'Carroll Osinski',
'firstName' => 'Ora',
'lastName' => 'Spinka',
'accountType' => 'k',
'userType' => 'X',
'employeeId' => 'O',
'employeeNumber' => 'p',
'employeeType' => 'NRluvYCyZe',
'employmentType' => 'NMlYVixcbD',
'mobilePhone' => '+1 (555) 123-4567',
'profileImageUrl' => 'https://picsum.photos/seed/jGHXAfjJ7/3232/1932',
'currencyCode' => 'USD',
'currencyName' => 'US Dollars',
'status' => 'ACTIVE',
'dateFormat' => 'MM/DD/YYYY',
'sourceId' => '2nFu2AI5LqVDHijIv3fR',
'actorType' => 'eCMJYkjHwy',
'aiAgentType' => 'bPoBClRbegbntvb',
'startDate' => '2025-10-14T14:16:32.154Z',
'terminationDate' => '2026-12-14T14:15:37.653Z',
'customAttributes' => [
'department' => 'Engineering',
'level' => 'Senior'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://staging.api.us.aptlydone.com/auth/v1/user/update-entities/{id}"
payload := strings.NewReader("{\n \"tenantId\": \"40c1d320-3048-4e61-9faa-7f73d6886616\",\n \"managerId\": \"066804be-6469-48ff-a787-12794368b6ea\",\n \"roleIds\": [\n \"b27ff533-f174-4daf-833e-37745fa25647\",\n \"df01a489-fc3b-429c-9bee-e8f9c2985733\"\n ],\n \"positionIds\": [\n \"cd72f6c0-866a-47d7-a529-18effdf40d35\",\n \"4c385a1d-c1c6-42a2-a9aa-f3db5b1ba360\"\n ],\n \"groups\": [\n {\n \"groupId\": \"f9ba0493-da6f-44bc-998c-ec417c6a0807\",\n \"isPrimaryOrg\": true\n }\n ],\n \"email\": \"[email protected]\",\n \"name\": \"Eula Cummerata\",\n \"displayName\": \"Carroll Osinski\",\n \"firstName\": \"Ora\",\n \"lastName\": \"Spinka\",\n \"accountType\": \"k\",\n \"userType\": \"X\",\n \"employeeId\": \"O\",\n \"employeeNumber\": \"p\",\n \"employeeType\": \"NRluvYCyZe\",\n \"employmentType\": \"NMlYVixcbD\",\n \"mobilePhone\": \"+1 (555) 123-4567\",\n \"profileImageUrl\": \"https://picsum.photos/seed/jGHXAfjJ7/3232/1932\",\n \"currencyCode\": \"USD\",\n \"currencyName\": \"US Dollars\",\n \"status\": \"ACTIVE\",\n \"dateFormat\": \"MM/DD/YYYY\",\n \"sourceId\": \"2nFu2AI5LqVDHijIv3fR\",\n \"actorType\": \"eCMJYkjHwy\",\n \"aiAgentType\": \"bPoBClRbegbntvb\",\n \"startDate\": \"2025-10-14T14:16:32.154Z\",\n \"terminationDate\": \"2026-12-14T14:15:37.653Z\",\n \"customAttributes\": {\n \"department\": \"Engineering\",\n \"level\": \"Senior\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://staging.api.us.aptlydone.com/auth/v1/user/update-entities/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"tenantId\": \"40c1d320-3048-4e61-9faa-7f73d6886616\",\n \"managerId\": \"066804be-6469-48ff-a787-12794368b6ea\",\n \"roleIds\": [\n \"b27ff533-f174-4daf-833e-37745fa25647\",\n \"df01a489-fc3b-429c-9bee-e8f9c2985733\"\n ],\n \"positionIds\": [\n \"cd72f6c0-866a-47d7-a529-18effdf40d35\",\n \"4c385a1d-c1c6-42a2-a9aa-f3db5b1ba360\"\n ],\n \"groups\": [\n {\n \"groupId\": \"f9ba0493-da6f-44bc-998c-ec417c6a0807\",\n \"isPrimaryOrg\": true\n }\n ],\n \"email\": \"[email protected]\",\n \"name\": \"Eula Cummerata\",\n \"displayName\": \"Carroll Osinski\",\n \"firstName\": \"Ora\",\n \"lastName\": \"Spinka\",\n \"accountType\": \"k\",\n \"userType\": \"X\",\n \"employeeId\": \"O\",\n \"employeeNumber\": \"p\",\n \"employeeType\": \"NRluvYCyZe\",\n \"employmentType\": \"NMlYVixcbD\",\n \"mobilePhone\": \"+1 (555) 123-4567\",\n \"profileImageUrl\": \"https://picsum.photos/seed/jGHXAfjJ7/3232/1932\",\n \"currencyCode\": \"USD\",\n \"currencyName\": \"US Dollars\",\n \"status\": \"ACTIVE\",\n \"dateFormat\": \"MM/DD/YYYY\",\n \"sourceId\": \"2nFu2AI5LqVDHijIv3fR\",\n \"actorType\": \"eCMJYkjHwy\",\n \"aiAgentType\": \"bPoBClRbegbntvb\",\n \"startDate\": \"2025-10-14T14:16:32.154Z\",\n \"terminationDate\": \"2026-12-14T14:15:37.653Z\",\n \"customAttributes\": {\n \"department\": \"Engineering\",\n \"level\": \"Senior\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.us.aptlydone.com/auth/v1/user/update-entities/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tenantId\": \"40c1d320-3048-4e61-9faa-7f73d6886616\",\n \"managerId\": \"066804be-6469-48ff-a787-12794368b6ea\",\n \"roleIds\": [\n \"b27ff533-f174-4daf-833e-37745fa25647\",\n \"df01a489-fc3b-429c-9bee-e8f9c2985733\"\n ],\n \"positionIds\": [\n \"cd72f6c0-866a-47d7-a529-18effdf40d35\",\n \"4c385a1d-c1c6-42a2-a9aa-f3db5b1ba360\"\n ],\n \"groups\": [\n {\n \"groupId\": \"f9ba0493-da6f-44bc-998c-ec417c6a0807\",\n \"isPrimaryOrg\": true\n }\n ],\n \"email\": \"[email protected]\",\n \"name\": \"Eula Cummerata\",\n \"displayName\": \"Carroll Osinski\",\n \"firstName\": \"Ora\",\n \"lastName\": \"Spinka\",\n \"accountType\": \"k\",\n \"userType\": \"X\",\n \"employeeId\": \"O\",\n \"employeeNumber\": \"p\",\n \"employeeType\": \"NRluvYCyZe\",\n \"employmentType\": \"NMlYVixcbD\",\n \"mobilePhone\": \"+1 (555) 123-4567\",\n \"profileImageUrl\": \"https://picsum.photos/seed/jGHXAfjJ7/3232/1932\",\n \"currencyCode\": \"USD\",\n \"currencyName\": \"US Dollars\",\n \"status\": \"ACTIVE\",\n \"dateFormat\": \"MM/DD/YYYY\",\n \"sourceId\": \"2nFu2AI5LqVDHijIv3fR\",\n \"actorType\": \"eCMJYkjHwy\",\n \"aiAgentType\": \"bPoBClRbegbntvb\",\n \"startDate\": \"2025-10-14T14:16:32.154Z\",\n \"terminationDate\": \"2026-12-14T14:15:37.653Z\",\n \"customAttributes\": {\n \"department\": \"Engineering\",\n \"level\": \"Senior\"\n }\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 200,
"timestamp": "2026-01-12T09:10:12.337Z",
"message": "Success",
"data": {
"id": "d4b8eae5-02dc-4a9a-9afe-b2f72e006ebb",
"userId": "10001",
"loginId": "[email protected]",
"descopeUserId": "7eOCsfn938mPjGwc5IZu4m5QAQWZS0xy",
"activeTenantId": "3d4c3b64-f52d-4890-aa26-ea2e52eb5a4d",
"email": "[email protected]",
"name": "Vera Wolf",
"displayName": "Brooke Rohan",
"isSAML": false,
"mobilePhone": "1-491-503-1712 x7659",
"firstName": "Jolie",
"lastName": "Morissette-Spencer",
"profileImageUrl": "https://loremflickr.com/807/3278?lock=727001695474930",
"currencyName": "Euro",
"currencyCode": "EUR",
"accountType": "h",
"autoProvisioned": false,
"employeeId": "f",
"employeeNumber": "h",
"employeeType": "D",
"employmentType": "j",
"userType": "z",
"sourceId": "LaTdLstQ4lRlowebEqMq",
"actorType": "khOhlolFNb",
"aiAgentType": "XwUPLzjRvaLBsCG",
"startDate": "2025-11-19T05:27:09.941Z",
"terminationDate": "2026-10-16T18:32:34.796Z",
"customAttributes": {
"department": "Engineering",
"level": "Senior"
},
"externalId": "EXT12345",
"instanceId": "6a5dd288-ec68-44ff-a1ce-b0128347b3b6",
"systemIntegrationId": "6e94c7f7-576d-48ed-8cc0-b8b09f56cba8",
"displayLanguage": "en-US",
"columnViewSettings": {
"columns": [
"name",
"email",
"status"
]
},
"searchData": [
"Directives",
"Liaison"
],
"managerSync": true,
"manager": {
"id": "f99a50c1-f10a-47ee-a20d-8792e1a41be8",
"userId": "10001",
"descopeUserId": "NAe2gVjONZqYRgtvliF3pyKmPchGcHXg",
"name": "Mr. Ivan Thiel",
"email": "[email protected]",
"firstName": "Adan",
"lastName": "Johnston",
"displayName": "Lucia Mayert",
"mobilePhone": "(270) 663-0245 x3376",
"profileImageUrl": "https://picsum.photos/seed/46GUUknbGJ/2329/2262",
"createdOn": "2026-01-12T05:07:05.101Z",
"updatedOn": "2026-01-12T03:30:03.871Z",
"userPositions": [
{
"id": "64648e27-e093-44c3-b5a1-49154a0a1660",
"userId": "898bf847-18c5-4022-b4be-6035aa06877f",
"tenantId": "4f1cd86e-c077-4acc-b242-09478ad3ec79",
"positionsId": "d2e8b360-686c-4e2c-a788-5ca9d7fc3daa",
"autoProvisioned": true,
"instanceId": "14120202-09d5-4b50-b522-b41d0821f7d0",
"isEditable": false,
"isDeleted": true,
"deletedOn": "2025-08-19T23:46:35.207Z",
"createdOn": "2026-01-11T12:03:07.517Z",
"updatedOn": "2026-01-11T19:28:18.878Z",
"positionName": "Senior Developer",
"isSCIMProvisioned": false,
"externalId": "f143825c-798e-43bb-8f88-da1ff0d8b399"
}
],
"primaryOrganization": {
"groupName": "Aplty Inc.",
"displayName": "Aplty Incorporated",
"tenantGroupTypeId": "03cf8779-7be8-4ea9-a02e-99aa4454e94a",
"tenantGroupTypeName": "Organization"
},
"managerName": "Doris Brakus",
"managerProfileImageUrl": "https://loremflickr.com/567/2473?lock=5385426157985712"
},
"isDeleted": true,
"isExpirePassword": true,
"createdOn": "2026-01-12T04:59:38.064Z",
"lastLoginDate": "2026-01-11T09:45:20.832Z",
"createdBy": "56dbdb67-fdb4-478c-bb02-cea7b3e899ec",
"updatedOn": "2026-01-11T11:57:54.376Z",
"updatedBy": "f6267b64-ddad-4db5-ab64-b587d49af1b6",
"deletedOn": "2025-01-27T10:51:41.196Z",
"delegationsReceived": 1,
"delegationsIssued": 1,
"dashboardData": [
{
"x": 0,
"y": 0,
"w": 2,
"h": 1,
"i": "0"
},
{
"x": 0,
"y": 1,
"w": 2,
"h": 4,
"i": "1"
},
{
"x": 0,
"y": 5,
"w": 1,
"h": 4,
"i": "2"
},
{
"x": 1,
"y": 5,
"w": 1,
"h": 4,
"i": "3"
}
],
"userRoles": [
{
"id": "320bf21d-7b31-4b31-93ef-1a2e9f93f8a9",
"tenantId": "8fcca66f-5b95-4f54-a8fd-b1c27dd092ef",
"tenantRoleId": "9c9bd186-23f1-4f5f-877f-b25aad685652",
"roleName": "pine begonia",
"autoProvisioned": false,
"instanceId": "5863ab84-7099-4ac2-8b48-f24f1b21b4a3",
"createdOn": "2026-01-11T22:33:40.204Z",
"deletedOn": "2025-05-31T10:27:33.998Z",
"updatedOn": "2026-01-12T03:25:36.185Z"
}
],
"userPositions": [
{
"id": "64648e27-e093-44c3-b5a1-49154a0a1660",
"userId": "898bf847-18c5-4022-b4be-6035aa06877f",
"tenantId": "4f1cd86e-c077-4acc-b242-09478ad3ec79",
"positionsId": "d2e8b360-686c-4e2c-a788-5ca9d7fc3daa",
"autoProvisioned": true,
"instanceId": "14120202-09d5-4b50-b522-b41d0821f7d0",
"isEditable": false,
"isDeleted": true,
"deletedOn": "2025-08-19T23:46:35.207Z",
"createdOn": "2026-01-11T12:03:07.517Z",
"updatedOn": "2026-01-11T19:28:18.878Z",
"positionName": "Senior Developer",
"isSCIMProvisioned": false,
"externalId": "f143825c-798e-43bb-8f88-da1ff0d8b399"
}
],
"userGroups": [
{
"id": "77827dfa-cf21-4fec-a5bd-c568d9583431",
"tenantId": "277ab493-cb1d-40f3-8d61-6432cc78df9a",
"userId": "0e2a3c9d-3210-4e98-9dcc-67e8f63305c1",
"groupId": "2b0e14b4-2d70-4517-afc3-9ba10bb890c2",
"groupTypeId": "40471fbe-5866-486d-9f76-c96482e42277",
"groupName": "Engineering Team",
"groupTypeName": "Department",
"displayName": "Engineering Department",
"isPrimaryOrg": false,
"externalId": "0802fdf7-09f2-4445-9e7c-3fc145cbf544",
"instanceId": "c024da14-f39b-4aa5-9be8-6003132f6c71",
"primaryOrgSetOn": "2026-01-11T23:45:02.944Z",
"autoProvisioned": true,
"isDeleted": true,
"deletedOn": "2025-06-16T09:06:25.957Z",
"createdOn": "2026-01-11T10:22:54.670Z",
"updatedOn": "2026-01-11T18:31:52.005Z"
}
],
"status": "ACTIVE",
"dateFormat": "MM/DD/YYYY",
"isImpersonated": true
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Tenant ID
Example:
"40c1d320-3048-4e61-9faa-7f73d6886616"
User manager ID
Example:
"066804be-6469-48ff-a787-12794368b6ea"
User roles IDs
Example:
[
"b27ff533-f174-4daf-833e-37745fa25647",
"df01a489-fc3b-429c-9bee-e8f9c2985733"
]
User positions IDs
Example:
[
"cd72f6c0-866a-47d7-a529-18effdf40d35",
"4c385a1d-c1c6-42a2-a9aa-f3db5b1ba360"
]
User groups
Show child attributes
Show child attributes
Example:
[
{
"groupId": "f9ba0493-da6f-44bc-998c-ec417c6a0807",
"isPrimaryOrg": true
}
]
Full name
Maximum string length:
50Example:
"Eula Cummerata"
Display name
Maximum string length:
50Example:
"Carroll Osinski"
First name
Maximum string length:
50Example:
"Ora"
Last name
Maximum string length:
20Example:
"Spinka"
Type of account
Maximum string length:
20Example:
"k"
Type of user
Maximum string length:
20Example:
"X"
Employee ID
Example:
"O"
Employee Number
Example:
"p"
Type of employment
Maximum string length:
20Example:
"NRluvYCyZe"
Employment Type
Maximum string length:
20Example:
"NMlYVixcbD"
Mobile phone
Maximum string length:
25Pattern:
/^[+()0-9.\s-]{7,25}$/Example:
"+1 (555) 123-4567"
User profile image URL
Maximum string length:
50Example:
"https://picsum.photos/seed/jGHXAfjJ7/3232/1932"
Display currency Code
Example:
"USD"
Display currency Name
Example:
"US Dollars"
User status
Available options:
ACTIVE, INACTIVE, INVITED, DELETED Example:
"ACTIVE"
Date format preference
Example:
"MM/DD/YYYY"
Source ID
Maximum string length:
100Example:
"2nFu2AI5LqVDHijIv3fR"
Actor type
Maximum string length:
50Example:
"eCMJYkjHwy"
AI agent type
Maximum string length:
50Example:
"bPoBClRbegbntvb"
Start date
Example:
"2025-10-14T14:16:32.154Z"
Termination date
Example:
"2026-12-14T14:15:37.653Z"
Custom attributes as JSON object
Example:
{
"department": "Engineering",
"level": "Senior"
}
Response
200 - application/json
User details and entities updated successfully
Was this page helpful?
āI