11min
Personas
Use the Personas API to get/update detailed information on contacts stored within AIQ.
The response will include size which is the same number of returned contacts in the current page, and total which is the total size of the dataset.
GET
Params
Header Parameters
X-APIKEY
required
String
Located in your dashboard at Settings -> API & Tracking.
Body Parameters
start
optional
Integer
Start range (default: 0)
limit
optional
Integer
Max number of contacts per hit, number between 100-2000, (default: 100)
sort
optional
String
Sort by one of ["name" "email" "mobilePhone" "homePhone" "source" "id" "inserted" "signup" "points" "usedpoints"] (default: name)
dir
optional
String
Sort direction - The value can be asc to specify an ascending direction or desc to specify a descending direction
search
optional
String
a string query param, can be any mix of:
has:phone
has:mobile
has:home
has:email
has:name
`is:member
`not:member"
has:points
has:usedpoints
"full name" (exact match)
name or email or phone or contact id or src id
Get a persona by its contact ID
GET
Params
Path Params
uid
required
String
Your unique user ID.
contactID
required
String
The contact ID.
Header Parameters
X-APIKEY
required
String
Located in your dashboard at Settings -> API & Tracking.
Create a new contact with loyalty status by phone number.
POST
Params
Path Params
uid
required
String
Your unique user ID.
Query Parameters
optionalstore
optional
String
When true, makes "favoriteStoreID" not required.
Header Parameters
X-APIKEY
required
String
Located in your dashboard at Settings -> API & Tracking.
Body Parameters
favoriteStoreID
required
Number
Located under Settings -> Retail Stores.
firstName
optional
String
lastName
optional
String
mobilePhone
required
String
A phone number or email is required for every contact.
email
required
String
A phone number or email is required for every contact.
address
optional
String
disableSMS
required
Boolean
Disable sending SMS opt-in message.
smsoptin
required
Boolean
Opt the contact into receiving SMS, without sending them a double opt-in message. Only works if a signature is provided.
loyalty
required
Boolean
Makes the contact a loyalty member.
tosconsent
required
Number
Unix timestamp of when the contact consented.
signature
required
String
Base64 encoded data URI .png of the contact's signature.
customAttributes
optional
Array
Add in an array of key and value pairs for custom attributes.
Permanently set contact attributes.
POST
Params
Path Params
uid
required
String
Your unique user ID.
cntID
required
String
The "Alpine IQ Universal ID" of the contact, as shown in the Personas Drawer.
Header Parameters
X-APIKEY
required
String
Located in your dashboard at Settings -> API & Tracking.
Get the permanently set attributes of a single contact.
GET
Params
Path Params
uid
required
String
Your unique user ID.
cntID
required
String
The "Alpine IQ Universal ID" of the contact, as shown in the Personas Drawer.
Header Parameters
X-APIKEY
required
String
Located in your dashboard at Configure Alpine IQ -> API & Tracking.
It's sometimes useful to understand if a phone number or email is currently used as a loyalty/ opted in user. This is a lightweight endpoint to check using a phone number or email.
GET
Params
Path Params
pii
required
String
Use the phone number or email address of customer you want to check
Header Parameters
X-APIKEY
required
String
Located in your dashboard at Settings -> API & Tracking.
PUT
Params
Header Parameters
X-APIKEY
required
String
Located in your dashboard at Settings -> API & Tracking.
Body Parameters
id
required
String
ID of the cake to get
Adding Customers Alert:
This endpoint allows you to create new SMS opt-ins. Sending a new contact or an updated phone number through this endpoint will cause the number in question to be send a text message with your double optin flow unless "loyalty" is set to false. (We will avoid anyone that has explicitly opted out in the past)
PUT
Params
Header Parameters
X-APIKEY
required
String
Located in your dashboard at Settings -> API & Tracking.
Body Parameters
note
optional
String
Any notes you'd like added to the point adjustment.
value
required
Number
The amount added to their point balance. Can be negative or positive.
GET
Params
Header Parameters
X-APIKEY
required
String
Located in your dashboard at Settings -> API & Tracking.
Body Parameters
id
required
String
ID of the cake to get
Find personas with the given source ID
GET
Params
Query Parameters
search
optional
String
srcid:${src id here}
Header Parameters
X-APIKEY
required
String
Located in your dashboard at Settings -> API & Tracking.
Add an array of custom attributes to a persona
POST
Params
Path Params
uid
required
String
unique user id
contact id
required
String
unique contact id
Header Parameters
X-APIKEY
required
String
Located in your dashboard at Settings -> API & Tracking.
Body Parameters
array
required
Array
Array of custom attributes to add
key
required
String
custom attribute key
value
required
String
custom attribute value
Update an array of custom attributes for a persona
PUT
Params
Path Params
uid
optional
String
unique user id
contactID
optional
String
unique contact id
Header Parameters
X-APIKEY
required
String
Located in your dashboard at Settings -> API & Tracking.
Body Parameters
array
required
Array
Array of custom attributes to set
key
required
String
custom attribute key
value
required
String
custom attribute value
Returns all orders made by a contactID.
GET
Params
Header Parameters
X-APIKEY
required
String
Located in your dashboard at Settings -> API & Tracking.
Returns all orders with accrued points, adjustments, boosts received by a contactID.
GET
Params
Header Parameters
X-APIKEY
required
String
Located in your dashboard at Settings -> API & Tracking.
Returns most likely products a contact will be interested in ranked in order.
GET
Params
Header Parameters
X-APIKEY
required
String
Located in your dashboard at Settings -> API & Tracking.
Body Parameters
SKU
required
String
SKU for this product
ProductName
required
String
Alpine ID for this product
Category
required
String
Category of the product
Brand
required
String
Brand name
