Skip to main content
Skip table of contents

Campaign event nonRPI feed layout definition

The following table represents the feed layout definition.

Required fields are marked as (Required) in the field description column; fields not marked as required are optional.

Business name

Field name

Field description

Field data type/length

System of Record Name

sor_name

(Required) Name of the system that is the authoritative data source for a record. 

char(100)

Client Campaign Event ID

client_campaign_event_id

(Required) Uniquely identifies marketing campaign event for this data source (defined in the API config).

char(150)

Campaign Event Datetime

campaign_event_datetime

(Required) Run Date: The day and time your advertisement appears in the publication; also known as insertion date.

Must use the following format: YYYY-MM-DD HH:mm:ss 

datetime

Business Unit Code

business_unit_code

Business Unit identifies the structure of brands within an organizational entity. It is the way in which the brands within a company’s portfolio are related to, and differentiated from, one another.

Values are defined as part of on-boarding, in BUSINESS_UNIT_LOOKUP; NULL values will default to enterprise. Refer to Business unit for details.

char(50)

Creative Text

creative_text

The content of the creative.

char(1000)

Campaign Code

campaign_code

(Required) Uniquely identifies the marketing campaign; a specific series of strategies, tactics, and activities designed to get desired marketing or other messages to intended target markets.

char(50)

Campaign Name

campaign_name

Marketing campaign's name.

char(500)

Campaign Description

campaign_desc

Marketing campaign's description.

char(1000)

Campaign Start Date

campaign_start_date

Date when marketing campaign starts: YYYY-MM-DD.

date

Campaign End Date

campaign_end_date

Date when marketing campaign ends: YYYY-MM-DD.

date

Cell Code

cell_code

Uniquely identifies the cell. Cell is a definable segment - a mass of people who can be identified and targeted with reasonable effort, cost, and time.

char(50)

Cell Name

cell_name

The name of the Cell, a definable segment - a mass of people who can be identified and targeted with reasonable effort, cost, and time.

char(500)

Offer Code

offer_code

Identifies a coupon, discount, etc. developed for use in marketing (direct or other types) that is available to be sent to the parties within one or more campaigns.

char(100)

Offer Code Value

offer_code_value

Coupon's value.

char(500)

Drop Date

drop_date

Marketing drop date: YYYY-MM-DD.

date

Control Group Indicator

control_group_ind

Indicates whether this is a control group record.

  • y for yes

  • n for no

char(1)

Channel Code

channel_code

Uniquely identifies a communication channel such as direct mail, Email, phone, social media, web, mobile, call center, display media, etc.

Values are defined as part of on-boarding, in CHANNEL_LOOKUP. Refer to Channel for details.

char(50)

Audience ID

audience_id

Audiences can be defined by either email address, Facebook UIDs, phone numbers, names, date of birth, gender, locations, app user IDs, Apple's Advertising Identifier (IDFA), Android's advertising ID, or by a combination of rules used to identify users who took specific actions on your website.

char(300)

Source Party Profile ID

source_party_profile_id

You must provide either the source_party_profile_id or ONE of the PII fields. See Campaign event nonRPI feed layout overview for details.

Customer ID - Uniquely identifies the customer's record in the client's system. Uses source_party_profile_id + business_unit_code for lookup.  

char(320)

Address 1

address_1

You must provide either the source_party_profile_id or ONE of the PII fields. See Campaign event nonRPI feed layout overview for details.

Address line 1.

char(128)

Address 2

address_2

You must provide either the source_party_profile_id or ONE of the PII fields. See Campaign event nonRPI feed layout overview for details.

Address line 2.

char(128)

Address 3

address_3

You must provide either the source_party_profile_id or ONE of the PII fields. See Campaign event nonRPI feed layout overview for details.

Address line 3.

char(128)

Address 4

address_4

You must provide either the source_party_profile_id or ONE of the PII fields. See Campaign event nonRPI feed layout overview for details.

Address line 4.

char(128)

City

city

You must provide either the source_party_profile_id or ONE of the PII fields. See Campaign event nonRPI feed layout overview for details.

City name.

char(64)

State Province

state_province

You must provide either the source_party_profile_id or ONE of the PII fields. See Campaign event nonRPI feed layout overview for details.

State code.

char(64)

Postal Code 1

postal_code_1

You must provide either the source_party_profile_id or ONE of the PII fields. See Campaign event nonRPI feed layout overview for details.

Postal code.

char(16)

Country Code

country_code

You must provide either the source_party_profile_id or ONE of the PII fields. See Campaign event nonRPI feed layout overview for details.

ISO 3166 (alpha-2) 2-character country code.

char(2)

Home Phone Country Code

home_phone_country_code

You must provide either the source_party_profile_id or ONE of the PII fields. See Campaign event nonRPI feed layout overview for details.

ISO 3166 (alpha-2) 2-character country code of home phone.  

char(2)

Home Phone Number

home_phone_num

You must provide either the source_party_profile_id or ONE of the PII fields. See Campaign event nonRPI feed layout overview for details.

Customer's home phone number, including area code. 

char(32)

Mobile Phone Country Code

mobile_phone_country_code

You must provide either the source_party_profile_id or ONE of the PII fields. See Campaign event nonRPI feed layout overview for details.

ISO 3166 (alpha-2) 2-character country code of mobile phone.  

char(2)

Mobile Phone Number

mobile_phone_num

You must provide either the source_party_profile_id or ONE of the PII fields. See Campaign event nonRPI feed layout overview for details.

Customer's cell phone number, including area code. 

char(32)

Work Phone Country Code

work_phone_country_code

You must provide either the source_party_profile_id or ONE of the PII fields. See Campaign event nonRPI feed layout overview for details.

ISO 3166 (alpha-2) 2-character country code of work phone.  

char(2)

Work Phone Number

work_phone_num

You must provide either the source_party_profile_id or ONE of the PII fields. See Campaign event nonRPI feed layout overview for details.

Customer's work phone number, including area code. 

char(32)

Other Phone Country Code

other_phone_country_code

You must provide either the source_party_profile_id or ONE of the PII fields. See Campaign event nonRPI feed layout overview for details.

ISO 3166 (alpha-2) 2-character country code of other phone.  

char(2)

Other Phone Number

other_phone_num

You must provide either the source_party_profile_id or ONE of the PII fields. See Campaign event nonRPI feed layout overview for details.

Customer's other phone number, including area code. 

char(32)

Other Phone Type Code

other_phone_type_code

You must provide either the source_party_profile_id or ONE of the PII fields. See Campaign event nonRPI feed layout overview for details.

The type of the phone, such as billing, shipping, home, work, primary, mobile, other as defined in the reference data worksheet.

Values are defined as part of on-boarding, in PHONE_TYPE. Refer to Phone type for details.

char(50)

Email Address

email_address

You must provide either the source_party_profile_id or ONE of the PII fields. See Campaign event nonRPI feed layout overview for details.

Customer's email address.

char(320)

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.