Skip to main content
Skip table of contents

Contact authorization 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

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)

Authorization Date Time

auth_datetime

(Required) This field is a natural primary key.

A date time when the preference was captured by the source system: YYYY-MM-DD HH:mm:ss 

This field is used in aggregate calculations.

datetime

Business Unit Code

business_unit_code

This field is a natural primary key.

Business Unit (BU) identifies the structure of brands within an organizational entity. When provided, permission or preference is applied only to that BU, otherwise it's enterprise-wide (in the case of multi-BU clients). 

This field is used in aggregate calculations.

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)

Contact Level Type Code

contact_level_type_code

(Required) This field is a natural primary key.

Contact level type identifies a level the preference or permission is for: global level, email, phone, direct mail address, SMS, etc.

This field is used in aggregate calculations.

Valid values are:

  • email

  • direct_mail

  • phone

  • sms

  • fax

  • soc_media

  • party_profile

char(50)

Contact Level Value

contact_level_value

(Required) This field is a natural primary key.

The contact item that a permission or preference is being provided for:

  • When contact level type is email: actual email address

  • When contact level type is phone: phone number

  • When contact level type is SMS: phone number

  • When contact level type is direct mail: should be left NULL; use mailing address fields instead to support address formatting 

  • When contact level type is party_profile: uses source_party_profile_id + business_unit_code for lookup

This field is used in aggregate calculations.   

char(320)

Contact Level Additional Code

contact_level_addtl_code

Can be used for an ISO 3166 (alpha-2) 2-character country code when contact_level_value is a phone number, or the type of social media when contact_level_value is social media account, etc.

char(50)

Authorization Code

auth_code

(Required) This field is a natural primary key.

Authorization values that indicate permission to contact (opt_in or opt_out)  

This field is used in aggregate calculations.

Valid values are:

  • opt_in

  • opt_out

char(10)

Authorization Value

auth_value

This field is a natural primary key.

The value of permission or preference code, for example: Newsletter / Catalog / Specials, or any other value for preference types like preferred contact language. 

This field is used in aggregate calculations.

char(100)

Authorization Frequency

auth_frequency

This field is a natural primary key.

When specifically noted, the frequency at which contact is authorized through a channel defined in this record contact level type code and value.  

This field is used in aggregate calculations.

char(100)

Address 1

address_1

Combined address fields are treated as a single Contact Level Value and are a natural primary key.

Address Line 1

char(128)

Address 2

address_2

Combined address fields are treated as a single Contact Level Value and are a natural primary key.

Address Line 2

char(128)

Address 3

address_3

Combined address fields are treated as a single Contact Level Value and are a natural primary key.

Address Line 3

char(128)

Address 4

address_4

Combined address fields are treated as a single Contact Level Value and are a natural primary key.

Address Line 4

char(128)

City 

city 

Combined address fields are treated as a single Contact Level Value and are a natural primary key.

City Name  

char(64)

State Province

state_province

Combined address fields are treated as a single Contact Level Value and are a natural primary key.

State Code

char(64)

Postal Code 1

postal_code_1

Combined address fields are treated as a single Contact Level Value and are a natural primary key.

Postal Code 1

char(16)

Postal Code 2

postal_code_2

Combined address fields are treated as a single Contact Level Value and are a natural primary key.

Postal Code 2

char(16)

Country Code

country_code

Combined address fields are treated as a single Contact Level Value and are a natural primary key.

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

char(2)

Double Verification Indicator

double_verification_ind

This field is a natural primary key.

Indicates double opt-in. Double opt-in is a type of email subscription where a user should confirm his or her consent to be added to the mailing list twice. 

This field is used in aggregate calculations.

Valid value is y.

char(1)

JavaScript errors detected

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

If this problem persists, please contact our support.