curl -X PATCH "<base_url>/usermanagement/v1/users" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"userName": "string",
"serviceSlug": "rmd",
"attributes": {
"countryId": 1,
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"addressLine1": "string",
"city": "string",
"zipCode": "string"
}
}'
{
"header": {
"code": 1,
"message": "User details updated successfully",
"response_code": 1
},
"body": {
"userName": "string",
"serviceSlug": "rmd",
"attributes": {
"countryId": 1,
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"addressLine1": "string",
"city": "string",
"zipCode": "string"
}
}
}
User Management
Update a User
Updates the profile service attributes of an existing user.
PATCH
/
usermanagement
/
v1
/
users
curl -X PATCH "<base_url>/usermanagement/v1/users" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"userName": "string",
"serviceSlug": "rmd",
"attributes": {
"countryId": 1,
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"addressLine1": "string",
"city": "string",
"zipCode": "string"
}
}'
{
"header": {
"code": 1,
"message": "User details updated successfully",
"response_code": 1
},
"body": {
"userName": "string",
"serviceSlug": "rmd",
"attributes": {
"countryId": 1,
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"addressLine1": "string",
"city": "string",
"zipCode": "string"
}
}
}
Updates the profile service attributes of an existing user.
See Errors for the response envelope and the full list of codes.
- URL:
/usermanagement/v1/users - Full URL:
<base_url>/usermanagement/v1/users - Request Method: PATCH
Authentication
Send the Access Token in theX-AccessToken request header on every authenticated call:
X-AccessToken: YOUR_ACCESS_TOKEN
Request Body
string
required
Username generated when the user was created.
string
required
Slug of the service this profile patch applies to.
object
required
Sample Request
cURL
curl -X PATCH "<base_url>/usermanagement/v1/users" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"userName": "string",
"serviceSlug": "rmd",
"attributes": {
"countryId": 1,
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"addressLine1": "string",
"city": "string",
"zipCode": "string"
}
}'
curl -X PATCH "<base_url>/usermanagement/v1/users" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"userName": "string",
"serviceSlug": "rmd",
"attributes": {
"countryId": 1,
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"addressLine1": "string",
"city": "string",
"zipCode": "string"
}
}'
Response
object
object
Sample Response
Success
{
"header": {
"code": 1,
"message": "User details updated successfully",
"response_code": 1
},
"body": {
"userName": "string",
"serviceSlug": "rmd",
"attributes": {
"countryId": 1,
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"addressLine1": "string",
"city": "string",
"zipCode": "string"
}
}
}
{
"header": {
"code": 1,
"message": "User details updated successfully",
"response_code": 1
},
"body": {
"userName": "string",
"serviceSlug": "rmd",
"attributes": {
"countryId": 1,
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"addressLine1": "string",
"city": "string",
"zipCode": "string"
}
}
}
Status Codes
| Status | Meaning |
|---|---|
200 | Success. |
500 | Internal Server Error. |
Error codes
Returned inheader.response_code when the request fails.
| Code | Message |
|---|---|
998 | Internal server error |
1001 | Validation error |
1002 | You are not permitted to the resource! |
1003 | Invalid service slug provided |
1004 | Account is not subscribed to this service |
1005 | Invalid username or reseller |