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"
}
]
}
'import requests
url = "https://api.sandbox.asapp.com/metadata-ingestion/v1/single-customer-metadata"
payload = {
"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"
}
]
}
headers = {
"asapp-api-id": "<api-key>",
"asapp-api-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'asapp-api-id': '<api-key>',
'asapp-api-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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'}
]
})
};
fetch('https://api.sandbox.asapp.com/metadata-ingestion/v1/single-customer-metadata', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.asapp.com/metadata-ingestion/v1/single-customer-metadata",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"asapp-api-id: <api-key>",
"asapp-api-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.asapp.com/metadata-ingestion/v1/single-customer-metadata"
payload := strings.NewReader("{\n \"externalConversationId\": \"id-509\",\n \"externalCustomerId\": \"555.555.0100-jdoe@example.com\",\n \"eventId\": \"eventId-1938\",\n \"status\": \"new\",\n \"phoneNumber\": \"(555)555-0100\",\n \"emailAddress\": \"jdoe@example.com\",\n \"userId\": \"user908038\",\n \"addressCountry\": \"United-States\",\n \"addressState\": \"New-York\",\n \"addressZipcode\": \"10001\",\n \"attributes\": [\n {\n \"name\": \"attr1_name\",\n \"value\": \"attr1_value\"\n },\n {\n \"name\": \"attr2_name\",\n \"value\": \"attr2_value\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("asapp-api-id", "<api-key>")
req.Header.Add("asapp-api-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.asapp.com/metadata-ingestion/v1/single-customer-metadata")
.header("asapp-api-id", "<api-key>")
.header("asapp-api-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"externalConversationId\": \"id-509\",\n \"externalCustomerId\": \"555.555.0100-jdoe@example.com\",\n \"eventId\": \"eventId-1938\",\n \"status\": \"new\",\n \"phoneNumber\": \"(555)555-0100\",\n \"emailAddress\": \"jdoe@example.com\",\n \"userId\": \"user908038\",\n \"addressCountry\": \"United-States\",\n \"addressState\": \"New-York\",\n \"addressZipcode\": \"10001\",\n \"attributes\": [\n {\n \"name\": \"attr1_name\",\n \"value\": \"attr1_value\"\n },\n {\n \"name\": \"attr2_name\",\n \"value\": \"attr2_value\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.asapp.com/metadata-ingestion/v1/single-customer-metadata")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["asapp-api-id"] = '<api-key>'
request["asapp-api-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalConversationId\": \"id-509\",\n \"externalCustomerId\": \"555.555.0100-jdoe@example.com\",\n \"eventId\": \"eventId-1938\",\n \"status\": \"new\",\n \"phoneNumber\": \"(555)555-0100\",\n \"emailAddress\": \"jdoe@example.com\",\n \"userId\": \"user908038\",\n \"addressCountry\": \"United-States\",\n \"addressState\": \"New-York\",\n \"addressZipcode\": \"10001\",\n \"attributes\": [\n {\n \"name\": \"attr1_name\",\n \"value\": \"attr1_value\"\n },\n {\n \"name\": \"attr2_name\",\n \"value\": \"attr2_value\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"result": {
"eventId": "5484e507-feaf-11ec-bfc1-fda566fa9333",
"error": "FAIL_BAD_PARAMS: ERROR: agent id cannot be blank"
}
}{
"result": {
"eventId": "5484e507-feaf-11ec-bfc1-fda566fa9333",
"error": "FAIL_BAD_PARAMS: ERROR: agent id cannot be blank"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "401-01",
"message": "Unauthorized"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "403-01",
"message": "Forbidden Response"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "404-01",
"message": "Not Found"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "409-01",
"message": "Conflict"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "413-01",
"message": "Request Entity Too Large"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "422-01",
"message": "Unprocessable Entity"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "429-01",
"message": "Too Many Requests"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "503-01",
"message": "Service Unavailable"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "500-01",
"message": "Internal server error"
}
}Customer Metadata
Add a customer metadata
Add metadata attributes of one customer
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"
}
]
}
'import requests
url = "https://api.sandbox.asapp.com/metadata-ingestion/v1/single-customer-metadata"
payload = {
"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"
}
]
}
headers = {
"asapp-api-id": "<api-key>",
"asapp-api-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'asapp-api-id': '<api-key>',
'asapp-api-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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'}
]
})
};
fetch('https://api.sandbox.asapp.com/metadata-ingestion/v1/single-customer-metadata', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.asapp.com/metadata-ingestion/v1/single-customer-metadata",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"asapp-api-id: <api-key>",
"asapp-api-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.asapp.com/metadata-ingestion/v1/single-customer-metadata"
payload := strings.NewReader("{\n \"externalConversationId\": \"id-509\",\n \"externalCustomerId\": \"555.555.0100-jdoe@example.com\",\n \"eventId\": \"eventId-1938\",\n \"status\": \"new\",\n \"phoneNumber\": \"(555)555-0100\",\n \"emailAddress\": \"jdoe@example.com\",\n \"userId\": \"user908038\",\n \"addressCountry\": \"United-States\",\n \"addressState\": \"New-York\",\n \"addressZipcode\": \"10001\",\n \"attributes\": [\n {\n \"name\": \"attr1_name\",\n \"value\": \"attr1_value\"\n },\n {\n \"name\": \"attr2_name\",\n \"value\": \"attr2_value\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("asapp-api-id", "<api-key>")
req.Header.Add("asapp-api-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.asapp.com/metadata-ingestion/v1/single-customer-metadata")
.header("asapp-api-id", "<api-key>")
.header("asapp-api-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"externalConversationId\": \"id-509\",\n \"externalCustomerId\": \"555.555.0100-jdoe@example.com\",\n \"eventId\": \"eventId-1938\",\n \"status\": \"new\",\n \"phoneNumber\": \"(555)555-0100\",\n \"emailAddress\": \"jdoe@example.com\",\n \"userId\": \"user908038\",\n \"addressCountry\": \"United-States\",\n \"addressState\": \"New-York\",\n \"addressZipcode\": \"10001\",\n \"attributes\": [\n {\n \"name\": \"attr1_name\",\n \"value\": \"attr1_value\"\n },\n {\n \"name\": \"attr2_name\",\n \"value\": \"attr2_value\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.asapp.com/metadata-ingestion/v1/single-customer-metadata")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["asapp-api-id"] = '<api-key>'
request["asapp-api-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalConversationId\": \"id-509\",\n \"externalCustomerId\": \"555.555.0100-jdoe@example.com\",\n \"eventId\": \"eventId-1938\",\n \"status\": \"new\",\n \"phoneNumber\": \"(555)555-0100\",\n \"emailAddress\": \"jdoe@example.com\",\n \"userId\": \"user908038\",\n \"addressCountry\": \"United-States\",\n \"addressState\": \"New-York\",\n \"addressZipcode\": \"10001\",\n \"attributes\": [\n {\n \"name\": \"attr1_name\",\n \"value\": \"attr1_value\"\n },\n {\n \"name\": \"attr2_name\",\n \"value\": \"attr2_value\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"result": {
"eventId": "5484e507-feaf-11ec-bfc1-fda566fa9333",
"error": "FAIL_BAD_PARAMS: ERROR: agent id cannot be blank"
}
}{
"result": {
"eventId": "5484e507-feaf-11ec-bfc1-fda566fa9333",
"error": "FAIL_BAD_PARAMS: ERROR: agent id cannot be blank"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "401-01",
"message": "Unauthorized"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "403-01",
"message": "Forbidden Response"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "404-01",
"message": "Not Found"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "409-01",
"message": "Conflict"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "413-01",
"message": "Request Entity Too Large"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "422-01",
"message": "Unprocessable Entity"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "429-01",
"message": "Too Many Requests"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "503-01",
"message": "Service Unavailable"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "500-01",
"message": "Internal server error"
}
}Body
application/json
A set of customer metadata attributes
Conversation ID from the external chat / voice system
Maximum string length:
256Pattern:
[a-zA-Z0-9\-\_]+Example:
"issue509"
The customer id involved in respect to the issue in question
Maximum string length:
256Pattern:
[a-zA-Z0-9\-\_\.\@]+Example:
"555.555.0100-jdoe@example.com"
An event id used to track the submission; if none is provided, service will generate one
Maximum string length:
256Pattern:
[a-zA-Z0-9\-\_]+Example:
"eventId-1938"
The descriptive label to describe the customer's status and/or type
Maximum string length:
256Pattern:
[a-zA-Z0-9\-\_]+Example:
"new"
The customer's phone number
Maximum string length:
32Pattern:
[0-9\-\.\(\)\+]+Example:
"(555)555-0100"
The customer's email address
Example:
"jdoe@example.com"
The customer's user Id
Maximum string length:
256Pattern:
[a-zA-Z0-9\-\_]+Example:
"user908038"
The country portion of the customer's address
Maximum string length:
128Pattern:
[a-zA-Z0-9\-\_]+Example:
"United-States"
The state portion of the customer's address
Maximum string length:
128Pattern:
[a-zA-Z0-9\-\_]+Example:
"New-York"
The zipcode/postal code portion of the customer's address
Maximum string length:
16Pattern:
[a-zA-Z0-9\-\_]+Example:
"10001"
A map of key-value pairs for extra metadata attributes
Maximum array length:
10Show child attributes
Show child attributes
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.
A response with the status of a sent message
Show child attributes
Show child attributes
Example:
{
"eventId": "5484e507-feaf-11ec-bfc1-fda566fa9333",
"error": "FAIL_BAD_PARAMS: ERROR: agent id cannot be blank"
}
Was this page helpful?