POST
/
metadata-ingestion
/
v1
/
single-agent-metadata

Authorizations

asapp-api-id
string
headerrequired
asapp-api-secret
string
headerrequired

Body

application/json

A set of agent metadata attributes

externalAgentId
string
required

The agent id in question

Maximum length: 256
eventId
string | null

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

Maximum length: 256
startTs
string | null

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

lobId
string | null

The line of business id

Maximum length: 256
lobName
string | null

The descriptive name of the line of business

Maximum length: 256
groupId
string | null

The group id of which the agent belong to

Maximum length: 256
groupName
string | null

The descriptive name of the group

Maximum length: 256
agentName
string | null

The name of the agent

Maximum length: 256
agentLocation
string | null

The location (or address) of where the agent worked

Maximum length: 256
supervisorId
string | null

The supervisor id of who the agent report to

Maximum length: 256
supervisorName
string | null

The name of the agent's supervisor

Maximum length: 256
languages
string[] | null

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

concurrency
integer | null

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

categoryLabel
string | null

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

Maximum length: 256
accountAccessLevel
string | null

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

Maximum length: 256
ranking
integer | null

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

vendor
string | null

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

Maximum length: 256
jobTitle
string | null

The agent's job title

Maximum length: 256
jobRole
string | null

The agent's role

Maximum length: 256
workShift
string | null

The hours or shift name they work

Maximum length: 256
emailAddress
string | null

The agent's email address

attributes
object[] | null

A map of key-value pairs for extra metadata attributes

Response

200 - application/json
result
object
required

A response with the status of a sent message

Was this page helpful?

Retrieve a feed fileAdd multiple agent metadata