Skip to content
Dixa API/
/
Patch agent

Patch agent

Request

Patch an agent/admin.

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

The agent/admin id

Bodyapplication/jsonrequired

The agent/admin patch

displayNamestring

The agent's display name

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

PATCH
/beta/agents/{agentId}
curl -i -X PATCH \
  'https://dev.dixa.io/beta/agents/{agentId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "displayName": "Alice Brown",
    "additionalEmails": [],
    "additionalPhoneNumbers": [],
    "firstName": "Alice",
    "lastName": "Brown",
    "middleNames": [],
    "avatarUrl": "http://avatar.url"
  }'

Responses

The patched agent/admin

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": [ … ]
  }
}