Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Last Updated:

Lastupdatedate

Livesearch
placeholderSearch the Vibes Developer Wiki
typepage



Overview

...

The Subscription entity

...

contains the information and

...

metadata for a Person's

...

Subscription to a

...

Subscription List.

...


Panel
borderColor#2B9CD7

Topics in this Section

Page Tree
root

...

@self
startDepth

...

2




Anchor
subscriptionentity
subscriptionentity
Subscription Entity

...

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

Code Block

...

{
   "person"

...

:{
      "id"

...

:

...

"ABC123",
      "url"

...

:

...

"/companies/:

...

company_key/mobiledb/persons/:person_id"
   },
   "subscription_list"

...

:{
      "id"

...

:

...

"1234",
      "url"

...

:

...

"/companies/:

...

company_key/mobiledb/subscription_lists/:id"
   },
   "opt_in_date"

...

:

...

"

...

2017-01-

...

15T15:

...

34Z",
   "url"

...

:

...

"/companies/:

...

company_key/mobiledb/persons/:person_id/subscriptions/:subscription_list_id"
}

Elements

Data Element

Type

Description

person

Object

Person reference information for the

...

Subscription.

subscription_list

Object

Subscription List object reference information for the

...

Subscription.

opt_in_date

...

Timestamp

Time reference of when the

...

Subscription was entered. It should be in the ISO 8601 format - for example: 2017-01-15T15:34Z.

opt_out_dateTimestampTime reference of when the Subscription was ended. It should be in the ISO 8601 format - for example: 2017-01-15T15:34Z.
opt_out_reasonString

The reason why the person was opted-out. The reason will be one of: “user_opt_out”, “disconnect”, “list_archived”, “bulk_opt_out”, “failed_at_carrier”, “obsolete_carrier”, “platform_opt_out”, “keyword_opt_out”, “api_opt_out”, “button_opt_out”.

url

String

A reference

...

URL to the existing object, as a relative URL to the existing domain.