Search documentation...

ChangelogBook a demoSign up


Reach customers across the open web and drive increased sales both on-site and in-store.

View CitrusAd's documentation.


Now deliver even more relevant ads both onsite and across the web by combining data from various sources within your data warehouse to build custom audiences for CitrusAd. By keeping your custom audiences updated automatically, you'll never show an irrelevant ad to anyone.

Supported syncing

TypeDescriptionSupported Sync ModesAPI documenation
CustomersSync customer data from any source to CitrusAd customersUpsert, Update, InsertCreate or update a customer

For more information about sync modes, refer to the sync modes docs.

Connect to CitrusAd

Go to the Destinations overview page and click the Add destination button. Select CitrusAd and click Continue. You can then authenticate Hightouch to CitrusAd by entering the following required fields into Hightouch:

  • Base URL: The base URL for staging or production environment. Visit CitrusAd's docs for information on retrieving your base URL.
  • API key: The API key for authenticating the API requests. Visit CitrusAd's docs for information on retrieving your API key.

Sync configuration

Once you've set up your CitrusAd destination and have a model to pull data from, you can set up your sync configuration to begin syncing data. Go to the Syncs overview page and click the Add sync button to begin. Then, select the relevant model and the CitrusAd destination you want to sync to.


Customer data is required to generate personalized ads with CitrusAd. See CitrusAd's docs for more details.

Record matching

You must match rows in your model with customers in CitrusAd on the Customer ID field.

In Insert mode, CitrusAd automatically generates a customer ID for every new record synced, so there is no need to match an existing record.

Field mapping

You can sync any model columns to CitrusAd's default customer fields including targetingData.

When creating new customer records in CitrusAd via insert or upsert mode, CitrusAd sets a default value to all fields without a value, whether you've mapped them or not.

You can find CitrusAd's default values in the table below:

Field nameDefault value
Year of Birth0

The Gender field accepts the following values: "Male","Female","Other" case insensitive. If you send any other values, CitrusAd changes them to "Other".

When updating existing customer data via update or upsert mode, Hightouch pulls the existing customer data from CitrusAd and merges it with your updates.

Tips and troubleshooting

Delete behavior

Clear is only available for update mode. All sync modes use the Do nothing behavior by default.

Do nothingKeep the customer record in CitrusAd with all its synced fields
ClearUnset all the mapped fields from CitrusAd

Common errors

To date, our customers haven't experienced any errors while using this destination. If you run into any issues, please don't hesitate to . We're here to help.

Live debugger

Hightouch provides complete visibility into the API calls made during each of your sync runs. We recommend reading our article on debugging tips and tricks to learn more.

Sync alerts

Hightouch can alert you of sync issues via Slack, PagerDuty, SMS, or email. For details, please visit our article on alerting.

Ready to get started?

Jump right in or a book a demo. Your first destination is always free.

Book a demoSign upBook a demo

Need help?

Our team is relentlessly focused on your success. Don't hesitate to reach out!

Feature requests?

We'd love to hear your suggestions for integrations and other features.

Last updated: Feb 23, 2023

On this page

OverviewSupported syncingConnect to CitrusAdSync configurationCustomersTips and troubleshootingCommon errorsLive debuggerSync alerts

Was this page helpful?