Aampe Property Update
Handle property updates coming from Aampe identify calls. Expects data in the exact format needed for publishing.
curl --request POST \
--url https://ingestion.{region}.api.aampe.com/v1/properties \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contact_id": "<string>",
"timestamp": 123,
"user_properties": {},
"event_name": "<string>",
"event_id": "<string>",
"metadata": {}
}
'import requests
url = "https://ingestion.{region}.api.aampe.com/v1/properties"
payload = {
"contact_id": "<string>",
"timestamp": 123,
"user_properties": {},
"event_name": "<string>",
"event_id": "<string>",
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contact_id: '<string>',
timestamp: 123,
user_properties: {},
event_name: '<string>',
event_id: '<string>',
metadata: {}
})
};
fetch('https://ingestion.{region}.api.aampe.com/v1/properties', 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://ingestion.{region}.api.aampe.com/v1/properties",
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([
'contact_id' => '<string>',
'timestamp' => 123,
'user_properties' => [
],
'event_name' => '<string>',
'event_id' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://ingestion.{region}.api.aampe.com/v1/properties"
payload := strings.NewReader("{\n \"contact_id\": \"<string>\",\n \"timestamp\": 123,\n \"user_properties\": {},\n \"event_name\": \"<string>\",\n \"event_id\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://ingestion.{region}.api.aampe.com/v1/properties")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contact_id\": \"<string>\",\n \"timestamp\": 123,\n \"user_properties\": {},\n \"event_name\": \"<string>\",\n \"event_id\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://ingestion.{region}.api.aampe.com/v1/properties")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contact_id\": \"<string>\",\n \"timestamp\": 123,\n \"user_properties\": {},\n \"event_name\": \"<string>\",\n \"event_id\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Your Ingestion API key. Obtain from Integrations > API keys in the Aampe Dashboard. See Authentication for details.
Body
Represents a property update event for a user.
Note on serialization:
Downstream consumers expect user_properties and (when present) metadata
to be JSON-encoded strings inside the outer JSON payload.
We implement this via Pydantic field serializers so callers can keep using
native dicts in Python.
The user's ID
Unix epoch seconds (number); decimals and millisecond values supported.
Dictionary of property names to values
Custom suffix for the event name. Will be appended to 'aampe_property_update_'
Optional unique ID of the event
Additional metadata dictionary for the event
Response
Successful Response
Was this page helpful?
curl --request POST \
--url https://ingestion.{region}.api.aampe.com/v1/properties \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contact_id": "<string>",
"timestamp": 123,
"user_properties": {},
"event_name": "<string>",
"event_id": "<string>",
"metadata": {}
}
'import requests
url = "https://ingestion.{region}.api.aampe.com/v1/properties"
payload = {
"contact_id": "<string>",
"timestamp": 123,
"user_properties": {},
"event_name": "<string>",
"event_id": "<string>",
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contact_id: '<string>',
timestamp: 123,
user_properties: {},
event_name: '<string>',
event_id: '<string>',
metadata: {}
})
};
fetch('https://ingestion.{region}.api.aampe.com/v1/properties', 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://ingestion.{region}.api.aampe.com/v1/properties",
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([
'contact_id' => '<string>',
'timestamp' => 123,
'user_properties' => [
],
'event_name' => '<string>',
'event_id' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://ingestion.{region}.api.aampe.com/v1/properties"
payload := strings.NewReader("{\n \"contact_id\": \"<string>\",\n \"timestamp\": 123,\n \"user_properties\": {},\n \"event_name\": \"<string>\",\n \"event_id\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://ingestion.{region}.api.aampe.com/v1/properties")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contact_id\": \"<string>\",\n \"timestamp\": 123,\n \"user_properties\": {},\n \"event_name\": \"<string>\",\n \"event_id\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://ingestion.{region}.api.aampe.com/v1/properties")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contact_id\": \"<string>\",\n \"timestamp\": 123,\n \"user_properties\": {},\n \"event_name\": \"<string>\",\n \"event_id\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}