Skip to content

JourneyLimits

Source code in docs_src/capo_pinpoint/types/journey_limits.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
class JourneyLimits(TypedDict, closed=True):
    daily_cap: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.</p>"""
    endpoint_reentry_cap: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.</p>"""
    messages_per_second: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The maximum number of messages that the journey can send each second.</p>"""
    endpoint_reentry_interval: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H. </p>"""
    timeframe_cap: NotRequired[
        "capo_pinpoint.types.journey_timeframe_cap.JourneyTimeframeCap"
    ]
    """<p>The number of messages that an endpoint can receive during the specified timeframe.</p>"""
    total_cap: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The maximum number of messages a journey can sent to a single endpoint. The maximum value is 100. If set to 0, this limit will not apply.</p>"""

daily_cap instance-attribute 

daily_cap: NotRequired[__integer]

The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.

endpoint_reentry_cap instance-attribute 

endpoint_reentry_cap: NotRequired[__integer]

The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.

endpoint_reentry_interval instance-attribute 

endpoint_reentry_interval: NotRequired[__string]

Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.

messages_per_second instance-attribute 

messages_per_second: NotRequired[__integer]

The maximum number of messages that the journey can send each second.

timeframe_cap instance-attribute 

timeframe_cap: NotRequired[JourneyTimeframeCap]

The number of messages that an endpoint can receive during the specified timeframe.

total_cap instance-attribute 

total_cap: NotRequired[__integer]

The maximum number of messages a journey can sent to a single endpoint. The maximum value is 100. If set to 0, this limit will not apply.