POST
/
metadata-ingestion
/
v1
/
single-agent-metadata
curl --request POST \
  --url https://api.sandbox.asapp.com/metadata-ingestion/v1/single-agent-metadata \
  --header 'Content-Type: application/json' \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>' \
  --data '{
  "externalAgentId": "agent158",
  "startTs": "2022-07-08T11:15:53.237517000Z",
  "lobId": "1038",
  "lobName": "manufacturing",
  "groupId": "group5",
  "groupName": "XYZ",
  "agentName": "Jane Doe",
  "agentLocation": "Northern-California",
  "supervisorId": "3080",
  "supervisorName": "Linda Lemon",
  "languages": [
    "en-us",
    "zh-hans-hk"
  ],
  "concurrency": 3,
  "categoryLabel": "Tier-2-Escalation",
  "accountAccessLevel": "High-Profile",
  "ranking": 78,
  "vendor": "Contracting",
  "jobTitle": "Booking-Manager",
  "jobRole": "booking",
  "workShift": "afternoon",
  "emailAddress": "jdoe@example.com",
  "attributes": [
    {
      "name": "attr1_name",
      "value": "attr1_value"
    },
    {
      "name": "attr2_name",
      "value": "attr2_value"
    }
  ]
}'
{
  "result": {
    "eventId": "5484e507-feaf-11ec-bfc1-fda566fa9333",
    "error": "FAIL_BAD_PARAMS: ERROR: agent id cannot be blank"
  }
}

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
​
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
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

Was this page helpful?

Retrieve a feed fileAdd multiple agent metadata