Subscription Lists

Contact Subscription List object

A list of subscription list items associated with the specified contact. Each item consists of a list of list IDs and an optional scope.

Jump to examples ↓

• list_ids arrayREQUIRED

  A list of subscription lists associated to the specified scope. If no scope is specified these subscription lists are not scoped.

• scope object<Scopes>

  The channel types where membership applies. The app scope includes iOS, Android, and Amazon channels.

Used in:

• Named User subscription lists listing

Examples

{
   "list_ids": ["example_listId-2", "example_listId-4"],
   "scope": "app"
}

Named User scoped batch item

Contains scope and subscription_lists.

Jump to examples ↓

• scope arrayREQUIRED
• subscription_lists object<Named User Subscription List object>REQUIRED

  Defines the Subscription List changes.

Examples

{
    "scope": ["app"],
    "subscription_lists": {
        "subscribe": ["stickers", "gifs"],
        "unsubscribe": ["cookies"]
    }
}

Named User Subscription List object

Defines the Subscription List changes.

Jump to examples ↓

• subscribe array[string]

  Subscribe to the specified Subscription List identifier.

• unsubscribe array[string]

  Unsubscribe the specified Subscription List identifier.

Examples

{
    "subscribe": ["stickers", "gifs"],
    "unsubscribe": ["cookies"]
}

Subscription List action

A string representing the membership mutation action to be taken for a given list.

Subscription List item object

An item consisting of a list of list IDs and scope.

Jump to examples ↓

• list_ids arrayREQUIRED

  A list of subscription lists associated to the specified scope. If no scope is specified these subscription lists are not scoped.

• scope string

  Scope as a string.

  Possible values: app, email, sms, web

Examples

{
  "list_ids": ["example_listId-2", "example_listId-3"],
  "scope": "app"
}

Subscription List object

Jump to examples ↓

• action objectREQUIRED
  One of
  • Channel Subscription List action object

    Alters Subscription List membership for a channel.

    OBJECT PROPERTIES
    • action object<Subscription List action>REQUIRED

      A string representing the membership mutation action to be taken for a given list.

    • list_id object<List ID>REQUIRED

      A list ID that contains only alphanumeric characters, underscores, or hyphens.

    • type stringREQUIRED

      Possible values: channel

  • Contact subscription list action object

    Alters subscription list membership for a contact.

    OBJECT PROPERTIES
    • action object<Subscription List action>REQUIRED

      A string representing the membership mutation action to be taken for a given list.

    • list_id object<List ID>REQUIRED

      A list ID that contains only alphanumeric characters, underscores, or hyphens.

    • scope object<Scopes>REQUIRED

      The channel types where membership applies. The app scope includes iOS, Android, and Amazon channels.

    • type stringREQUIRED

      Possible values: contact

• list_id object<List ID>REQUIRED

  A list ID that contains only alphanumeric characters, underscores, or hyphens.

• timestamp string

  The date-time when the attribute changed. Server time is used when not present.

Used in:

• Channel listing
• Channel lookup
• Look up an email address
• SMS channel lookup
• Subscribe or unsubscribe channels to/from subscription lists

Examples

{
  "action": "subscribe",
  "list_id": "exciting_news"
}

Subscription List result object

Defines the subscription list result object.

Jump to examples ↓

• default_opted_in booleanREQUIRED

  True if the audience defined by scopes are opted in by default, otherwise false.

• description object

  Description of the subscription list.

• list_id object<List ID>REQUIRED

  A list ID that contains only alphanumeric characters, underscores, or hyphens.

• message_type string

  The message type.

  Possible values: transactional, commercial

• name string

  Human readable name.

• scopes arrayREQUIRED

  An array of scopes applicable to the subscription list. Valid scopes are app, web, email, and sms.

Used in:

• Subscription lists listing

Examples

{
   "list_id": "example_listId-2",
   "name": "A nice readable name 2",
   "description": "A very nice description for you.",
   "scopes": ["app", "web"],
   "default_opted_in": true
}