{"command":{"effect":"write","timeoutSeconds":30,"inputSchema":{"type":"object","description":"Create a segment.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d`\n\n**Scopes:**\n`segments:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_segment.json)","properties":{"query":{"type":"object","properties":{"fields[segment]":{"type":"array","items":{"type":"string","enum":["created","definition","definition.condition_groups","id","is_active","is_processing","is_starred","name","updated"]},"description":"For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets"}},"required":[],"additionalProperties":false},"headers":{"type":"object","properties":{"revision":{"type":"string","default":"2026-10-15","enum":["2026-10-15"],"description":"API endpoint revision (format: YYYY-MM-DD[.suffix])"}},"required":["revision"],"additionalProperties":false},"body":{"$ref":"#/definitions/SegmentCreateQuery"}},"required":["headers","body"],"additionalProperties":false,"definitions":{"SegmentCreateQuery":{"type":"object","properties":{"data":{"$ref":"#/definitions/SegmentCreateQueryResourceObject"}},"required":["data"]},"SegmentCreateQueryResourceObject":{"type":"object","properties":{"type":{"$ref":"#/definitions/SegmentEnum"},"attributes":{"type":"object","properties":{"name":{"type":"string"},"definition":{"$ref":"#/definitions/SegmentDefinition"},"is_starred":{"type":["boolean","null"],"default":false}},"required":["name","definition"]}},"required":["type","attributes"]},"SegmentEnum":{"type":"string","enum":["segment"]},"SegmentDefinition":{"type":"object","properties":{"condition_groups":{"description":"Condition groups are combined with AND: a profile must match every group to be in the segment. To require several conditions at once, put each condition in its own condition group.","type":"array","items":{"$ref":"#/definitions/ConditionGroup"}}},"required":["condition_groups"]},"ConditionGroup":{"type":"object","properties":{"conditions":{"description":"Conditions within a group are combined with OR: a profile matches the group if it matches at least one condition. Do not put conditions that must all be true in the same group.","type":"array","items":{"oneOf":[{"$ref":"#/definitions/ProfileHasGroupMembershipCondition"},{"$ref":"#/definitions/ProfileNoGroupMembershipCondition"},{"$ref":"#/definitions/SegmentsProfileMetricCondition"},{"$ref":"#/definitions/ProfileMarketingConsentCondition"},{"$ref":"#/definitions/ProfilePostalCodeDistanceCondition"},{"$ref":"#/definitions/ProfilePropertyCondition"},{"$ref":"#/definitions/ProfileRegionCondition"},{"$ref":"#/definitions/ProfilePredictiveAnalyticsDateCondition"},{"$ref":"#/definitions/ProfilePredictiveAnalyticsNumericCondition"},{"$ref":"#/definitions/ProfilePredictiveAnalyticsStringCondition"},{"$ref":"#/definitions/ProfilePredictiveAnalyticsChannelAffinityPriorityCondition"},{"$ref":"#/definitions/ProfilePredictiveAnalyticsChannelAffinityRankCondition"},{"$ref":"#/definitions/ProfileHasCustomObjectCondition"},{"$ref":"#/definitions/ProfilePermissionsCondition"},{"$ref":"#/definitions/SegmentsProfileMetricFunnelCondition"}]}}},"required":["conditions"]},"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":"#/definitions/StaticDateFilter"},{"$ref":"#/definitions/StaticDateRangeFilter"},{"$ref":"#/definitions/RelativeDateOperatorBaseRelativeDateFilter"},{"$ref":"#/definitions/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"]},"SegmentsProfileMetricCondition":{"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":"#/definitions/NumericOperatorNumericFilter"},"timeframe_filter":{"oneOf":[{"$ref":"#/definitions/StaticDateFilter"},{"$ref":"#/definitions/StaticDateRangeFilter"},{"$ref":"#/definitions/RelativeDateOperatorBaseRelativeDateFilter"},{"$ref":"#/definitions/RelativeAnniversaryDateFilter"},{"$ref":"#/definitions/RelativeDateRangeFilter"},{"$ref":"#/definitions/AlltimeDateFilter"}]},"metric_filters":{"type":["array","null"],"items":{"$ref":"#/definitions/ProfileMetricPropertyFilter"}}},"required":["type","metric_id","measurement","measurement_filter","timeframe_filter"]},"ProfileMarketingConsentCondition":{"type":"object","properties":{"type":{"type":"string","enum":["profile-marketing-consent"]},"consent":{"oneOf":[{"$ref":"#/definitions/HasEmailMarketingConsent"},{"$ref":"#/definitions/NoEmailMarketingConsent"},{"$ref":"#/definitions/HasSMSMarketingConsent"},{"$ref":"#/definitions/NoSMSMarketingConsent"},{"$ref":"#/definitions/HasPushMarketingConsent"},{"$ref":"#/definitions/NoPushMarketingConsent"}]}},"required":["type","consent"]},"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":"#/definitions/GreaterThanPositiveNumericFilter"},{"$ref":"#/definitions/LessThanPositiveNumericFilter"}]}},"required":["type","country_code","postal_code","unit","filter"]},"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","examples":["properties['Favorite Color']"]},"filter":{"oneOf":[{"$ref":"#/definitions/StringOperatorStringFilter"},{"$ref":"#/definitions/StringArrayOperatorStringArrayFilter"},{"$ref":"#/definitions/StringPhoneOperatorStringArrayFilter"},{"$ref":"#/definitions/NumericOperatorNumericFilter"},{"$ref":"#/definitions/BooleanFilter"},{"$ref":"#/definitions/StaticDateFilter"},{"$ref":"#/definitions/StaticDateRangeFilter"},{"$ref":"#/definitions/RelativeDateOperatorBaseRelativeDateFilter"},{"$ref":"#/definitions/RelativeAnniversaryDateFilter"},{"$ref":"#/definitions/RelativeDateRangeFilter"},{"$ref":"#/definitions/CalendarDateFilter"},{"$ref":"#/definitions/AnniversaryDateFilter"},{"$ref":"#/definitions/ListContainsOperatorListContainsFilter"},{"$ref":"#/definitions/ListLengthFilter"},{"$ref":"#/definitions/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":"#/definitions/StaticDateFilter"},{"$ref":"#/definitions/StaticDateRangeFilter"},{"$ref":"#/definitions/RelativeDateOperatorBaseRelativeDateFilter"},{"$ref":"#/definitions/RelativeAnniversaryDateFilter"},{"$ref":"#/definitions/RelativeDateRangeFilter"},{"$ref":"#/definitions/CalendarDateFilter"},{"$ref":"#/definitions/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":"#/definitions/NumericOperatorNumericFilter"}},"required":["type","dimension","filter"]},"ProfilePredictiveAnalyticsStringCondition":{"type":"object","properties":{"type":{"type":"string","enum":["profile-predictive-analytics"]},"dimension":{"description":"Dimension for string profile predictive analytics conditions.","type":"string","enum":["predicted_gender"]},"filter":{"$ref":"#/definitions/ProfilePredictiveAnalyticsStringFilter"}},"required":["type","dimension","filter"]},"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":"#/definitions/ProfilePredictiveAnalyticsChannelAffinityPriorityFilter"}},"required":["type","dimension","measurement","predicted_channel","filter"]},"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":"#/definitions/ProfilePredictiveAnalyticsChannelAffinityRankFilter"}},"required":["type","dimension","measurement","predicted_channel","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":"#/definitions/IntegerFilter"},"filters":{"type":"array","items":{"$ref":"#/definitions/ProfileHasCustomObjectFilter"}}},"required":["type","object_type_id","object_type_relationship_id","filter","filters"]},"ProfilePermissionsCondition":{"type":"object","properties":{"type":{"type":"string","enum":["profile-permissions"]},"permission":{"oneOf":[{"$ref":"#/definitions/ExplicitlyReachable"},{"$ref":"#/definitions/ImplicitlyReachable"},{"$ref":"#/definitions/ImplicitlyOrExplicitlyReachable"},{"$ref":"#/definitions/ExplicitlyUnreachable"},{"$ref":"#/definitions/ImplicitlyUnreachable"},{"$ref":"#/definitions/ImplicitlyOrExplicitlyUnreachable"}]},"channel":{"description":"Possible channels for profile permissions criterion.","type":"string","enum":["email_click_tracking","email_open_tracking","whatsapp_marketing","whatsapp_transactional"]}},"required":["type","permission","channel"]},"SegmentsProfileMetricFunnelCondition":{"type":"object","properties":{"type":{"type":"string","enum":["profile-metric-funnel"]},"timeframe_filter":{"oneOf":[{"$ref":"#/definitions/StaticDateRangeFilter"},{"$ref":"#/definitions/RelativeDateRangeFilter"},{"$ref":"#/definitions/RelativeDateOperatorBaseRelativeDateFilter"}]},"completion_window_seconds":{"description":"Allowed completion window durations for funnel conditions (in\n    seconds).","type":["string","null"],"enum":["DAYS_1","DAYS_180","DAYS_3","DAYS_30","DAYS_5","DAYS_90","HOURS_1","WEEKS_1","YEARS_1"]},"steps":{"type":"array","items":{"$ref":"#/definitions/ProfileMetricFunnelSteps"}}},"required":["type","timeframe_filter","steps"]},"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","examples":["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","examples":["2022-11-08T00:00:00+00:00"]},"end":{"type":"string","format":"date-time","examples":["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"]},"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"]},"ProfileMetricPropertyFilter":{"type":"object","properties":{"property":{"type":"string"},"filter":{"oneOf":[{"$ref":"#/definitions/StringOperatorStringFilter"},{"$ref":"#/definitions/StringArrayOperatorStringArrayFilter"},{"$ref":"#/definitions/ExistenceOperatorExistenceFilter"},{"$ref":"#/definitions/ListSetFilter"},{"$ref":"#/definitions/ListLengthFilter"},{"$ref":"#/definitions/ListSubstringFilter"},{"$ref":"#/definitions/BooleanFilter"},{"$ref":"#/definitions/NumericOperatorNumericFilter"}]}},"required":["property","filter"]},"HasEmailMarketingConsent":{"type":"object","properties":{"channel":{"type":"string","enum":["email"]},"can_receive_marketing":{"type":"boolean","enum":[true]},"consent_status":{"oneOf":[{"$ref":"#/definitions/HasEmailMarketing"},{"$ref":"#/definitions/HasEmailMarketingSubscribed"},{"$ref":"#/definitions/HasEmailMarketingNeverSubscribed"}]}},"required":["channel","can_receive_marketing","consent_status"]},"NoEmailMarketingConsent":{"type":"object","properties":{"channel":{"type":"string","enum":["email"]},"can_receive_marketing":{"type":"boolean","enum":[false]},"consent_status":{"oneOf":[{"$ref":"#/definitions/NoEmailMarketing"},{"$ref":"#/definitions/NoEmailMarketingUnsubscribed"},{"$ref":"#/definitions/NoEmailMarketingNeverSubscribed"},{"$ref":"#/definitions/NoEmailMarketingSubscribed"}]}},"required":["channel","can_receive_marketing","consent_status"]},"HasSMSMarketingConsent":{"type":"object","properties":{"channel":{"type":"string","enum":["sms"]},"can_receive_marketing":{"type":"boolean","enum":[true]},"consent_status":{"$ref":"#/definitions/HasSMSMarketingSubscribed"}},"required":["channel","can_receive_marketing","consent_status"]},"NoSMSMarketingConsent":{"type":"object","properties":{"channel":{"type":"string","enum":["sms"]},"can_receive_marketing":{"type":"boolean","enum":[false]},"consent_status":{"oneOf":[{"$ref":"#/definitions/NoSMSMarketing"},{"$ref":"#/definitions/NoSMSMarketingUnsubscribed"},{"$ref":"#/definitions/NoSMSMarketingNeverSubscribed"}]}},"required":["channel","can_receive_marketing","consent_status"]},"HasPushMarketingConsent":{"type":"object","properties":{"channel":{"type":"string","enum":["push"]},"can_receive_marketing":{"type":"boolean","enum":[true]},"consent_status":{"$ref":"#/definitions/HasPushMarketing"}},"required":["channel","can_receive_marketing","consent_status"]},"NoPushMarketingConsent":{"type":"object","properties":{"channel":{"type":"string","enum":["push"]},"can_receive_marketing":{"type":"boolean","enum":[false]},"consent_status":{"$ref":"#/definitions/NoPushMarketing"}},"required":["channel","can_receive_marketing","consent_status"]},"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"]},"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","null"]}},"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"]},"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"]},"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"]},"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"]},"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"]},"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"]},"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"]},"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"]},"ProfilePredictiveAnalyticsChannelAffinityPriorityFilter":{"type":"object","properties":{"type":{"type":"string","enum":["numeric"]},"operator":{"type":"string","enum":["equals"]},"value":{"type":"integer"}},"required":["type","operator","value"]},"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"]},"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"]},"ProfileHasCustomObjectFilter":{"type":"object","properties":{"property_id":{"type":"integer"},"filter":{"oneOf":[{"$ref":"#/definitions/StringOperatorStringFilter"},{"$ref":"#/definitions/StringArrayOperatorStringArrayFilter"},{"$ref":"#/definitions/NumericOperatorNumericFilter"},{"$ref":"#/definitions/NumericRangeFilter"},{"$ref":"#/definitions/BooleanFilter"},{"$ref":"#/definitions/StaticDateFilter"},{"$ref":"#/definitions/StaticDateRangeFilter"},{"$ref":"#/definitions/RelativeDateOperatorBaseRelativeDateFilter"},{"$ref":"#/definitions/RelativeAnniversaryDateFilter"},{"$ref":"#/definitions/RelativeDateRangeFilter"},{"$ref":"#/definitions/ListContainsOperatorListContainsFilter"},{"$ref":"#/definitions/ListLengthFilter"},{"$ref":"#/definitions/ExistenceOperatorExistenceFilter"}]}},"required":["property_id","filter"]},"ExplicitlyReachable":{"type":"object","properties":{"reachable_status":{"type":"string","enum":["explicitly_reachable"]},"filters":{"type":"array","items":{"oneOf":[{"$ref":"#/definitions/EffectiveDateFilter"},{"$ref":"#/definitions/RecordedDateFilter"},{"$ref":"#/definitions/MethodFilter"},{"$ref":"#/definitions/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":"#/definitions/EffectiveDateFilter"},{"$ref":"#/definitions/RecordedDateFilter"},{"$ref":"#/definitions/MethodFilter"},{"$ref":"#/definitions/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"]},"ProfileMetricFunnelSteps":{"type":"object","properties":{"metric_exists":{"type":"boolean"},"metric_id":{"type":"string"},"metric_filters":{"type":["array","null"],"items":{"$ref":"#/definitions/ProfileMetricPropertyFilter"}}},"required":["metric_exists","metric_id"]},"ListSetFilter":{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"operator":{"description":"Operators for list contains set filters.","type":"string","enum":["contains-all","contains-any","not-contains-all","not-contains-any"]},"value":{"type":"array","items":{"type":"string"}}},"required":["type","operator","value"]},"ListSubstringFilter":{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"operator":{"description":"Operators for list substring filters.","type":"string","enum":["contains-substring","not-contains-substring"]},"value":{"type":["string","null"]}},"required":["type","operator","value"]},"HasEmailMarketing":{"type":"object","properties":{"subscription":{"type":"string","enum":["any"]},"filters":{}},"required":["subscription"]},"HasEmailMarketingSubscribed":{"type":"object","properties":{"subscription":{"type":"string","enum":["subscribed"]},"filters":{"type":["array","null"],"items":{"oneOf":[{"$ref":"#/definitions/DoubleOptinFilter"},{"$ref":"#/definitions/StatusDateFilter"},{"$ref":"#/definitions/CustomSourceFilter"},{"$ref":"#/definitions/FormMethodFilter"},{"$ref":"#/definitions/PreferencePageFilter"},{"$ref":"#/definitions/APIMethodFilter"},{"$ref":"#/definitions/InboundMessageMethodFilter"},{"$ref":"#/definitions/BackInStockMethodFilter"},{"$ref":"#/definitions/SftpMethodFilter"},{"$ref":"#/definitions/ManualImportManualMethodFilter"},{"$ref":"#/definitions/ManualAddManualMethodFilter"},{"$ref":"#/definitions/ShopifyIntegrationMethodFilter"}]}}},"required":["subscription"]},"HasEmailMarketingNeverSubscribed":{"type":"object","properties":{"subscription":{"type":"string","enum":["never_subscribed"]},"filters":{}},"required":["subscription"]},"NoEmailMarketing":{"type":"object","properties":{"subscription":{"type":"string","enum":["any"]},"filters":{"type":["array","null"],"items":{"oneOf":[{"$ref":"#/definitions/BounceDateFilter"},{"$ref":"#/definitions/ManualSuppressionDateFilter"},{"$ref":"#/definitions/InvalidEmailDateFilter"}]}}},"required":["subscription"]},"NoEmailMarketingUnsubscribed":{"type":"object","properties":{"subscription":{"type":"string","enum":["unsubscribed"]},"filters":{"oneOf":[{"type":"array","items":{"oneOf":[{"$ref":"#/definitions/StatusDateFilter"},{"$ref":"#/definitions/APIMethodFilter"},{"$ref":"#/definitions/InboundMessageMethodFilter"},{"$ref":"#/definitions/PreferencePageMethodFilter"},{"$ref":"#/definitions/ManualRemoveMethodFilter"},{"$ref":"#/definitions/SpamComplaintMethodFilter"},{"$ref":"#/definitions/MailboxProviderMethodFilter"},{"$ref":"#/definitions/OneClickUnsubscribeMethodFilter"},{"$ref":"#/definitions/ManualImportMethodFilter"},{"$ref":"#/definitions/SftpMethodFilter"},{"$ref":"#/definitions/DataWarehouseImportMethodFilter"},{"$ref":"#/definitions/ProfileModificationMethodFilter"},{"$ref":"#/definitions/ConstantContactIntegrationMethodFilter"}]}},{"type":"array","items":{"oneOf":[{"$ref":"#/definitions/BounceDateFilter"},{"$ref":"#/definitions/ManualSuppressionDateFilter"},{"$ref":"#/definitions/InvalidEmailDateFilter"}]}}]}},"required":["subscription"]},"NoEmailMarketingNeverSubscribed":{"type":"object","properties":{"subscription":{"type":"string","enum":["never_subscribed"]},"filters":{"type":"array","items":{"oneOf":[{"$ref":"#/definitions/BounceDateFilter"},{"$ref":"#/definitions/ManualSuppressionDateFilter"},{"$ref":"#/definitions/InvalidEmailDateFilter"}]}}},"required":["subscription","filters"]},"NoEmailMarketingSubscribed":{"type":"object","properties":{"subscription":{"type":"string","enum":["subscribed"]},"filters":{"type":"array","items":{"oneOf":[{"$ref":"#/definitions/BounceDateFilter"},{"$ref":"#/definitions/ManualSuppressionDateFilter"},{"$ref":"#/definitions/InvalidEmailDateFilter"}]}}},"required":["subscription","filters"]},"HasSMSMarketingSubscribed":{"type":"object","properties":{"subscription":{"type":"string","enum":["subscribed"]},"filters":{"type":["array","null"],"items":{"oneOf":[{"$ref":"#/definitions/StatusDateFilter"},{"$ref":"#/definitions/FormMethodFilter"},{"$ref":"#/definitions/ManualImportManualMethodFilter"},{"$ref":"#/definitions/ManualAddManualMethodFilter"},{"$ref":"#/definitions/CheckoutMethodFilter"},{"$ref":"#/definitions/InboundMessageMethodFilter"},{"$ref":"#/definitions/PreferencePageMethodFilter"},{"$ref":"#/definitions/SftpMethodFilter"},{"$ref":"#/definitions/ShopifyIntegrationMethodFilter"},{"$ref":"#/definitions/SubscribedSMSIsRcsCapableFilter"}]}}},"required":["subscription"]},"NoSMSMarketing":{"type":"object","properties":{"subscription":{"type":"string","enum":["any"]}},"required":["subscription"]},"NoSMSMarketingUnsubscribed":{"type":"object","properties":{"subscription":{"type":"string","enum":["unsubscribed"]},"filters":{"type":["array","null"],"items":{"oneOf":[{"$ref":"#/definitions/StatusDateFilter"},{"$ref":"#/definitions/FormMethodFilter"},{"$ref":"#/definitions/ManualImportManualMethodFilter"},{"$ref":"#/definitions/ManualAddManualMethodFilter"},{"$ref":"#/definitions/ManualRemoveMethodFilter"},{"$ref":"#/definitions/BulkRemoveMethodFilter"},{"$ref":"#/definitions/CheckoutMethodFilter"},{"$ref":"#/definitions/InboundMessageMethodFilter"},{"$ref":"#/definitions/PreferencePageMethodFilter"},{"$ref":"#/definitions/SftpMethodFilter"},{"$ref":"#/definitions/CarrierDeactivationMethodFilter"},{"$ref":"#/definitions/ProvidedLandlineMethodFilter"},{"$ref":"#/definitions/MessageBlockedMethodFilter"},{"$ref":"#/definitions/ProvidedNoAgeMethodFilter"},{"$ref":"#/definitions/FailedAgeGateMethodFilter"},{"$ref":"#/definitions/ShopifyIntegrationMethodFilter"}]}}},"required":["subscription"]},"NoSMSMarketingNeverSubscribed":{"type":"object","properties":{"subscription":{"type":"string","enum":["never_subscribed"]}},"required":["subscription"]},"HasPushMarketing":{"type":"object","properties":{"subscription":{"type":"string","enum":["any"]},"filters":{"type":["array","null"],"items":{"$ref":"#/definitions/StatusDateFilter"}}},"required":["subscription"]},"NoPushMarketing":{"type":"object","properties":{"subscription":{"type":"string","enum":["any"]}},"required":["subscription"]},"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"]},"EffectiveDateFilter":{"type":"object","properties":{"field":{"type":"string","enum":["effective_date"]},"filter":{"oneOf":[{"$ref":"#/definitions/StaticDateFilter"},{"$ref":"#/definitions/StaticDateRangeFilter"},{"$ref":"#/definitions/RelativeDateOperatorBaseRelativeDateFilter"},{"$ref":"#/definitions/RelativeAnniversaryDateFilter"},{"$ref":"#/definitions/RelativeDateRangeFilter"},{"$ref":"#/definitions/CalendarDateFilter"},{"$ref":"#/definitions/AnniversaryDateFilter"}]}},"required":["field","filter"]},"RecordedDateFilter":{"type":"object","properties":{"field":{"type":"string","enum":["recorded_date"]},"filter":{"oneOf":[{"$ref":"#/definitions/StaticDateFilter"},{"$ref":"#/definitions/StaticDateRangeFilter"},{"$ref":"#/definitions/RelativeDateOperatorBaseRelativeDateFilter"},{"$ref":"#/definitions/RelativeAnniversaryDateFilter"},{"$ref":"#/definitions/RelativeDateRangeFilter"},{"$ref":"#/definitions/CalendarDateFilter"},{"$ref":"#/definitions/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":{"$ref":"#/definitions/InStringArrayFilter"}},"required":["field","method"]},"DoubleOptinFilter":{"type":"object","properties":{"field":{"type":"string","enum":["is_double_opt_in"]},"filter":{"$ref":"#/definitions/BooleanFilter"}},"required":["field","filter"]},"StatusDateFilter":{"type":"object","properties":{"field":{"type":"string","enum":["status_date"]},"filter":{"oneOf":[{"$ref":"#/definitions/StaticDateFilter"},{"$ref":"#/definitions/StaticDateRangeFilter"},{"$ref":"#/definitions/RelativeDateOperatorBaseRelativeDateFilter"},{"$ref":"#/definitions/RelativeAnniversaryDateFilter"},{"$ref":"#/definitions/RelativeDateRangeFilter"},{"$ref":"#/definitions/CalendarDateFilter"},{"$ref":"#/definitions/AnniversaryDateFilter"}]}},"required":["field","filter"]},"CustomSourceFilter":{"type":"object","properties":{"field":{"type":"string","enum":["custom_source"]},"filter":{"$ref":"#/definitions/EqualsStringFilter"}},"required":["field","filter"]},"FormMethodFilter":{"type":"object","properties":{"field":{"type":"string","enum":["method"]},"method":{"type":"string","enum":["form"]},"filter":{"$ref":"#/definitions/InStringArrayFilter"}},"required":["field","method"]},"PreferencePageFilter":{"type":"object","properties":{"field":{"type":"string","enum":["method"]},"method":{"type":"string","enum":["preference_page"]},"filter":{"$ref":"#/definitions/EqualsStringFilter"}},"required":["field","method"]},"APIMethodFilter":{"type":"object","properties":{"field":{"type":"string","enum":["method"]},"method":{"type":"string","enum":["api"]},"filter":{"$ref":"#/definitions/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":{"$ref":"#/definitions/InStringArrayFilter"}},"required":["field","method"]},"ManualAddManualMethodFilter":{"type":"object","properties":{"field":{"type":"string","enum":["method"]},"method":{"type":"string","enum":["manual_add"]},"filter":{"$ref":"#/definitions/InStringArrayFilter"}},"required":["field","method"]},"ShopifyIntegrationMethodFilter":{"type":"object","properties":{"field":{"type":"string","enum":["method"]},"method":{"type":"string","enum":["integration"]},"filter":{"$ref":"#/definitions/ShopifyIntegrationFilter"}},"required":["field","method","filter"]},"BounceDateFilter":{"type":"object","properties":{"field":{"type":"string","enum":["bounce_date"]},"filter":{"oneOf":[{"$ref":"#/definitions/StaticDateFilter"},{"$ref":"#/definitions/StaticDateRangeFilter"},{"$ref":"#/definitions/RelativeDateOperatorBaseRelativeDateFilter"},{"$ref":"#/definitions/RelativeAnniversaryDateFilter"},{"$ref":"#/definitions/RelativeDateRangeFilter"},{"$ref":"#/definitions/CalendarDateFilter"},{"$ref":"#/definitions/AnniversaryDateFilter"},{"$ref":"#/definitions/IsSetExistenceFilter"}]}},"required":["field","filter"]},"ManualSuppressionDateFilter":{"type":"object","properties":{"field":{"type":"string","enum":["manual_suppression_date"]},"filter":{"oneOf":[{"$ref":"#/definitions/StaticDateFilter"},{"$ref":"#/definitions/StaticDateRangeFilter"},{"$ref":"#/definitions/RelativeDateOperatorBaseRelativeDateFilter"},{"$ref":"#/definitions/RelativeAnniversaryDateFilter"},{"$ref":"#/definitions/RelativeDateRangeFilter"},{"$ref":"#/definitions/CalendarDateFilter"},{"$ref":"#/definitions/AnniversaryDateFilter"},{"$ref":"#/definitions/IsSetExistenceFilter"}]}},"required":["field","filter"]},"InvalidEmailDateFilter":{"type":"object","properties":{"field":{"type":"string","enum":["invalid_email_date"]},"filter":{"oneOf":[{"$ref":"#/definitions/StaticDateFilter"},{"$ref":"#/definitions/StaticDateRangeFilter"},{"$ref":"#/definitions/RelativeDateOperatorBaseRelativeDateFilter"},{"$ref":"#/definitions/RelativeAnniversaryDateFilter"},{"$ref":"#/definitions/RelativeDateRangeFilter"},{"$ref":"#/definitions/CalendarDateFilter"},{"$ref":"#/definitions/AnniversaryDateFilter"},{"$ref":"#/definitions/IsSetExistenceFilter"}]}},"required":["field","filter"]},"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"]},"ConstantContactIntegrationMethodFilter":{"type":"object","properties":{"field":{"type":"string","enum":["method"]},"method":{"type":"string","enum":["integration"]},"filter":{"$ref":"#/definitions/ConstantContactIntegrationFilter"}},"required":["field","method","filter"]},"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":"#/definitions/BooleanFilter"}},"required":["field","filter"]},"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"]},"InStringArrayFilter":{"type":"object","properties":{"type":{"type":"string","enum":["string"]},"operator":{"type":"string","enum":["in"]},"value":{"type":"array","items":{"type":"string"}}},"required":["type","operator","value"]},"EqualsStringFilter":{"type":"object","properties":{"type":{"type":"string","enum":["string"]},"operator":{"type":"string","enum":["equals"]},"value":{"type":["string","null"]}},"required":["type","operator","value"]},"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"]},"IsSetExistenceFilter":{"type":"object","properties":{"type":{"type":"string","enum":["existence"]},"operator":{"type":"string","enum":["is-set"]}},"required":["type","operator"]},"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"]}}},"name":"Create Segment","id":"klaviyo.create_segment","example":{"headers":{"revision":"2026-10-15"},"body":{"data":{"type":"segment","attributes":{"name":"example","definition":{"condition_groups":[]}}}}},"maxRequests":1,"summary":false}}