A REST API call allows you to send information from one server to another server. Information is passed in a JSON (JavaScript Object Notation) format that both the sending sever and the receiving server can process. You can accomplish a variety of activities and send a large variety of data via Listrak's APIs. Below you can learn more about the available methods and API routes available within Listrak.
HTTP Methods
The HTTP methods are the different actions that can be completed when an API call is made between servers. You can use multiple methods when acting on a single piece of data to accomplish your objectives.
The following types of actions can be completed using Listrak's REST API.
GET: A GET request retrieves information from the server where it is stored and sends it to the requesting server. Information retrieved cannot be changed or overwritten. Common GET requests include retrieving a contact or a list of all available profile fields.
POST: A POST request adds or updates information on the requesting server. Common POST requests include subscribing a contact or sending a transactional message.
PUT: A PUT request modifies an existing piece of information on the requesting server. Common PUT requests include updating contact information or updating a profile field.
DELETE: A DELETE request removes information from the requesting server. Common DELETE requests include unsubscribing a contact and closing a two-way SMS ticket.
PATCH: A PATCH request makes a partial update to information on the requesting server. A common PATCH request is to update a mobile app device.
REST API Integrations
Listrak offers multiple REST API integrations to support the passage of multiple data types.
π The Mobile App Push API require setup assistance from Listrak. All other integrations can be set up in the Integrations Manager.
Email: The Email API integration enables you to manage the opt-in status of email contacts, update contact profile data, send broadcast marketing or transactional emails, and return email analytics.
SMS: The SMS API integration enables you to manage the opt-in status of SMS contacts, update contact profile data, and send broadcast marketing or transactional SMS messages.
Cross Channel: The Cross Channel API integration enables you to pass contacts and their details into a custom event journey in Journey Hub.
Data Import: The Data Import API integration enables you to pass customer, order, product, and product review data into Listrak.
Two-Way SMS: The Two-Way SMS API integration enables you to pass customer support ticket information between Listrak and your customer service platform.
Mobile App Push: The Mobile App Push API integration enables you to pass information when a user registers or patches of a mobile device and pass details on app engagement.
Privacy: The Privacy API integration enables you to remove contact information to maintain CCPA or GDPR compliance.