Create agents

POST
/v1/agents/bulk

Create agents in bulk.

Authorization

ApiKeyAuth organization.member
headerAuthorization<token>

Scope: organization.member

Request Body

The list of agent's details

application/json
  1. body
data?array<>

Response Body

The created agents

application/json
  1. response
data?array<|>
Example Request
curl -X POST 'https://dev.dixa.io/v1/agents/bulk' \  -H 'Authorization: <API token>' \  -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"    }  ]}'
{
"data": [
{
"data": {
"id": "93b885ad-fe0d-3089-8df6-34904fd59f71",
"createdAt": "2020-12-16T09:41:43Z",
"displayName": "Agent 0",
"email": "agent.0@example.org",
"avatarUrl": "https://files.dixa.io/public/image_0_id",
"additionalEmails": [],
"additionalPhoneNumbers": [],
"middleNames": [],
"roles": [
"Agent"
]
},
"_type": "BulkActionSuccess"
},
{
"data": {
"id": "55a54008-ad1b-3589-aa21-0d2629c1df41",
"createdAt": "2020-12-16T09:41:43Z",
"displayName": "Agent 1",
"email": "agent.1@example.org",
"avatarUrl": "https://files.dixa.io/public/image_1_id",
"additionalEmails": [],
"additionalPhoneNumbers": [],
"middleNames": [],
"roles": [
"Agent"
]
},
"_type": "BulkActionSuccess"
},
{
"data": {
"id": "9e688c58-a548-3b8e-af69-c9e1005ad0bf",
"createdAt": "2020-12-16T09:41:43Z",
"displayName": "Agent 2",
"email": "agent.2@example.org",
"avatarUrl": "https://files.dixa.io/public/image_2_id",
"additionalEmails": [],
"additionalPhoneNumbers": [],
"middleNames": [],
"roles": [
"Agent"
]
},
"_type": "BulkActionSuccess"
},
{
"data": {
"id": "86666835-06aa-3d90-8bbd-5a74ac4edf68",
"createdAt": "2020-12-16T09:41:43Z",
"displayName": "Agent 3",
"email": "agent.3@example.org",
"avatarUrl": "https://files.dixa.io/public/image_3_id",
"additionalEmails": [],
"additionalPhoneNumbers": [],
"middleNames": [],
"roles": [
"Agent"
]
},
"_type": "BulkActionSuccess"
},
{
"error": {
"id": "e8ecd53b-2f6c-4471-a3a0-34d94caff8c8",
"message": "Create Agent [userId=...] in [orgId=...] failed with [errors=...]",
"_type": "Validation"
},
"_type": "BulkActionFailure"
}
]
}