Patch agents

PATCH
/v1/agents

Bulk patch agents/admins.

Authorization

ApiKeyAuth organization.member
headerAuthorization<token>

Scope: organization.member

Request Body

List of agent/admin patch actions

application/json
  1. body
[index: integer]?

Response Body

The list of patch action outcomes

application/json
  1. response
data?array<|>
Example Request
curl -X PATCH 'https://dev.dixa.io/v1/agents' \  -H 'Authorization: <API token>' \  -H 'Content-Type: application/json' \  -d '[  {    "id": "434ce9f5-14c8-4be1-a0a8-f755010deb9b",    "displayName": "AB",    "additionalEmails": [],    "additionalPhoneNumbers": [],    "middleNames": []  },  {    "id": "434ce9f5-14c8-4be1-a0a8-f755010deb9c",    "displayName": "JB",    "additionalEmails": [],    "additionalPhoneNumbers": [],    "middleNames": []  }]'
{
"data": [
{
"data": {
"id": "4d2ab456-8510-4a35-b266-e502160d5177",
"createdAt": "2020-12-16T09:41:43Z",
"displayName": "AB",
"email": "jb@example.org",
"avatarUrl": "https://files.dixa.io/public/image_id",
"additionalEmails": [],
"additionalPhoneNumbers": [],
"middleNames": [],
"roles": [
"Agent"
]
},
"_type": "BulkActionSuccess"
},
{
"error": {
"id": "434ce9f5-14c8-4be1-a0a8-f755010deb9c",
"message": "Agent not found",
"_type": "NotFound"
},
"_type": "BulkActionFailure"
}
]
}