Subscription

Last Updated: Monday, January 7, 2019

Overview

The Subscription entity contains the information and metadata for a Person's Subscription to a Subscription List.

Topics in this Section

Subscription Entity

The following shows the JSON representation of a Subscription entity within the APIs.

{
   "person":{
      "id":"ABC123",
      "url":"/companies/:company_id/mobiledb/persons/:person_id"
   },
   "subscription_list":{
      "id":"1234",
      "url":"/companies/:company_id/mobiledb/subscription_lists/:id"
   },
   "opt_in_date":"2017-01-15T15:34Z",
   "url":"/companies/:company_id/mobiledb/persons/:person_id/subscriptions/:subscription_list_id"
}

Elements

Data Element	Type	Max Char Length	Description
person	Object		Person reference information for the Subscription.
subscription_list	Object		Subscription List object reference information for the Subscription.
opt_in_date	Timestamp	20	Time reference of when the Subscription was entered. It should be in the ISO 8601 format - for example: 2017-01-15T15:34Z.
acquisition	Object		The Acquisition Campaign reference to indicate how the Subscription was created.
url	String	50	A reference URL to the existing object, as a relative URL to the existing domain.