Amazon Pinpoint · Schema

HoldoutActivity

Specifies the settings for a holdout activity in a journey. This type of activity stops a journey for a specified percentage of participants.

CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

Properties

Name Type Description
NextActivity object
Percentage object
View JSON Schema on GitHub

JSON Schema

amazon-pinpoint-holdout-activity-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-schema/amazon-pinpoint-holdout-activity-schema.json",
  "title": "HoldoutActivity",
  "description": "Specifies the settings for a holdout activity in a journey. This type of activity stops a journey for a specified percentage of participants.",
  "type": "object",
  "properties": {
    "NextActivity": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for the next activity to perform, after performing the holdout activity."
        }
      ]
    },
    "Percentage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "description": "<p>The percentage of participants who shouldn't continue the journey.</p> <p>To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.</p>"
        }
      ]
    }
  },
  "required": [
    "Percentage"
  ]
}