Note: GET all contacts endpoint filters out any blocklisted personas.

___________________________________________________________

<a href="https://lab.alpineiq.com/swagger#/contact/get_api_v1_1_piis__uid__contactID" target="_blank" rel="nofollow noopener noreferrer">/api/v1.1/piis/:uid/:contactID</a>

Note: lastTouch in the response is used internally by AIQ, it does NOT signify dates of persona entering/exiting an audience, we do not track this.

<a href="https://lab.alpineiq.com/swagger#/contact/post_api_v2_loyalty" target="_blank" rel="nofollow noopener noreferrer">/api/v2/loyalty</a>

Permanently override a contact's attributes.

<a href="https://lab.alpineiq.com/swagger#/contact/post_api_v2_loyaltyContact_override__uid__contactID" target="_blank" rel="nofollow noopener noreferrer">/api/v2/loyaltyContact/override/:uid/:contactID</a>

<a href="https://lab.alpineiq.com/swagger#/contact/get_api_v2_loyaltyContact_override__uid__contactID" target="_blank" rel="nofollow noopener noreferrer">/api/v2/loyaltyContact/override/:uid/:contactID</a>

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.

<a href="https://lab.alpineiq.com/swagger#/contact/get_api_v2_loyalty_lookup__pii" target="_blank" rel="nofollow noopener noreferrer">/api/v2/loyalty/lookup/:pii</a>

This endpoint allows you to set or update a customer’s SMS opt-in status. It does not create a new contact record; it only manages opt-in flags for an existing or incoming phone number.

By default, sending a phone number to this endpoint will force-set the opt-in state.

If you’d like the number to go through your double opt-in flow, include the query parameter <code>doubleOpt=true</code>.

If the loyalty parameter is set to false, the double opt-in flow will be skipped.

Numbers that have explicitly opted out in the past will not be re-opted in via this endpoint.

- By default, sending a phone number to this endpoint will force-set the opt-in state.
- If you’d like the number to go through your double opt-in flow, include the query parameter <code>doubleOpt=true</code>.
- If the loyalty parameter is set to false, the double opt-in flow will be skipped.
- Numbers that have explicitly opted out in the past will not be re-opted in via this endpoint.

Use this endpoint only for managing opt-in status.

If you need to create new contacts, we suggest uploading a csv, see <a href="https://help.aiq.com/en/articles/13444196-bulk-import-personas">Bulk Import Personas</a>.

- Use this endpoint only for managing opt-in status.
- If you need to create new contacts, we suggest uploading a csv, see <a href="https://help.aiq.com/en/articles/13444196-bulk-import-personas">Bulk Import Personas</a>.

<a href="https://lab.alpineiq.com/swagger#/opt-in/put_api_v2_optin_text__phone__status" target="_blank" rel="nofollow noopener noreferrer">/api/v2/optin/text/:phone/:status</a>

<a href="https://lab.alpineiq.com/swagger#/contact/put_api_v1_1_adjust_loyaltyPoints__uid__contactID" target="_blank" rel="nofollow noopener noreferrer">/api/v1.1/adjust/loyaltyPoints/:uid/:contactID</a>

<a href="https://lab.alpineiq.com/swagger#/contact/get_api_v1_1_adjustments__uid__start__end" target="_blank" rel="nofollow noopener noreferrer">/api/v1.1/adjustments/:uid/:start/:end</a>

<a href="https://lab.alpineiq.com/swagger#/contact/get_api_v1_1_piis__uid_bySrcID__srcID" target="_blank" rel="nofollow noopener noreferrer">/api/v1.1/piis/:uid/bySrcID/:srcID</a>

Find a contact by their source ID from an integration.

POST/PUT/GET Custom Attributes for a Persona

Add an array of custom attributes to a persona

<a href="https://lab.alpineiq.com/swagger#/contact/get_api_v1_1_contact_traits__uid__contactID" target="_blank" rel="nofollow noopener noreferrer">/get_api_v1_1_contact_traits__uid__contactID</a>

<a href="https://lab.alpineiq.com/swagger#/contact/post_api_v1_1_contact_traits__uid__contactID" target="_blank" rel="nofollow noopener noreferrer">/post_api_v1_1_contact_traits__uid__contactID</a>

<a href="https://lab.alpineiq.com/swagger#/contact/put_api_v1_1_contact_traits__uid__contactID" target="_blank" rel="nofollow noopener noreferrer">/put_api_v1_1_contact_traits__uid__contactID</a>

<a href="https://lab.alpineiq.com/swagger#/contact/get_api_v1_1_contact_orders__uid__contactID" target="_blank" rel="nofollow noopener noreferrer">/api/v1.1/contact/orders/:uid/:contactID</a>

<a href="https://lab.alpineiq.com/swagger#/contact/get_api_v1_1_contact_loyaltyPoints_timeline__uid__contactID" target="_blank" rel="nofollow noopener noreferrer">/api/v1.1/contact/loyaltyPoints/timeline/:uid/:contactID</a>

Returns the products a contact will most likely be interested in, ranked in order.

/<a href="https://lab.alpineiq.com/swagger#/recommendation/get_api_v2_contact_recommendations__contactID" target="_blank" rel="nofollow noopener noreferrer">get_api_v2_contact_recommendations__contactID</a>

Use the Personas API to get and update detailed information on contacts stored within AIQ.

Personas Endpoints

AIQ Academy

Find answers and get help from Intercom Support and Community Experts

Conversations you've started through the messenger will appear here.

No conversations created by you

Try using different keywords or checking for typos.

No conversations found

Title

This site employs cookies and other technologies that we and our third party vendors use to monitor and record personal information about you and your interactions with the site (including content viewed, cursor movements, screen recordings, and chat contents) for the purposes described in our Cookie Policy. By continuing to visit our site, you agree to our {websiteTermsLink}, {privacyPolicyLink} and {cookiePolicyLink}.

This site uses cookies and similar technologies ("cookies") as strictly necessary for site operation. We and our partners also would like to set additional cookies to enable site performance analytics, functionality, advertising and social media features. See our {cookiePolicyLink} for details. You can change your cookie preferences in our Cookie Settings.

We use cookies to make our site work and also for analytics and advertising purposes. You can enable or disable optional cookies as desired. See our {cookiePolicyLink} for more details.

Advertising cookies are set by our advertising partners to collect information about your use of the site, our communications, and other online services over time and with different browsers and devices. They use this information to show you ads online that they think will interest you and measure the ads' performance. Social media cookies are set by social media platforms to enable you to share content on those platforms, and are capable of tracking information about your activity across other online services for use as described in their privacy policies.

These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.

These cookies are necessary for the website to function and cannot be switched off in our systems.

These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site.

You have the right to opt out of the sale of your personal information. See our {cookiePolicyLink} for more details about how we use your data.

Your Privacy Choices

We use cookies to enhance your experience. You can customize your cookie preferences below. See our {cookiePolicyLink} for more details.

Cookie Settings

Empty Help Center

Uh oh. That page doesn’t exist.

Home

Search results

Disappointed

Neutral

Smiley

Thinking...

Searching through sources...

Analyzing...

Tickets submitted through the messenger or by a support agent in your conversation will appear here.

Personas Endpoints

GET All Personas

GET Persona by Contact ID

POST New Contact

POST Override Contact Attributes

GET Override Contact Attributes

GET Loyalty Status

PUT New Opt-in

PUT Adjust Persona Points

GET Points Adjustments

GET Persona By Source ID

POST/PUT/GET Custom Attributes for a Persona

GET Personas Orders

GET Personas Points Timeline

GET Personas Predicted Top Products