Skip to content
Dixa API/
/
Create end users

Create end users

Request

Create multiple end users in a single bulk action

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

The list of end user details

dataArray of objects(CreateEndUserInput)
POST
/beta/endusers/bulk
curl -i -X POST \
  https://dev.dixa.io/beta/endusers/bulk \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": [
      {
        "displayName": "Alice Brown",
        "email": "alice@brown.com",
        "phoneNumber": "+551155256325",
        "additionalEmails": [],
        "additionalPhoneNumbers": [],
        "firstName": "Alice",
        "lastName": "Brown",
        "middleNames": [],
        "avatarUrl": "http://avatar.url",
        "externalId": "#12345678"
      }
    ]
  }'

Responses

The created end users

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