{ "$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-journey-response-schema.json", "title": "JourneyResponse", "description": "Provides information about the status, configuration, and other settings for a journey.", "type": "object", "properties": { "Activities": { "allOf": [ { "$ref": "#/components/schemas/MapOfActivity" }, { "description": "A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity." } ] }, "ApplicationId": { "allOf": [ { "$ref": "#/components/schemas/__string" }, { "description": "The unique identifier for the application that the journey applies to." } ] }, "CreationDate": { "allOf": [ { "$ref": "#/components/schemas/__string" }, { "description": "The date, in ISO 8601 format, when the journey was created." } ] }, "Id": { "allOf": [ { "$ref": "#/components/schemas/__string" }, { "description": "The unique identifier for the journey." } ] }, "LastModifiedDate": { "allOf": [ { "$ref": "#/components/schemas/__string" }, { "description": "The date, in ISO 8601 format, when the journey was last modified." } ] }, "Limits": { "allOf": [ { "$ref": "#/components/schemas/JourneyLimits" }, { "description": "The messaging and entry limits for the journey." } ] }, "LocalTime": { "allOf": [ { "$ref": "#/components/schemas/__boolean" }, { "description": "Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time." } ] }, "Name": { "allOf": [ { "$ref": "#/components/schemas/__string" }, { "description": "The name of the journey." } ] }, "QuietTime": { "allOf": [ { "$ref": "#/components/schemas/QuietTime" }, { "description": "

The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

" } ] }, "RefreshFrequency": { "allOf": [ { "$ref": "#/components/schemas/__string" }, { "description": "The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format." } ] }, "Schedule": { "allOf": [ { "$ref": "#/components/schemas/JourneySchedule" }, { "description": "The schedule settings for the journey." } ] }, "StartActivity": { "allOf": [ { "$ref": "#/components/schemas/__string" }, { "description": "The unique identifier for the first activity in the journey." } ] }, "StartCondition": { "allOf": [ { "$ref": "#/components/schemas/StartCondition" }, { "description": "The segment that defines which users are participants in the journey." } ] }, "State": { "allOf": [ { "$ref": "#/components/schemas/State" }, { "description": "

The current status of the journey. Possible values are:

" } ] }, "tags": { "allOf": [ { "$ref": "#/components/schemas/MapOf__string" }, { "description": "This object is not used or supported." } ] }, "WaitForQuietTime": { "allOf": [ { "$ref": "#/components/schemas/__boolean" }, { "description": "Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours." } ] }, "RefreshOnSegmentUpdate": { "allOf": [ { "$ref": "#/components/schemas/__boolean" }, { "description": "Specifies whether a journey should be refreshed on segment update." } ] }, "JourneyChannelSettings": { "allOf": [ { "$ref": "#/components/schemas/JourneyChannelSettings" }, { "description": "The channel-specific configurations for the journey." } ] }, "SendingSchedule": { "allOf": [ { "$ref": "#/components/schemas/__boolean" }, { "description": "Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays). This flag should be set to true in order to allow (OpenHours and ClosedDays)" } ] }, "OpenHours": { "allOf": [ { "$ref": "#/components/schemas/OpenHours" }, { "description": "The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true." } ] }, "ClosedDays": { "allOf": [ { "$ref": "#/components/schemas/ClosedDays" }, { "description": "The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true." } ] } }, "required": [ "Name", "Id", "ApplicationId" ] }