Integrate the API and ODP channels
Deliver content or update attributes through a third-party provider with API access using the API and ODP channels. 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. Optimizely Data Platform (ODP) is the connection between the two, so you can send data from one platform to another.
For example, if you use Zendesk to manage customer support and sync segments of customers with open tickets to ODP, you can use the API channel to 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 configure the integrations between ODP and LoyaltyLion and ODP and Zendesk.
The difference between the API channel and the ODP channel is as follows:
- ODP 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 ODP 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 ODP 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 key/value pairs.
Run a campaign with the API channel
- Go to Data Setup > App Directory in ODP.
- Select the API Channel app.
- Click Install App.
- Go to Activations > Overview and edit or create a campaign. Configure the campaign enrollment as desired.
- Click to add a touchpoint and select API Channel.
- Expand Targeting and select a Target Identifier. For example, if your API identifies users by email, choose Last Seen Email.
Only messaging identifiers are available for targeting.
- Add any necessary API Headers, such as content-type = application/json or x-api-key = [your_public_or_private_API_key].
- Configure the rest of your API call in the message section. For example, if your goal is to send customer attributes to another system, you would POST to a specified API endpoint (like https://example.api/customers), and send the desired data in the endpoint's expected format (like as a block of JSON that contains specific attributes). The following screenshot shows this complete example.
- (Optional) Preview and test your API channel touchpoint.
- Click Save.
- Click Go Live when you are ready to start your campaign.
Run a campaign with the ODP channel
- Go to Data Setup > App Directory in ODP.
- Select the ODP Channel app.
- Click Install App.
- Go to Activations > Overview and edit or create a campaign. Configure the campaign enrollment as desired.
- Click to add a touchpoint and select ODP Channel.
- Expand Targeting and select a Target Identifier. Choose the one you know your customers will have, such as Phone for SMS opt-in updates.
Only messaging identifiers are available for targeting.
- Enable the customers or subscriptions updates in the Configure section.
- If you selected customers, expand the Customer Updates section and select the Number of Fields.
- If you selected subscriptions, expand the Subscription Updates section and specify which lists you want to subscribe or unsubscribe customers to. Additionally, you can choose to update the customers’ global consent to the identifier. For example, if you are using the ODP channel to update the SMS opt-in status of customers, you would select Subscribe for Changes to the Identifier’s Global Consent.
- (Optional) Preview and test your ODP channel touchpoint.
- Click Save.
- Click Go Live when you are ready to start your campaign.