Request the anonymization of an end user.
The end user's anonymization request status
{- "data": {
- "id": "6bf55369-a670-4e6b-9f70-ecdb9913549f",
- "entityType": "UserAnonymizationType",
- "_type": "User",
- "initiatedAt": "2021-12-01T12:46:36.581Z[GMT]",
- "targetEntityId": "f28fafd6-2e42-4441-943c-388a8e0ef433",
- "requestedBy": "2b01e4c9-0c3a-47d4-9462-cd5a1a4687f5"
}
}
Create an end user.
The created end user
Invalid value extracted from request context, Invalid value for: body, Validation failure during enduser creation
Internal failure during request processing
{- "displayName": "Alice Brown",
- "email": "alice@brown.com",
- "phoneNumber": "+551155256325",
- "firstName": "Alice",
- "lastName": "Brown",
- "middleNames": [ ],
}
{- "data": {
- "id": "434ce9f5-14c8-4be1-a0a8-f755010deb9b",
- "createdAt": "2020-12-16T09:41:43Z",
- "displayName": "Alice Brown",
- "email": "alice@brown.com",
- "phoneNumber": "+551155256325",
- "firstName": "Alice",
- "lastName": "Brown",
- "middleNames": [ ],
}
}
Create end users.
The list of end user details
Array of objects (CreateEndUserInput) |
The created end users
Invalid value extracted from request context, Invalid value for: body
Internal failure during request processing
{- "data": [
- {
- "displayName": "Alice Brown",
- "email": "alice@brown.com",
- "phoneNumber": "+551155256325",
- "firstName": "Alice",
- "lastName": "Brown",
- "middleNames": [ ],
}
]
}
{- "data": [
- {
- "data": {
- "id": "93b885ad-fe0d-3089-8df6-34904fd59f71",
- "createdAt": "2020-12-16T09:41:43Z",
- "displayName": "Enduser 0",
- "email": "enduser.0@example.org",
- "middleNames": [ ],
}, - "_type": "BulkActionSuccess"
}, - {
- "data": {
- "id": "55a54008-ad1b-3589-aa21-0d2629c1df41",
- "createdAt": "2020-12-16T09:41:43Z",
- "displayName": "Enduser 1",
- "email": "enduser.1@example.org",
- "middleNames": [ ],
}, - "_type": "BulkActionSuccess"
}, - {
- "data": {
- "id": "9e688c58-a548-3b8e-af69-c9e1005ad0bf",
- "createdAt": "2020-12-16T09:41:43Z",
- "displayName": "Enduser 2",
- "email": "enduser.2@example.org",
- "middleNames": [ ],
}, - "_type": "BulkActionSuccess"
}, - {
- "data": {
- "id": "86666835-06aa-3d90-8bbd-5a74ac4edf68",
- "createdAt": "2020-12-16T09:41:43Z",
- "displayName": "Enduser 3",
- "email": "enduser.3@example.org",
- "middleNames": [ ],
}, - "_type": "BulkActionSuccess"
}, - {
- "error": {
- "id": "1b6d1e11-0626-414e-906a-b80a384cfef0",
- "message": "Create EndUser [userId=...] in [orgId=...] failed with [errors=...]",
- "_type": "Validation"
}, - "_type": "BulkActionFailure"
}
]
}
Get an end user by id.
The end user
Invalid value for: path parameter userId, Invalid value extracted from request context
An entity in this request could not be found
Internal failure during request processing
{- "data": {
- "id": "434ce9f5-14c8-4be1-a0a8-f755010deb9b",
- "createdAt": "2020-12-16T09:41:43Z",
- "displayName": "Alice Brown",
- "email": "alice@brown.com",
- "phoneNumber": "+551155256325",
- "firstName": "Alice",
- "lastName": "Brown",
- "middleNames": [ ],
}
}
Lists conversations requested by an end user.
The list of conversations requested by an EndUser
Invalid value for: path parameter userId, Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey
An entity in this request could not be found
Internal failure during request processing
{- "data": [
- {
- "id": 1,
- "requesterId": "9deb936b-52e5-4c44-828d-4c8d48fe0c7e",
- "channel": "WidgetChat",
- "createdAt": "2020-12-16T09:41:43Z",
- "direction": "Outbound",
- "state": "Open",
- "stateUpdatedAt": "2020-12-16T09:41:43Z",
- "assignment": {
- "agentId": "0e4d0ead-dc69-470a-9b3a-e7eb16a56453",
- "assignedAt": "2020-12-16T11:00:34Z"
}, - "queue": {
- "id": "cd87b232-64c8-4ad5-b81a-6f9233352d97",
- "queuedAt": "2020-12-16T10:40:40Z"
}, - "browserInfo": {
- "name": "Chrome 9",
- "version": "91.0.4472.114",
- "ipAddress": "127.0.0.1",
}, - "language": "en",
- "link": {
- "parentId": 1234,
- "_type": "SideConversation"
}, - "_type": "ChatConversation"
}
]
}
Lists all end users in an organization. It is possible to filter by one of the mutually exclusive parameters: email or phone number. In case both are provided, an error is returned.
The list of end users
Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey, Invalid value for: query parameter email, Invalid value for: query parameter phone, Duplicate phone number, Duplicate email address, Invalid filters: Cannot provide both phone number and email address
An entity in this request could not be found
Internal failure during request processing
{- "data": [
- {
- "id": "93b885ad-fe0d-3089-8df6-34904fd59f71",
- "createdAt": "2020-12-16T09:41:43Z",
- "displayName": "Enduser 0",
- "email": "enduser.0@example.org",
- "middleNames": [ ],
}, - {
- "id": "55a54008-ad1b-3589-aa21-0d2629c1df41",
- "createdAt": "2020-12-16T09:41:43Z",
- "displayName": "Enduser 1",
- "email": "enduser.1@example.org",
- "middleNames": [ ],
}, - {
- "id": "9e688c58-a548-3b8e-af69-c9e1005ad0bf",
- "createdAt": "2020-12-16T09:41:43Z",
- "displayName": "Enduser 2",
- "email": "enduser.2@example.org",
- "middleNames": [ ],
}, - {
- "id": "86666835-06aa-3d90-8bbd-5a74ac4edf68",
- "createdAt": "2020-12-16T09:41:43Z",
- "displayName": "Enduser 3",
- "email": "enduser.3@example.org",
- "middleNames": [ ],
}
]
}
Patch an end user.
The patched end user
Invalid value for: path parameter userId, Invalid value extracted from request context, Invalid value for: body, Validation failure during update
An entity in this request could not be found
Internal failure during request processing
{- "displayName": "Alice Brown",
- "email": "alice@soon.unicorn",
- "firstName": "Alice",
- "lastName": "Brown",
- "middleNames": [ ],
}
{- "data": {
- "id": "434ce9f5-14c8-4be1-a0a8-f755010deb9b",
- "createdAt": "2020-12-16T09:41:43Z",
- "displayName": "Alice Brown",
- "email": "alice@brown.com",
- "phoneNumber": "+551155256325",
- "firstName": "Alice",
- "lastName": "Brown",
- "middleNames": [ ],
}
}
Bulk patch end users.
List of end user patch actions
Array of objects (BulkPatchEndUserInput) |
The patched end users
Invalid value extracted from request context, Invalid value for: body
Internal failure during request processing
{- "data": [
- {
- "id": "43b1fe06-a7c4-4f34-8e48-b0559e6acdb9",
- "displayName": "Alice Brown",
- "email": "alice@soon.unicorn",
- "firstName": "Alice",
- "lastName": "Brown",
- "middleNames": [ ],
}
]
}
{- "data": [
- {
- "data": {
- "id": "434ce9f5-14c8-4be1-a0a8-f755010deb9b",
- "createdAt": "2020-12-16T09:41:43Z",
- "displayName": "Alice Brown",
- "email": "alice@brown.com",
- "phoneNumber": "+551155256325",
- "firstName": "Alice",
- "lastName": "Brown",
- "middleNames": [ ],
}, - "_type": "BulkActionSuccess"
}, - {
- "error": {
- "id": "ace11abb-4ed0-42bd-9e3b-4ef6db58e0aa",
- "message": "Updating EndUser [id=ace11abb-4ed0-42bd-9e3b-4ef6db58e0aa] in [org=b86a1842-437c-4c55-ac4b-0a9cd2f44dfb] failed with [errors=PhoneNumberExists]",
- "_type": "Validation"
}, - "_type": "BulkActionFailure"
}
]
}
Update an end user.
The updated end user
Invalid value for: path parameter userId, Invalid value extracted from request context, Invalid value for: body, Validation failure during update
An entity in this request could not be found
Internal failure during request processing
{- "displayName": "Alice User",
- "email": "alice@soon.unicorn",
- "phoneNumber": "+55112233445566",
- "firstName": "Alice",
- "lastName": "User",
- "middleNames": [
- "End"
],
}
{- "data": {
- "id": "434ce9f5-14c8-4be1-a0a8-f755010deb9b",
- "createdAt": "2020-12-16T09:41:43Z",
- "displayName": "Alice Brown",
- "email": "alice@brown.com",
- "phoneNumber": "+551155256325",
- "firstName": "Alice",
- "lastName": "Brown",
- "middleNames": [
- "End"
],
}
}
Bulk update end users.
List of end user update actions
Array of objects (BulkUpdateEndUserInput) |
The updated end users
Invalid value extracted from request context, Invalid value for: body
Internal failure during request processing
{- "data": [
- {
- "id": "d4826125-559f-496f-ad71-a0340f0cae06",
- "displayName": "Alice User",
- "email": "alice@soon.unicorn",
- "phoneNumber": "+55112233445566",
- "firstName": "Alice",
- "lastName": "User",
- "middleNames": [
- "End"
],
}
]
}
{- "data": [
- {
- "data": {
- "id": "434ce9f5-14c8-4be1-a0a8-f755010deb9b",
- "createdAt": "2020-12-16T09:41:43Z",
- "displayName": "Alice Brown",
- "email": "alice@brown.com",
- "phoneNumber": "+551155256325",
- "firstName": "Alice",
- "lastName": "Brown",
- "middleNames": [ ],
}, - "_type": "BulkActionSuccess"
}, - {
- "error": {
- "id": "8fe8f4c3-7bc6-4767-924a-d9afa7ac7009",
- "message": "Updating EndUser [id:8fe8f4c3-7bc6-4767-924a-d9afa7ac7009] failed with [errors:PhoneNumberExists]",
- "_type": "Validation"
}, - "_type": "BulkActionFailure"
}
]
}