Select the appropriate button below for documentation containing the information required to work with the Purple portal API:

Purple uses API Key authentication. Our php demo file and Company API docs v1.6.2 and v1.7 are available to help with getting started, with API system settings and requirements included.

Postman is an API platform which assists with building and using APIs. It’s typically used for testing in a Purple context. Check our guide for setting up Postman for more information. 

Once connected, check our Portal Company API documentation for assistance. This has our latest API documentation with all available endpoints.

With your portal API you can query raw user data from your portal and use them to populate external systems (like a CRM). If you want to export data to your CRM without making repeated requests to Purple’s API, you can use Webhooks. Webhooks can also be used to trigger real-time events using LogicFlow.

API integration with connectors listed in our library is possible. This is typically conducted by our Professional Services Team.

There are no rate limits on our API (i.e. it can support any number of requests or transactions).

An Enterprise license is required for API access.

API 1.7 changes

With the release of API v1.7:

• There is improved clarity when displaying the subscription status of end users. The 'unsubscribed' property has been updated to show whether the visitor has opted-out of marketing after previously being subscribed. The change clearly demarcates between those who were subscribed then opted-out, and those who never subscribed. This marks a change from API v1.6.2, where there is no distinction between those who opted-out and those who never subscribed
• The property name in the ‘Unsubscribes’ endpoint response has been corrected, from 'unsubcribers' to 'unsubscribers'
• The ‘Visitors’ and ‘Venues’ endpoints now return an HTTP 200 response (“OK”) when no visitors are found. This shows users that the data is being displayed successfully. Previously, an HTTP 404 response (“Not Found”) was shown, which could made it look as though an error was taking place

Update API to v1.7

To change the API version from v1.6.2 to v1.7:

• Change all relevant URLS to include v1.7
• Update any scripts or processes that request the 'Unsubscribes' endpoint so they use the corrected data response property name of ‘unsubscribers'

If employing a third party to manage API use, ask them to update it with the above information.