Subscription Extract
The daily subscription extract is used to sync subscriptions between Vibes platform and a Customer Relationship Management (CRM) or Campaign Management system.
Standard File Name
The following is the recommended best practice for file names. File naming conventions may be changed upon request.
subscriptions_<company_key>_<date>.<extension>
How to Read Files
Extract files will be delivered in tab-separated value (TSV) text files. The information is separated into rows and columns. Column data will be separated by tabs, while each new row will be separated by a hard return.
File Body
The file body can contain the following fields as data, separated by the delimiter and a header row.
| Field Name | Data Type | Field Length | Allows Nulls | Description |
|---|---|---|---|---|
| person_id | String | 255 | No | Unique Vibes-specified GUID representing the person. Note that while the field is labeled person_id, the value is the person_key. |
| external_person_id | String | 255 | Yes | External system's person identifier. |
| mdn | String | 20 | No | Mobile number included in the Subscription List. The Mobile Directory Number (MDN) must be in E.164 format. Example: +12295551234. |
| company_id | String | 255 | No | ID representing the customer account at Vibes. |
| carrier_code | String | 50 | No | The carrier code indicating specific carrier. See Appendix - Carrier Codes for all valid carriers. |
| subscription_list_id | String | 255 | No | A unique identifier for the subscription list the person is associated with |
| subscription_list_name | String | 255 | No | Name of the list the person is associated with |
| opt_in_date | Date/Time | N/A | No | The date/time that the subscriber had opted into the list. Format example: "2017-04-05 14:30:00 -0600". |
| opt_out_date | Date/Time | N/A | Yes | The date/time the subscriber opted out of the list. Format example: "2017-04-05 14:30:00 -0600". |
| subscription_event | String | 5 | No | The type of subscription event: OPT_IN; OPT_OUT. |
| opt_out_reason | String | 100 | Yes | The reason for the disconnect. Values are: - USER_OPT_OUT - DISCONNECT - LIST_ARCHIVED - BULK_OPT_OUT - FAILED_AT_CARRIER - OBSOLETE_CARRIER |
| activity_description | String | 255 | Yes | The acquisition campaign that a subscriber used to opt-in to the list |
| activity_id | String | 255 | Yes | Vibes UID for the acquisition campaign that the subscriber used to opt-in to the list |
Example File
Updated about 2 months ago