Skip to content
Dixa API/
/
Update end user

Update end user

Request

Update an end user.

Security
ApiKeyAuth(Required scopes: organization.member)
Path
userIdstring, (uuid)required

The end user id

Bodyapplication/jsonrequired

The updated details for an end user

displayNamestringrequired
emailstring
phoneNumberstring
additionalEmailsArray of strings, unique
additionalPhoneNumbersArray of strings, unique
firstNamestring
lastNamestring
middleNamesArray of strings
avatarUrlstring
externalIdstring
PUT
/beta/endusers/{userId}
curl -i -X PUT \
  'https://dev.dixa.io/beta/endusers/{userId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "displayName": "Alice Brown",
    "email": "alice@brown.com",
    "phoneNumber": "+551155256325",
    "additionalEmails": [
      "alice@secondary.email"
    ],
    "additionalPhoneNumbers": [
      "+5566778899"
    ],
    "firstName": "Alice",
    "lastName": "Brown",
    "middleNames": [
      "J."
    ],
    "avatarUrl": "http://avatar.url",
    "externalId": "#12345678"
  }'

Responses

The updated end user

Bodyapplication/json
dataobject(EndUser)required
Response
{
  "data": {
    "id": "434ce9f5-14c8-4be1-a0a8-f755010deb9b",
    "createdAt": "2020-12-16T09:41:43Z",
    "displayName": "Alice Brown",
    "email": "alice@brown.com",
    "phoneNumber": "+551155256325",
    "additionalEmails": [ … ],
    "additionalPhoneNumbers": [ … ],
    "firstName": "Alice",
    "lastName": "Brown",
    "middleNames": [ … ],
    "avatarUrl": "https://files.dixa.io/public/image_id",
    "externalId": "#12345678",
    "customAttributes": [ … ]
  }
}