Skip to main content
POST
/
metadata-ingestion
/
v1
/
single-customer-metadata
Add a customer metadata
curl --request POST \
  --url https://api.sandbox.asapp.com/metadata-ingestion/v1/single-customer-metadata \
  --header 'Content-Type: application/json' \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>' \
  --data '{
  "externalConversationId": "id-509",
  "externalCustomerId": "555.555.0100-jdoe@example.com",
  "eventId": "eventId-1938",
  "status": "new",
  "phoneNumber": "(555)555-0100",
  "emailAddress": "jdoe@example.com",
  "userId": "user908038",
  "addressCountry": "United-States",
  "addressState": "New-York",
  "addressZipcode": "10001",
  "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 customer metadata attributes

​
externalConversationId
string
required

Conversation ID from the external chat / voice system

Maximum length: 256
Example:

"issue509"

​
externalCustomerId
string
required

The customer id involved in respect to the issue in question

Maximum length: 256
Example:

"555.555.0100-jdoe@example.com"

​
eventId
string | null

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

Maximum length: 256
Example:

"eventId-1938"

​
status
string | null

The descriptive label to describe the customer's status and/or type

Maximum length: 256
Example:

"new"

​
phoneNumber
string | null

The customer's phone number

Maximum length: 32
Example:

"(555)555-0100"

​
emailAddress
string<email> | null

The customer's email address

Example:

"jdoe@example.com"

​
userId
string | null

The customer's user Id

Maximum length: 256
Example:

"user908038"

​
addressCountry
string | null

The country portion of the customer's address

Maximum length: 128
Example:

"United-States"

​
addressState
string | null

The state portion of the customer's address

Maximum length: 128
Example:

"New-York"

​
addressZipcode
string | null

The zipcode/postal code portion of the customer's address

Maximum length: 16
Example:

"10001"

​
attributes
object[] | null

A map of key-value pairs for extra metadata attributes

Maximum length: 10
Example:
[
  {
    "name": "attr1_name",
    "value": "attr1_value"
  },
  {
    "name": "attr2_name",
    "value": "attr2_value"
  }
]

Response

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

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