Schema Information for Heypoplar
Schema Information for Heypoplar
In this article, we will look at the schema information of the supported APIs and tables for Heypoplar.
Find the links to other articles related to Neon Pixel below:
Tables/APIs Supported
The tables and APIs associated with the Heypoplar connector are as follows.
Audience
Purpose: The Audience API is designed to help businesses build, maintain, and update targeted customer segments for direct mail campaigns. Its primary purpose is to enable seamless integration of customer data from external systems (like CRMs, eCommerce platforms, or data warehouses) into HeyPoplar, ensuring that marketing campaigns are delivered to the right people at the right time.
Source API Documentation: https://developers.heypoplar.com/endpoints/audience#fetch-audiences
Replication Type: Key Based
| Name | DataType |
| Id | UUID |
| Name | STRING |
| Description | STRING |
| Member_count | INTEGER |
Primary Key: NA
Active_Campaigns
Purpose: The HeyPoplar Active Campaigns API lets you retrieve details of currently running direct mail campaigns for tracking and analysis.
Source API Documentation: https://developers.heypoplar.com/endpoints/other-endpoints#fetch-active-campaigns
Replication Type: Key Based
Primary Key: NA
| Name | DataType |
| Id | UUID |
| Name | STRING |
Campaign_Mailings
Purpose: The Campaign_Mailings API in HeyPoplar provides details about individual mail pieces sent as part of a campaign, including their status, recipient info, and delivery tracking.
Source API Documentation: https://developers.heypoplar.com/endpoints/other-endpoints#fetch-campaign-mailings
Replication Type: Key Based
Primary Key: NA
| Field | Type |
|---|---|
| id | string |
| campaign_id | string |
| creative_id | string |
| merge_tags | object |
| state | string |
| front_url | string |
| back_url | string |
| pdf_url | string |
| total_cost | string |
| address | record |
| send_at | string |
| created_at | string |
