Add a customer metadata

Add metadata attributes of one customer

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:

"[e-mail]"

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:

"[phone]"

emailAddress

string | null

The customer's email address

Example:

"[e-mail]"

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

A key-value pair of additional metadata attributes

Show child attributes

attributes.name

string

The name of the attribute

Maximum length: 256

attributes.value

string

The value of the named attribute

Maximum length: 1024

Example:

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

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

Show child attributes

result.eventId

string

An UUID identifier string computed for the submitted event message

Example:

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

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

Example:

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