Integrate API and Zaius channels

The API and Zaius channels let you deliver content or update attributes through a third-party provider with API access. You can add these channels to One-time, Behavioral, and Transactional campaigns as touchpoints, the same way you would add an email or SMS to your campaign. ODP is the connection between the two, so you can send data from one platform to another.

For instance, imagine that you use Zendesk to manage customer support and synchronize segments of customers with open tickets to ODP. With API Channel, you can pass these segments to your LoyaltyLion account and suppress them from campaigns that ask customers to provide product reviews. ODP acts as the connection as long as you have an integration between ODP and LoyaltyLion and ODP and Zendesk.  

The difference between the API Channel and the Zaius Channel is as follows:

• Zaius Channel –  A pre-configured version of the API Channel, which makes its setup more user-friendly for marketers.
• API channel – A flexible way to call any API within the execution of a campaign. Even if ODP does not have a formal integration with a third-party tool, the API channel lets marketers send data from ODP to the tool.

The Zaius channel works on top of the API channel as a preconfigured way to send data back into ODP, so you do not need to set up APIs, like adding headers to include the content type and API keys. Additionally, the Zaius Channel turns the API calls into more user-friendly inputs (for example, clicking which fields you want to update on the customer records, instead of needing to know how to call the profiles API endpoint with new field/value pairs).

Run a campaign with API Channel

1. Enable API Channel in the App Directory.
   1. Go to App Directory > API Channel.

      

   2. Click Install App to enable the channel. After the installation is complete, it shows Installed.

      

2. Add API Channel to a campaign.
   1. Create a new campaign and add API Channel as a touchpoint.

      

   2. Under Targeting, select your Target Identifier. For example, if your API identifies users by email, choose Last Seen Email.

      

   3. Add any necessary Headers, such as content-type or x-api-key.
   4. Configure the rest of your API call as the message.

      For instance, if your goal is to send customer attributes to another system, you would POST to a specified API endpoint (for example, https://example.api/customers), and send the desired data in the endpoint's expected format (for example, as a block of JSON which contains specific attributes). See the below screenshot for the complete example.

      

   5. Click Preview to see your setup and verify.
   6. Once you are satisfied with your setup, click Go Live.

Run a campaign with ODP Channel

1. Enable ODP Channel in the App Directory.
   1. Go to App Directory and select Zaius Channel.

      

   2. Click Install App to enable the channel.

      

2. Add ODP Channel to a campaign.
   1. Create a new campaign/touchpoint and choose Zaius Channel.
   2. Under Targeting, select your Target Identifier. Choose the one you know your customers will have, such as Phone for SMS opt-in updates.
   3. Below Configure, choose to enable either Customer Updates or Subscription Updates.
      • If you selected Customer Updates, select the number of fields.
      • If you selected Subscription Updates, specify to which list(s) you want to subscribe or unsubscribe customers. Additionally, you can choose to update the customers’ global consent to the identifier.
      • Example: If you are using the Zaius Channel to update the SMS opt-in status of customers, you would select Subscribe below Changes to the Identifier’s Global Consent.
   4. Click Preview to see your setup and verify.
   5. Once you are satisfied with your setup, click Go Live.