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

externalCustomerId

string

required

The customer id involved in respect to the issue in question

Maximum length: 256

addressCountry

string | null

The country portion of the customer's address

Maximum length: 128

addressState

string | null

The state portion of the customer's address

Maximum length: 128

addressZipcode

string | null

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

Maximum length: 16

attributes

object[] | null

A map of key-value pairs for extra 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

emailAddress

string | null

The customer's email address

eventId

string | null

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

Maximum length: 256

phoneNumber

string | null

The customer's phone number

Maximum length: 32

status

string | null

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

Maximum length: 256

userId

string | null

The customer's user Id

Maximum length: 256

Response

200 - application/json

result

object

required

A response with the status of a sent message

Show child attributes

result.error

string

Status of the failed message if value is not blank; the error is contained in the string

result.eventId

string

An UUID identifier string computed for the submitted event message