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 array<List ID>REQUIRED

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

  Min items: 1, Max items: 100

  Example: [example_listId-1 example_listId-5]

• scope string<Scopes>

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

  Possible values:

  • app
  • web
  • email
  • sms

Used in:

• List named user subscription lists

Examples

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

Contact subscription list object

Defines the subscription list changes.

• subscribe array[string]

  Subscribe to the specified subscription list identifier.

• unsubscribe array[string]

  Unsubscribe the specified subscription list identifier.

Used in:

• Perform scoped contact batch operations

List ID

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

Used in:

• Create and send experiment (A/B test)
• Create and Send message
• Create pipelines (automated message)
• Create segment
• Create template
• Enter or exit users from Sequence
• List channels
• List existing pipelines
• List experiments
• List filtered pipelines
• List named user subscription lists
• List or look up named users
• List scheduled experiments
• List schedules
• List subscription lists
• List templates
• Look up channel
• Look up email address
• Look up experiment
• Look up pipeline
• Look up schedule
• Look up segment
• Look up SMS channel
• Look up template
• Schedule Create and Send message
• Schedule message with bulk ID
• Schedule notifications
• Schedule templated pushes
• Send message with bulk ID
• Send pushes
• Send templated pushes
• Subscribe or unsubscribe channels to/from subscription lists
• Update pipeline
• Update schedule
• Update segment
• Update template
• Validate Create and Send payload
• Validate experiment
• Validate message with bulk ID
• Validate pipelines
• Validate pushes
• Validate templated pushes

Named user scoped batch item

Contains scope and subscription_lists.

Jump to examples ↓

• scope array<Scopes>REQUIRED
• subscription_lists object<Named user subscription list object>REQUIRED

  Defines the subscription list changes.

Used in:

• Perform scoped named user batch operations

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.

Used in:

• Perform scoped named user batch operations

Examples

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

Scopes

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

• app
• web
• email
• sms

Used in:

• Create and send experiment (A/B test)
• Create and Send message
• Create pipelines (automated message)
• Create template
• List channels
• List existing pipelines
• List experiments
• List filtered pipelines
• List named user subscription lists
• List or look up named users
• List scheduled experiments
• List schedules
• List subscription lists
• List templates
• Look up channel
• Look up email address
• Look up experiment
• Look up pipeline
• Look up schedule
• Look up SMS channel
• Look up template
• Perform scoped contact batch operations
• Perform scoped named user batch operations
• Schedule Create and Send message
• Schedule message with bulk ID
• Schedule notifications
• Schedule templated pushes
• Send message with bulk ID
• Send pushes
• Subscribe or unsubscribe channels to/from subscription lists
• Update pipeline
• Update schedule
• Update template
• Validate Create and Send payload
• Validate experiment
• Validate message with bulk ID
• Validate pipelines
• Validate pushes

Subscription list action

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

• subscribe
• unsubscribe

Used in:

• Create and send experiment (A/B test)
• Create and Send message
• Create pipelines (automated message)
• Create template
• List channels
• List existing pipelines
• List experiments
• List filtered pipelines
• List or look up named users
• List scheduled experiments
• List schedules
• List templates
• Look up channel
• Look up email address
• Look up experiment
• Look up pipeline
• Look up schedule
• Look up SMS channel
• Look up template
• Schedule Create and Send message
• Schedule message with bulk ID
• Schedule notifications
• Schedule templated pushes
• Send message with bulk ID
• Send pushes
• Subscribe or unsubscribe channels to/from subscription lists
• Update pipeline
• Update schedule
• Update template
• Validate Create and Send payload
• Validate experiment
• Validate message with bulk ID
• Validate pipelines
• Validate pushes

Subscription list item object

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

Jump to examples ↓

• list_ids array<List ID>REQUIRED

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

  Min items: 1, Max items: 100

  Example: [example_listId-1 example_listId-5]

• scope string

  Scope as a string.

  Possible values:

  • app
  • email
  • sms
  • web

Used in:

• List or look up named users

Examples

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

Subscription list object

Jump to examples ↓

• action REQUIRED
  One of
  • Channel subscription list action object

    Alters subscription list membership for a channel.

    OBJECT PROPERTIES
    • action string<Subscription list action>REQUIRED

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

      Possible values:

      • subscribe
      • unsubscribe
    • list_id string<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 string<Subscription list action>REQUIRED

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

      Possible values:

      • subscribe
      • unsubscribe
    • list_id string<List ID>REQUIRED

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

    • scope string<Scopes>REQUIRED

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

      Possible values:

      • app
      • web
      • email
      • sms
    • type stringREQUIRED

      Possible values:

      • contact
• list_id string<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.

  Format: date-time

Used in:

• List channels
• List or look up named users
• Look up channel
• Look up email address
• Look up SMS channel
• 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 string<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.

  Example: A nice name readable name 1

• scopes array<Scopes>REQUIRED

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

  Min items: 1, Max items: 100

Used in:

• List subscription lists

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
}