Personas

15min

Use the Personas API to get and update detailed information on contacts stored within AIQ.
Also visit the Full API Reference.
GET All Personas
Loading...
﻿
Note: GET all contacts endpoint filters out any blocklisted personas.
GET Persona by Contact ID
Loading...
﻿
POST New Contact
Loading...
﻿
POST Override Contact Attributes
Permanently override a contact's attributes.
Loading...
﻿
GET Override Contact Attributes
Loading...
﻿
GET Loyalty Status
It's sometimes useful to understand if a phone number or email is currently used as a loyalty or opted in user. This is a lightweight endpoint to check using a phone number or email. 
Loading...
﻿
PUT New User or Opt-in
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)
Loading...
﻿
PUT Adjust Persona Points
Loading...
﻿
GET Points Adjustments
Loading...
﻿
GET Persona By Source ID
Loading...
﻿
POST/PUT/GET Custom Attributes for a Persona
Add an array of custom attributes to a persona
Loading...
﻿
GET Personas Orders
Loading...
﻿
GET Personas Points Timeline
Loading...
﻿
GET Personas Predicted Top Products
Returns the products a contact will most likely be interested in, ranked in order.
Loading...
﻿
﻿

Store locations

Audiences