This section defines key terms and data objects used throughout our API documentation. These definitions are designed to ensure consistency and clarity, helping you understand the core concepts and data models involved in operating the Aampe agents.
Contact
A Contact is the way Aampe refers to your users within the platform. Every contact is uniquely identified by a contact_id (string), which serves as the primary key for all interactions and data related to that user.
Attribute
An Attribute is a key-value pair that stores additional information about a contact. Attributes allow you to extend the basic contact profile with data such as demographics, preferences, or any custom information needed for audience creation.
-
Key:
The name of the attribute (a string) that defines the type of information (e.g.,age,email,subscription_status). -
Value:
The corresponding value, which can be a string, number, boolean, or null. Anullvalue indicates that the attribute should be removed or is not set.