Skip to content
Dixa API/
/
Patch end users

Patch end users

Request

Bulk patch end users.

Security
ApiKeyAuth(Required scopes: organization.member)
Bodyapplication/jsonrequired

List of end user patch actions

dataArray of objects(BulkPatchEndUserInput)
PATCH
/beta/endusers
curl -i -X PATCH \
  https://dev.dixa.io/beta/endusers \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": [
      {
        "id": "43b1fe06-a7c4-4f34-8e48-b0559e6acdb9",
        "displayName": "Alice Brown",
        "email": "alice@brown.com",
        "phoneNumber": "+551155256325",
        "additionalEmails": [
          "alice@secondary.email"
        ],
        "additionalPhoneNumbers": [
          "+5566778899"
        ],
        "firstName": "Alice",
        "lastName": "Brown",
        "middleNames": [],
        "avatarUrl": "http://avatar.url",
        "externalId": "#12345678"
      }
    ]
  }'

Responses

The patched end users

Bodyapplication/json
dataArray of any(BulkActionOutcome_BulkError_EndUser)
Response
{
  "data": [
    { … },
    { … }
  ]
}