Audience limits

Audience limits object

Defines limits to be applied to Push Notifications and standard in-app messages (not In-App Automations or Scenes) only. See Audience Limit in the Message delivery user guide for additional information and limitations.

Jump to examples ↓

• max_recipients integer

  The maximum number of recipients a push can be delivered to.

Used in:

• Create experiment (A/B Test)
• Create pipeline (automated message)
• Experiment listing
• Experiment lookup
• Schedule a notification
• Schedule a templated push
• Schedule message with bulk ID
• Scheduled experiment listing
• Send a push
• Send message with bulk ID
• Update pipeline
• Update schedule
• Validate a push
• Validate experiment
• Validate message with bulk ID
• Validate pipeline

Examples

{
  "options": {
    "audience_limits": {
      "max_recipients": 1000
    }
  }
}

Ban List parameters

A list of parameters, where the key and value are both strings, that will be used to override the default values set for variables in a Ban List request URL.

Jump to examples ↓

• * string

Used in:

• Create experiment (A/B Test)
• Create pipeline (automated message)
• Experiment listing
• Experiment lookup
• Schedule a notification
• Schedule a templated push
• Schedule message with bulk ID
• Scheduled experiment listing
• Send a push
• Send message with bulk ID
• Update pipeline
• Update schedule
• Validate a push
• Validate experiment
• Validate message with bulk ID
• Validate pipeline

Examples

{
  "ban_list_parameters": {
    "category": "api-cat"
  }
}