Appearance
Update user
Updates a user's name, contact, address, or profile picture. The username and email address cannot be changed.
PUT /fieldservicegateway/usermanagement/v3/user
Request
Send only the fields you want to change, plus userNumber.
| Field | Type | Required | Description |
|---|---|---|---|
userNumber | string | yes | User to update |
firstName | string | no | 1–100 characters |
middleName | string | no | Up to 100 characters |
lastName | string | no | 1–100 characters |
contact.email | array | no | Replacement email list |
contact.email[].type | string | yes, when email is sent | DEFAULT, WORK, PERSONAL, or OTHER |
contact.email[].address | string | yes, when email is sent | Email address |
contact.email[].primary | boolean | yes, when email is sent | Whether this email is primary |
contact.phone | array | no | Replacement phone list |
contact.phone[].type | string | yes, when phone is sent | MOBILE, HOME, WORK, or OTHER |
contact.phone[].number | string | yes, when phone is sent | 7–15 digits |
contact.phone[].countryCode | string | yes, when phone is sent | 1–4 digits |
contact.phone[].primary | boolean | yes, when phone is sent | Whether this phone is primary |
addresses | array | no | Addresses to store |
addresses[].type | string | yes, when an address is sent | SERVICE, HOME, WORK, BILLING, SHIPPING, or OTHER |
addresses[].addressLine1 | string | yes, when an address is sent | Street line 1 |
addresses[].addressLine2 | string | no | Street line 2 |
addresses[].city | string | yes, when an address is sent | City |
addresses[].state | string | yes, when an address is sent | State |
addresses[].postalCode | string | yes, when an address is sent | Postal code |
addresses[].country | string | yes, when an address is sent | Country |
profilePictureUrl | string | no | http or https URL, or empty |
asurionEmpId | string | no | Employee id, 1–50 characters |
Example
json
{
"userNumber": "1001",
"firstName": "Ada",
"lastName": "Lovelace",
"contact": {
"phone": [
{
"type": "MOBILE",
"number": "5550100",
"countryCode": "1",
"primary": true
}
]
}
}cURL
bash
curl --request PUT 'https://[BASE_URL]/fieldservicegateway/usermanagement/v3/user' \
--header 'Content-Type: application/json' \
--header 'x-api-key: {{x-api-key}}' \
--header 'Authorization: {{Authorization}}' \
--header 'Asurion-correlationid: correlation-id' \
--header 'Asurion-enduser: end-user' \
--header 'Asurion-sourcesystem: source-system' \
--header 'Asurion-serviceprovider: company-id' \
--header 'Asurion-client: default' \
--data '{
"userNumber": "1001",
"firstName": "Ada",
"lastName": "Lovelace",
"contact": {
"phone": [
{
"type": "MOBILE",
"number": "5550100",
"countryCode": "1",
"primary": true
}
]
}
}'Response
200 OK
json
{
"success": true,
"message": "User updated successfully",
"data": {
"user": {
"userId": "user-id",
"userNumber": 1001,
"username": "user@example.com",
"firstName": "Ada",
"lastName": "Lovelace",
"email": "user@example.com",
"phone": "5550100",
"activeIndicator": true,
"updatedDatetime": "2026-10-16T00:00:00.000Z"
}
}
}| Field | Type | Description |
|---|---|---|
success | boolean | true when the update completed |
message | string | Short result |
data.user | object | Updated profile |
Errors
| Status | Code | When |
|---|---|---|
| 400 | VALIDATION_ERROR | userNumber is missing, or a field has the wrong type |
| 500 | INTERNAL_ERROR | Something unexpected failed |
json
{
"success": false,
"error": "Internal server error",
"code": "INTERNAL_ERROR",
"correlationId": "correlation-id",
"timestamp": "2026-10-16T00:00:00.000Z"
}