Add an agent metadata

Add metadata attributes of one agent

Authorizations

asapp-api-id

string

header

required

asapp-api-secret

string

header

required

Body

application/json

A set of agent metadata attributes

externalAgentId

string

required

The agent id in question

Maximum length: 256

Example:

"agent158"

eventId

string | null

An event id used to track the submission; if none is provided, service will generate one

Maximum length: 256

Example:

"eventId-158"

startTs

string | null

The date and time when the agent is hired in ISO-8601

Example:

"2022-07-08T11:15:53.237517000Z"

lobId

string | null

The line of business id

Maximum length: 256

Example:

"1038"

lobName

string | null

The descriptive name of the line of business

Maximum length: 256

Example:

"manufacturing"

groupId

string | null

The group id of which the agent belong to

Maximum length: 256

Example:

"group5"

groupName

string | null

The descriptive name of the group

Maximum length: 256

Example:

"XYZ"

agentName

string | null

The name of the agent

Maximum length: 256

Example:

"Jane Doe"

agentLocation

string | null

The location (or address) of where the agent worked

Maximum length: 256

Example:

"Northern-California"

supervisorId

string | null

The supervisor id of who the agent report to

Maximum length: 256

Example:

"3080"

supervisorName

string | null

The name of the agent's supervisor

Maximum length: 256

Example:

"Linda Lemon"

languages

string[] | null

A list of agent's known language codes in ISO 639 e.g., English (United States) code = en-US

Example:

["en-us", "zh-hans-hk"]

concurrency

integer | null

The number of issues that an agent can take at a time

Example:

3

categoryLabel

string | null

The category label that indicates the types of workflows an agent have access to or problems they solved

Maximum length: 256

Example:

"Tier-2-Escalation"

accountAccessLevel

string | null

The levels of mapping that an agent have access to make changes to customer accounts

Maximum length: 256

Example:

"High-Profile"

ranking

integer | null

Some numerical value indicating relative or absolute performance on a single scale

Example:

78

vendor

string | null

Vendor or BPO (Business Process Outsourcing) that the agent is part of

Maximum length: 256

Example:

"Contracting"

jobTitle

string | null

The agent's job title

Maximum length: 256

Example:

"Booking-Manager"

jobRole

string | null

The agent's role

Maximum length: 256

Example:

"booking"

workShift

string | null

The hours or shift name they work

Maximum length: 256

Example:

"afternoon"

emailAddress

string | null

The agent's email address

Example:

"[e-mail]"

attributes

object[] | null

A map of key-value pairs for extra metadata attributes

A key-value pair of additional metadata attributes

Show child attributes

attributes.name

string

The name of the attribute

Maximum length: 256

attributes.value

string

The value of the named attribute

Maximum length: 1024

Example:

[
  {
    "name": "attr1_name",
    "value": "attr1_value"
  },
  {
    "name": "attr2_name",
    "value": "attr2_value"
  }
]

Response

200

application/json

200 - Success Submit a single item to the service to be ingested. Record can be traced back to the submitted record by the eventId. A message sent status will be returned with no error message for successful input checks.

result

object

required

A response with the status of a sent message

Show child attributes

result.eventId

string

An UUID identifier string computed for the submitted event message

Example:

"5484e507-feaf-11ec-bfc1-fda566fa9333"

result.error

string

Status of the failed message if value is not blank; the error is contained in the string

Example:

"FAIL_BAD_PARAMS: ERROR: agent id cannot be blank"

Example:

{
  "eventId": "5484e507-feaf-11ec-bfc1-fda566fa9333",
  "error": "FAIL_BAD_PARAMS: ERROR: agent id cannot be blank"
}