Add multiple agent metadata

Add multiple agent metadata items; submit items in a batch in one request

Authorizations

asapp-api-id

string

header

required

asapp-api-secret

string

header

required

Body

application/json

A request to send more than one agent metadata; send a list of items

items

object[]

Show child attributes

items.externalAgentId

string

required

The agent id in question

Maximum length: 256

items.eventId

string | null

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

Maximum length: 256

items.startTs

string | null

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

items.lobId

string | null

The line of business id

Maximum length: 256

items.lobName

string | null

The descriptive name of the line of business

Maximum length: 256

items.groupId

string | null

The group id of which the agent belong to

Maximum length: 256

items.groupName

string | null

The descriptive name of the group

Maximum length: 256

items.agentName

string | null

The name of the agent

Maximum length: 256

items.agentLocation

string | null

The location (or address) of where the agent worked

Maximum length: 256

items.supervisorId

string | null

The supervisor id of who the agent report to

Maximum length: 256

items.supervisorName

string | null

The name of the agent's supervisor

Maximum length: 256

items.languages

string[] | null

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

items.concurrency

integer | null

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

items.categoryLabel

string | null

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

Maximum length: 256

items.accountAccessLevel

string | null

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

Maximum length: 256

items.ranking

integer | null

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

items.vendor

string | null

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

Maximum length: 256

items.jobTitle

string | null

The agent's job title

Maximum length: 256

items.jobRole

string | null

The agent's role

Maximum length: 256

items.workShift

string | null

The hours or shift name they work

Maximum length: 256

items.emailAddress

string | null

The agent's email address

items.attributes

object[] | null

A map of key-value pairs for extra metadata attributes

Show child attributes

items.attributes.name

string

The name of the attribute

Maximum length: 256

items.attributes.value

string

The value of the named attribute

Maximum length: 1024

Response

200

application/json

200 - Success | Partial Success Submit a batch of items to the service to be ingested. Record can be traced back to the submitted record by the eventId. If any of the records encounter issue during the ingestion, a message sent status will be returned with an error message for each record. A 200 success is returned as long as there is one item ingested successfully, i.e., "partial success".

errorCount

integer

required

Number of message sent with error(s)

results

object[]

required

A list of send result

Show child attributes

results.eventId

string

An UUID identifier string computed for the submitted event message

results.error

string

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