{
"openapi": "3.0.2",
"info": {
"title": "Klaviyo API",
"version": "2026-04-15",
"description": "The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.",
"contact": {
"name": "Klaviyo Developer Experience Team",
"email": "developers@klaviyo.com",
"url": "https://developers.klaviyo.com"
},
"termsOfService": "https://www.klaviyo.com/legal/api-terms",
"license": {
"name": "License",
"url": "https://www.klaviyo.com/legal"
}
},
"servers": [
{
"url": "https://a.klaviyo.com",
"description": "Production"
}
],
"security": [
{
"Klaviyo-API-Key": []
}
],
"paths": {
"/api/flows": {
"get": {
"operationId": "get_flows",
"summary": "Get Flows",
"description": "Get all flows in an account.\n\nReturns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flows.json)",
"parameters": [
{
"name": "fields[flow-action]",
"in": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created",
"definition",
"definition.data",
"definition.data.action_output_filter",
"definition.data.action_output_filter.condition_groups",
"definition.data.branches",
"definition.data.current_experiment",
"definition.data.current_experiment.allocations",
"definition.data.current_experiment.automatic_winner_selection_settings",
"definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date",
"definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty",
"definition.data.current_experiment.automatic_winner_selection_settings.enabled",
"definition.data.current_experiment.id",
"definition.data.current_experiment.name",
"definition.data.current_experiment.started",
"definition.data.current_experiment.variations",
"definition.data.current_experiment.winner_metric",
"definition.data.delay_until_time",
"definition.data.delay_until_weekdays",
"definition.data.experiment_status",
"definition.data.expire_after_unit",
"definition.data.expire_after_value",
"definition.data.list_id",
"definition.data.main_action",
"definition.data.main_action.data",
"definition.data.main_action.data.message",
"definition.data.main_action.data.message.action_buttons",
"definition.data.main_action.data.message.add_info_link",
"definition.data.main_action.data.message.add_opt_out_language",
"definition.data.main_action.data.message.add_org_prefix",
"definition.data.main_action.data.message.add_tracking_params",
"definition.data.main_action.data.message.additional_filters",
"definition.data.main_action.data.message.additional_filters.condition_groups",
"definition.data.main_action.data.message.android_link",
"definition.data.main_action.data.message.badge",
"definition.data.main_action.data.message.badge_options",
"definition.data.main_action.data.message.badge_options.badge_config",
"definition.data.main_action.data.message.badge_options.set_from_property",
"definition.data.main_action.data.message.badge_options.value",
"definition.data.main_action.data.message.bcc_email",
"definition.data.main_action.data.message.body",
"definition.data.main_action.data.message.cc_email",
"definition.data.main_action.data.message.conversion_metric_id",
"definition.data.main_action.data.message.custom_tracking_params",
"definition.data.main_action.data.message.dynamic_image",
"definition.data.main_action.data.message.from_email",
"definition.data.main_action.data.message.from_label",
"definition.data.main_action.data.message.id",
"definition.data.main_action.data.message.image_id",
"definition.data.main_action.data.message.include_contact_card",
"definition.data.main_action.data.message.ios_link",
"definition.data.main_action.data.message.kv_pairs",
"definition.data.main_action.data.message.name",
"definition.data.main_action.data.message.on_open",
"definition.data.main_action.data.message.preview_text",
"definition.data.main_action.data.message.push_type",
"definition.data.main_action.data.message.reply_to_email",
"definition.data.main_action.data.message.shorten_links",
"definition.data.main_action.data.message.smart_sending_enabled",
"definition.data.main_action.data.message.sms_quiet_hours_enabled",
"definition.data.main_action.data.message.sound",
"definition.data.main_action.data.message.subject_line",
"definition.data.main_action.data.message.template_id",
"definition.data.main_action.data.message.title",
"definition.data.main_action.data.message.transactional",
"definition.data.main_action.data.message.video_asset_id",
"definition.data.main_action.data.status",
"definition.data.main_action.id",
"definition.data.main_action.links",
"definition.data.main_action.links.next",
"definition.data.main_action.temporary_id",
"definition.data.main_action.type",
"definition.data.message",
"definition.data.message.action_buttons",
"definition.data.message.add_info_link",
"definition.data.message.add_opt_out_language",
"definition.data.message.add_org_prefix",
"definition.data.message.add_tracking_params",
"definition.data.message.additional_filters",
"definition.data.message.additional_filters.condition_groups",
"definition.data.message.android_link",
"definition.data.message.badge",
"definition.data.message.badge_options",
"definition.data.message.badge_options.badge_config",
"definition.data.message.badge_options.set_from_property",
"definition.data.message.badge_options.value",
"definition.data.message.bcc_email",
"definition.data.message.body",
"definition.data.message.cc_email",
"definition.data.message.conversion_metric_id",
"definition.data.message.custom_tracking_params",
"definition.data.message.dynamic_image",
"definition.data.message.from_email",
"definition.data.message.from_label",
"definition.data.message.headers",
"definition.data.message.id",
"definition.data.message.image_id",
"definition.data.message.include_contact_card",
"definition.data.message.ios_link",
"definition.data.message.kv_pairs",
"definition.data.message.name",
"definition.data.message.on_open",
"definition.data.message.preview_text",
"definition.data.message.push_type",
"definition.data.message.reply_to_email",
"definition.data.message.shorten_links",
"definition.data.message.smart_sending_enabled",
"definition.data.message.sms_quiet_hours_enabled",
"definition.data.message.sound",
"definition.data.message.subject_line",
"definition.data.message.template_id",
"definition.data.message.title",
"definition.data.message.to_emails",
"definition.data.message.transactional",
"definition.data.message.url",
"definition.data.message.vendor_id",
"definition.data.message.video_asset_id",
"definition.data.name",
"definition.data.on_execution",
"definition.data.profile_filter",
"definition.data.profile_filter.condition_groups",
"definition.data.profile_operations",
"definition.data.secondary_value",
"definition.data.service_configuration",
"definition.data.service_configuration.event_key",
"definition.data.service_configuration.event_payload",
"definition.data.service_configuration.report_id",
"definition.data.service_configuration.service_method_type",
"definition.data.service_configuration.tracking_company_id",
"definition.data.status",
"definition.data.target_days",
"definition.data.target_time",
"definition.data.timezone",
"definition.data.trigger_filter",
"definition.data.trigger_filter.condition_groups",
"definition.data.trigger_id",
"definition.data.trigger_subtype",
"definition.data.trigger_type",
"definition.data.unit",
"definition.data.value",
"definition.id",
"definition.links",
"definition.links.next",
"definition.links.next_if_false",
"definition.links.next_if_true",
"definition.temporary_id",
"definition.type",
"id",
"updated"
]
}
},
"explode": false
},
{
"name": "fields[flow]",
"in": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"archived",
"created",
"id",
"name",
"status",
"trigger_type",
"updated"
]
}
},
"explode": false
},
{
"name": "fields[tag]",
"in": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"id",
"name"
]
}
},
"explode": false
},
{
"name": "filter",
"in": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`id`: `any`
`name`: `contains`, `ends-with`, `equals`, `starts-with`
`status`: `equals`
`archived`: `equals`
`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`trigger_type`: `equals`",
"schema": {
"type": "string",
"example": "any(id,['example'])"
}
},
{
"name": "include",
"in": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"flow-actions",
"tags"
]
}
},
"explode": false
},
{
"name": "page[cursor]",
"in": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[size]",
"in": "query",
"description": "Default: 50. Min: 1. Max: 50.",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"maximum": 50,
"minimum": 1
}
},
{
"name": "sort",
"in": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"schema": {
"type": "string",
"enum": [
"created",
"-created",
"id",
"-id",
"name",
"-name",
"status",
"-status",
"trigger_type",
"-trigger_type",
"updated",
"-updated"
]
}
},
{
"name": "revision",
"in": "header",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"required": true,
"schema": {
"type": "string",
"default": "2026-04-15"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetFlowResponseCollectionCompoundDocument"
}
}
}
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"tags": [
"Flows"
],
"x-klaviyo-filters": {
"id": {
"operators": {
"list": [
"any"
]
},
"value": {
"type": "string"
}
},
"name": {
"operators": {
"single": [
"contains",
"ends-with",
"equals",
"starts-with"
]
},
"value": {
"type": "string"
}
},
"status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"archived": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "boolean"
}
},
"created": {
"operators": {
"single": [
"equals",
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"type": "string",
"format": "date-time"
}
},
"updated": {
"operators": {
"single": [
"equals",
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"type": "string",
"format": "date-time"
}
},
"trigger_type": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string",
"enum": [
"Metric",
"Added to List",
"Unconfigured",
"Date Based",
"Price Drop",
"Low Inventory"
]
}
}
},
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:read"
]
}
}
},
"components": {
"responses": {
"ClientError": {
"description": "Client Error",
"content": {
"application/vnd.api+json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"code",
"title",
"detail"
],
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"pointer": {
"type": "string"
},
"parameter": {
"type": "string"
}
}
}
}
}
}
},
"required": [
"errors"
]
}
}
}
},
"ServerError": {
"description": "Server Error",
"content": {
"application/vnd.api+json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"code",
"title",
"detail"
],
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"pointer": {
"type": "string"
},
"parameter": {
"type": "string"
}
}
}
}
}
}
},
"required": [
"errors"
]
}
}
}
}
},
"schemas": {
"APIMethodFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"method"
]
},
"method": {
"type": "string",
"enum": [
"api"
]
},
"filter": {
"description": "Optional filter on a specific list of API keys (using last 4 digits of the key)",
"$ref": "#/components/schemas/InStringArrayFilter",
"nullable": true
}
},
"required": [
"field",
"method"
]
},
"AbTestAction": {
"type": "object",
"properties": {
"id": {
"description": "The real ID of an action. Not allowed on create.",
"type": "string",
"example": "123",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"type": "string",
"example": "action-1",
"nullable": true,
"writeOnly": true
},
"type": {
"type": "string",
"enum": [
"ab-test"
]
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"data": {
"type": "object",
"properties": {
"status": {
"description": "Flow action status.",
"type": "string",
"example": "draft",
"default": "draft",
"enum": [
"disabled",
"draft",
"live",
"manual"
]
},
"experiment_status": {
"description": "Not allowed on create.",
"type": "string",
"example": "draft",
"default": "draft",
"enum": [
"completed",
"draft",
"live"
]
},
"main_action": {
"oneOf": [
{
"$ref": "#/components/schemas/SendEmailAction"
},
{
"$ref": "#/components/schemas/SendSmsAction"
}
]
},
"current_experiment": {
"type": "object",
"nullable": true,
"properties": {
"id": {
"description": "Not allowed on create.",
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"variations": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/SendEmailAction"
},
{
"$ref": "#/components/schemas/SendSmsAction"
}
]
}
},
"allocations": {
"type": "object",
"nullable": true
},
"started": {
"type": "string",
"format": "date-time",
"example": "2022-11-08T00:00:00+00:00",
"nullable": true,
"readOnly": true
},
"winner_metric": {
"description": "The metric to use to determine the winner of the A/B test action.\n\nNote that this is different from the metrics used as a flow trigger.",
"type": "string",
"enum": [
"submission",
"unique-clicks",
"unique-opens",
"unique-placed-orders"
],
"nullable": true
},
"automatic_winner_selection_settings": {
"$ref": "#/components/schemas/AutomaticWinnerSelectionSettings",
"nullable": true
}
},
"required": [
"variations"
]
}
},
"required": [
"main_action"
]
}
},
"required": [
"type",
"data"
]
},
"ActionOutputCondition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"action-output"
]
},
"output_config_id": {
"type": "integer"
},
"field": {
"type": "string"
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StringOperatorStringFilter"
},
{
"$ref": "#/components/schemas/StringArrayOperatorStringArrayFilter"
},
{
"$ref": "#/components/schemas/NumericOperatorNumericFilter"
},
{
"$ref": "#/components/schemas/NumericRangeFilter"
},
{
"$ref": "#/components/schemas/BooleanFilter"
},
{
"$ref": "#/components/schemas/ExistenceOperatorExistenceFilter"
}
]
}
},
"required": [
"type",
"output_config_id",
"field",
"filter"
]
},
"ActionOutputConditionConditionGroup": {
"type": "object",
"properties": {
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActionOutputCondition"
}
}
},
"required": [
"conditions"
]
},
"ActionOutputConditionFilter": {
"type": "object",
"properties": {
"condition_groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActionOutputConditionConditionGroup"
}
}
},
"required": [
"condition_groups"
]
},
"ActionOutputSplitAction": {
"type": "object",
"properties": {
"id": {
"description": "The real ID of an action. Not allowed on create.",
"type": "string",
"example": "123",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"type": "string",
"example": "action-1",
"nullable": true,
"writeOnly": true
},
"type": {
"type": "string",
"enum": [
"action-output-split"
]
},
"links": {
"$ref": "#/components/schemas/BooleanBranchLinks",
"nullable": true
},
"data": {
"$ref": "#/components/schemas/ActionOutputSplitActionData",
"nullable": true
}
},
"required": [
"type"
]
},
"ActionOutputSplitActionData": {
"type": "object",
"properties": {
"action_output_filter": {
"$ref": "#/components/schemas/ActionOutputConditionFilter",
"nullable": true
}
},
"required": [
"action_output_filter"
]
},
"AlltimeDateFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"date"
]
},
"operator": {
"description": "Operators for alltime date filters.",
"type": "string",
"enum": [
"alltime"
]
}
},
"required": [
"type",
"operator"
]
},
"AnniversaryDateFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"date"
]
},
"operator": {
"description": "Operators for anniversary date filters.",
"type": "string",
"enum": [
"anniversary",
"anniversary-month"
]
}
},
"required": [
"type",
"operator"
]
},
"AutomaticWinnerSelectionSettings": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"automatic_end_date": {
"type": "string",
"format": "date-time",
"example": "2022-11-08T00:00:00+00:00",
"nullable": true
},
"automatic_end_statistical_certainty": {
"type": "boolean"
}
},
"required": [
"enabled",
"automatic_end_statistical_certainty"
]
},
"BackInStockDelayAction": {
"type": "object",
"properties": {
"id": {
"description": "The real ID of an action. Not allowed on create.",
"type": "string",
"example": "123",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"type": "string",
"example": "action-1",
"nullable": true,
"writeOnly": true
},
"type": {
"type": "string",
"enum": [
"back-in-stock-delay"
]
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
}
},
"required": [
"type"
]
},
"BackInStockMethodFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"method"
]
},
"method": {
"type": "string",
"enum": [
"back_in_stock"
]
}
},
"required": [
"field",
"method"
]
},
"BooleanBranchLinks": {
"type": "object",
"properties": {
"next_if_true": {
"type": "string",
"nullable": true
},
"next_if_false": {
"type": "string",
"nullable": true
}
},
"required": [
"next_if_true",
"next_if_false"
]
},
"BooleanFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"boolean"
]
},
"operator": {
"description": "Operators for boolean filters.",
"type": "string",
"enum": [
"equals"
]
},
"value": {
"type": "boolean"
}
},
"required": [
"type",
"operator",
"value"
]
},
"BounceDateFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"bounce_date"
]
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/CalendarDateFilter"
},
{
"$ref": "#/components/schemas/AnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/IsSetExistenceFilter"
}
]
}
},
"required": [
"field",
"filter"
]
},
"BulkRemoveMethodFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"method"
]
},
"method": {
"type": "string",
"enum": [
"bulk_remove"
]
}
},
"required": [
"field",
"method"
]
},
"CalendarDateFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"date"
]
},
"operator": {
"description": "Operators for calendar date filters.",
"type": "string",
"enum": [
"calendar-month"
]
},
"value": {
"type": "integer"
}
},
"required": [
"type",
"operator",
"value"
]
},
"CampaignEnum": {
"type": "string",
"enum": [
"campaign"
]
},
"CarrierDeactivationMethodFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"method"
]
},
"method": {
"type": "string",
"enum": [
"carrier_deactivation"
]
}
},
"required": [
"field",
"method"
]
},
"CheckoutMethodFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"method"
]
},
"method": {
"type": "string",
"enum": [
"checkout"
]
}
},
"required": [
"field",
"method"
]
},
"CodeAction": {
"type": "object",
"properties": {
"id": {
"description": "The real ID of an action. Not allowed on create.",
"type": "string",
"example": "123",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"type": "string",
"example": "action-1",
"nullable": true,
"writeOnly": true
},
"type": {
"type": "string",
"enum": [
"code"
]
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"data": {
"nullable": true
}
},
"required": [
"type"
]
},
"CollectionLinks": {
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri"
},
"prev": {
"type": "string",
"format": "uri"
},
"next": {
"type": "string",
"format": "uri"
}
},
"required": [
"self"
]
},
"ConditionalBranchAction": {
"type": "object",
"properties": {
"id": {
"description": "The real ID of an action. Not allowed on create.",
"type": "string",
"example": "123",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"type": "string",
"example": "action-1",
"nullable": true,
"writeOnly": true
},
"type": {
"type": "string",
"enum": [
"conditional-split"
]
},
"links": {
"$ref": "#/components/schemas/BooleanBranchLinks",
"nullable": true
},
"data": {
"$ref": "#/components/schemas/ConditionalBranchActionData",
"nullable": true
}
},
"required": [
"type"
]
},
"ConditionalBranchActionData": {
"type": "object",
"properties": {
"profile_filter": {
"type": "object",
"nullable": true,
"properties": {
"condition_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ProfilePropertyCondition"
},
{
"$ref": "#/components/schemas/ProfileHasGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileNoGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileRegionCondition"
},
{
"$ref": "#/components/schemas/ProfilePostalCodeDistanceCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsDateCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsStringCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsNumericCondition"
},
{
"$ref": "#/components/schemas/ProfileMarketingConsentCondition"
},
{
"$ref": "#/components/schemas/FlowsProfileMetricCondition"
},
{
"$ref": "#/components/schemas/ProfileRandomSampleCondition"
},
{
"$ref": "#/components/schemas/ProfileHasCustomObjectCondition"
},
{
"$ref": "#/components/schemas/ProfilePermissionsCondition"
}
]
}
}
},
"required": [
"conditions"
]
}
}
},
"required": [
"condition_groups"
]
}
},
"required": [
"profile_filter"
]
},
"ConstantContactIntegrationFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"string"
]
},
"operator": {
"type": "string",
"enum": [
"in"
]
},
"value": {
"type": "array",
"items": {
"enum": [
"constant_contact"
],
"type": "string"
}
}
},
"required": [
"type",
"operator",
"value"
]
},
"ConstantContactIntegrationMethodFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"method"
]
},
"method": {
"type": "string",
"enum": [
"integration"
]
},
"filter": {
"$ref": "#/components/schemas/ConstantContactIntegrationFilter"
}
},
"required": [
"field",
"method",
"filter"
]
},
"ContentExperimentAction": {
"type": "object",
"properties": {
"id": {
"description": "The real ID of an action. Not allowed on create.",
"type": "string",
"example": "123",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"type": "string",
"example": "action-1",
"nullable": true,
"writeOnly": true
},
"type": {
"type": "string",
"enum": [
"content-experiment"
]
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"data": {
"$ref": "#/components/schemas/SendPushNotificationActionContentExperimentActionData"
}
},
"required": [
"type",
"data"
]
},
"CountdownDelayAction": {
"type": "object",
"properties": {
"id": {
"description": "The real ID of an action. Not allowed on create.",
"type": "string",
"example": "123",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"type": "string",
"example": "action-1",
"nullable": true,
"writeOnly": true
},
"type": {
"type": "string",
"enum": [
"countdown-delay"
]
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"data": {
"$ref": "#/components/schemas/CountdownDelayActionData"
}
},
"required": [
"type",
"data"
]
},
"CountdownDelayActionData": {
"type": "object",
"properties": {
"unit": {
"description": "Defined as FlowDateTrigger attributes in app.",
"type": "string",
"example": "days",
"default": "days",
"enum": [
"days",
"months",
"weeks"
]
},
"value": {
"type": "integer",
"default": 0
},
"timezone": {
"type": "string",
"example": "profile",
"default": "profile",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Addis_Ababa",
"Africa/Algiers",
"Africa/Asmara",
"Africa/Bamako",
"Africa/Bangui",
"Africa/Banjul",
"Africa/Bissau",
"Africa/Blantyre",
"Africa/Brazzaville",
"Africa/Bujumbura",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Douala",
"Africa/El_Aaiun",
"Africa/Freetown",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Johannesburg",
"Africa/Juba",
"Africa/Kampala",
"Africa/Khartoum",
"Africa/Kigali",
"Africa/Kinshasa",
"Africa/Lagos",
"Africa/Libreville",
"Africa/Lome",
"Africa/Luanda",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Malabo",
"Africa/Maputo",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Mogadishu",
"Africa/Monrovia",
"Africa/Nairobi",
"Africa/Ndjamena",
"Africa/Niamey",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Porto-Novo",
"Africa/Sao_Tome",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Anguilla",
"America/Antigua",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Aruba",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc-Sablon",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Cayman",
"America/Chicago",
"America/Chihuahua",
"America/Ciudad_Juarez",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Curacao",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Dominica",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Fort_Nelson",
"America/Fortaleza",
"America/Glace_Bay",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Grenada",
"America/Guadeloupe",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Indianapolis",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/Kralendijk",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Lower_Princes",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Marigot",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Montserrat",
"America/Nassau",
"America/New_York",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Nuuk",
"America/Ojinaga",
"America/Panama",
"America/Paramaribo",
"America/Phoenix",
"America/Port-au-Prince",
"America/Port_of_Spain",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Punta_Arenas",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Rio_Branco",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Barthelemy",
"America/St_Johns",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Tijuana",
"America/Toronto",
"America/Tortola",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Antarctica/McMurdo",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Arctic/Longyearbyen",
"Asia/Aden",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Bahrain",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Colombo",
"Asia/Damascus",
"Asia/Dhaka",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Kolkata",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Kuwait",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Muscat",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Phnom_Penh",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qatar",
"Asia/Qostanay",
"Asia/Qyzylorda",
"Asia/Riyadh",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Shanghai",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Urumqi",
"Asia/Ust-Nera",
"Asia/Vientiane",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yangon",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/St_Helena",
"Atlantic/Stanley",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lindeman",
"Australia/Lord_Howe",
"Australia/Melbourne",
"Australia/Perth",
"Australia/Sydney",
"Canada/Atlantic",
"Canada/Central",
"Canada/Eastern",
"Canada/Mountain",
"Canada/Newfoundland",
"Canada/Pacific",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Bratislava",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Busingen",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Dublin",
"Europe/Gibraltar",
"Europe/Guernsey",
"Europe/Helsinki",
"Europe/Isle_of_Man",
"Europe/Istanbul",
"Europe/Jersey",
"Europe/Kaliningrad",
"Europe/Kirov",
"Europe/Kyiv",
"Europe/Lisbon",
"Europe/Ljubljana",
"Europe/London",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Mariehamn",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Oslo",
"Europe/Paris",
"Europe/Podgorica",
"Europe/Prague",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/San_Marino",
"Europe/Sarajevo",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Skopje",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Vaduz",
"Europe/Vatican",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zagreb",
"Europe/Zurich",
"GMT",
"Indian/Antananarivo",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Comoro",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Mayotte",
"Indian/Reunion",
"Pacific/Apia",
"Pacific/Auckland",
"Pacific/Bougainville",
"Pacific/Chatham",
"Pacific/Chuuk",
"Pacific/Easter",
"Pacific/Efate",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kanton",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Kwajalein",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Midway",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Pago_Pago",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Saipan",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"US/Alaska",
"US/Arizona",
"US/Central",
"US/Eastern",
"US/Hawaii",
"US/Mountain",
"US/Pacific",
"UTC",
"profile"
]
},
"delay_until_time": {
"type": "string",
"format": "time",
"nullable": true
},
"delay_until_weekdays": {
"type": "array",
"items": {
"type": "string",
"enum": [
"friday",
"monday",
"saturday",
"sunday",
"thursday",
"tuesday",
"wednesday"
],
"description": "Days of the week."
},
"nullable": true
}
}
},
"CustomObjectPropertyCondition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"custom-object-property"
]
},
"custom_object_label": {
"type": "string"
},
"field": {
"type": "string"
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StringOperatorStringFilter"
},
{
"$ref": "#/components/schemas/StringArrayOperatorStringArrayFilter"
},
{
"$ref": "#/components/schemas/NumericOperatorNumericFilter"
},
{
"$ref": "#/components/schemas/NumericRangeFilter"
},
{
"$ref": "#/components/schemas/BooleanFilter"
},
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/CalendarDateFilter"
},
{
"$ref": "#/components/schemas/AnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/ListContainsOperatorListContainsFilter"
},
{
"$ref": "#/components/schemas/ListLengthFilter"
},
{
"$ref": "#/components/schemas/ExistenceOperatorExistenceFilter"
}
]
}
},
"required": [
"type",
"custom_object_label",
"field",
"filter"
]
},
"CustomObjectTriggerCondition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"custom-object-trigger-property"
]
},
"property_id": {
"type": "integer"
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StringOperatorStringFilter"
},
{
"$ref": "#/components/schemas/NumericOperatorNumericFilter"
},
{
"$ref": "#/components/schemas/NumericRangeFilter"
},
{
"$ref": "#/components/schemas/BooleanFilter"
},
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/ListContainsOperatorListContainsFilter"
},
{
"$ref": "#/components/schemas/ListLengthFilter"
},
{
"$ref": "#/components/schemas/ExistenceOperatorExistenceFilter"
}
]
}
},
"required": [
"type",
"property_id",
"filter"
]
},
"CustomSourceFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"custom_source"
]
},
"filter": {
"$ref": "#/components/schemas/EqualsStringFilter"
}
},
"required": [
"field",
"filter"
]
},
"DataWarehouseImportMethodFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"method"
]
},
"method": {
"type": "string",
"enum": [
"data_warehouse_import"
]
}
},
"required": [
"field",
"method"
]
},
"DoubleOptinFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"is_double_opt_in"
]
},
"filter": {
"$ref": "#/components/schemas/BooleanFilter"
}
},
"required": [
"field",
"filter"
]
},
"EffectiveDateFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"effective_date"
]
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/CalendarDateFilter"
},
{
"$ref": "#/components/schemas/AnniversaryDateFilter"
}
]
}
},
"required": [
"field",
"filter"
]
},
"EnrollFormAction": {
"type": "object",
"properties": {
"id": {
"description": "The real ID of an action. Not allowed on create.",
"type": "string",
"example": "123",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"type": "string",
"example": "action-1",
"nullable": true,
"writeOnly": true
},
"data": {
"$ref": "#/components/schemas/EnrollFormActionData"
},
"type": {
"type": "string",
"enum": [
"enroll-form"
]
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
}
},
"required": [
"data",
"type"
]
},
"EnrollFormActionData": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"list_id": {
"type": "string",
"nullable": true
},
"expire_after_unit": {
"description": "aka expire_after_unit in app.",
"type": "string",
"example": "days",
"default": "days",
"enum": [
"days",
"hours",
"minutes"
]
},
"expire_after_value": {
"type": "integer",
"default": 0
},
"status": {
"description": "Flow action status.",
"type": "string",
"example": "draft",
"default": "draft",
"enum": [
"disabled",
"draft",
"live",
"manual"
]
}
},
"required": [
"name",
"list_id"
]
},
"EqualsStringFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"string"
]
},
"operator": {
"type": "string",
"enum": [
"equals"
]
},
"value": {
"type": "string",
"nullable": true
}
},
"required": [
"type",
"operator",
"value"
]
},
"ExistenceOperatorExistenceFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"existence"
]
},
"operator": {
"description": "Operators for existence filters.",
"type": "string",
"enum": [
"is-set",
"not-set"
]
}
},
"required": [
"type",
"operator"
]
},
"ExplicitlyReachable": {
"type": "object",
"properties": {
"reachable_status": {
"type": "string",
"enum": [
"explicitly_reachable"
]
},
"filters": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/EffectiveDateFilter"
},
{
"$ref": "#/components/schemas/RecordedDateFilter"
},
{
"$ref": "#/components/schemas/MethodFilter"
},
{
"$ref": "#/components/schemas/FormSubscribeFilter"
}
]
}
}
},
"required": [
"reachable_status",
"filters"
]
},
"ExplicitlyUnreachable": {
"type": "object",
"properties": {
"reachable_status": {
"type": "string",
"enum": [
"explicitly_unreachable"
]
},
"filters": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/EffectiveDateFilter"
},
{
"$ref": "#/components/schemas/RecordedDateFilter"
},
{
"$ref": "#/components/schemas/MethodFilter"
},
{
"$ref": "#/components/schemas/FormSubscribeFilter"
}
]
}
}
},
"required": [
"reachable_status",
"filters"
]
},
"FailedAgeGateMethodFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"method"
]
},
"method": {
"type": "string",
"enum": [
"failed_age_gate"
]
}
},
"required": [
"field",
"method"
]
},
"FlowActionEncodedResponseObjectResource": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/FlowActionEnum"
},
"id": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"created": {
"type": "string",
"format": "date-time",
"example": "2022-11-08T00:00:00+00:00",
"nullable": true
},
"updated": {
"type": "string",
"format": "date-time",
"example": "2022-11-08T00:00:00+00:00",
"nullable": true
},
"definition": {
"description": "The encoded flow action definition.",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ActionOutputSplitAction"
},
{
"$ref": "#/components/schemas/BackInStockDelayAction"
},
{
"$ref": "#/components/schemas/ConditionalBranchAction"
},
{
"$ref": "#/components/schemas/ContentExperimentAction"
},
{
"$ref": "#/components/schemas/SendEmailAction"
},
{
"$ref": "#/components/schemas/SendPushNotificationAction"
},
{
"$ref": "#/components/schemas/SendSmsAction"
},
{
"$ref": "#/components/schemas/SendWebhookAction"
},
{
"$ref": "#/components/schemas/SendInternalAlertAction"
},
{
"$ref": "#/components/schemas/SendWhatsAppAction"
},
{
"$ref": "#/components/schemas/TimeDelayAction"
},
{
"$ref": "#/components/schemas/TriggerBranchAction"
},
{
"$ref": "#/components/schemas/UpdateProfileAction"
},
{
"$ref": "#/components/schemas/TargetDateAction"
},
{
"$ref": "#/components/schemas/CountdownDelayAction"
},
{
"$ref": "#/components/schemas/AbTestAction"
},
{
"$ref": "#/components/schemas/InternalServiceAction"
},
{
"$ref": "#/components/schemas/CodeAction"
},
{
"$ref": "#/components/schemas/MultiBranchSplitAction"
},
{
"$ref": "#/components/schemas/ListUpdateAction"
},
{
"$ref": "#/components/schemas/EnrollFormAction"
}
]
}
}
},
"relationships": {
"type": "object",
"properties": {
"flow": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/FlowEnum"
},
"id": {
"type": "string"
}
},
"required": [
"type",
"id"
]
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
}
},
"flow-messages": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"$ref": "#/components/schemas/FlowMessageEnum"
},
"id": {
"type": "string"
}
}
}
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
}
}
}
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"type",
"id",
"attributes",
"links"
]
},
"FlowActionEnum": {
"type": "string",
"enum": [
"flow-action"
]
},
"FlowEmail": {
"type": "object",
"properties": {
"from_email": {
"type": "string",
"nullable": true
},
"from_label": {
"type": "string",
"nullable": true
},
"reply_to_email": {
"type": "string",
"nullable": true
},
"cc_email": {
"type": "string",
"nullable": true
},
"bcc_email": {
"type": "string",
"nullable": true
},
"subject_line": {
"type": "string",
"nullable": true
},
"preview_text": {
"type": "string",
"nullable": true
},
"template_id": {
"type": "string",
"nullable": true
},
"smart_sending_enabled": {
"type": "boolean",
"example": true,
"default": true
},
"transactional": {
"type": "boolean",
"default": false
},
"add_tracking_params": {
"type": "boolean",
"default": false
},
"custom_tracking_params": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UtmParam"
},
"nullable": true
},
"additional_filters": {
"type": "object",
"nullable": true,
"properties": {
"condition_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ProfilePropertyCondition"
},
{
"$ref": "#/components/schemas/ProfileHasGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileNoGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileRegionCondition"
},
{
"$ref": "#/components/schemas/ProfilePostalCodeDistanceCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsDateCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsStringCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsNumericCondition"
},
{
"$ref": "#/components/schemas/ProfileMarketingConsentCondition"
},
{
"$ref": "#/components/schemas/FlowsProfileMetricCondition"
},
{
"$ref": "#/components/schemas/ProfileRandomSampleCondition"
},
{
"$ref": "#/components/schemas/ProfileHasCustomObjectCondition"
},
{
"$ref": "#/components/schemas/ProfilePermissionsCondition"
},
{
"$ref": "#/components/schemas/ProfileHasNotReceivedEmailMessageCondition"
}
]
}
}
},
"required": [
"conditions"
]
}
}
},
"required": [
"condition_groups"
]
},
"name": {
"type": "string",
"nullable": true
},
"id": {
"description": "Not allowed on create.",
"type": "string",
"nullable": true
}
}
},
"FlowEnum": {
"type": "string",
"enum": [
"flow"
]
},
"FlowInternalAlert": {
"type": "object",
"properties": {
"from_email": {
"type": "string",
"nullable": true
},
"from_label": {
"type": "string",
"nullable": true
},
"to_emails": {
"type": "array",
"items": {
"type": "string"
}
},
"subject_line": {
"type": "string",
"nullable": true
},
"template_id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"id": {
"description": "Not allowed on create.",
"type": "string",
"nullable": true
}
},
"required": [
"from_email",
"from_label",
"to_emails",
"subject_line"
]
},
"FlowMessageEnum": {
"type": "string",
"enum": [
"flow-message"
]
},
"FlowPushNotification": {
"type": "object",
"properties": {
"title": {
"type": "string",
"nullable": true
},
"body": {
"type": "string"
},
"sound": {
"type": "boolean",
"default": false
},
"badge": {
"type": "boolean",
"default": false
},
"badge_options": {
"oneOf": [
{
"$ref": "#/components/schemas/Increment"
},
{
"$ref": "#/components/schemas/StaticCount"
},
{
"$ref": "#/components/schemas/Property"
}
]
},
"image_id": {
"description": "The id of an ImageAsset. If provided, this will take precedence over a dynamic_image.",
"type": "string",
"example": "123",
"nullable": true
},
"dynamic_image": {
"description": "A dynamic image asset to include in the push notification.",
"type": "string",
"example": "{{ event.items.0.url }}",
"nullable": true
},
"video_asset_id": {
"description": "The ULID of a video asset. If provided, videos and images are mutually exclusive.",
"type": "string",
"example": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"nullable": true
},
"on_open": {
"description": "See PushLinkAction in app.\n\nThis is not a flow action, but the literal action that should be\n taken when the push notification is tapped.",
"type": "string",
"example": "home",
"default": "home",
"enum": [
"home",
"link"
]
},
"ios_link": {
"type": "string",
"nullable": true
},
"android_link": {
"type": "string",
"nullable": true
},
"push_type": {
"description": "The type of push notification to send.",
"type": "string",
"enum": [
"silent",
"standard"
],
"nullable": true
},
"kv_pairs": {
"type": "object",
"nullable": true
},
"conversion_metric_id": {
"type": "string",
"nullable": true
},
"smart_sending_enabled": {
"type": "boolean",
"example": true,
"default": true
},
"additional_filters": {
"type": "object",
"nullable": true,
"properties": {
"condition_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ProfilePropertyCondition"
},
{
"$ref": "#/components/schemas/ProfileHasGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileNoGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileRegionCondition"
},
{
"$ref": "#/components/schemas/ProfilePostalCodeDistanceCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsDateCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsStringCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsNumericCondition"
},
{
"$ref": "#/components/schemas/ProfileMarketingConsentCondition"
},
{
"$ref": "#/components/schemas/FlowsProfileMetricCondition"
},
{
"$ref": "#/components/schemas/ProfileRandomSampleCondition"
},
{
"$ref": "#/components/schemas/ProfileHasCustomObjectCondition"
},
{
"$ref": "#/components/schemas/ProfilePermissionsCondition"
},
{
"$ref": "#/components/schemas/ProfileHasNotReceivedPushMessageCondition"
}
]
}
}
},
"required": [
"conditions"
]
}
}
},
"required": [
"condition_groups"
]
},
"action_buttons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PushActionButton"
},
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"id": {
"description": "Not allowed on create.",
"type": "string",
"nullable": true
}
},
"required": [
"body"
]
},
"FlowResponseObjectResource": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/FlowEnum"
},
"id": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
},
"archived": {
"type": "boolean",
"nullable": true
},
"created": {
"type": "string",
"format": "date-time",
"example": "2022-11-08T00:00:00+00:00",
"nullable": true
},
"updated": {
"type": "string",
"format": "date-time",
"example": "2022-11-08T00:00:00+00:00",
"nullable": true
},
"trigger_type": {
"description": "Corresponds to the object which triggered the flow.",
"type": "string",
"enum": [
"Added to List",
"Date Based",
"Low Inventory",
"Metric",
"Price Drop",
"Unconfigured"
],
"nullable": true
}
}
},
"relationships": {
"type": "object",
"properties": {
"flow-actions": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"$ref": "#/components/schemas/FlowActionEnum"
},
"id": {
"type": "string"
}
}
}
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
}
},
"tags": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"$ref": "#/components/schemas/TagEnum"
},
"id": {
"type": "string"
}
}
}
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
}
}
}
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"type",
"id",
"attributes",
"links"
]
},
"FlowSms": {
"type": "object",
"properties": {
"body": {
"type": "string"
},
"image_id": {
"description": "The id of an ImageAsset. If provided, this will take precedence over a dynamic_image.",
"type": "string",
"example": "123",
"nullable": true
},
"dynamic_image": {
"description": "A dynamic image asset to include in the SMS message.",
"type": "string",
"example": "{{ person|lookup:'image_url' }}",
"nullable": true
},
"shorten_links": {
"type": "boolean",
"example": true,
"default": true
},
"include_contact_card": {
"type": "boolean",
"default": false
},
"add_org_prefix": {
"type": "boolean",
"example": true,
"default": true
},
"add_info_link": {
"type": "boolean",
"example": true,
"default": true
},
"add_opt_out_language": {
"type": "boolean",
"default": false
},
"smart_sending_enabled": {
"type": "boolean",
"example": true,
"default": true
},
"sms_quiet_hours_enabled": {
"type": "boolean",
"example": true,
"default": true
},
"transactional": {
"type": "boolean",
"default": false
},
"add_tracking_params": {
"type": "boolean",
"default": false
},
"custom_tracking_params": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UtmParam"
},
"nullable": true
},
"template_id": {
"type": "string",
"nullable": true
},
"additional_filters": {
"type": "object",
"nullable": true,
"properties": {
"condition_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ProfilePropertyCondition"
},
{
"$ref": "#/components/schemas/ProfileHasGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileNoGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileRegionCondition"
},
{
"$ref": "#/components/schemas/ProfilePostalCodeDistanceCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsDateCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsStringCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsNumericCondition"
},
{
"$ref": "#/components/schemas/ProfileMarketingConsentCondition"
},
{
"$ref": "#/components/schemas/FlowsProfileMetricCondition"
},
{
"$ref": "#/components/schemas/ProfileRandomSampleCondition"
},
{
"$ref": "#/components/schemas/ProfileHasCustomObjectCondition"
},
{
"$ref": "#/components/schemas/ProfilePermissionsCondition"
},
{
"$ref": "#/components/schemas/ProfileHasNotReceivedSmsMessageCondition"
}
]
}
}
},
"required": [
"conditions"
]
}
}
},
"required": [
"condition_groups"
]
},
"name": {
"type": "string",
"nullable": true
},
"id": {
"description": "Not allowed on create.",
"type": "string",
"nullable": true
}
},
"required": [
"body"
]
},
"FlowWebhook": {
"type": "object",
"properties": {
"url": {
"type": "string",
"nullable": true
},
"headers": {
"type": "object",
"nullable": true
},
"body": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"id": {
"description": "Not allowed on create.",
"type": "string",
"nullable": true
}
},
"required": [
"url"
]
},
"FlowWhatsApp": {
"type": "object",
"properties": {
"id": {
"description": "Not allowed on create.",
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"vendor_id": {
"type": "string",
"nullable": true
},
"smart_sending_enabled": {
"type": "boolean",
"example": true,
"default": true
},
"transactional": {
"type": "boolean",
"default": false
},
"add_tracking_params": {
"type": "boolean",
"default": false
},
"additional_filters": {
"type": "object",
"nullable": true,
"properties": {
"condition_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ProfilePropertyCondition"
},
{
"$ref": "#/components/schemas/ProfileHasGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileNoGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileRegionCondition"
},
{
"$ref": "#/components/schemas/ProfilePostalCodeDistanceCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsDateCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsStringCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsNumericCondition"
},
{
"$ref": "#/components/schemas/ProfileMarketingConsentCondition"
},
{
"$ref": "#/components/schemas/FlowsProfileMetricCondition"
},
{
"$ref": "#/components/schemas/ProfileRandomSampleCondition"
},
{
"$ref": "#/components/schemas/ProfileHasCustomObjectCondition"
},
{
"$ref": "#/components/schemas/ProfilePermissionsCondition"
}
]
}
}
},
"required": [
"conditions"
]
}
}
},
"required": [
"condition_groups"
]
}
}
},
"FlowsProfileMetricCondition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"profile-metric"
]
},
"metric_id": {
"type": "string"
},
"measurement": {
"description": "Measurements for profile metrics.",
"type": "string",
"enum": [
"count",
"sum"
]
},
"measurement_filter": {
"$ref": "#/components/schemas/NumericOperatorNumericFilter"
},
"timeframe_filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/AlltimeDateFilter"
},
{
"$ref": "#/components/schemas/SinceFlowStartDateFilter"
}
]
},
"metric_filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProfileMetricPropertyFilter"
},
"nullable": true
}
},
"required": [
"type",
"metric_id",
"measurement",
"measurement_filter",
"timeframe_filter"
]
},
"FormMethodFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"method"
]
},
"method": {
"type": "string",
"enum": [
"form"
]
},
"filter": {
"description": "Optional filter on a specific list of form ids",
"$ref": "#/components/schemas/InStringArrayFilter",
"nullable": true
}
},
"required": [
"field",
"method"
]
},
"FormSubscribeFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"subscribe_method"
]
},
"method": {
"type": "string",
"enum": [
"form"
]
},
"filter": {
"description": "Optional filter on a specific list of form IDs",
"$ref": "#/components/schemas/InStringArrayFilter",
"nullable": true
}
},
"required": [
"field",
"method"
]
},
"GetFlowResponseCollectionCompoundDocument": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlowResponseObjectResource"
}
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
},
"included": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/FlowActionEncodedResponseObjectResource"
},
{
"$ref": "#/components/schemas/TagResponseObjectResource"
}
]
}
}
},
"required": [
"data"
]
},
"GreaterThanPositiveNumericFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"numeric"
]
},
"operator": {
"type": "string",
"enum": [
"greater-than"
]
},
"value": {
"oneOf": [
{
"type": "integer"
},
{
"type": "number"
}
]
}
},
"required": [
"type",
"operator",
"value"
]
},
"HasEmailMarketing": {
"type": "object",
"properties": {
"subscription": {
"type": "string",
"enum": [
"any"
]
},
"filters": {
"nullable": true
}
},
"required": [
"subscription"
]
},
"HasEmailMarketingConsent": {
"type": "object",
"properties": {
"channel": {
"type": "string",
"enum": [
"email"
]
},
"can_receive_marketing": {
"type": "boolean",
"enum": [
true
]
},
"consent_status": {
"oneOf": [
{
"$ref": "#/components/schemas/HasEmailMarketing"
},
{
"$ref": "#/components/schemas/HasEmailMarketingSubscribed"
},
{
"$ref": "#/components/schemas/HasEmailMarketingNeverSubscribed"
}
]
}
},
"required": [
"channel",
"can_receive_marketing",
"consent_status"
]
},
"HasEmailMarketingNeverSubscribed": {
"type": "object",
"properties": {
"subscription": {
"type": "string",
"enum": [
"never_subscribed"
]
},
"filters": {
"nullable": true
}
},
"required": [
"subscription"
]
},
"HasEmailMarketingSubscribed": {
"type": "object",
"properties": {
"subscription": {
"type": "string",
"enum": [
"subscribed"
]
},
"filters": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DoubleOptinFilter"
},
{
"$ref": "#/components/schemas/StatusDateFilter"
},
{
"$ref": "#/components/schemas/CustomSourceFilter"
},
{
"$ref": "#/components/schemas/FormMethodFilter"
},
{
"$ref": "#/components/schemas/PreferencePageFilter"
},
{
"$ref": "#/components/schemas/APIMethodFilter"
},
{
"$ref": "#/components/schemas/InboundMessageMethodFilter"
},
{
"$ref": "#/components/schemas/BackInStockMethodFilter"
},
{
"$ref": "#/components/schemas/SftpMethodFilter"
},
{
"$ref": "#/components/schemas/ManualImportManualMethodFilter"
},
{
"$ref": "#/components/schemas/ManualAddManualMethodFilter"
},
{
"$ref": "#/components/schemas/ShopifyIntegrationMethodFilter"
}
]
},
"nullable": true
}
},
"required": [
"subscription"
]
},
"HasPushMarketing": {
"type": "object",
"properties": {
"subscription": {
"type": "string",
"enum": [
"any"
]
},
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusDateFilter"
},
"nullable": true
}
},
"required": [
"subscription"
]
},
"HasPushMarketingConsent": {
"type": "object",
"properties": {
"channel": {
"type": "string",
"enum": [
"push"
]
},
"can_receive_marketing": {
"type": "boolean",
"enum": [
true
]
},
"consent_status": {
"$ref": "#/components/schemas/HasPushMarketing"
}
},
"required": [
"channel",
"can_receive_marketing",
"consent_status"
]
},
"HasSMSMarketingConsent": {
"type": "object",
"properties": {
"channel": {
"type": "string",
"enum": [
"sms"
]
},
"can_receive_marketing": {
"type": "boolean",
"enum": [
true
]
},
"consent_status": {
"$ref": "#/components/schemas/HasSMSMarketingSubscribed"
}
},
"required": [
"channel",
"can_receive_marketing",
"consent_status"
]
},
"HasSMSMarketingSubscribed": {
"type": "object",
"properties": {
"subscription": {
"type": "string",
"enum": [
"subscribed"
]
},
"filters": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/StatusDateFilter"
},
{
"$ref": "#/components/schemas/FormMethodFilter"
},
{
"$ref": "#/components/schemas/ManualImportManualMethodFilter"
},
{
"$ref": "#/components/schemas/ManualAddManualMethodFilter"
},
{
"$ref": "#/components/schemas/CheckoutMethodFilter"
},
{
"$ref": "#/components/schemas/InboundMessageMethodFilter"
},
{
"$ref": "#/components/schemas/PreferencePageMethodFilter"
},
{
"$ref": "#/components/schemas/SftpMethodFilter"
},
{
"$ref": "#/components/schemas/ShopifyIntegrationMethodFilter"
},
{
"$ref": "#/components/schemas/SubscribedSMSIsRcsCapableFilter"
}
]
},
"nullable": true
}
},
"required": [
"subscription"
]
},
"ImplicitlyOrExplicitlyReachable": {
"type": "object",
"properties": {
"reachable_status": {
"type": "string",
"enum": [
"implicitly_or_explicitly_reachable"
]
}
},
"required": [
"reachable_status"
]
},
"ImplicitlyOrExplicitlyUnreachable": {
"type": "object",
"properties": {
"reachable_status": {
"type": "string",
"enum": [
"implicitly_or_explicitly_unreachable"
]
}
},
"required": [
"reachable_status"
]
},
"ImplicitlyReachable": {
"type": "object",
"properties": {
"reachable_status": {
"type": "string",
"enum": [
"implicitly_reachable"
]
}
},
"required": [
"reachable_status"
]
},
"ImplicitlyUnreachable": {
"type": "object",
"properties": {
"reachable_status": {
"type": "string",
"enum": [
"implicitly_unreachable"
]
}
},
"required": [
"reachable_status"
]
},
"InStringArrayFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"string"
]
},
"operator": {
"type": "string",
"enum": [
"in"
]
},
"value": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type",
"operator",
"value"
]
},
"InTheLastBaseRelativeDateFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"date"
]
},
"operator": {
"type": "string",
"enum": [
"in-the-last"
]
},
"unit": {
"description": "Units for relative date filters.",
"type": "string",
"enum": [
"day",
"hour",
"week"
]
},
"quantity": {
"type": "integer"
}
},
"required": [
"type",
"operator",
"unit",
"quantity"
]
},
"InboundMessageMethodFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"method"
]
},
"method": {
"type": "string",
"enum": [
"inbound_message"
]
}
},
"required": [
"field",
"method"
]
},
"Increment": {
"type": "object",
"properties": {
"badge_config": {
"type": "string",
"enum": [
"increment_one"
]
}
},
"required": [
"badge_config"
]
},
"IntegerFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"numeric"
]
},
"operator": {
"description": "Operators for numeric filters.",
"type": "string",
"enum": [
"equals",
"greater-than",
"greater-than-or-equal",
"less-than",
"less-than-or-equal",
"not-equals"
]
},
"value": {
"type": "integer"
}
},
"required": [
"type",
"operator",
"value"
]
},
"InternalScheduledReportBuilderReportData": {
"type": "object",
"properties": {
"service_method_type": {
"type": "string",
"enum": [
"schedule-report-builder-report"
]
},
"report_id": {
"type": "string"
}
},
"required": [
"service_method_type",
"report_id"
]
},
"InternalScheduledReportData": {
"type": "object",
"properties": {
"service_method_type": {
"type": "string",
"enum": [
"schedule-report"
]
},
"report_id": {
"type": "string"
}
},
"required": [
"service_method_type",
"report_id"
]
},
"InternalServiceAction": {
"type": "object",
"properties": {
"id": {
"description": "The real ID of an action. Not allowed on create.",
"type": "string",
"example": "123",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"type": "string",
"example": "action-1",
"nullable": true,
"writeOnly": true
},
"type": {
"type": "string",
"enum": [
"internal-service"
]
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"data": {
"$ref": "#/components/schemas/InternalServiceActionData",
"nullable": true
}
},
"required": [
"type"
]
},
"InternalServiceActionData": {
"type": "object",
"properties": {
"service_configuration": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/InternalScheduledReportData"
},
{
"$ref": "#/components/schemas/InternalTrackEventData"
},
{
"$ref": "#/components/schemas/InternalScheduledReportBuilderReportData"
},
{
"$ref": "#/components/schemas/InternalUnknownServiceData"
}
]
},
"status": {
"description": "Flow action status.",
"type": "string",
"example": "draft",
"default": "draft",
"enum": [
"disabled",
"draft",
"live",
"manual"
]
}
}
},
"InternalTrackEventData": {
"type": "object",
"properties": {
"service_method_type": {
"type": "string",
"enum": [
"track-event"
]
},
"event_key": {
"type": "string",
"nullable": true
},
"event_payload": {
"type": "object",
"nullable": true
},
"tracking_company_id": {
"type": "string",
"nullable": true
}
},
"required": [
"service_method_type"
]
},
"InternalUnknownServiceData": {
"type": "object",
"properties": {
"service_method_type": {
"type": "string",
"enum": [
"unknown"
]
}
},
"required": [
"service_method_type"
]
},
"InvalidEmailDateFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"invalid_email_date"
]
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/CalendarDateFilter"
},
{
"$ref": "#/components/schemas/AnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/IsSetExistenceFilter"
}
]
}
},
"required": [
"field",
"filter"
]
},
"IsSetExistenceFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"existence"
]
},
"operator": {
"type": "string",
"enum": [
"is-set"
]
}
},
"required": [
"type",
"operator"
]
},
"LessThanPositiveNumericFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"numeric"
]
},
"operator": {
"type": "string",
"enum": [
"less-than"
]
},
"value": {
"oneOf": [
{
"type": "integer"
},
{
"type": "number"
}
]
}
},
"required": [
"type",
"operator",
"value"
]
},
"Link": {
"type": "object",
"properties": {
"next": {
"type": "string",
"nullable": true
}
}
},
"ListContainsOperatorListContainsFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"list"
]
},
"operator": {
"description": "Operators for list contains filters.",
"type": "string",
"enum": [
"contains",
"not-contains"
]
},
"value": {
"nullable": true,
"oneOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
}
},
"required": [
"type",
"operator",
"value"
]
},
"ListEnum": {
"type": "string",
"enum": [
"list"
]
},
"ListLengthFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"list"
]
},
"operator": {
"description": "Operators for list length filters.",
"type": "string",
"enum": [
"length-equals",
"length-greater-than",
"length-greater-than-or-equal",
"length-less-than",
"length-less-than-or-equal"
]
},
"value": {
"type": "integer"
}
},
"required": [
"type",
"operator",
"value"
]
},
"ListSetFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"list"
]
},
"operator": {
"description": "Operators for list contains set filters.",
"type": "string",
"enum": [
"contains-all",
"contains-any",
"not-contains-all",
"not-contains-any"
]
},
"value": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type",
"operator",
"value"
]
},
"ListSubstringFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"list"
]
},
"operator": {
"description": "Operators for list substring filters.",
"type": "string",
"enum": [
"contains-substring",
"not-contains-substring"
]
},
"value": {
"type": "string",
"nullable": true
}
},
"required": [
"type",
"operator",
"value"
]
},
"ListUpdateAction": {
"type": "object",
"properties": {
"id": {
"description": "The real ID of an action. Not allowed on create.",
"type": "string",
"example": "123",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"type": "string",
"example": "action-1",
"nullable": true,
"writeOnly": true
},
"data": {
"$ref": "#/components/schemas/ListUpdateActionData"
},
"type": {
"type": "string",
"enum": [
"list-update"
]
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
}
},
"required": [
"data",
"type"
]
},
"ListUpdateActionData": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"on_execution": {
"description": "The enum for whether the action will add/remove from the list in the\n List Update Action.",
"type": "boolean",
"enum": [
false,
true
],
"nullable": true
},
"list_id": {
"type": "string",
"nullable": true
},
"status": {
"description": "Flow action status.",
"type": "string",
"example": "draft",
"default": "draft",
"enum": [
"disabled",
"draft",
"live",
"manual"
]
}
},
"required": [
"name",
"on_execution",
"list_id"
]
},
"LowInventoryCondition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"low-inventory-property"
]
},
"metric_id": {
"type": "string",
"nullable": true
},
"field": {
"type": "string"
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StringOperatorStringFilter"
},
{
"$ref": "#/components/schemas/StringArrayOperatorStringArrayFilter"
},
{
"$ref": "#/components/schemas/NumericOperatorNumericFilter"
},
{
"$ref": "#/components/schemas/NumericRangeFilter"
},
{
"$ref": "#/components/schemas/BooleanFilter"
},
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/CalendarDateFilter"
},
{
"$ref": "#/components/schemas/AnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/ListContainsOperatorListContainsFilter"
},
{
"$ref": "#/components/schemas/ListLengthFilter"
},
{
"$ref": "#/components/schemas/ExistenceOperatorExistenceFilter"
}
]
}
},
"required": [
"type",
"metric_id",
"field",
"filter"
]
},
"MailboxProviderMethodFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"method"
]
},
"method": {
"type": "string",
"enum": [
"mailbox_provider"
]
}
},
"required": [
"field",
"method"
]
},
"ManualAddManualMethodFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"method"
]
},
"method": {
"type": "string",
"enum": [
"manual_add"
]
},
"filter": {
"description": "Optional filter on a specific list of user email addresses who initiated the manual action",
"$ref": "#/components/schemas/InStringArrayFilter",
"nullable": true
}
},
"required": [
"field",
"method"
]
},
"ManualImportManualMethodFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"method"
]
},
"method": {
"type": "string",
"enum": [
"manual_import"
]
},
"filter": {
"description": "Optional filter on a specific list of user email addresses who initiated the manual action",
"$ref": "#/components/schemas/InStringArrayFilter",
"nullable": true
}
},
"required": [
"field",
"method"
]
},
"ManualImportMethodFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"method"
]
},
"method": {
"type": "string",
"enum": [
"manual_import"
]
}
},
"required": [
"field",
"method"
]
},
"ManualRemoveMethodFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"method"
]
},
"method": {
"type": "string",
"enum": [
"manual_remove"
]
}
},
"required": [
"field",
"method"
]
},
"ManualSuppressionDateFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"manual_suppression_date"
]
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/CalendarDateFilter"
},
{
"$ref": "#/components/schemas/AnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/IsSetExistenceFilter"
}
]
}
},
"required": [
"field",
"filter"
]
},
"MessageBlockedMethodFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"method"
]
},
"method": {
"type": "string",
"enum": [
"message_blocked"
]
}
},
"required": [
"field",
"method"
]
},
"MethodFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"subscribe_method"
]
},
"method": {
"description": "Method for subscribing / unsubscribing.",
"type": "string",
"enum": [
"api",
"back_in_stock",
"bigcommerce",
"bulk_remove",
"campaign_monitor",
"carrier_deactivation",
"checkout",
"constant_contact",
"exact_target",
"facebook",
"failed_age_gate",
"inbound_message",
"integration",
"mad_mimi",
"magento_two",
"mailbox_provider",
"manual_add",
"manual_import",
"manual_remove",
"message_blocked",
"netsuite",
"preference_page",
"provided_landline",
"provided_no_age",
"sftp",
"shopify",
"social_instagram_message",
"spam_complaint",
"square",
"wix",
"woocommerce"
]
}
},
"required": [
"field",
"method"
]
},
"MetricPropertyCondition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"metric-property"
]
},
"metric_id": {
"type": "string"
},
"field": {
"type": "string"
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StringOperatorStringFilter"
},
{
"$ref": "#/components/schemas/StringArrayOperatorStringArrayFilter"
},
{
"$ref": "#/components/schemas/NumericOperatorNumericFilter"
},
{
"$ref": "#/components/schemas/NumericRangeFilter"
},
{
"$ref": "#/components/schemas/BooleanFilter"
},
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/CalendarDateFilter"
},
{
"$ref": "#/components/schemas/AnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/ListContainsOperatorListContainsFilter"
},
{
"$ref": "#/components/schemas/ListLengthFilter"
},
{
"$ref": "#/components/schemas/ExistenceOperatorExistenceFilter"
}
]
}
},
"required": [
"type",
"metric_id",
"field",
"filter"
]
},
"MultiBranchSplitAction": {
"type": "object",
"properties": {
"id": {
"description": "The real ID of an action. Not allowed on create.",
"type": "string",
"example": "123",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"type": "string",
"example": "action-1",
"nullable": true,
"writeOnly": true
},
"type": {
"type": "string",
"enum": [
"multi-branch-split"
]
},
"links": {
"nullable": true
},
"data": {
"$ref": "#/components/schemas/MultiBranchSplitActionData",
"nullable": true
}
},
"required": [
"type"
]
},
"MultiBranchSplitActionData": {
"type": "object",
"properties": {
"branches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MultiBranchSplitBranch"
}
},
"name": {
"type": "string"
}
},
"required": [
"branches",
"name"
]
},
"MultiBranchSplitBranch": {
"type": "object",
"properties": {
"branch_id": {
"type": "string"
},
"order": {
"type": "integer",
"nullable": true
},
"is_else": {
"type": "boolean",
"default": false
},
"branch_filter": {
"type": "object",
"nullable": true,
"properties": {
"condition_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ProfilePropertyCondition"
},
{
"$ref": "#/components/schemas/ProfileHasGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileNoGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileRegionCondition"
},
{
"$ref": "#/components/schemas/ProfilePostalCodeDistanceCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsDateCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsStringCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsNumericCondition"
},
{
"$ref": "#/components/schemas/ProfileMarketingConsentCondition"
},
{
"$ref": "#/components/schemas/FlowsProfileMetricCondition"
},
{
"$ref": "#/components/schemas/ProfileRandomSampleCondition"
},
{
"$ref": "#/components/schemas/ProfileHasCustomObjectCondition"
},
{
"$ref": "#/components/schemas/ProfilePermissionsCondition"
},
{
"$ref": "#/components/schemas/MetricPropertyCondition"
},
{
"$ref": "#/components/schemas/CustomObjectTriggerCondition"
}
]
}
}
},
"required": [
"conditions"
]
}
}
},
"required": [
"condition_groups"
]
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
},
"required": [
"branch_id"
]
},
"NoEmailMarketing": {
"type": "object",
"properties": {
"subscription": {
"type": "string",
"enum": [
"any"
]
},
"filters": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/BounceDateFilter"
},
{
"$ref": "#/components/schemas/ManualSuppressionDateFilter"
},
{
"$ref": "#/components/schemas/InvalidEmailDateFilter"
}
]
},
"nullable": true
}
},
"required": [
"subscription"
]
},
"NoEmailMarketingConsent": {
"type": "object",
"properties": {
"channel": {
"type": "string",
"enum": [
"email"
]
},
"can_receive_marketing": {
"type": "boolean",
"enum": [
false
]
},
"consent_status": {
"oneOf": [
{
"$ref": "#/components/schemas/NoEmailMarketing"
},
{
"$ref": "#/components/schemas/NoEmailMarketingUnsubscribed"
},
{
"$ref": "#/components/schemas/NoEmailMarketingNeverSubscribed"
},
{
"$ref": "#/components/schemas/NoEmailMarketingSubscribed"
}
]
}
},
"required": [
"channel",
"can_receive_marketing",
"consent_status"
]
},
"NoEmailMarketingNeverSubscribed": {
"type": "object",
"properties": {
"subscription": {
"type": "string",
"enum": [
"never_subscribed"
]
},
"filters": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/BounceDateFilter"
},
{
"$ref": "#/components/schemas/ManualSuppressionDateFilter"
},
{
"$ref": "#/components/schemas/InvalidEmailDateFilter"
}
]
}
}
},
"required": [
"subscription",
"filters"
]
},
"NoEmailMarketingSubscribed": {
"type": "object",
"properties": {
"subscription": {
"type": "string",
"enum": [
"subscribed"
]
},
"filters": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/BounceDateFilter"
},
{
"$ref": "#/components/schemas/ManualSuppressionDateFilter"
},
{
"$ref": "#/components/schemas/InvalidEmailDateFilter"
}
]
}
}
},
"required": [
"subscription",
"filters"
]
},
"NoEmailMarketingUnsubscribed": {
"type": "object",
"properties": {
"subscription": {
"type": "string",
"enum": [
"unsubscribed"
]
},
"filters": {
"nullable": true,
"oneOf": [
{
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/StatusDateFilter"
},
{
"$ref": "#/components/schemas/APIMethodFilter"
},
{
"$ref": "#/components/schemas/InboundMessageMethodFilter"
},
{
"$ref": "#/components/schemas/PreferencePageMethodFilter"
},
{
"$ref": "#/components/schemas/ManualRemoveMethodFilter"
},
{
"$ref": "#/components/schemas/SpamComplaintMethodFilter"
},
{
"$ref": "#/components/schemas/MailboxProviderMethodFilter"
},
{
"$ref": "#/components/schemas/OneClickUnsubscribeMethodFilter"
},
{
"$ref": "#/components/schemas/ManualImportMethodFilter"
},
{
"$ref": "#/components/schemas/SftpMethodFilter"
},
{
"$ref": "#/components/schemas/DataWarehouseImportMethodFilter"
},
{
"$ref": "#/components/schemas/ProfileModificationMethodFilter"
},
{
"$ref": "#/components/schemas/ConstantContactIntegrationMethodFilter"
}
]
}
},
{
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/BounceDateFilter"
},
{
"$ref": "#/components/schemas/ManualSuppressionDateFilter"
},
{
"$ref": "#/components/schemas/InvalidEmailDateFilter"
}
]
}
}
]
}
},
"required": [
"subscription"
]
},
"NoPushMarketing": {
"type": "object",
"properties": {
"subscription": {
"type": "string",
"enum": [
"any"
]
}
},
"required": [
"subscription"
]
},
"NoPushMarketingConsent": {
"type": "object",
"properties": {
"channel": {
"type": "string",
"enum": [
"push"
]
},
"can_receive_marketing": {
"type": "boolean",
"enum": [
false
]
},
"consent_status": {
"$ref": "#/components/schemas/NoPushMarketing"
}
},
"required": [
"channel",
"can_receive_marketing",
"consent_status"
]
},
"NoSMSMarketing": {
"type": "object",
"properties": {
"subscription": {
"type": "string",
"enum": [
"any"
]
}
},
"required": [
"subscription"
]
},
"NoSMSMarketingConsent": {
"type": "object",
"properties": {
"channel": {
"type": "string",
"enum": [
"sms"
]
},
"can_receive_marketing": {
"type": "boolean",
"enum": [
false
]
},
"consent_status": {
"oneOf": [
{
"$ref": "#/components/schemas/NoSMSMarketing"
},
{
"$ref": "#/components/schemas/NoSMSMarketingUnsubscribed"
},
{
"$ref": "#/components/schemas/NoSMSMarketingNeverSubscribed"
}
]
}
},
"required": [
"channel",
"can_receive_marketing",
"consent_status"
]
},
"NoSMSMarketingNeverSubscribed": {
"type": "object",
"properties": {
"subscription": {
"type": "string",
"enum": [
"never_subscribed"
]
}
},
"required": [
"subscription"
]
},
"NoSMSMarketingUnsubscribed": {
"type": "object",
"properties": {
"subscription": {
"type": "string",
"enum": [
"unsubscribed"
]
},
"filters": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/StatusDateFilter"
},
{
"$ref": "#/components/schemas/FormMethodFilter"
},
{
"$ref": "#/components/schemas/ManualImportManualMethodFilter"
},
{
"$ref": "#/components/schemas/ManualAddManualMethodFilter"
},
{
"$ref": "#/components/schemas/ManualRemoveMethodFilter"
},
{
"$ref": "#/components/schemas/BulkRemoveMethodFilter"
},
{
"$ref": "#/components/schemas/CheckoutMethodFilter"
},
{
"$ref": "#/components/schemas/InboundMessageMethodFilter"
},
{
"$ref": "#/components/schemas/PreferencePageMethodFilter"
},
{
"$ref": "#/components/schemas/SftpMethodFilter"
},
{
"$ref": "#/components/schemas/CarrierDeactivationMethodFilter"
},
{
"$ref": "#/components/schemas/ProvidedLandlineMethodFilter"
},
{
"$ref": "#/components/schemas/MessageBlockedMethodFilter"
},
{
"$ref": "#/components/schemas/ProvidedNoAgeMethodFilter"
},
{
"$ref": "#/components/schemas/FailedAgeGateMethodFilter"
},
{
"$ref": "#/components/schemas/ShopifyIntegrationMethodFilter"
}
]
},
"nullable": true
}
},
"required": [
"subscription"
]
},
"NumericOperatorNumericFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"numeric"
]
},
"operator": {
"description": "Operators for numeric filters.",
"type": "string",
"enum": [
"equals",
"greater-than",
"greater-than-or-equal",
"less-than",
"less-than-or-equal",
"not-equals"
]
},
"value": {
"oneOf": [
{
"type": "integer"
},
{
"type": "number"
}
]
}
},
"required": [
"type",
"operator",
"value"
]
},
"NumericRangeFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"numeric"
]
},
"operator": {
"description": "Operators for numeric range filters.",
"type": "string",
"enum": [
"between"
]
},
"start": {
"oneOf": [
{
"type": "integer"
},
{
"type": "number"
}
]
},
"end": {
"oneOf": [
{
"type": "integer"
},
{
"type": "number"
}
]
}
},
"required": [
"type",
"operator",
"start",
"end"
]
},
"ObjectLinks": {
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri"
}
},
"required": [
"self"
]
},
"OneClickUnsubscribeMethodFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"method"
]
},
"method": {
"type": "string",
"enum": [
"one_click_unsubscribe"
]
}
},
"required": [
"field",
"method"
]
},
"PreferencePageFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"method"
]
},
"method": {
"type": "string",
"enum": [
"preference_page"
]
},
"filter": {
"description": "Optional filter on a specific subscribe page url",
"$ref": "#/components/schemas/EqualsStringFilter",
"nullable": true
}
},
"required": [
"field",
"method"
]
},
"PreferencePageMethodFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"method"
]
},
"method": {
"type": "string",
"enum": [
"preference_page"
]
}
},
"required": [
"field",
"method"
]
},
"PriceDropCondition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"price-drop-property"
]
},
"metric_id": {
"type": "string",
"nullable": true
},
"field": {
"type": "string"
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StringOperatorStringFilter"
},
{
"$ref": "#/components/schemas/StringArrayOperatorStringArrayFilter"
},
{
"$ref": "#/components/schemas/NumericOperatorNumericFilter"
},
{
"$ref": "#/components/schemas/NumericRangeFilter"
},
{
"$ref": "#/components/schemas/BooleanFilter"
},
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/CalendarDateFilter"
},
{
"$ref": "#/components/schemas/AnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/ListContainsOperatorListContainsFilter"
},
{
"$ref": "#/components/schemas/ListLengthFilter"
},
{
"$ref": "#/components/schemas/ExistenceOperatorExistenceFilter"
}
]
}
},
"required": [
"type",
"metric_id",
"field",
"filter"
]
},
"ProfileHasCustomObjectCondition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"profile-has-custom-object"
]
},
"object_type_id": {
"type": "string"
},
"object_type_relationship_id": {
"type": "string"
},
"filter": {
"$ref": "#/components/schemas/IntegerFilter"
},
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProfileHasCustomObjectFilter"
}
}
},
"required": [
"type",
"object_type_id",
"object_type_relationship_id",
"filter",
"filters"
]
},
"ProfileHasCustomObjectFilter": {
"type": "object",
"properties": {
"property_id": {
"type": "integer"
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StringOperatorStringFilter"
},
{
"$ref": "#/components/schemas/StringArrayOperatorStringArrayFilter"
},
{
"$ref": "#/components/schemas/NumericOperatorNumericFilter"
},
{
"$ref": "#/components/schemas/NumericRangeFilter"
},
{
"$ref": "#/components/schemas/BooleanFilter"
},
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/ExistenceOperatorExistenceFilter"
}
]
}
},
"required": [
"property_id",
"filter"
]
},
"ProfileHasGroupMembershipCondition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"profile-group-membership"
]
},
"is_member": {
"type": "boolean",
"enum": [
true
]
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"timeframe_filter": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
}
]
}
},
"required": [
"type",
"is_member",
"group_ids"
]
},
"ProfileHasNotReceivedEmailMessageCondition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"profile-not-sent-email"
]
},
"timeframe_filter": {
"oneOf": [
{
"$ref": "#/components/schemas/AlltimeDateFilter"
},
{
"$ref": "#/components/schemas/InTheLastBaseRelativeDateFilter"
}
]
}
},
"required": [
"type",
"timeframe_filter"
]
},
"ProfileHasNotReceivedPushMessageCondition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"profile-not-sent-push"
]
},
"timeframe_filter": {
"oneOf": [
{
"$ref": "#/components/schemas/AlltimeDateFilter"
},
{
"$ref": "#/components/schemas/InTheLastBaseRelativeDateFilter"
}
]
}
},
"required": [
"type",
"timeframe_filter"
]
},
"ProfileHasNotReceivedSmsMessageCondition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"profile-not-sent-sms"
]
},
"timeframe_filter": {
"oneOf": [
{
"$ref": "#/components/schemas/AlltimeDateFilter"
},
{
"$ref": "#/components/schemas/InTheLastBaseRelativeDateFilter"
}
]
}
},
"required": [
"type",
"timeframe_filter"
]
},
"ProfileMarketingConsentCondition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"profile-marketing-consent"
]
},
"consent": {
"oneOf": [
{
"$ref": "#/components/schemas/HasEmailMarketingConsent"
},
{
"$ref": "#/components/schemas/NoEmailMarketingConsent"
},
{
"$ref": "#/components/schemas/HasSMSMarketingConsent"
},
{
"$ref": "#/components/schemas/NoSMSMarketingConsent"
},
{
"$ref": "#/components/schemas/HasPushMarketingConsent"
},
{
"$ref": "#/components/schemas/NoPushMarketingConsent"
}
]
}
},
"required": [
"type",
"consent"
]
},
"ProfileMetricPropertyFilter": {
"type": "object",
"properties": {
"property": {
"type": "string"
},
"filter": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StringOperatorStringFilter"
},
{
"$ref": "#/components/schemas/StringArrayOperatorStringArrayFilter"
},
{
"$ref": "#/components/schemas/ExistenceOperatorExistenceFilter"
},
{
"$ref": "#/components/schemas/ListSetFilter"
},
{
"$ref": "#/components/schemas/ListLengthFilter"
},
{
"$ref": "#/components/schemas/ListSubstringFilter"
},
{
"$ref": "#/components/schemas/BooleanFilter"
},
{
"$ref": "#/components/schemas/NumericOperatorNumericFilter"
}
]
}
},
"required": [
"property"
]
},
"ProfileModificationMethodFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"method"
]
},
"method": {
"type": "string",
"enum": [
"profile_modification"
]
}
},
"required": [
"field",
"method"
]
},
"ProfileNoGroupMembershipCondition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"profile-group-membership"
]
},
"is_member": {
"type": "boolean",
"enum": [
false
]
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type",
"is_member",
"group_ids"
]
},
"ProfileOperationDelete": {
"type": "object",
"properties": {
"operator": {
"description": "The type of operation to perform on a profile property.",
"type": "string",
"enum": [
"delete"
]
},
"property_key": {
"type": "string"
}
},
"required": [
"operator",
"property_key"
]
},
"ProfileOperationUpdateOrCreateBoolean": {
"type": "object",
"properties": {
"operator": {
"description": "The type of operation to perform on a profile property.",
"type": "string",
"enum": [
"create",
"update"
]
},
"property_type": {
"type": "string",
"enum": [
"boolean"
]
},
"property_key": {
"type": "string"
},
"property_value": {
"type": "boolean"
}
},
"required": [
"operator",
"property_type",
"property_key",
"property_value"
]
},
"ProfileOperationUpdateOrCreateDate": {
"type": "object",
"properties": {
"operator": {
"description": "The type of operation to perform on a profile property.",
"type": "string",
"enum": [
"create",
"update"
]
},
"property_type": {
"type": "string",
"enum": [
"date"
]
},
"property_key": {
"type": "string"
},
"property_value": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"enum": [
"today"
],
"type": "string"
}
]
}
},
"required": [
"operator",
"property_type",
"property_key",
"property_value"
]
},
"ProfileOperationUpdateOrCreateList": {
"type": "object",
"properties": {
"operator": {
"description": "The type of operation to perform on a profile property.",
"type": "string",
"enum": [
"create",
"update"
]
},
"property_type": {
"type": "string",
"enum": [
"list"
]
},
"property_operation": {
"description": "The type of operation to perform on a list property.",
"type": "string",
"enum": [
"add",
"remove"
],
"nullable": true
},
"property_key": {
"type": "string"
},
"property_value": {
"type": "string"
}
},
"required": [
"operator",
"property_type",
"property_key",
"property_value"
]
},
"ProfileOperationUpdateOrCreateNumeric": {
"type": "object",
"properties": {
"operator": {
"description": "The type of operation to perform on a profile property.",
"type": "string",
"enum": [
"create",
"update"
]
},
"property_type": {
"type": "string",
"enum": [
"numeric"
]
},
"property_key": {
"type": "string"
},
"property_value": {
"oneOf": [
{
"type": "integer"
},
{
"type": "number"
}
]
}
},
"required": [
"operator",
"property_type",
"property_key",
"property_value"
]
},
"ProfileOperationUpdateOrCreateString": {
"type": "object",
"properties": {
"operator": {
"description": "The type of operation to perform on a profile property.",
"type": "string",
"enum": [
"create",
"update"
]
},
"property_type": {
"type": "string",
"enum": [
"string"
]
},
"property_key": {
"type": "string"
},
"property_value": {
"type": "string"
}
},
"required": [
"operator",
"property_type",
"property_key",
"property_value"
]
},
"ProfilePermissionsCondition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"profile-permissions"
]
},
"permission": {
"oneOf": [
{
"$ref": "#/components/schemas/ExplicitlyReachable"
},
{
"$ref": "#/components/schemas/ImplicitlyReachable"
},
{
"$ref": "#/components/schemas/ImplicitlyOrExplicitlyReachable"
},
{
"$ref": "#/components/schemas/ExplicitlyUnreachable"
},
{
"$ref": "#/components/schemas/ImplicitlyUnreachable"
},
{
"$ref": "#/components/schemas/ImplicitlyOrExplicitlyUnreachable"
}
]
},
"channel": {
"description": "Possible channels for profile permissions criterion.",
"type": "string",
"enum": [
"whatsapp_marketing",
"whatsapp_transactional"
]
}
},
"required": [
"type",
"permission",
"channel"
]
},
"ProfilePostalCodeDistanceCondition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"profile-postal-code-distance"
]
},
"country_code": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"unit": {
"description": "Units for profile postal code distance conditions.",
"type": "string",
"enum": [
"kilometers",
"miles"
]
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/GreaterThanPositiveNumericFilter"
},
{
"$ref": "#/components/schemas/LessThanPositiveNumericFilter"
}
]
}
},
"required": [
"type",
"country_code",
"postal_code",
"unit",
"filter"
]
},
"ProfilePredictiveAnalyticsDateCondition": {
"type": "object",
"properties": {
"dimension": {
"description": "Dimension for date profile predictive analytics conditions.",
"type": "string",
"enum": [
"expected_date_of_next_purchase"
]
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/CalendarDateFilter"
},
{
"$ref": "#/components/schemas/AnniversaryDateFilter"
}
]
},
"type": {
"type": "string",
"enum": [
"profile-predictive-analytics"
]
}
},
"required": [
"dimension",
"filter",
"type"
]
},
"ProfilePredictiveAnalyticsNumericCondition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"profile-predictive-analytics"
]
},
"dimension": {
"description": "Dimensions for numeric profile predictive analytics conditions.",
"type": "string",
"enum": [
"average_days_between_orders",
"average_order_value",
"churn_probability",
"historic_clv",
"historic_number_of_orders",
"predicted_clv",
"predicted_number_of_orders",
"total_clv"
]
},
"filter": {
"$ref": "#/components/schemas/NumericOperatorNumericFilter"
}
},
"required": [
"type",
"dimension",
"filter"
]
},
"ProfilePredictiveAnalyticsStringCondition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"profile-predictive-analytics"
]
},
"dimension": {
"description": "Dimension for string profile predictive analytics conditions.",
"type": "string",
"enum": [
"predicted_gender"
]
},
"filter": {
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsStringFilter"
}
},
"required": [
"type",
"dimension",
"filter"
]
},
"ProfilePredictiveAnalyticsStringFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"string"
]
},
"operator": {
"oneOf": [
{
"enum": [
"equals"
],
"type": "string"
},
{
"enum": [
"not-equals"
],
"type": "string"
}
]
},
"value": {
"description": "Values for profile predictive analytics gender conditions.",
"type": "string",
"enum": [
"likely_female",
"likely_male",
"uncertain"
]
}
},
"required": [
"type",
"operator",
"value"
]
},
"ProfilePropertyCondition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"profile-property"
]
},
"property": {
"type": "string"
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StringOperatorStringFilter"
},
{
"$ref": "#/components/schemas/StringArrayOperatorStringArrayFilter"
},
{
"$ref": "#/components/schemas/StringPhoneOperatorStringArrayFilter"
},
{
"$ref": "#/components/schemas/NumericOperatorNumericFilter"
},
{
"$ref": "#/components/schemas/BooleanFilter"
},
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/CalendarDateFilter"
},
{
"$ref": "#/components/schemas/AnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/ListContainsOperatorListContainsFilter"
},
{
"$ref": "#/components/schemas/ListLengthFilter"
},
{
"$ref": "#/components/schemas/ExistenceOperatorExistenceFilter"
}
]
}
},
"required": [
"type",
"property",
"filter"
]
},
"ProfileRandomSampleCondition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"profile-sample"
]
},
"percentage": {
"type": "integer"
}
},
"required": [
"type",
"percentage"
]
},
"ProfileRegionCondition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"profile-region"
]
},
"in_region": {
"type": "boolean"
},
"region": {
"description": "Regions for profile region conditions.",
"type": "string",
"enum": [
"european_union",
"united_states"
]
}
},
"required": [
"type",
"in_region",
"region"
]
},
"Property": {
"type": "object",
"properties": {
"badge_config": {
"type": "string",
"enum": [
"set_property"
]
},
"set_from_property": {
"type": "string"
}
},
"required": [
"badge_config",
"set_from_property"
]
},
"ProvidedLandlineMethodFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"method"
]
},
"method": {
"type": "string",
"enum": [
"provided_landline"
]
}
},
"required": [
"field",
"method"
]
},
"ProvidedNoAgeMethodFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"method"
]
},
"method": {
"type": "string",
"enum": [
"provided_no_age"
]
}
},
"required": [
"field",
"method"
]
},
"PushActionButton": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"action_type": {
"description": "The action type for a push notification action button.",
"type": "string",
"enum": [
"deep_link",
"dismiss",
"open_app",
"open_url"
]
},
"position": {
"type": "integer",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"icon": {
"type": "string",
"nullable": true
},
"custom_action_id": {
"type": "string",
"nullable": true
}
},
"required": [
"label",
"action_type"
]
},
"RecordedDateFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"recorded_date"
]
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/CalendarDateFilter"
},
{
"$ref": "#/components/schemas/AnniversaryDateFilter"
}
]
}
},
"required": [
"field",
"filter"
]
},
"RelationshipLinks": {
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri"
},
"related": {
"type": "string",
"format": "uri"
}
},
"required": [
"self",
"related"
]
},
"RelativeAnniversaryDateFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"date"
]
},
"operator": {
"description": "Operators for relative date filters.\n\ne.g. \"anniversary in the last 10 days\"",
"type": "string",
"enum": [
"anniversary-last",
"anniversary-next"
]
},
"unit": {
"description": "Units for relative date filters.",
"type": "string",
"enum": [
"day",
"hour",
"week"
]
},
"quantity": {
"type": "integer"
}
},
"required": [
"type",
"operator",
"unit",
"quantity"
]
},
"RelativeDateOperatorBaseRelativeDateFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"date"
]
},
"operator": {
"description": "Operators for relative date filters.\n\ne.g. \"in the last 10 days\"",
"type": "string",
"enum": [
"at-least",
"in-the-last",
"in-the-next"
]
},
"unit": {
"description": "Units for relative date filters.",
"type": "string",
"enum": [
"day",
"hour",
"week"
]
},
"quantity": {
"type": "integer"
}
},
"required": [
"type",
"operator",
"unit",
"quantity"
]
},
"RelativeDateRangeFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"date"
]
},
"operator": {
"description": "Operators for relative date range filters.\n\ne.g. \"between 10 and 20 days ago\"",
"type": "string",
"enum": [
"between"
]
},
"start": {
"type": "integer"
},
"end": {
"type": "integer"
},
"unit": {
"description": "Units for relative date filters.",
"type": "string",
"enum": [
"day",
"hour",
"week"
]
}
},
"required": [
"type",
"operator",
"start",
"end",
"unit"
]
},
"SegmentEnum": {
"type": "string",
"enum": [
"segment"
]
},
"SendEmailAction": {
"type": "object",
"properties": {
"id": {
"description": "The real ID of an action. Not allowed on create.",
"type": "string",
"example": "123",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"type": "string",
"example": "action-1",
"nullable": true,
"writeOnly": true
},
"type": {
"type": "string",
"enum": [
"send-email"
]
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"data": {
"$ref": "#/components/schemas/SendEmailActionData",
"nullable": true
}
},
"required": [
"type"
]
},
"SendEmailActionData": {
"type": "object",
"properties": {
"message": {
"$ref": "#/components/schemas/FlowEmail",
"nullable": true
},
"status": {
"description": "Flow action status.",
"type": "string",
"example": "draft",
"default": "draft",
"enum": [
"disabled",
"draft",
"live",
"manual"
]
}
}
},
"SendInternalAlertAction": {
"type": "object",
"properties": {
"id": {
"description": "The real ID of an action. Not allowed on create.",
"type": "string",
"example": "123",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"type": "string",
"example": "action-1",
"nullable": true,
"writeOnly": true
},
"type": {
"type": "string",
"enum": [
"send-internal-alert"
]
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"data": {
"$ref": "#/components/schemas/SendInternalAlertActionData",
"nullable": true
}
},
"required": [
"type"
]
},
"SendInternalAlertActionData": {
"type": "object",
"properties": {
"message": {
"$ref": "#/components/schemas/FlowInternalAlert"
},
"status": {
"description": "Flow action status.",
"type": "string",
"example": "draft",
"default": "draft",
"enum": [
"disabled",
"draft",
"live",
"manual"
]
}
},
"required": [
"message"
]
},
"SendPushNotificationAction": {
"type": "object",
"properties": {
"id": {
"description": "The real ID of an action. Not allowed on create.",
"type": "string",
"example": "123",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"type": "string",
"example": "action-1",
"nullable": true,
"writeOnly": true
},
"type": {
"type": "string",
"enum": [
"send-mobile-push"
]
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"data": {
"$ref": "#/components/schemas/SendPushNotificationActionData",
"nullable": true
}
},
"required": [
"type"
]
},
"SendPushNotificationActionContentExperimentActionData": {
"type": "object",
"properties": {
"status": {
"description": "Flow action status.",
"type": "string",
"example": "draft",
"default": "draft",
"enum": [
"disabled",
"draft",
"live",
"manual"
]
},
"experiment_status": {
"description": "Not allowed on create.",
"type": "string",
"enum": [
"completed",
"draft",
"live"
],
"nullable": true
},
"main_action": {
"$ref": "#/components/schemas/SendPushNotificationAction"
},
"current_experiment": {
"$ref": "#/components/schemas/SendPushNotificationActionCurrentExperiment",
"nullable": true
}
},
"required": [
"main_action"
]
},
"SendPushNotificationActionCurrentExperiment": {
"type": "object",
"properties": {
"id": {
"description": "Not allowed on create.",
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"variations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SendPushNotificationAction"
}
},
"allocations": {
"type": "object",
"nullable": true
},
"started": {
"type": "string",
"format": "date-time",
"example": "2022-11-08T00:00:00+00:00",
"nullable": true,
"readOnly": true
},
"winner_metric": {
"description": "The metric to use to determine the winner of the content experiment\n action.",
"type": "string",
"enum": [
"open-rate"
],
"nullable": true
}
},
"required": [
"variations"
]
},
"SendPushNotificationActionData": {
"type": "object",
"properties": {
"message": {
"$ref": "#/components/schemas/FlowPushNotification",
"nullable": true
},
"status": {
"description": "Flow action status.",
"type": "string",
"example": "draft",
"default": "draft",
"enum": [
"disabled",
"draft",
"live",
"manual"
]
}
}
},
"SendSmsAction": {
"type": "object",
"properties": {
"id": {
"description": "The real ID of an action. Not allowed on create.",
"type": "string",
"example": "123",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"type": "string",
"example": "action-1",
"nullable": true,
"writeOnly": true
},
"type": {
"type": "string",
"enum": [
"send-sms"
]
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"data": {
"$ref": "#/components/schemas/SendSmsActionData",
"nullable": true
}
},
"required": [
"type"
]
},
"SendSmsActionData": {
"type": "object",
"properties": {
"message": {
"$ref": "#/components/schemas/FlowSms",
"nullable": true
},
"status": {
"description": "Flow action status.",
"type": "string",
"example": "draft",
"default": "draft",
"enum": [
"disabled",
"draft",
"live",
"manual"
]
}
}
},
"SendWebhookAction": {
"type": "object",
"properties": {
"id": {
"description": "The real ID of an action. Not allowed on create.",
"type": "string",
"example": "123",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"type": "string",
"example": "action-1",
"nullable": true,
"writeOnly": true
},
"type": {
"type": "string",
"enum": [
"send-webhook"
]
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"data": {
"$ref": "#/components/schemas/SendWebhookActionData",
"nullable": true
}
},
"required": [
"type"
]
},
"SendWebhookActionData": {
"type": "object",
"properties": {
"message": {
"$ref": "#/components/schemas/FlowWebhook"
},
"status": {
"description": "Flow action status.",
"type": "string",
"example": "draft",
"default": "draft",
"enum": [
"disabled",
"draft",
"live",
"manual"
]
}
},
"required": [
"message"
]
},
"SendWhatsAppAction": {
"type": "object",
"properties": {
"id": {
"description": "The real ID of an action. Not allowed on create.",
"type": "string",
"example": "123",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"type": "string",
"example": "action-1",
"nullable": true,
"writeOnly": true
},
"type": {
"type": "string",
"enum": [
"send-whatsapp"
]
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"data": {
"$ref": "#/components/schemas/SendWhatsAppActionData",
"nullable": true
}
},
"required": [
"type"
]
},
"SendWhatsAppActionData": {
"type": "object",
"properties": {
"message": {
"$ref": "#/components/schemas/FlowWhatsApp",
"nullable": true
},
"status": {
"description": "Flow action status.",
"type": "string",
"example": "draft",
"default": "draft",
"enum": [
"disabled",
"draft",
"live",
"manual"
]
}
}
},
"SftpMethodFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"method"
]
},
"method": {
"type": "string",
"enum": [
"sftp"
]
}
},
"required": [
"field",
"method"
]
},
"ShopifyIntegrationFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"string"
]
},
"operator": {
"type": "string",
"enum": [
"in"
]
},
"value": {
"type": "array",
"items": {
"enum": [
"shopify"
],
"type": "string"
}
}
},
"required": [
"type",
"operator",
"value"
]
},
"ShopifyIntegrationMethodFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"method"
]
},
"method": {
"type": "string",
"enum": [
"integration"
]
},
"filter": {
"$ref": "#/components/schemas/ShopifyIntegrationFilter"
}
},
"required": [
"field",
"method",
"filter"
]
},
"SinceFlowStartDateFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"date"
]
},
"operator": {
"description": "Possible operators for since flow start date.",
"type": "string",
"enum": [
"flow-start"
]
}
},
"required": [
"type",
"operator"
]
},
"SpamComplaintMethodFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"method"
]
},
"method": {
"type": "string",
"enum": [
"spam_complaint"
]
}
},
"required": [
"field",
"method"
]
},
"StaticCount": {
"type": "object",
"properties": {
"badge_config": {
"type": "string",
"enum": [
"set_count"
]
},
"value": {
"type": "string"
}
},
"required": [
"badge_config",
"value"
]
},
"StaticDateFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"date"
]
},
"operator": {
"description": "Operators for static date filters.\n\nE.g. \"before 2023-01-01\"",
"type": "string",
"enum": [
"after",
"before"
]
},
"date": {
"type": "string",
"format": "date-time",
"example": "2022-11-08T00:00:00+00:00"
}
},
"required": [
"type",
"operator",
"date"
]
},
"StaticDateRangeFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"date"
]
},
"operator": {
"description": "Operators for static date range filters.\n\nE.g. \"between 2023-01-01 and 2023-02-01\"",
"type": "string",
"enum": [
"between-static"
]
},
"start": {
"type": "string",
"format": "date-time",
"example": "2022-11-08T00:00:00+00:00"
},
"end": {
"type": "string",
"format": "date-time",
"example": "2022-11-08T00:00:00+00:00"
}
},
"required": [
"type",
"operator",
"start",
"end"
]
},
"StatusDateFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"status_date"
]
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/CalendarDateFilter"
},
{
"$ref": "#/components/schemas/AnniversaryDateFilter"
}
]
}
},
"required": [
"field",
"filter"
]
},
"StringArrayOperatorStringArrayFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"string"
]
},
"operator": {
"description": "Operators for string-in-array filters.",
"type": "string",
"enum": [
"in",
"not-in"
]
},
"value": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type",
"operator",
"value"
]
},
"StringOperatorStringFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"string"
]
},
"operator": {
"description": "Operators for string filters.",
"type": "string",
"enum": [
"contains",
"ends-with",
"equals",
"not-contains",
"not-ends-with",
"not-equals",
"not-starts-with",
"nregex",
"regex",
"starts-with"
]
},
"value": {
"type": "string",
"nullable": true
}
},
"required": [
"type",
"operator",
"value"
]
},
"StringPhoneOperatorStringArrayFilter": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"string"
]
},
"operator": {
"description": "Operators for phone string array filters.\n\nExample condition using this filter:\n {",
"type": "string",
"enum": [
"phone-country-code-in",
"phone-country-code-not-in"
]
},
"value": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type",
"operator",
"value"
]
},
"SubscribedSMSIsRcsCapableFilter": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"is_rcs_capable"
]
},
"filter": {
"$ref": "#/components/schemas/BooleanFilter"
}
},
"required": [
"field",
"filter"
]
},
"TagEnum": {
"type": "string",
"enum": [
"tag"
]
},
"TagGroupEnum": {
"type": "string",
"enum": [
"tag-group"
]
},
"TagResponseObjectResource": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/TagEnum"
},
"id": {
"description": "The Tag ID",
"type": "string",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"description": "The Tag name",
"type": "string",
"example": "My Tag"
}
},
"required": [
"name"
]
},
"relationships": {
"type": "object",
"properties": {
"tag-group": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/TagGroupEnum"
},
"id": {
"type": "string"
}
},
"required": [
"type",
"id"
]
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
}
},
"lists": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"$ref": "#/components/schemas/ListEnum"
},
"id": {
"type": "string"
}
}
}
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
}
},
"segments": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"$ref": "#/components/schemas/SegmentEnum"
},
"id": {
"type": "string"
}
}
}
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
}
},
"campaigns": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"$ref": "#/components/schemas/CampaignEnum"
},
"id": {
"type": "string"
}
}
}
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
}
},
"flows": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"$ref": "#/components/schemas/FlowEnum"
},
"id": {
"type": "string"
}
}
}
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
}
}
}
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"type",
"id",
"attributes",
"links"
]
},
"TargetDateAction": {
"type": "object",
"properties": {
"id": {
"description": "The real ID of an action. Not allowed on create.",
"type": "string",
"example": "123",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"type": "string",
"example": "action-1",
"nullable": true,
"writeOnly": true
},
"type": {
"type": "string",
"enum": [
"target-date"
]
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"data": {
"$ref": "#/components/schemas/TargetDateActionData"
}
},
"required": [
"type",
"data"
]
},
"TargetDateActionData": {
"type": "object",
"properties": {
"timezone": {
"type": "string",
"example": "profile",
"default": "profile",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Addis_Ababa",
"Africa/Algiers",
"Africa/Asmara",
"Africa/Bamako",
"Africa/Bangui",
"Africa/Banjul",
"Africa/Bissau",
"Africa/Blantyre",
"Africa/Brazzaville",
"Africa/Bujumbura",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Douala",
"Africa/El_Aaiun",
"Africa/Freetown",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Johannesburg",
"Africa/Juba",
"Africa/Kampala",
"Africa/Khartoum",
"Africa/Kigali",
"Africa/Kinshasa",
"Africa/Lagos",
"Africa/Libreville",
"Africa/Lome",
"Africa/Luanda",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Malabo",
"Africa/Maputo",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Mogadishu",
"Africa/Monrovia",
"Africa/Nairobi",
"Africa/Ndjamena",
"Africa/Niamey",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Porto-Novo",
"Africa/Sao_Tome",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Anguilla",
"America/Antigua",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Aruba",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc-Sablon",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Cayman",
"America/Chicago",
"America/Chihuahua",
"America/Ciudad_Juarez",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Curacao",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Dominica",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Fort_Nelson",
"America/Fortaleza",
"America/Glace_Bay",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Grenada",
"America/Guadeloupe",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Indianapolis",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/Kralendijk",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Lower_Princes",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Marigot",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Montserrat",
"America/Nassau",
"America/New_York",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Nuuk",
"America/Ojinaga",
"America/Panama",
"America/Paramaribo",
"America/Phoenix",
"America/Port-au-Prince",
"America/Port_of_Spain",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Punta_Arenas",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Rio_Branco",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Barthelemy",
"America/St_Johns",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Tijuana",
"America/Toronto",
"America/Tortola",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Antarctica/McMurdo",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Arctic/Longyearbyen",
"Asia/Aden",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Bahrain",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Colombo",
"Asia/Damascus",
"Asia/Dhaka",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Kolkata",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Kuwait",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Muscat",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Phnom_Penh",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qatar",
"Asia/Qostanay",
"Asia/Qyzylorda",
"Asia/Riyadh",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Shanghai",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Urumqi",
"Asia/Ust-Nera",
"Asia/Vientiane",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yangon",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/St_Helena",
"Atlantic/Stanley",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lindeman",
"Australia/Lord_Howe",
"Australia/Melbourne",
"Australia/Perth",
"Australia/Sydney",
"Canada/Atlantic",
"Canada/Central",
"Canada/Eastern",
"Canada/Mountain",
"Canada/Newfoundland",
"Canada/Pacific",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Bratislava",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Busingen",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Dublin",
"Europe/Gibraltar",
"Europe/Guernsey",
"Europe/Helsinki",
"Europe/Isle_of_Man",
"Europe/Istanbul",
"Europe/Jersey",
"Europe/Kaliningrad",
"Europe/Kirov",
"Europe/Kyiv",
"Europe/Lisbon",
"Europe/Ljubljana",
"Europe/London",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Mariehamn",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Oslo",
"Europe/Paris",
"Europe/Podgorica",
"Europe/Prague",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/San_Marino",
"Europe/Sarajevo",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Skopje",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Vaduz",
"Europe/Vatican",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zagreb",
"Europe/Zurich",
"GMT",
"Indian/Antananarivo",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Comoro",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Mayotte",
"Indian/Reunion",
"Pacific/Apia",
"Pacific/Auckland",
"Pacific/Bougainville",
"Pacific/Chatham",
"Pacific/Chuuk",
"Pacific/Easter",
"Pacific/Efate",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kanton",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Kwajalein",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Midway",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Pago_Pago",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Saipan",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"US/Alaska",
"US/Arizona",
"US/Central",
"US/Eastern",
"US/Hawaii",
"US/Mountain",
"US/Pacific",
"UTC",
"profile"
]
},
"target_time": {
"type": "string",
"format": "time"
},
"target_days": {
"type": "array",
"items": {
"type": "string",
"enum": [
"friday",
"monday",
"saturday",
"sunday",
"thursday",
"tuesday",
"wednesday"
],
"description": "Days of the week."
},
"nullable": true
}
}
},
"TimeDelayAction": {
"type": "object",
"properties": {
"id": {
"description": "The real ID of an action. Not allowed on create.",
"type": "string",
"example": "123",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"type": "string",
"example": "action-1",
"nullable": true,
"writeOnly": true
},
"type": {
"type": "string",
"enum": [
"time-delay"
]
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"data": {
"$ref": "#/components/schemas/TimeDelayActionData"
}
},
"required": [
"type",
"data"
]
},
"TimeDelayActionData": {
"type": "object",
"properties": {
"unit": {
"description": "aka delay_units in app.",
"type": "string",
"example": "days",
"default": "days",
"enum": [
"days",
"hours",
"minutes"
]
},
"value": {
"type": "integer"
},
"secondary_value": {
"type": "integer",
"nullable": true
},
"timezone": {
"type": "string",
"example": "profile",
"default": "profile",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Addis_Ababa",
"Africa/Algiers",
"Africa/Asmara",
"Africa/Bamako",
"Africa/Bangui",
"Africa/Banjul",
"Africa/Bissau",
"Africa/Blantyre",
"Africa/Brazzaville",
"Africa/Bujumbura",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Douala",
"Africa/El_Aaiun",
"Africa/Freetown",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Johannesburg",
"Africa/Juba",
"Africa/Kampala",
"Africa/Khartoum",
"Africa/Kigali",
"Africa/Kinshasa",
"Africa/Lagos",
"Africa/Libreville",
"Africa/Lome",
"Africa/Luanda",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Malabo",
"Africa/Maputo",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Mogadishu",
"Africa/Monrovia",
"Africa/Nairobi",
"Africa/Ndjamena",
"Africa/Niamey",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Porto-Novo",
"Africa/Sao_Tome",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Anguilla",
"America/Antigua",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Aruba",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc-Sablon",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Cayman",
"America/Chicago",
"America/Chihuahua",
"America/Ciudad_Juarez",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Curacao",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Dominica",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Fort_Nelson",
"America/Fortaleza",
"America/Glace_Bay",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Grenada",
"America/Guadeloupe",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Indianapolis",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/Kralendijk",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Lower_Princes",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Marigot",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Montserrat",
"America/Nassau",
"America/New_York",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Nuuk",
"America/Ojinaga",
"America/Panama",
"America/Paramaribo",
"America/Phoenix",
"America/Port-au-Prince",
"America/Port_of_Spain",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Punta_Arenas",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Rio_Branco",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Barthelemy",
"America/St_Johns",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Tijuana",
"America/Toronto",
"America/Tortola",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Antarctica/McMurdo",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Arctic/Longyearbyen",
"Asia/Aden",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Bahrain",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Colombo",
"Asia/Damascus",
"Asia/Dhaka",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Kolkata",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Kuwait",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Muscat",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Phnom_Penh",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qatar",
"Asia/Qostanay",
"Asia/Qyzylorda",
"Asia/Riyadh",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Shanghai",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Urumqi",
"Asia/Ust-Nera",
"Asia/Vientiane",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yangon",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/St_Helena",
"Atlantic/Stanley",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lindeman",
"Australia/Lord_Howe",
"Australia/Melbourne",
"Australia/Perth",
"Australia/Sydney",
"Canada/Atlantic",
"Canada/Central",
"Canada/Eastern",
"Canada/Mountain",
"Canada/Newfoundland",
"Canada/Pacific",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Bratislava",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Busingen",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Dublin",
"Europe/Gibraltar",
"Europe/Guernsey",
"Europe/Helsinki",
"Europe/Isle_of_Man",
"Europe/Istanbul",
"Europe/Jersey",
"Europe/Kaliningrad",
"Europe/Kirov",
"Europe/Kyiv",
"Europe/Lisbon",
"Europe/Ljubljana",
"Europe/London",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Mariehamn",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Oslo",
"Europe/Paris",
"Europe/Podgorica",
"Europe/Prague",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/San_Marino",
"Europe/Sarajevo",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Skopje",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Vaduz",
"Europe/Vatican",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zagreb",
"Europe/Zurich",
"GMT",
"Indian/Antananarivo",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Comoro",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Mayotte",
"Indian/Reunion",
"Pacific/Apia",
"Pacific/Auckland",
"Pacific/Bougainville",
"Pacific/Chatham",
"Pacific/Chuuk",
"Pacific/Easter",
"Pacific/Efate",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kanton",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Kwajalein",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Midway",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Pago_Pago",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Saipan",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"US/Alaska",
"US/Arizona",
"US/Central",
"US/Eastern",
"US/Hawaii",
"US/Mountain",
"US/Pacific",
"UTC",
"profile"
]
},
"delay_until_time": {
"type": "string",
"format": "time",
"nullable": true
},
"delay_until_weekdays": {
"type": "array",
"items": {
"type": "string",
"enum": [
"friday",
"monday",
"saturday",
"sunday",
"thursday",
"tuesday",
"wednesday"
],
"description": "Days of the week."
},
"nullable": true
}
},
"required": [
"value"
]
},
"TriggerBranchAction": {
"type": "object",
"properties": {
"id": {
"description": "The real ID of an action. Not allowed on create.",
"type": "string",
"example": "123",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"type": "string",
"example": "action-1",
"nullable": true,
"writeOnly": true
},
"type": {
"type": "string",
"enum": [
"trigger-split"
]
},
"links": {
"$ref": "#/components/schemas/BooleanBranchLinks",
"nullable": true
},
"data": {
"$ref": "#/components/schemas/TriggerBranchActionData",
"nullable": true
}
},
"required": [
"type"
]
},
"TriggerBranchActionData": {
"type": "object",
"properties": {
"trigger_filter": {
"type": "object",
"nullable": true,
"properties": {
"condition_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/MetricPropertyCondition"
},
{
"$ref": "#/components/schemas/CustomObjectTriggerCondition"
},
{
"$ref": "#/components/schemas/CustomObjectPropertyCondition"
},
{
"$ref": "#/components/schemas/PriceDropCondition"
},
{
"$ref": "#/components/schemas/LowInventoryCondition"
}
]
}
}
},
"required": [
"conditions"
]
}
}
},
"required": [
"condition_groups"
]
},
"trigger_id": {
"type": "string"
},
"trigger_type": {
"description": "Trigger type.",
"type": "string",
"enum": [
"date",
"list",
"low-inventory",
"metric",
"price-drop",
"scheduled",
"segment"
]
},
"trigger_subtype": {
"description": "Date trigger type.",
"type": "string",
"enum": [
"custom-object",
"legacy-custom-object",
"profile-property",
"profile-trait"
],
"nullable": true
}
},
"required": [
"trigger_filter",
"trigger_id",
"trigger_type"
]
},
"UpdateProfileAction": {
"type": "object",
"properties": {
"id": {
"description": "The real ID of an action. Not allowed on create.",
"type": "string",
"example": "123",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"type": "string",
"example": "action-1",
"nullable": true,
"writeOnly": true
},
"type": {
"type": "string",
"enum": [
"update-profile"
]
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"data": {
"description": "The maximum allowed sum of profile strings is 100KB.",
"$ref": "#/components/schemas/UpdateProfileActionData",
"nullable": true
}
},
"required": [
"type"
]
},
"UpdateProfileActionData": {
"type": "object",
"properties": {
"profile_operations": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ProfileOperationUpdateOrCreateString"
},
{
"$ref": "#/components/schemas/ProfileOperationUpdateOrCreateBoolean"
},
{
"$ref": "#/components/schemas/ProfileOperationUpdateOrCreateNumeric"
},
{
"$ref": "#/components/schemas/ProfileOperationUpdateOrCreateDate"
},
{
"$ref": "#/components/schemas/ProfileOperationUpdateOrCreateList"
},
{
"$ref": "#/components/schemas/ProfileOperationDelete"
}
]
}
},
"status": {
"description": "Flow action status.",
"type": "string",
"example": "draft",
"default": "draft",
"enum": [
"disabled",
"draft",
"live",
"manual"
]
}
},
"required": [
"profile_operations"
]
},
"UtmParam": {
"type": "object",
"properties": {
"param": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"param",
"value"
]
}
},
"securitySchemes": {
"Klaviyo-API-Key": {
"type": "apiKey",
"in": "header",
"name": "Authorization",
"description": "Private key authentication for /api/ endpoints is performed by setting the `Authorization` header to `Klaviyo-API-Key your-private-api-key`
For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#authentication",
"x-default": "Klaviyo-API-Key your-private-api-key"
}
}
},
"tags": [
{
"name": "Flows",
"description": "flows"
}
]
}