Skip to content

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.

FieldTypeRequiredDescription
userNumberstringyesUser to update
firstNamestringno1–100 characters
middleNamestringnoUp to 100 characters
lastNamestringno1–100 characters
contact.emailarraynoReplacement email list
contact.email[].typestringyes, when email is sentDEFAULT, WORK, PERSONAL, or OTHER
contact.email[].addressstringyes, when email is sentEmail address
contact.email[].primarybooleanyes, when email is sentWhether this email is primary
contact.phonearraynoReplacement phone list
contact.phone[].typestringyes, when phone is sentMOBILE, HOME, WORK, or OTHER
contact.phone[].numberstringyes, when phone is sent7–15 digits
contact.phone[].countryCodestringyes, when phone is sent1–4 digits
contact.phone[].primarybooleanyes, when phone is sentWhether this phone is primary
addressesarraynoAddresses to store
addresses[].typestringyes, when an address is sentSERVICE, HOME, WORK, BILLING, SHIPPING, or OTHER
addresses[].addressLine1stringyes, when an address is sentStreet line 1
addresses[].addressLine2stringnoStreet line 2
addresses[].citystringyes, when an address is sentCity
addresses[].statestringyes, when an address is sentState
addresses[].postalCodestringyes, when an address is sentPostal code
addresses[].countrystringyes, when an address is sentCountry
profilePictureUrlstringnohttp or https URL, or empty
asurionEmpIdstringnoEmployee 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"
    }
  }
}
FieldTypeDescription
successbooleantrue when the update completed
messagestringShort result
data.userobjectUpdated profile

Errors ​

StatusCodeWhen
400VALIDATION_ERRORuserNumber is missing, or a field has the wrong type
500INTERNAL_ERRORSomething unexpected failed
json
{
  "success": false,
  "error": "Internal server error",
  "code": "INTERNAL_ERROR",
  "correlationId": "correlation-id",
  "timestamp": "2026-10-16T00:00:00.000Z"
}