Skip to content
Dixa API/
/
Create agent

Create agent

Request

Create an agent.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

The agent's details

displayNamestringrequired

The agent's display name

emailstringrequired

The agent's primary email address

phoneNumberstring

The agent's primary phone number

additionalEmailsArray of strings, unique

Additional email addresses for the agent

additionalPhoneNumbersArray of strings, unique

Additional phone numbers for the agent

firstNamestring

The agent's first name

lastNamestring

The agent's last name

middleNamesArray of strings

The agent's middle names

avatarUrlstring

The url from which to load the agent's avatar

POST
/v1/agents
curl -i -X POST \
  https://dev.dixa.io/v1/agents \
  -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": [],
    "avatarUrl": "http://avatar.url"
  }'

Responses

The created agent

Bodyapplication/json
dataobject(Agent)required
Response
{
  "data": {
    "id": "4d2ab456-8510-4a35-b266-e502160d5177",
    "createdAt": "2020-12-16T09:41:43Z",
    "displayName": "Alice Brown",
    "email": "alice@brown.com",
    "avatarUrl": "https://files.dixa.io/public/image_id",
    "phoneNumber": "+551155256325",
    "additionalEmails": [ … ],
    "additionalPhoneNumbers": [ … ],
    "firstName": "Alice",
    "lastName": "Brown",
    "middleNames": [],
    "roles": [ … ]
  }
}