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:

• Named User subscription lists listing

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.

List ID

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

Used in:

• Channel listing
• Channel lookup
• Create and Send a message
• Create experiment (A/B Test)
• Create pipeline (automated message)
• Create Segment
• Create template
• Experiment listing
• Experiment lookup
• Individual pipeline lookup
• List a specific schedule
• List existing pipelines
• List filtered pipelines
• List schedules
• List templates
• Look up a template
• Look up an email address
• Named User listing or lookup
• Named User subscription lists listing
• Push to template
• Schedule a Create and Send message
• Schedule a notification
• Schedule a templated push
• Schedule message with bulk ID
• Scheduled experiment listing
• Segment lookup
• Send a push
• Send message with bulk ID
• SMS channel lookup
• Subscribe or unsubscribe channels to/from subscription lists
• Subscription lists listing
• Update pipeline
• Update schedule
• Update Segment
• Update template
• Validate a push
• Validate a template
• Validate Create and Send payload
• Validate experiment
• Validate message with bulk ID
• Validate pipeline

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:

• 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:

• Scoped Contact batch operations
• 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:

• Channel listing
• Channel lookup
• Create and Send a message
• Create experiment (A/B Test)
• Create pipeline (automated message)
• Create template
• Experiment listing
• Experiment lookup
• Individual pipeline lookup
• List a specific schedule
• List existing pipelines
• List filtered pipelines
• List schedules
• List templates
• Look up a template
• Look up an email address
• Named User listing or lookup
• Named User subscription lists listing
• Schedule a Create and Send message
• Schedule a notification
• Schedule a templated push
• Schedule message with bulk ID
• Scheduled experiment listing
• Scoped Contact batch operations
• Scoped Named User batch operations
• Send a push
• Send message with bulk ID
• SMS channel lookup
• Subscribe or unsubscribe channels to/from subscription lists
• Subscription lists listing
• Update pipeline
• Update schedule
• Update template
• Validate a push
• Validate Create and Send payload
• Validate experiment
• Validate message with bulk ID
• Validate pipeline

Subscription List action

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

• subscribe
• unsubscribe

Used in:

• Channel listing
• Channel lookup
• Create and Send a message
• Create experiment (A/B Test)
• Create pipeline (automated message)
• Create template
• Experiment listing
• Experiment lookup
• Individual pipeline lookup
• List a specific schedule
• List existing pipelines
• List filtered pipelines
• List schedules
• List templates
• Look up a template
• Look up an email address
• Named User listing or lookup
• Schedule a Create and Send message
• Schedule a notification
• Schedule a templated push
• Schedule message with bulk ID
• Scheduled experiment listing
• Send a push
• Send message with bulk ID
• SMS channel lookup
• Subscribe or unsubscribe channels to/from subscription lists
• Update pipeline
• Update schedule
• Update template
• Validate a push
• Validate Create and Send payload
• Validate experiment
• Validate message with bulk ID
• Validate pipeline

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:

• Named User listing or lookup

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 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:

• Channel listing
• Channel lookup
• Look up an email address
• Named User listing or lookup
• 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 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:

• 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
}