Unsubscribe Data File Specifications

This section describes the distinct data elements that you must provide in the unsubscribe data file that you transfer to Oracle Utilities. Each unsubscribe data file that you send to Oracle Utilities should include the data fields described in the tables below. Each table row below is a column in the data file. The header row in each file you generate must contain all the values specified in the Column Name column, even if the values in those columns are blank. Additional notes to keep in mind include the following:

• The columns should appear from left to right in the order in which they appear in the table and must be separated by commas.
• All of the data fields described in the sections must be included in a single, channel-specific data file and sent to Oracle Utilities. For example, all data related to email unsubscribe must be included in a single email unsubscribe data file, while all data related to voice unsubscribes must be included in a single IVR unsubscribe data file. See Unsubscribe Data File Name Conventions for more information.

Email Unsubscribe Fields

Column Name	Description
address	The email address that the event applies to. The email address must be encoded in ASCII format. Email addresses that contain characters that are not in the ASCII character set are not supported. Type: STRING Can Be Empty?: No.
occurred_on	The date and time of the event. This should comply with the ISO 8601 date and time standard in the UTC time zone. Type: STRING Can Be Empty?: No.
email_address_event_type	The event type. This should always be UNSUBSCRIBE. Type: STRING Can Be Empty?: No.

Example Email Unsubscribe File

The following table is an example of an email unsubscribe file.

address	occurred_on	email_address_event_type
[e-mail]	2015-07-05T22:16:18+00:00	UNSUBSCRIBE
[e-mail]	2015-07-08T23:16:18+00:00	UNSUBSCRIBE

Interactive Voice Response (IVR) Unsubscribe Fields

Column Name	Description
address	The phone number that the event applies to. This should comply with the International Telecommunication Union (ITU) E.164 standard. Type: STRING Can Be Empty?: No.
occurred_on	The date and time of the event. This should comply with the ISO 8601 date and time standard in the UTC time zone. Type: STRING Can Be Empty?: No.
ivr_address_event_type	The event type. This should always be UNSUBSCRIBE. Type: STRING Can Be Empty?: No.

Example IVR Unsubscribe File

The following table is an example of an IVR unsubscribe file.

address	occurred_on	ivr_address_event_type
[phone]	2015-07-05T22:16:18+00:00	UNSUBSCRIBE
[phone]	2015-07-08T23:16:18+00:00	UNSUBSCRIBE

SMS Unsubscribe Fields

Column Name	Description
address	The phone number that the event applies to. This should comply with the International Telecommunication Union (ITU) E.164 standard. Type: STRING Can Be Empty?: No.
occurred_on	The date and time of the event. This should comply with the ISO 8601 date and time standard in the UTC time zone. Type: STRING Can Be Empty?: No.
sms_address_event_type	The event type. This should always be UNSUBSCRIBE. Type: STRING Can Be Empty?: No.
short_code	The short code that the address receives communications from. This must only consist of digits. The minimum length is 3 characters. The maximum length is 8 characters. Type: STRING Can Be Empty?: No.

Example SMS Unsubscribe File

The following table is an example of an SMS unsubscribe file.

address	occurred_on	sms_address_event_type	short_code
[phone]	2015-07-05T22:16:18+00:00	UNSUBSCRIBE	12345
[phone]	2015-07-08T23:16:18+00:00	UNSUBSCRIBE	12346