Add multiple customer metadata

curl --request POST \
  --url https://api.sandbox.asapp.com/metadata-ingestion/v1/many-customer-metadata \
  --header 'Content-Type: application/json' \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>' \
  --data '
{
  "items": [
    {
      "externalConversationId": "id-509",
      "externalCustomerId": "[email protected]",
      "eventId": "eventId-1938",
      "status": "new",
      "phoneNumber": "(555)555-0100",
      "emailAddress": "[email protected]",
      "userId": "user908038",
      "addressCountry": "United-States",
      "addressState": "New-York",
      "addressZipcode": "10001",
      "attributes": [
        {
          "name": "attr1_name",
          "value": "attr1_value"
        },
        {
          "name": "attr2_name",
          "value": "attr2_value"
        }
      ]
    },
    {
      "externalConversationId": "id-203",
      "externalCustomerId": "[email protected]",
      "eventId": "eventId-1331",
      "status": "existing",
      "phoneNumber": "(555)555-0101",
      "emailAddress": "[email protected]",
      "userId": "user3201033",
      "addressCountry": "United-States",
      "addressState": "New-York",
      "addressZipcode": "10002",
      "attributes": [
        {
          "name": "attr1_name",
          "value": "attr1_value"
        },
        {
          "name": "attr2_name",
          "value": "attr2_value"
        }
      ]
    },
    {
      "externalConversationId": "id-69221",
      "externalCustomerId": "555.555.0191",
      "attributes": null
    },
    {
      "externalConversationId": "id-69223",
      "externalCustomerId": "555.555.0193"
    },
    {
      "externalConversationId": "id-69229",
      "externalCustomerId": "[email protected]",
      "phoneNumber": null,
      "userId": null,
      "addressCountry": null
    }
  ]
}
'

{
  "errorCount": 1,
  "results": [
    {
      "eventId": "5484e507-feaf-11ec-bfc1-fda566fa9333",
      "error": "FAIL_BAD_PARAMS: ERROR: agent id cannot be blank"
    },
    {
      "eventId": "fcf99667-feaf-11ec-a42e-11799134528c",
      "error": ""
    }
  ]
}

POST

metadata-ingestion

many-customer-metadata

Add multiple customer metadata

curl --request POST \
  --url https://api.sandbox.asapp.com/metadata-ingestion/v1/many-customer-metadata \
  --header 'Content-Type: application/json' \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>' \
  --data '
{
  "items": [
    {
      "externalConversationId": "id-509",
      "externalCustomerId": "[email protected]",
      "eventId": "eventId-1938",
      "status": "new",
      "phoneNumber": "(555)555-0100",
      "emailAddress": "[email protected]",
      "userId": "user908038",
      "addressCountry": "United-States",
      "addressState": "New-York",
      "addressZipcode": "10001",
      "attributes": [
        {
          "name": "attr1_name",
          "value": "attr1_value"
        },
        {
          "name": "attr2_name",
          "value": "attr2_value"
        }
      ]
    },
    {
      "externalConversationId": "id-203",
      "externalCustomerId": "[email protected]",
      "eventId": "eventId-1331",
      "status": "existing",
      "phoneNumber": "(555)555-0101",
      "emailAddress": "[email protected]",
      "userId": "user3201033",
      "addressCountry": "United-States",
      "addressState": "New-York",
      "addressZipcode": "10002",
      "attributes": [
        {
          "name": "attr1_name",
          "value": "attr1_value"
        },
        {
          "name": "attr2_name",
          "value": "attr2_value"
        }
      ]
    },
    {
      "externalConversationId": "id-69221",
      "externalCustomerId": "555.555.0191",
      "attributes": null
    },
    {
      "externalConversationId": "id-69223",
      "externalCustomerId": "555.555.0193"
    },
    {
      "externalConversationId": "id-69229",
      "externalCustomerId": "[email protected]",
      "phoneNumber": null,
      "userId": null,
      "addressCountry": null
    }
  ]
}
'

{
  "errorCount": 1,
  "results": [
    {
      "eventId": "5484e507-feaf-11ec-bfc1-fda566fa9333",
      "error": "FAIL_BAD_PARAMS: ERROR: agent id cannot be blank"
    },
    {
      "eventId": "fcf99667-feaf-11ec-a42e-11799134528c",
      "error": ""
    }
  ]
}

Authorizations

asapp-api-id

string

header

required

asapp-api-secret

string

header

required

Body

application/json

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

items

object[]

Required array length: 1 - 1000 elements

Show child attributes

items.externalConversationId

string

required

Conversation ID from the external chat / voice system

Maximum string length: 256

Example:

"issue509"

items.externalCustomerId

string

required

The customer id involved in respect to the issue in question

Maximum string length: 256

Example:

"[email protected]"

items.eventId

string | null

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

Maximum string length: 256

Example:

"eventId-1938"

items.status

string | null

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

Maximum string length: 256

Example:

"new"

items.phoneNumber

string | null

The customer's phone number

Maximum string length: 32

Example:

"(555)555-0100"

items.emailAddress

string<email> | null

The customer's email address

Example:

"[email protected]"

items.userId

string | null

The customer's user Id

Maximum string length: 256

Example:

"user908038"

items.addressCountry

string | null

The country portion of the customer's address

Maximum string length: 128

Example:

"United-States"

items.addressState

string | null

The state portion of the customer's address

Maximum string length: 128

Example:

"New-York"

items.addressZipcode

string | null

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

Maximum string length: 16

Example:

"10001"

items.attributes

object[] | null

A map of key-value pairs for extra metadata attributes

Maximum array length: 10

Show child attributes

items.attributes.name

string

The name of the attribute

Maximum string length: 256

items.attributes.value

string

The value of the named attribute

Maximum string length: 1024

Example:

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

Response

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

Example:

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

results.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"

Add a customer metadata Check ASAPP's API's health.

⌘I

ASAPP APIs

Authorizations

Body

Response