REST APIs

Overview

The Cardlytics API is based on the REST software architecture, which is lightweight and flexible. Our REST API uses standard HTTP requests like GET, PUT, POST, and DELETE verbs to manage CRUD (Create, Read, Update, and Delete) operations. Because the REST API is stateless, each request contains all the necessary information to complete the request.

Cardlytics API endpoints and webhooks all support JSON-encoded request bodies submitted over HTTPS. Note that Cardlytics requires Publisher traffic to originate from a static IP address or addresses and for that traffic to support mTLS over HTTPS.

You can use these APIs to create and modify customers, accounts and cards, portfolio enhancements, client events, and other data.

Important

The Data APIs are meant to be accessed server-side only. Requests that come from unlisted origins will be rejected.

Topics

API	Description
Ads	Use Get Ads POST calls for customers appropriate for ad channels and inputs. Use Get Rewards GET calls to return a customer profile ad reward summary and POST calls to update the state of one or more ads targeted to a customer.
Customers	Use GET and POST calls to get customer ids, profiles, rewards summary and ad redemption.
Data	Use POST calls to create one or more customers, customer events and customer transactions. Also, use PUT calls to update accounts, customers and cards.
Events	Use this endpoint to capture a customer's activity throughout a session.
Support	Use GET and POST calls to get customer offers, tickets and reward settlements for customers, as well as to update tickets and to look up transactions.