Update a User by id or external ref

1min
PUT
https://{domain}/app/api/v2/users/{userId}
Note:
Do not use groups with Single Leg designations ['Business Owner', 'Team Manager', 'Field Executive']
Header Parameters
X-Solutions-Callback-Secret
string
Body Parameters
body
UpdateUserRequest
Description
Update User Request
All Of
UserCore  +
userOwnerId
string
userOwnerType
string
function
string
firstName
string
middleName
string
lastName
string
email
string
primaryMobile
object
secondaryMobile
object
groups
string[]
workLocations
string[]
teams
string[]
identification
object
fileID
string
userType
string
department
string
aaaId
string
aaaGroups
string[]
designation
string
employmentType
string<Full-time | Part-time | Contract | NA>
callback
object
Responses
202
Request Accepted
SuccessResponse
data
Data
error
Error
request
Request
default
Default Error Response
DefaultResponse
error
Error
request
Request
Curl
JS
Ruby
Python
curl --location --globoff --request PUT 'https://{domain}/app/api/v2/users/{userId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "primaryMobile": {
    "countryCode": "",
    "number": ""
  },
  "secondaryMobile": {
    "countryCode": "",
    "number": ""
  },
  "callback": {
    "url": ""
  }
}'
curl --location --globoff --request PUT 'https://{domain}/app/api/v2/users/{userId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "primaryMobile": {
    "countryCode": "",
    "number": ""
  },
  "secondaryMobile": {
    "countryCode": "",
    "number": ""
  },
  "callback": {
    "url": ""
  }
}'
Responses
202
default
// Request Accepted 
{
  "data": {
    "id": ""
  },
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "requestId": "",
    "queryString": "",
    "body": {},
    "method": ""
  }
}
// Request Accepted 
{
  "data": {
    "id": ""
  },
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "requestId": "",
    "queryString": "",
    "body": {},
    "method": ""
  }
}
﻿
﻿
Updated 15 Mar 2024
Did this page help you?
Get a User by id or external ref
Get current state of User by id or external ref