# Update Flow Action Update a flow action.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_flow_action.json) # OpenAPI definition ```json { "openapi": "3.0.2", "info": { "title": "Flows API", "version": "2026-07-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" } ], "paths": { "/api/flow-actions/{id}": { "patch": { "operationId": "update_flow_action", "summary": "Update Flow Action", "description": "Update a flow action.

*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_flow_action.json)", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "fields[flow-action]", "in": "query", "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-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.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.automation_id", "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.expiry_hours", "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.message_hierarchy", "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.vendor_id", "definition.data.main_action.data.message.video_asset_id", "definition.data.main_action.data.message.web_url", "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.automation_id", "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.expiry_hours", "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.message_hierarchy", "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.message.web_url", "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": "revision", "in": "header", "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])", "required": true, "schema": { "type": "string", "default": "2026-07-15" } } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/FlowActionUpdateQuery" } } } }, "responses": { "200": { "description": "Success", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/PatchFlowActionEncodedResponse" } } } }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } }, "tags": [ "Flows" ], "x-klaviyo-pre-release": "None", "x-klaviyo-ratelimit": { "burst": "3/s", "steady": "60/m" }, "x-klaviyo-scopes": [ "flows:write" ] } } }, "components": { "schemas": { "FlowEnum": { "type": "string", "enum": [ "flow" ] }, "FlowMessageEnum": { "type": "string", "enum": [ "flow-message" ] }, "FlowActionEnum": { "type": "string", "enum": [ "flow-action" ] }, "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" ] }, "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" ] }, "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": { "oneOf": [ { "$ref": "#/components/schemas/StaticDateFilter" }, { "$ref": "#/components/schemas/StaticDateRangeFilter" }, { "$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter" }, { "$ref": "#/components/schemas/RelativeDateRangeFilter" } ] } }, "required": [ "type", "is_member", "group_ids" ] }, "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" ] }, "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" ] }, "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" ] }, "AlltimeDateFilter": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "date" ] }, "operator": { "description": "Operators for alltime date filters.", "type": "string", "enum": [ "alltime" ] } }, "required": [ "type", "operator" ] }, "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" } }, "required": [ "type", "operator", "value" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" } }, "required": [ "type", "operator", "value" ] }, "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" ] }, "ProfileMetricPropertyFilter": { "type": "object", "properties": { "property": { "type": "string" }, "filter": { "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", "filter" ] }, "HasEmailMarketing": { "type": "object", "properties": { "subscription": { "type": "string", "enum": [ "any" ] } }, "required": [ "subscription" ] }, "DoubleOptinFilter": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "is_double_opt_in" ] }, "filter": { "$ref": "#/components/schemas/BooleanFilter" } }, "required": [ "field", "filter" ] }, "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" ] }, "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" ] }, "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" ] }, "EqualsStringFilter": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string" ] }, "operator": { "type": "string", "enum": [ "equals" ] }, "value": { "type": "string" } }, "required": [ "type", "operator", "value" ] }, "CustomSourceFilter": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "custom_source" ] }, "filter": { "$ref": "#/components/schemas/EqualsStringFilter" } }, "required": [ "field", "filter" ] }, "InStringArrayFilter": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string" ] }, "operator": { "type": "string", "enum": [ "in" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "type", "operator", "value" ] }, "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" } }, "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" } }, "required": [ "field", "method" ] }, "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" } }, "required": [ "field", "method" ] }, "InboundMessageMethodFilter": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "method" ] }, "method": { "type": "string", "enum": [ "inbound_message" ] } }, "required": [ "field", "method" ] }, "BackInStockMethodFilter": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "method" ] }, "method": { "type": "string", "enum": [ "back_in_stock" ] } }, "required": [ "field", "method" ] }, "SftpMethodFilter": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "method" ] }, "method": { "type": "string", "enum": [ "sftp" ] } }, "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" } }, "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" } }, "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" ] }, "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" } ] } } }, "required": [ "subscription" ] }, "HasEmailMarketingNeverSubscribed": { "type": "object", "properties": { "subscription": { "type": "string", "enum": [ "never_subscribed" ] } }, "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" ] }, "IsSetExistenceFilter": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "existence" ] }, "operator": { "type": "string", "enum": [ "is-set" ] } }, "required": [ "type", "operator" ] }, "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" ] }, "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" ] }, "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" ] }, "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" } ] } } }, "required": [ "subscription" ] }, "PreferencePageMethodFilter": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "method" ] }, "method": { "type": "string", "enum": [ "preference_page" ] } }, "required": [ "field", "method" ] }, "ManualRemoveMethodFilter": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "method" ] }, "method": { "type": "string", "enum": [ "manual_remove" ] } }, "required": [ "field", "method" ] }, "SpamComplaintMethodFilter": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "method" ] }, "method": { "type": "string", "enum": [ "spam_complaint" ] } }, "required": [ "field", "method" ] }, "MailboxProviderMethodFilter": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "method" ] }, "method": { "type": "string", "enum": [ "mailbox_provider" ] } }, "required": [ "field", "method" ] }, "OneClickUnsubscribeMethodFilter": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "method" ] }, "method": { "type": "string", "enum": [ "one_click_unsubscribe" ] } }, "required": [ "field", "method" ] }, "ManualImportMethodFilter": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "method" ] }, "method": { "type": "string", "enum": [ "manual_import" ] } }, "required": [ "field", "method" ] }, "DataWarehouseImportMethodFilter": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "method" ] }, "method": { "type": "string", "enum": [ "data_warehouse_import" ] } }, "required": [ "field", "method" ] }, "ProfileModificationMethodFilter": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "method" ] }, "method": { "type": "string", "enum": [ "profile_modification" ] } }, "required": [ "field", "method" ] }, "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" ] }, "NoEmailMarketingUnsubscribed": { "type": "object", "properties": { "subscription": { "type": "string", "enum": [ "unsubscribed" ] }, "filters": { "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" ] }, "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" ] }, "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" ] }, "CheckoutMethodFilter": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "method" ] }, "method": { "type": "string", "enum": [ "checkout" ] } }, "required": [ "field", "method" ] }, "SubscribedSMSIsRcsCapableFilter": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "is_rcs_capable" ] }, "filter": { "$ref": "#/components/schemas/BooleanFilter" } }, "required": [ "field", "filter" ] }, "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" } ] } } }, "required": [ "subscription" ] }, "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" ] }, "NoSMSMarketing": { "type": "object", "properties": { "subscription": { "type": "string", "enum": [ "any" ] } }, "required": [ "subscription" ] }, "BulkRemoveMethodFilter": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "method" ] }, "method": { "type": "string", "enum": [ "bulk_remove" ] } }, "required": [ "field", "method" ] }, "CarrierDeactivationMethodFilter": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "method" ] }, "method": { "type": "string", "enum": [ "carrier_deactivation" ] } }, "required": [ "field", "method" ] }, "ProvidedLandlineMethodFilter": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "method" ] }, "method": { "type": "string", "enum": [ "provided_landline" ] } }, "required": [ "field", "method" ] }, "MessageBlockedMethodFilter": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "method" ] }, "method": { "type": "string", "enum": [ "message_blocked" ] } }, "required": [ "field", "method" ] }, "ProvidedNoAgeMethodFilter": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "method" ] }, "method": { "type": "string", "enum": [ "provided_no_age" ] } }, "required": [ "field", "method" ] }, "FailedAgeGateMethodFilter": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "method" ] }, "method": { "type": "string", "enum": [ "failed_age_gate" ] } }, "required": [ "field", "method" ] }, "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" } ] } } }, "required": [ "subscription" ] }, "NoSMSMarketingNeverSubscribed": { "type": "object", "properties": { "subscription": { "type": "string", "enum": [ "never_subscribed" ] } }, "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" ] }, "HasPushMarketing": { "type": "object", "properties": { "subscription": { "type": "string", "enum": [ "any" ] }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/StatusDateFilter" } } }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "StringPhoneOperatorStringArrayFilter": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string" ] }, "operator": { "description": "Operators for phone string array filters.\n\nExample condition using this filter:\n {\n \"type\": \"profile-property\",\n \"field\": \"phone\",\n \"filter\": {\n \"type\": \"string\",\n \"operator\": \"phone-country-code-in\",\n \"value\": [\"US\", \"GB\"]\n }\n }", "type": "string", "enum": [ "phone-country-code-in", "phone-country-code-not-in" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "type", "operator", "value" ] }, "ListContainsOperatorListContainsFilter": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "list" ] }, "operator": { "description": "Operators for list contains filters.", "type": "string", "enum": [ "contains", "not-contains" ] }, "value": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] } }, "required": [ "type", "operator", "value" ] }, "ProfilePropertyCondition": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "profile-property" ] }, "property": { "description": "The profile property to check. Use one of the well-known property names (e.g. `email`, `first_name`) or, for custom profile properties, the form `properties['property name']`.", "type": "string", "example": "properties['Favorite Color']" }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "ProfilePredictiveAnalyticsChannelAffinityPriorityFilter": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "numeric" ] }, "operator": { "type": "string", "enum": [ "equals" ] }, "value": { "type": "integer" } }, "required": [ "type", "operator", "value" ] }, "ProfilePredictiveAnalyticsChannelAffinityPriorityCondition": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "profile-predictive-analytics" ] }, "dimension": { "description": "Possible dimension for channel affinity criterion.", "type": "string", "enum": [ "channel_affinity" ] }, "measurement": { "type": "string", "enum": [ "priority" ] }, "predicted_channel": { "description": "Possible channels in a channel affinity definition.", "type": "string", "enum": [ "email", "push", "sms", "whatsapp" ] }, "filter": { "$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityPriorityFilter" } }, "required": [ "type", "dimension", "measurement", "predicted_channel", "filter" ] }, "ProfilePredictiveAnalyticsChannelAffinityRankFilter": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string" ] }, "operator": { "oneOf": [ { "enum": [ "equals" ], "type": "string" }, { "enum": [ "not-equals" ], "type": "string" } ] }, "value": { "description": "Possible rank values in a channel affinity definition.", "type": "string", "enum": [ "high", "low", "medium" ] } }, "required": [ "type", "operator", "value" ] }, "ProfilePredictiveAnalyticsChannelAffinityRankCondition": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "profile-predictive-analytics" ] }, "dimension": { "description": "Possible dimension for channel affinity criterion.", "type": "string", "enum": [ "channel_affinity" ] }, "measurement": { "type": "string", "enum": [ "rank" ] }, "predicted_channel": { "description": "Possible channels in a channel affinity definition.", "type": "string", "enum": [ "email", "push", "sms", "whatsapp" ] }, "filter": { "$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityRankFilter" } }, "required": [ "type", "dimension", "measurement", "predicted_channel", "filter" ] }, "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" ] }, "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" ] }, "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/ListContainsOperatorListContainsFilter" }, { "$ref": "#/components/schemas/ListLengthFilter" }, { "$ref": "#/components/schemas/ExistenceOperatorExistenceFilter" } ] } }, "required": [ "property_id", "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" } }, "required": [ "field", "method" ] }, "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" ] }, "ImplicitlyReachable": { "type": "object", "properties": { "reachable_status": { "type": "string", "enum": [ "implicitly_reachable" ] } }, "required": [ "reachable_status" ] }, "ImplicitlyOrExplicitlyReachable": { "type": "object", "properties": { "reachable_status": { "type": "string", "enum": [ "implicitly_or_explicitly_reachable" ] } }, "required": [ "reachable_status" ] }, "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" ] }, "ImplicitlyUnreachable": { "type": "object", "properties": { "reachable_status": { "type": "string", "enum": [ "implicitly_unreachable" ] } }, "required": [ "reachable_status" ] }, "ImplicitlyOrExplicitlyUnreachable": { "type": "object", "properties": { "reachable_status": { "type": "string", "enum": [ "implicitly_or_explicitly_unreachable" ] } }, "required": [ "reachable_status" ] }, "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" ] }, "BooleanBranchLinks": { "type": "object", "properties": { "next_if_true": { "type": "string" }, "next_if_false": { "type": "string" } } }, "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" ] }, "ActionOutputSplitActionData": { "type": "object", "properties": { "action_output_filter": { "type": "object", "properties": { "condition_groups": { "type": "array", "items": { "type": "object", "properties": { "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionOutputCondition" } } }, "required": [ "conditions" ] } } }, "required": [ "condition_groups" ] } }, "required": [ "action_output_filter" ] }, "ActionOutputSplitAction": { "type": "object", "properties": { "id": { "description": "The real ID of an action. Not allowed on create.", "type": "string", "example": "123" }, "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", "writeOnly": true }, "type": { "type": "string", "enum": [ "action-output-split" ] }, "links": { "$ref": "#/components/schemas/BooleanBranchLinks" }, "data": { "$ref": "#/components/schemas/ActionOutputSplitActionData" } }, "required": [ "type" ] }, "Link": { "type": "object", "properties": { "next": { "type": "string" } } }, "BackInStockDelayAction": { "type": "object", "properties": { "id": { "description": "The real ID of an action. Not allowed on create.", "type": "string", "example": "123" }, "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", "writeOnly": true }, "type": { "type": "string", "enum": [ "back-in-stock-delay" ] }, "links": { "$ref": "#/components/schemas/Link" } }, "required": [ "type" ] }, "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" ] }, "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" } } }, "required": [ "type", "metric_id", "measurement", "measurement_filter", "timeframe_filter" ] }, "ProfileRandomSampleCondition": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "profile-sample" ] }, "percentage": { "type": "integer" } }, "required": [ "type", "percentage" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "ConditionalBranchActionData": { "type": "object", "properties": { "profile_filter": { "type": "object", "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/ProfilePredictiveAnalyticsChannelAffinityPriorityCondition" }, { "$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityRankCondition" }, { "$ref": "#/components/schemas/ProfileMarketingConsentCondition" }, { "$ref": "#/components/schemas/FlowsProfileMetricCondition" }, { "$ref": "#/components/schemas/ProfileRandomSampleCondition" }, { "$ref": "#/components/schemas/ProfileHasCustomObjectCondition" }, { "$ref": "#/components/schemas/ProfilePermissionsCondition" }, { "$ref": "#/components/schemas/ProfileHasNotReceivedEmailMessageCondition" }, { "$ref": "#/components/schemas/ProfileHasNotReceivedSmsMessageCondition" }, { "$ref": "#/components/schemas/ProfileHasNotReceivedPushMessageCondition" } ] } } }, "required": [ "conditions" ] } } }, "required": [ "condition_groups" ] } }, "required": [ "profile_filter" ] }, "ConditionalBranchAction": { "type": "object", "properties": { "id": { "description": "The real ID of an action. Not allowed on create.", "type": "string", "example": "123" }, "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", "writeOnly": true }, "type": { "type": "string", "enum": [ "conditional-split" ] }, "links": { "$ref": "#/components/schemas/BooleanBranchLinks" }, "data": { "$ref": "#/components/schemas/ConditionalBranchActionData" } }, "required": [ "type" ] }, "Increment": { "type": "object", "properties": { "badge_config": { "type": "string", "enum": [ "increment_one" ] } }, "required": [ "badge_config" ] }, "StaticCount": { "type": "object", "properties": { "badge_config": { "type": "string", "enum": [ "set_count" ] }, "value": { "type": "string" } }, "required": [ "badge_config", "value" ] }, "Property": { "type": "object", "properties": { "badge_config": { "type": "string", "enum": [ "set_property" ] }, "set_from_property": { "type": "string" } }, "required": [ "badge_config", "set_from_property" ] }, "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" }, "url": { "type": "string" }, "icon": { "type": "string" }, "custom_action_id": { "type": "string" }, "ios_deep_link": { "type": "string" }, "android_deep_link": { "type": "string" } }, "required": [ "label", "action_type" ] }, "FlowPushNotification": { "type": "object", "properties": { "title": { "type": "string" }, "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" }, "dynamic_image": { "description": "A dynamic image asset to include in the push notification.", "type": "string", "example": "{{ event.items.0.url }}" }, "video_asset_id": { "description": "The ULID of a video asset. If provided, videos and images are mutually exclusive.", "type": "string", "example": "01ARZ3NDEKTSV4RRFFQ69G5FAV" }, "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", "open_url" ] }, "ios_link": { "type": "string" }, "android_link": { "type": "string" }, "web_url": { "type": "string" }, "push_type": { "description": "The type of push notification to send.", "type": "string", "enum": [ "silent", "standard" ] }, "kv_pairs": { "type": "object" }, "conversion_metric_id": { "type": "string" }, "smart_sending_enabled": { "type": "boolean", "example": true, "default": true }, "additional_filters": { "type": "object", "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/ProfilePredictiveAnalyticsChannelAffinityPriorityCondition" }, { "$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityRankCondition" }, { "$ref": "#/components/schemas/ProfileMarketingConsentCondition" }, { "$ref": "#/components/schemas/FlowsProfileMetricCondition" }, { "$ref": "#/components/schemas/ProfileRandomSampleCondition" }, { "$ref": "#/components/schemas/ProfileHasCustomObjectCondition" }, { "$ref": "#/components/schemas/ProfilePermissionsCondition" }, { "$ref": "#/components/schemas/ProfileHasNotReceivedEmailMessageCondition" }, { "$ref": "#/components/schemas/ProfileHasNotReceivedSmsMessageCondition" }, { "$ref": "#/components/schemas/ProfileHasNotReceivedPushMessageCondition" } ] } } }, "required": [ "conditions" ] } } }, "required": [ "condition_groups" ] }, "action_buttons": { "type": "array", "items": { "$ref": "#/components/schemas/PushActionButton" } }, "name": { "type": "string" }, "id": { "description": "Not allowed on create.", "type": "string" } }, "required": [ "body" ] }, "SendPushNotificationActionData": { "type": "object", "properties": { "message": { "$ref": "#/components/schemas/FlowPushNotification" }, "status": { "description": "Flow action status.", "type": "string", "example": "draft", "default": "draft", "enum": [ "disabled", "draft", "live", "manual" ] } } }, "SendPushNotificationAction": { "type": "object", "properties": { "id": { "description": "The real ID of an action. Not allowed on create.", "type": "string", "example": "123" }, "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", "writeOnly": true }, "type": { "type": "string", "enum": [ "send-mobile-push" ] }, "links": { "$ref": "#/components/schemas/Link" }, "data": { "$ref": "#/components/schemas/SendPushNotificationActionData" } }, "required": [ "type" ] }, "FlowWhatsApp": { "type": "object", "properties": { "id": { "description": "Not allowed on create.", "type": "string" }, "name": { "type": "string" }, "vendor_id": { "type": "string" }, "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", "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/ProfilePredictiveAnalyticsChannelAffinityPriorityCondition" }, { "$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityRankCondition" }, { "$ref": "#/components/schemas/ProfileMarketingConsentCondition" }, { "$ref": "#/components/schemas/FlowsProfileMetricCondition" }, { "$ref": "#/components/schemas/ProfileRandomSampleCondition" }, { "$ref": "#/components/schemas/ProfileHasCustomObjectCondition" }, { "$ref": "#/components/schemas/ProfilePermissionsCondition" }, { "$ref": "#/components/schemas/ProfileHasNotReceivedEmailMessageCondition" }, { "$ref": "#/components/schemas/ProfileHasNotReceivedSmsMessageCondition" }, { "$ref": "#/components/schemas/ProfileHasNotReceivedPushMessageCondition" } ] } } }, "required": [ "conditions" ] } } }, "required": [ "condition_groups" ] }, "automation_id": { "type": "string" }, "expiry_hours": { "type": "integer" } } }, "SendWhatsAppActionData": { "type": "object", "properties": { "message": { "$ref": "#/components/schemas/FlowWhatsApp" }, "status": { "description": "Flow action status.", "type": "string", "example": "draft", "default": "draft", "enum": [ "disabled", "draft", "live", "manual" ] } } }, "SendWhatsAppAction": { "type": "object", "properties": { "id": { "description": "The real ID of an action. Not allowed on create.", "type": "string", "example": "123" }, "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", "writeOnly": true }, "type": { "type": "string", "enum": [ "send-whatsapp" ] }, "links": { "$ref": "#/components/schemas/Link" }, "data": { "$ref": "#/components/schemas/SendWhatsAppActionData" } }, "required": [ "type" ] }, "ContentExperimentAction": { "type": "object", "properties": { "id": { "description": "The real ID of an action. Not allowed on create.", "type": "string", "example": "123" }, "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", "writeOnly": true }, "type": { "type": "string", "enum": [ "content-experiment" ] }, "links": { "$ref": "#/components/schemas/Link" }, "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", "enum": [ "completed", "draft", "live" ] }, "main_action": { "oneOf": [ { "$ref": "#/components/schemas/SendPushNotificationAction" }, { "$ref": "#/components/schemas/SendWhatsAppAction" } ] }, "current_experiment": { "type": "object", "properties": { "id": { "description": "Not allowed on create.", "type": "string" }, "name": { "type": "string" }, "variations": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/SendPushNotificationAction" }, { "$ref": "#/components/schemas/SendWhatsAppAction" } ] } }, "allocations": { "type": "object" }, "started": { "type": "string", "format": "date-time", "example": "2022-11-08T00:00:00+00:00", "readOnly": true }, "winner_metric": { "description": "The metric to use to determine the winner of the content experiment\n action.", "type": "string", "enum": [ "click-rate", "open-rate" ] } }, "required": [ "variations" ] } }, "required": [ "main_action" ] } }, "required": [ "type", "data" ] }, "UtmParam": { "type": "object", "properties": { "param": { "type": "string" }, "value": { "type": "string" } }, "required": [ "param", "value" ] }, "FlowEmail": { "type": "object", "properties": { "from_email": { "type": "string" }, "from_label": { "type": "string" }, "reply_to_email": { "type": "string" }, "cc_email": { "type": "string" }, "bcc_email": { "type": "string" }, "subject_line": { "type": "string" }, "preview_text": { "type": "string" }, "template_id": { "type": "string" }, "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" } }, "additional_filters": { "type": "object", "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/ProfilePredictiveAnalyticsChannelAffinityPriorityCondition" }, { "$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityRankCondition" }, { "$ref": "#/components/schemas/ProfileMarketingConsentCondition" }, { "$ref": "#/components/schemas/FlowsProfileMetricCondition" }, { "$ref": "#/components/schemas/ProfileRandomSampleCondition" }, { "$ref": "#/components/schemas/ProfileHasCustomObjectCondition" }, { "$ref": "#/components/schemas/ProfilePermissionsCondition" }, { "$ref": "#/components/schemas/ProfileHasNotReceivedEmailMessageCondition" }, { "$ref": "#/components/schemas/ProfileHasNotReceivedSmsMessageCondition" }, { "$ref": "#/components/schemas/ProfileHasNotReceivedPushMessageCondition" } ] } } }, "required": [ "conditions" ] } } }, "required": [ "condition_groups" ] }, "name": { "type": "string" }, "id": { "description": "Not allowed on create.", "type": "string" } } }, "SendEmailActionData": { "type": "object", "properties": { "message": { "$ref": "#/components/schemas/FlowEmail" }, "status": { "description": "Flow action status.", "type": "string", "example": "draft", "default": "draft", "enum": [ "disabled", "draft", "live", "manual" ] } } }, "SendEmailAction": { "type": "object", "properties": { "id": { "description": "The real ID of an action. Not allowed on create.", "type": "string", "example": "123" }, "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", "writeOnly": true }, "type": { "type": "string", "enum": [ "send-email" ] }, "links": { "$ref": "#/components/schemas/Link" }, "data": { "$ref": "#/components/schemas/SendEmailActionData" } }, "required": [ "type" ] }, "ImageAsset": { "type": "object", "properties": { "id": { "description": "The unique identifier for this image asset. Not allowed on update.", "type": "integer" }, "file_path": { "description": "The file path of the image in Klaviyo's storage.", "type": "string", "example": "images/aa1ee5c1-039e-4d20-9e98-345755214556.jpeg" }, "name": { "description": "The human-readable name of the image.", "type": "string", "example": "product-image" }, "format": { "description": "The image file format.", "type": "string", "enum": [ "gif", "jpeg", "jpg", "png", "webp" ] }, "file_size": { "description": "The size of the image file in bytes.", "type": "integer" }, "updated": { "description": "Timestamp when the image was last updated.", "type": "string", "format": "date-time", "example": "2022-11-08T00:00:00+00:00" }, "origin": { "description": "The origin/source of the image (e.g., UI, API, AI, etc.).", "type": "string", "enum": [ "ADOPTION_SMS_FORM_FROM_EMAIL_FORM", "ADOPTION_SMS_MULTI_STEP_FORM_FROM_EMAIL_FORM", "AI", "API", "APPLICATION", "CLONED", "COMPOSER", "COMPOSER_AI_EDITED", "COMPOSER_AI_GENERATED", "COMPOSER_USED_IN_KLAVIYO_OBJECT", "COMPOSER_USER_UPLOADED", "COMPOSER_WEB_SCRAPED", "INTEGRATION", "KLAVIYO", "LIBRARY", "MARKETING_AGENT", "SOCIAL_INSTAGRAM", "SOCIAL_INSTAGRAM_OVERLAID", "UI", "WEB_SCRAPE" ] }, "url": { "description": "The full URL to access the image.", "type": "string", "example": "https://d3k81ch9hvuctc.cloudfront.net/company/RyGRiN/images/aa1ee5c1-039e-4d20-9e98-345755214556.jpeg" }, "image_type": { "description": "The type of image (static or dynamic).", "type": "string", "enum": [ "dynamic", "static" ] }, "l10n_key": { "description": "Localization key for this image asset, if applicable.", "type": "string", "example": "sms::01KAPBZTQBAJFD5RG9NYXBWHMR::mms_static_image_asset_id" } }, "required": [ "id", "file_path", "name", "format", "file_size", "updated", "url", "image_type" ] }, "SlimImageReference": { "type": "object", "properties": { "static_image_asset_id": { "description": "ID of the static image asset when the card uses a library image.", "type": "integer" }, "dynamic_image_template": { "description": "Dynamic image template (e.g. Django tags) for the card image.", "type": "string" }, "rendered_asset_url": { "description": "Pre-rendered image URL when available.", "type": "string" } } }, "MediaAsset": { "type": "object", "properties": { "id": { "description": "The unique identifier for this media asset. Not allowed on update.", "type": "string" }, "company_id": { "description": "The company ID that owns this media.", "type": "string", "example": "RyGRiN" }, "url": { "description": "The full URL to access the media.", "type": "string", "example": "https://d3k81ch9hvuctc.cloudfront.net/company/RyGRiN/videos/01KG5BPQBSY8F12ZWTGYHPPRXC.mp4" }, "media_type": { "description": "The media type (e.g., 'video' for video assets).", "type": "string", "example": "video", "default": "video" }, "name": { "description": "The human-readable name of the media.", "type": "string", "example": "demo video.1" }, "file_size": { "description": "The size of the media file in bytes.", "type": "integer" }, "thumbnail_url": { "description": "Optional thumbnail URL for video previews in RCS cards.", "type": "string" }, "l10n_key": { "description": "Localization key for this media asset, if applicable.", "type": "string" } }, "required": [ "id", "company_id", "url", "name", "file_size" ] }, "MediaAssetReference": { "type": "object", "properties": { "static_asset_id": { "description": "Reference to a static media asset.", "type": "string" }, "dynamic_template": { "description": "Dynamic template (e.g. Django tags) resolving to the media URL.", "type": "string" }, "thumbnail": { "description": "Optional thumbnail image reference for video media.", "$ref": "#/components/schemas/SlimImageReference" } } }, "RCSSuggestion": { "type": "object", "properties": { "id": { "description": "Unique identifier for this suggestion/button.", "type": "string", "example": "quick-action-1767105662671" }, "text": { "description": "The display text for the suggestion button. 25 characters is the rendered-length budget; the stored value may be longer because it is template-evaluated before it reaches the carrier.", "type": "string", "example": "Shop Now" }, "type": { "description": "The type of action this suggestion performs.", "type": "string", "enum": [ "OPEN_URL", "REPLY" ] }, "url": { "description": "The URL to open (required for OPEN_URL type).", "type": "string", "example": "https://www.example.com/shop" }, "open_mode": { "description": "How the URL opens on the device for OPEN_URL suggestions (browser vs webview size). Emitted to Infobip as openIn. Absent means browser.", "type": "string", "example": "WEBVIEW_FULL", "enum": [ "BROWSER", "WEBVIEW_FULL", "WEBVIEW_HALF", "WEBVIEW_TALL" ] } }, "required": [ "id", "text", "type" ] }, "RCSCard": { "type": "object", "properties": { "id": { "description": "Unique identifier for this card.", "type": "string", "example": "44214e8f-a2fb-43b1-a8e1-1170715ffcfa" }, "title": { "description": "Optional title for the card. 200 characters is the rendered-length budget; the stored value may be longer because it is template-evaluated before it reaches the carrier.", "type": "string", "example": "Special Offer" }, "text": { "description": "The text content/description of the card. 2000 characters is the rendered-length budget; the stored value may be longer because it is template-evaluated before it reaches the carrier.", "type": "string", "example": "Check out our new collection!" }, "extra": { "description": "Additional card-specific metadata (e.g., product info). Optional.", "type": "object" }, "image": { "description": "Optional image for this card.", "oneOf": [ { "$ref": "#/components/schemas/ImageAsset" }, { "$ref": "#/components/schemas/SlimImageReference" } ] }, "video": { "description": "Optional video for this card. May be a hydrated MediaAsset or a reference-style payload (e.g. static_asset_id), matching MMS ``MessageHierarchySmsItem.media`` behavior.", "oneOf": [ { "$ref": "#/components/schemas/MediaAsset" }, { "$ref": "#/components/schemas/MediaAssetReference" } ] }, "buttons": { "description": "Optional action buttons for this card. At most 4.", "type": "array", "items": { "$ref": "#/components/schemas/RCSSuggestion" } } }, "required": [ "id" ] }, "RCSRichContent": { "type": "object", "properties": { "cards": { "description": "List of cards in this rich content. At most 10.", "type": "array", "items": { "$ref": "#/components/schemas/RCSCard" } }, "suggestions": { "description": "List of suggestion buttons for user interaction. At most 11.", "type": "array", "items": { "$ref": "#/components/schemas/RCSSuggestion" } }, "file": { "description": "Standalone media file for RCS messages without cards.", "$ref": "#/components/schemas/MediaAssetReference" } } }, "MessageHierarchyRcsItem": { "type": "object", "properties": { "message": { "description": "The plain text message content. Often empty for RCS when rich_content is used.", "type": "string", "default": "" }, "message_format": { "description": "The format of this message (always 'RCS' for RCS entries).", "type": "string", "example": "RCS", "default": "RCS", "enum": [ "RCS" ] }, "rich_content": { "description": "Rich content for RCS messages (cards, suggestions, etc.).", "$ref": "#/components/schemas/RCSRichContent" }, "extra": { "description": "Additional metadata for RCS messages. Legacy placement. This is typically used in rich_content.cards.extra.", "type": "object" }, "image": { "description": "Legacy top-level image reference on the RCS hierarchy row (MySQL-backed). Prefer rich_content for RCS media going forward.", "$ref": "#/components/schemas/SlimImageReference" } } }, "StaticSMSImage": { "type": "object", "properties": { "dynamic": { "type": "boolean", "default": false, "enum": [ false ] }, "static_image_asset_id": { "description": "The ID of the static image asset to include.", "type": "integer" } }, "required": [ "static_image_asset_id" ] }, "DynamicSMSImage": { "type": "object", "properties": { "dynamic": { "type": "boolean", "example": true, "default": true, "enum": [ true ] }, "dynamic_image_template": { "description": "Dynamic image template URL (e.g., {{product.image_url}}).", "type": "string" } }, "required": [ "dynamic_image_template" ] }, "MessageHierarchySmsItem": { "type": "object", "properties": { "message": { "description": "The plain text SMS message content.", "type": "string", "example": "Check out our latest deals: https://example.com" }, "message_format": { "description": "The format of this message (always 'SMS' for SMS entries).", "type": "string", "example": "SMS", "default": "SMS", "enum": [ "SMS" ] }, "extra": { "description": "Additional metadata for SMS messages (e.g., should_use_same_content flag).", "type": "object" }, "image": { "description": "Image reference for MMS messages. Mutually exclusive with media.", "oneOf": [ { "$ref": "#/components/schemas/StaticSMSImage" }, { "$ref": "#/components/schemas/DynamicSMSImage" } ] }, "media": { "description": "Video media for MMS messages as either a hydrated MediaAsset or a reference-style payload. Mutually exclusive with image.", "oneOf": [ { "$ref": "#/components/schemas/MediaAsset" }, { "$ref": "#/components/schemas/MediaAssetReference" } ] } }, "required": [ "message" ] }, "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" }, "dynamic_image": { "description": "A dynamic image asset to include in the SMS message.", "type": "string", "example": "{{ person|lookup:'image_url' }}" }, "message_hierarchy": { "description": "The message hierarchy (fallback chain): exactly one RCS entry followed by one SMS entry, in priority order. Rendering selects the first entry whose format the recipient supports.", "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/MessageHierarchyRcsItem" }, { "$ref": "#/components/schemas/MessageHierarchySmsItem" } ] } }, "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" } }, "template_id": { "type": "string" }, "additional_filters": { "type": "object", "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/ProfilePredictiveAnalyticsChannelAffinityPriorityCondition" }, { "$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityRankCondition" }, { "$ref": "#/components/schemas/ProfileMarketingConsentCondition" }, { "$ref": "#/components/schemas/FlowsProfileMetricCondition" }, { "$ref": "#/components/schemas/ProfileRandomSampleCondition" }, { "$ref": "#/components/schemas/ProfileHasCustomObjectCondition" }, { "$ref": "#/components/schemas/ProfilePermissionsCondition" }, { "$ref": "#/components/schemas/ProfileHasNotReceivedEmailMessageCondition" }, { "$ref": "#/components/schemas/ProfileHasNotReceivedSmsMessageCondition" }, { "$ref": "#/components/schemas/ProfileHasNotReceivedPushMessageCondition" } ] } } }, "required": [ "conditions" ] } } }, "required": [ "condition_groups" ] }, "name": { "type": "string" }, "id": { "description": "Not allowed on create.", "type": "string" } }, "required": [ "body" ] }, "SendSmsActionData": { "type": "object", "properties": { "message": { "$ref": "#/components/schemas/FlowSms" }, "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" }, "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", "writeOnly": true }, "type": { "type": "string", "enum": [ "send-sms" ] }, "links": { "$ref": "#/components/schemas/Link" }, "data": { "$ref": "#/components/schemas/SendSmsActionData" } }, "required": [ "type" ] }, "FlowWebhook": { "type": "object", "properties": { "url": { "type": "string" }, "headers": { "type": "object" }, "body": { "type": "string" }, "name": { "type": "string" }, "id": { "description": "Not allowed on create.", "type": "string" } }, "required": [ "url" ] }, "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" ] }, "SendWebhookAction": { "type": "object", "properties": { "id": { "description": "The real ID of an action. Not allowed on create.", "type": "string", "example": "123" }, "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", "writeOnly": true }, "type": { "type": "string", "enum": [ "send-webhook" ] }, "links": { "$ref": "#/components/schemas/Link" }, "data": { "$ref": "#/components/schemas/SendWebhookActionData" } }, "required": [ "type" ] }, "FlowInternalAlert": { "type": "object", "properties": { "from_email": { "type": "string" }, "from_label": { "type": "string" }, "to_emails": { "type": "array", "items": { "type": "string" } }, "subject_line": { "type": "string" }, "template_id": { "type": "string" }, "name": { "type": "string" }, "id": { "description": "Not allowed on create.", "type": "string" } }, "required": [ "from_email", "from_label", "to_emails", "subject_line" ] }, "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" ] }, "SendInternalAlertAction": { "type": "object", "properties": { "id": { "description": "The real ID of an action. Not allowed on create.", "type": "string", "example": "123" }, "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", "writeOnly": true }, "type": { "type": "string", "enum": [ "send-internal-alert" ] }, "links": { "$ref": "#/components/schemas/Link" }, "data": { "$ref": "#/components/schemas/SendInternalAlertActionData" } }, "required": [ "type" ] }, "FlowWhatsAppWithAC": { "type": "object", "properties": { "id": { "description": "Not allowed on create.", "type": "string" }, "name": { "type": "string" }, "vendor_id": { "type": "string" }, "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", "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/ProfilePredictiveAnalyticsChannelAffinityPriorityCondition" }, { "$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityRankCondition" }, { "$ref": "#/components/schemas/ProfileMarketingConsentCondition" }, { "$ref": "#/components/schemas/FlowsProfileMetricCondition" }, { "$ref": "#/components/schemas/ProfileRandomSampleCondition" }, { "$ref": "#/components/schemas/ProfileHasCustomObjectCondition" }, { "$ref": "#/components/schemas/ProfilePermissionsCondition" }, { "$ref": "#/components/schemas/ProfileHasNotReceivedEmailMessageCondition" }, { "$ref": "#/components/schemas/ProfileHasNotReceivedSmsMessageCondition" }, { "$ref": "#/components/schemas/ProfileHasNotReceivedPushMessageCondition" } ] } } }, "required": [ "conditions" ] } } }, "required": [ "condition_groups" ] }, "automation_id": { "type": "string" }, "expiry_hours": { "type": "integer" } } }, "SendWhatsAppWithACActionData": { "type": "object", "properties": { "message": { "$ref": "#/components/schemas/FlowWhatsAppWithAC" }, "status": { "description": "Flow action status.", "type": "string", "example": "draft", "default": "draft", "enum": [ "disabled", "draft", "live", "manual" ] } } }, "SendWhatsAppWithACAction": { "type": "object", "properties": { "id": { "description": "The real ID of an action. Not allowed on create.", "type": "string", "example": "123" }, "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", "writeOnly": true }, "type": { "type": "string", "enum": [ "send-whatsapp-with-ac" ] }, "links": { "$ref": "#/components/schemas/Link" }, "data": { "$ref": "#/components/schemas/SendWhatsAppWithACActionData" } }, "required": [ "type" ] }, "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" }, "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" }, "delay_until_weekdays": { "type": "array", "items": { "type": "string", "enum": [ "friday", "monday", "saturday", "sunday", "thursday", "tuesday", "wednesday" ], "description": "Days of the week." } } }, "required": [ "value" ] }, "TimeDelayAction": { "type": "object", "properties": { "id": { "description": "The real ID of an action. Not allowed on create.", "type": "string", "example": "123" }, "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", "writeOnly": true }, "type": { "type": "string", "enum": [ "time-delay" ] }, "links": { "$ref": "#/components/schemas/Link" }, "data": { "$ref": "#/components/schemas/TimeDelayActionData" } }, "required": [ "type", "data" ] }, "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" ] }, "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" ] }, "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" ] }, "PriceDropCondition": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "price-drop-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" ] }, "LowInventoryCondition": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "low-inventory-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" ] }, "TriggerBranchActionData": { "type": "object", "properties": { "trigger_filter": { "type": "object", "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" ] } }, "required": [ "trigger_filter", "trigger_id", "trigger_type" ] }, "TriggerBranchAction": { "type": "object", "properties": { "id": { "description": "The real ID of an action. Not allowed on create.", "type": "string", "example": "123" }, "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", "writeOnly": true }, "type": { "type": "string", "enum": [ "trigger-split" ] }, "links": { "$ref": "#/components/schemas/BooleanBranchLinks" }, "data": { "$ref": "#/components/schemas/TriggerBranchActionData" } }, "required": [ "type" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "property_key": { "type": "string" }, "property_value": { "type": "string" } }, "required": [ "operator", "property_type", "property_key", "property_value" ] }, "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" ] }, "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" ] }, "UpdateProfileAction": { "type": "object", "properties": { "id": { "description": "The real ID of an action. Not allowed on create.", "type": "string", "example": "123" }, "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", "writeOnly": true }, "type": { "type": "string", "enum": [ "update-profile" ] }, "links": { "$ref": "#/components/schemas/Link" }, "data": { "description": "The maximum allowed sum of profile strings is 100KB.", "$ref": "#/components/schemas/UpdateProfileActionData" } }, "required": [ "type" ] }, "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." } } } }, "TargetDateAction": { "type": "object", "properties": { "id": { "description": "The real ID of an action. Not allowed on create.", "type": "string", "example": "123" }, "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", "writeOnly": true }, "type": { "type": "string", "enum": [ "target-date" ] }, "links": { "$ref": "#/components/schemas/Link" }, "data": { "$ref": "#/components/schemas/TargetDateActionData" } }, "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" }, "delay_until_weekdays": { "type": "array", "items": { "type": "string", "enum": [ "friday", "monday", "saturday", "sunday", "thursday", "tuesday", "wednesday" ], "description": "Days of the week." } } } }, "CountdownDelayAction": { "type": "object", "properties": { "id": { "description": "The real ID of an action. Not allowed on create.", "type": "string", "example": "123" }, "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", "writeOnly": true }, "type": { "type": "string", "enum": [ "countdown-delay" ] }, "links": { "$ref": "#/components/schemas/Link" }, "data": { "$ref": "#/components/schemas/CountdownDelayActionData" } }, "required": [ "type", "data" ] }, "AutomaticWinnerSelectionSettings": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "automatic_end_date": { "type": "string", "format": "date-time", "example": "2022-11-08T00:00:00+00:00" }, "automatic_end_statistical_certainty": { "type": "boolean" } }, "required": [ "enabled", "automatic_end_statistical_certainty" ] }, "AbTestAction": { "type": "object", "properties": { "id": { "description": "The real ID of an action. Not allowed on create.", "type": "string", "example": "123" }, "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", "writeOnly": true }, "type": { "type": "string", "enum": [ "ab-test" ] }, "links": { "$ref": "#/components/schemas/Link" }, "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", "properties": { "id": { "description": "Not allowed on create.", "type": "string" }, "name": { "type": "string" }, "variations": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/SendEmailAction" }, { "$ref": "#/components/schemas/SendSmsAction" } ] } }, "allocations": { "type": "object" }, "started": { "type": "string", "format": "date-time", "example": "2022-11-08T00:00:00+00:00", "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" ] }, "automatic_winner_selection_settings": { "$ref": "#/components/schemas/AutomaticWinnerSelectionSettings" } }, "required": [ "variations" ] } }, "required": [ "main_action" ] } }, "required": [ "type", "data" ] }, "InternalScheduledReportData": { "type": "object", "properties": { "service_method_type": { "type": "string", "enum": [ "schedule-report" ] }, "report_id": { "type": "string" } }, "required": [ "service_method_type", "report_id" ] }, "InternalTrackEventData": { "type": "object", "properties": { "service_method_type": { "type": "string", "enum": [ "track-event" ] }, "event_key": { "type": "string" }, "event_payload": { "type": "object" }, "tracking_company_id": { "type": "string" } }, "required": [ "service_method_type" ] }, "InternalScheduledReportBuilderReportData": { "type": "object", "properties": { "service_method_type": { "type": "string", "enum": [ "schedule-report-builder-report" ] }, "report_id": { "type": "string" } }, "required": [ "service_method_type", "report_id" ] }, "InternalUnknownServiceData": { "type": "object", "properties": { "service_method_type": { "type": "string", "enum": [ "unknown" ] } }, "required": [ "service_method_type" ] }, "InternalServiceActionData": { "type": "object", "properties": { "service_configuration": { "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" ] } } }, "InternalServiceAction": { "type": "object", "properties": { "id": { "description": "The real ID of an action. Not allowed on create.", "type": "string", "example": "123" }, "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", "writeOnly": true }, "type": { "type": "string", "enum": [ "internal-service" ] }, "links": { "$ref": "#/components/schemas/Link" }, "data": { "$ref": "#/components/schemas/InternalServiceActionData" } }, "required": [ "type" ] }, "CodeAction": { "type": "object", "properties": { "id": { "description": "The real ID of an action. Not allowed on create.", "type": "string", "example": "123" }, "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", "writeOnly": true }, "type": { "type": "string", "enum": [ "code" ] }, "links": { "$ref": "#/components/schemas/Link" } }, "required": [ "type" ] }, "ProfileNotInFlowCondition": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "profile-not-in-flow" ] }, "timeframe_filter": { "oneOf": [ { "$ref": "#/components/schemas/AlltimeDateFilter" }, { "$ref": "#/components/schemas/InTheLastBaseRelativeDateFilter" } ] } }, "required": [ "type", "timeframe_filter" ] }, "MultiBranchSplitBranch": { "type": "object", "properties": { "branch_id": { "type": "string" }, "order": { "type": "integer" }, "is_else": { "type": "boolean", "default": false }, "branch_filter": { "type": "object", "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/ProfilePredictiveAnalyticsChannelAffinityPriorityCondition" }, { "$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityRankCondition" }, { "$ref": "#/components/schemas/ProfileMarketingConsentCondition" }, { "$ref": "#/components/schemas/FlowsProfileMetricCondition" }, { "$ref": "#/components/schemas/ProfileRandomSampleCondition" }, { "$ref": "#/components/schemas/ProfileHasCustomObjectCondition" }, { "$ref": "#/components/schemas/ProfilePermissionsCondition" }, { "$ref": "#/components/schemas/ProfileHasNotReceivedEmailMessageCondition" }, { "$ref": "#/components/schemas/ProfileHasNotReceivedSmsMessageCondition" }, { "$ref": "#/components/schemas/ProfileHasNotReceivedPushMessageCondition" }, { "$ref": "#/components/schemas/ProfileNotInFlowCondition" }, { "$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" ] }, "links": { "$ref": "#/components/schemas/Link" }, "name": { "type": "string" } }, "required": [ "branch_id" ] }, "MultiBranchSplitActionData": { "type": "object", "properties": { "branches": { "type": "array", "items": { "$ref": "#/components/schemas/MultiBranchSplitBranch" } }, "name": { "type": "string" } }, "required": [ "branches", "name" ] }, "MultiBranchSplitAction": { "type": "object", "properties": { "id": { "description": "The real ID of an action. Not allowed on create.", "type": "string", "example": "123" }, "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", "writeOnly": true }, "type": { "type": "string", "enum": [ "multi-branch-split" ] }, "data": { "$ref": "#/components/schemas/MultiBranchSplitActionData" } }, "required": [ "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 ] }, "list_id": { "type": "string" }, "status": { "description": "Flow action status.", "type": "string", "example": "draft", "default": "draft", "enum": [ "disabled", "draft", "live", "manual" ] } }, "required": [ "name", "on_execution", "list_id" ] }, "ListUpdateAction": { "type": "object", "properties": { "id": { "description": "The real ID of an action. Not allowed on create.", "type": "string", "example": "123" }, "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", "writeOnly": true }, "data": { "$ref": "#/components/schemas/ListUpdateActionData" }, "type": { "type": "string", "enum": [ "list-update" ] }, "links": { "$ref": "#/components/schemas/Link" } }, "required": [ "data", "type" ] }, "FlowActionUpdateQueryResourceObject": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/FlowActionEnum" }, "id": { "type": "string" }, "attributes": { "type": "object", "properties": { "definition": { "description": "The encoded flow action definition.", "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/SendWhatsAppWithACAction" }, { "$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" } ] } }, "required": [ "definition" ] } }, "required": [ "type", "id", "attributes" ] }, "FlowActionUpdateQuery": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FlowActionUpdateQueryResourceObject" } }, "required": [ "data" ] }, "PatchFlowActionEncodedResponse": { "type": "object", "properties": { "data": { "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" }, "updated": { "type": "string", "format": "date-time", "example": "2022-11-08T00:00:00+00:00" }, "definition": { "description": "The encoded flow action definition.", "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/SendWhatsAppWithACAction" }, { "$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" } ] } } }, "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" ] }, "links": { "$ref": "#/components/schemas/ObjectLinks" }, "meta": { "$ref": "#/components/schemas/ResponseMeta" } }, "required": [ "data" ] }, "RelationshipLinks": { "type": "object", "properties": { "self": { "type": "string", "format": "uri" }, "related": { "type": "string", "format": "uri" } }, "required": [ "self", "related" ] }, "ObjectLinks": { "type": "object", "properties": { "self": { "type": "string", "format": "uri" } }, "required": [ "self" ] }, "AgentHints": { "description": "Optional hints emitted by the API for agent callers", "type": "object", "properties": { "next_steps": { "description": "Suggested follow-up actions for agents to take after this response", "type": "array", "items": { "type": "string" } } } }, "ResponseMeta": { "description": "Response-level metadata", "type": "object", "properties": { "agent_hints": { "$ref": "#/components/schemas/AgentHints" } } } }, "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" ] } } } } }, "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-07-15/reference/api-overview#authentication", "x-default": "Klaviyo-API-Key your-private-api-key" } } }, "tags": [ { "name": "Flows" } ], "security": [ { "Klaviyo-API-Key": [] } ], "x-readme": { "explorer-enabled": false, "proxy-enabled": true, "samples-enabled": true }, "_id": { "buffer": { "0": 106, "1": 87, "2": 133, "3": 248, "4": 182, "5": 179, "6": 234, "7": 252, "8": 177, "9": 30, "10": 99, "11": 30 } } } ```