How to integrate custom subscriber field data
How to integrate custom subscriber field data
Registering a subscriber with custom field data
Updating and deleting custom field data for a subscriber
Retrieving custom field data for a subscriber
Retrieving campaigns for a subscriber
Overview
Custom subscriber fields enable you to store a rich profile of data for your subscribers in Echobox, which can be used in segmentation.
Please see our ‘How to work with custom subscriber fields’ which explains using custom subscriber fields within the platform including how to:
- Define your list of custom fields
- Upload a subscriber list with custom fields
- How to manually update custom field values
Echobox also provides API support to allow you to update the custom fields for individual subscribers records. This allows you to synchronize custom field data from other systems with Echobox.
Securing your requests
See Getting Started to learn about securing your requests.
Registering a subscriber with custom field data
We can provide an endpoint URL, which will look something like this:
This endpoint will allow you to subscribe a new subscriber to a campaign with custom field data. You are required to create the fields in your subscriber list in the Echobox platform first. The keys for custom fields must match the display name for the field in Echobox.
The endpoint can be used to subscribe a new subscriber with custom field data by making a POST request with a body of the following form:
Updating and deleting custom field data for a subscriber
We can provide an endpoint URL, which will look something like this:
This endpoint allows you to update and delete custom field data for a subscriber at the property level.
If null values are passed, these will overwrite the existing values stored in Echobox.
This endpoint can be used to update the custom field data for one or more subscribers by making a POST request with a body of the following form:
Retrieving custom field data for a subscriber
We can provide an endpoint URL, which will look something like this:
https://prod.cdp.service.echobox.com/v1/properties/urn:property:12345/customers/{email}
This endpoint allows you to retrieve the custom field data for a given subscriber by making a GET request, specifying the email in the path.
Below is an example response from the endpoint:
Retrieving campaigns for a subscriber
We can provide an endpoint URL, which will look something like this:
https://prod.campaignapi.service.echobox.com/v1/properties/urn:property:12345/subscriptions/{email}
This endpoint allows you to retrieve the campaigns a reader is subscribed to by making a GET request, specifying the email in the path.
Below is an example response from the endpoint: