@automate.ax/integration-contracts 0.147.1 → 0.148.0

package/src/kit/openapi-operations.generated.ts

@@ -0,0 +1,7 @@
+/**
+ * Generated from https://developers.kit.com/api-reference/v4.json; parsed at
+ * runtime to avoid an enormous inferred literal type.
+ */
+export const KIT_OPENAPI_DATA: unknown = JSON.parse(
+  '{"definitions":{"BroadcastAnyCondition":{"type":"object","description":"Filter by specific broadcast IDs. Subscriber must have interacted with ANY of the specified broadcasts.","properties":{"type":{"type":"string","enum":["broadcasts"],"description":"Must be \'broadcasts\'"},"ids":{"type":"array","items":{"type":"integer"},"description":"Array of broadcast IDs. Subscriber must match ANY of these."}},"required":["type","ids"]},"FilterCondition":{"type":"object","description":"A filter condition with type and optional parameters. Used within the \'all\' array for complex filtering where multiple conditions must be met.","properties":{"type":{"type":"string","enum":["opens","clicks","sent","delivered","subscribed","subscriber_state","tags","attribution","custom_field","location"],"description":"Type of filter condition. `attribution` matches subscribers by their *original signup attribution* — supports two sub-conditions: `forms` matches by the form / landing-page id the subscriber signed up through, and `kit_source` matches by any combination of the underlying Kit source fields (source type, source id, source name, mechanism, mechanism id). Attribution is the original signup source; it does not track current subscription state. `custom_field` matches subscribers by the value they have stored for a particular custom field, identified by `subscriber_custom_field_id`. `location` matches subscribers whose primary location falls within a `radius` (miles) of (`latitude`, `longitude`). All three fields are required."},"countGreaterThan":{"type":"integer","description":"Minimum count (exclusive). Only applicable for engagement types (\'opens\', \'clicks\', \'sent\', \'delivered\')."},"countGreaterThanOrEqual":{"type":"integer","description":"Minimum count (inclusive). Only applicable for engagement types (\'opens\', \'clicks\', \'sent\', \'delivered\')."},"countLessThan":{"type":"integer","description":"Maximum count (exclusive). Only applicable for engagement types (\'opens\', \'clicks\', \'sent\', \'delivered\')."},"countLessThanOrEqual":{"type":"integer","description":"Maximum count (inclusive). Only applicable for engagement types (\'opens\', \'clicks\', \'sent\', \'delivered\')."},"after":{"type":"string","format":"date","description":"Start date (YYYY-MM-DD). For \'subscribed\' type, filters by subscriber_created_at. For engagement types, filters by event date. Not applicable for \'tags\', \'subscriber_state\', \'attribution\', or \'custom_field\' types."},"before":{"type":"string","format":"date","description":"End date (YYYY-MM-DD). For \'subscribed\' type, filters by subscriber_created_at. For engagement types, filters by event date. Not applicable for \'tags\', \'subscriber_state\', \'attribution\', or \'custom_field\' types."},"states":{"type":"array","items":{"type":"string","enum":["active","inactive","bounced","cancelled","complained"]},"description":"Subscriber lifecycle states. Required for \'subscriber_state\' type; ignored for other types. Subscribers matching any of the listed states pass the filter. Strongly recommended to use `[\'active\']` unless you specifically need other states — most subscriber-facing queries elsewhere in the app scope to active subscribers by default."},"subscriberCustomFieldId":{"type":"integer","description":"Id of the custom field whose stored value is being filtered on. Required for \'custom_field\' type; ignored for other types."},"value":{"type":"string","description":"Value to compare against. Used by \'custom_field\' type together with `comparison`. For the numeric comparisons (`greater_than`, `greater_than_or_equal`, `less_than`, `less_than_or_equal`) the value is parsed as a number; non-numeric stored values are excluded. Ignored when `comparison` is `has_value`."},"comparison":{"type":"string","enum":["is","contains","has_value","greater_than","greater_than_or_equal","less_than","less_than_or_equal"],"description":"How `value` is matched against the stored custom-field value. `is` is exact equality, `contains` is a case-insensitive substring (blank `value` matches any subscriber that has a value stored for the field), `has_value` matches any non-empty stored value (ignores `value`), `greater_than` / `greater_than_or_equal` / `less_than` / `less_than_or_equal` compare numerically. Only applicable for \'custom_field\' type."},"latitude":{"type":"number","format":"float","description":"Center latitude (decimal degrees). Required for the \'location\' type. Combined with `longitude` and `radius` to form a bounding box around the point."},"longitude":{"type":"number","format":"float","description":"Center longitude (decimal degrees). Required for the \'location\' type."},"radius":{"type":"number","description":"Radius around (`latitude`, `longitude`) in miles. Required for the \'location\' type. Subscribers whose primary location falls inside the bounding box pass the filter."},"any":{"type":"array","description":"Array of OR conditions. Subscriber activity must match ANY of these conditions. Engagement types accept broadcasts/URLs; \'tags\' accepts tag id matchers; \'attribution\' accepts attribution sub-conditions (\'forms\' or \'kit_source\'). Not applicable for \'subscribed\', \'subscriber_state\', \'custom_field\', or \'location\' types.","items":{"oneOf":[{"title":"Broadcasts","$ref":"#/$defs/BroadcastAnyCondition"},{"title":"URLs (clicks only)","$ref":"#/$defs/UrlAnyCondition"},{"title":"Tag ids (tags only)","$ref":"#/$defs/IdsAnyCondition"},{"title":"Forms (attribution only)","$ref":"#/$defs/FormsAnyCondition"},{"title":"Kit source (attribution only)","$ref":"#/$defs/KitSourceAnyCondition"}]}}},"required":["type"]},"FormsAnyCondition":{"type":"object","description":"Attribution sub-condition: matches subscribers whose original signup attribution points at one of the given form / landing-page ids. Ids may refer to either a form or a legacy landing page — the attribution source does not distinguish between the two.","properties":{"type":{"type":"string","enum":["forms"],"description":"Must be \'forms\'"},"ids":{"type":"array","items":{"type":"integer"},"description":"Form / landing-page ids the subscriber\'s attribution should match."}},"required":["type","ids"]},"IdsAnyCondition":{"type":"object","description":"Match a list of ids. Used by the \'tags\' filter to select tag ids.","properties":{"type":{"type":"string","enum":["ids"],"description":"Must be \'ids\'"},"matching":{"type":"array","items":{"type":"integer"},"description":"Ids the filter should match against."}},"required":["type","matching"]},"KitSourceAnyCondition":{"type":"object","description":"Attribution sub-condition: matches subscribers whose original signup attribution row matches any combination of the supplied Kit source fields. All fields are optional; supplied fields are ANDed together against the same attribution row, and array fields (`source_ids`, `source_names`, `mechanism_ids`) match any value in the array. Known `source_type` values include `form_subscription` (form / landing-page signup), `api_subscription` (added via the API), and `manual` (added by the creator). Multiple entries in the parent `attribution` filter\'s `any` array are OR-ed together (consistent with `any` semantics elsewhere in this endpoint), so use separate entries to express \\"kit_source A OR kit_source B\\".","properties":{"type":{"type":"string","enum":["kit_source"],"description":"Must be \'kit_source\'"},"sourceType":{"type":"string","description":"Match attribution rows whose `kit_source_type` equals this value."},"sourceIds":{"type":"array","items":{"type":"integer"},"description":"Match attribution rows whose `kit_source_id` is in this list."},"sourceNames":{"type":"array","items":{"type":"string"},"description":"Match attribution rows whose `kit_source_name` is in this list."},"mechanism":{"type":"string","description":"Match attribution rows whose `kit_source_mechanism` equals this value."},"mechanismIds":{"type":"array","items":{"type":"integer"},"description":"Match attribution rows whose `kit_source_mechanism_id` is in this list."}},"required":["type"]},"SubscriberFilterRequest":{"type":"object","description":"Filter subscribers based on engagement and subscription criteria using the \'all\' array with filter conditions that must all be met (AND logic).","properties":{"countingMode":{"type":"string","enum":["raw","unique_email"],"description":"Controls how engagement-filter count thresholds are tallied. `raw` (default) counts every event — five opens of the same email = five. `unique_email` counts distinct emails on which the action occurred — five opens of the same email = one. Applies to every engagement filter (opens, clicks, sent, delivered) in the request; ignored for other filter types."},"all":{"type":"array","description":"Array of filter conditions where ALL must be met (AND logic)","items":{"$ref":"#/$defs/FilterCondition"}},"include":{"type":"array","description":"Optional. Array of `{ type, ...config }` objects naming additional fields to embed on each subscriber row. Valid types: `attribution`, `tags`, `location`, `canceled_at`, `stats`, `custom_fields`. The `stats` type accepts an optional `range: { start, end }` (YYYY-MM-DD dates, defaulting to the last 90 days). The `custom_fields` type adds a `fields` object with all account custom field values (null for fields the subscriber has not set).","example":[{"type":"tags"},{"type":"stats","range":{"start":"2026-05-01","end":"2026-06-30"}}],"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["attribution","tags","location","canceled_at","stats","custom_fields"]},"range":{"type":"object","description":"Only used by the `stats` type. Date window for the engagement stats. Defaults to the last 90 days; clamped to the account\'s data-retention window.","properties":{"start":{"type":"string","format":"date"},"end":{"type":"string","format":"date"}}}}}},"sortField":{"type":"string","default":"created_at","enum":["id","first_name","email_address","created_at","engagement__sent","engagement__opens","engagement__clicks","engagement__open_rate","engagement__click_rate","location__distance"],"description":"Field to order results by. Base columns (`id`, `first_name`, `email_address`, `created_at`) order by that subscriber attribute. `engagement__<metric>` orders by an engagement stat over the trailing 90 days: counts (`sent`, `opens`, `clicks`) and rates (`open_rate`, `click_rate`); subscribers with no sends order as 0. `location__distance` orders by great-circle distance and requires a `location` filter in the same request — its `latitude`/`longitude` supply the origin, and subscribers without a primary location are excluded. Distance defaults to nearest-first (`sort_order` defaults to `asc` for this field); pass `sort_order=desc` for farthest-first."},"sortOrder":{"type":"string","enum":["asc","desc"],"description":"Sort direction (default: desc)."}},"required":["all"]},"UrlAnyCondition":{"type":"object","description":"Filter by URL patterns. Only applicable for \'clicks\' type. Subscriber must have clicked ANY of the specified URLs.","properties":{"type":{"type":"string","enum":["urls"],"description":"Must be \'urls\'"},"ids":{"type":"array","items":{"type":"integer"},"description":"Array of URL IDs. Subscriber must have clicked ANY of these."},"urls":{"type":"array","items":{"type":"string"},"description":"Array of URL patterns. Subscriber must have clicked ANY of these."},"matching":{"type":"string","enum":["exact","contains","starts_with","ends_with"],"description":"URL matching strategy","default":"exact"}},"required":["type"]}},"operations":{"getCurrentAccount":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{},"required":[],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"user":{"type":"object","properties":{"email":{"type":"string"},"id":{"type":"integer"}},"required":["email"]},"account":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"planType":{"type":"string"},"primaryEmailAddress":{"type":"string"},"createdAt":{"type":"string"},"timezone":{"type":"object","properties":{"name":{"type":"string","description":"Product name"},"friendlyName":{"type":"string"},"utcOffset":{"type":"string"}},"required":["name","friendlyName","utcOffset"]},"sendingAddresses":{"type":"array","items":{"type":"object","properties":{"emailAddress":{"type":"string"},"fromName":{"type":"string"},"status":{"type":"string"},"isDefault":{"type":"boolean"},"isVerified":{"type":"boolean"},"isDmarcConfigured":{"type":"boolean"}},"required":["emailAddress","fromName","status","isDefault","isVerified","isDmarcConfigured"]}},"plan":{"type":"object","properties":{"planType":{"type":"string"},"interval":{"type":"string"},"subscriberLimit":{"type":"integer"},"onTrial":{"type":"boolean"},"trialLapseDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"renewsAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancelsAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["planType","interval","subscriberLimit","onTrial","trialLapseDate","renewsAt","cancelsAt"]}},"required":["id","name","planType","primaryEmailAddress","createdAt","timezone"]}},"required":["user","account"]},"outputWireSchema":{"type":"object","properties":{"user":{"type":"object","properties":{"email":{"type":"string"},"id":{"type":"integer"}},"required":["email"]},"account":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"plan_type":{"type":"string"},"primary_email_address":{"type":"string"},"created_at":{"type":"string"},"timezone":{"type":"object","properties":{"name":{"type":"string","description":"Product name"},"friendly_name":{"type":"string"},"utc_offset":{"type":"string"}},"required":["name","friendly_name","utc_offset"]},"sending_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string"},"from_name":{"type":"string"},"status":{"type":"string"},"is_default":{"type":"boolean"},"is_verified":{"type":"boolean"},"is_dmarc_configured":{"type":"boolean"}},"required":["email_address","from_name","status","is_default","is_verified","is_dmarc_configured"]}},"plan":{"type":"object","properties":{"plan_type":{"type":"string"},"interval":{"type":"string"},"subscriber_limit":{"type":"integer"},"on_trial":{"type":"boolean"},"trial_lapse_date":{"type":"string","nullable":true},"renews_at":{"nullable":true,"type":"string"},"cancels_at":{"nullable":true,"type":"string"}},"required":["plan_type","interval","subscriber_limit","on_trial","trial_lapse_date","renews_at","cancels_at"]}},"required":["id","name","plan_type","primary_email_address","created_at","timezone"]}},"required":["user","account"]},"path":"/v4/account","pathParameters":[],"queryParameters":[],"responseMode":"json"},"listColors":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{},"required":[],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"colors":{"type":"array","items":{"type":"string"}}},"required":["colors"]},"outputWireSchema":{"type":"object","properties":{"colors":{"type":"array","items":{"type":"string"}}},"required":["colors"]},"path":"/v4/account/colors","pathParameters":[],"queryParameters":[],"responseMode":"json"},"updateColors":{"bodyParameters":["colors"],"bodyWireSchema":{"type":"object","properties":{"colors":{"type":"array","description":"An array of up to 10 color hex codes","items":{"type":"string"}}},"required":["colors"]},"inputSchema":{"additionalProperties":false,"properties":{"colors":{"type":"array","description":"An array of up to 10 color hex codes","items":{"type":"string"}}},"required":["colors"],"type":"object"},"method":"PUT","outputSchema":{"type":"object","properties":{"colors":{"type":"array","items":{"type":"string"}}},"required":["colors"]},"outputWireSchema":{"type":"object","properties":{"colors":{"type":"array","items":{"type":"string"}}},"required":["colors"]},"path":"/v4/account/colors","pathParameters":[],"queryParameters":[],"responseMode":"json"},"getCreatorProfile":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{},"required":[],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"profile":{"type":"object","properties":{"name":{"type":"string"},"byline":{"type":"string"},"bio":{"type":"string"},"imageUrl":{"type":"string"},"profileUrl":{"type":"string"}},"required":["name","byline","bio","imageUrl","profileUrl"]}},"required":["profile"]},"outputWireSchema":{"type":"object","properties":{"profile":{"type":"object","properties":{"name":{"type":"string"},"byline":{"type":"string"},"bio":{"type":"string"},"image_url":{"type":"string"},"profile_url":{"type":"string"}},"required":["name","byline","bio","image_url","profile_url"]}},"required":["profile"]},"path":"/v4/account/creator_profile","pathParameters":[],"queryParameters":[],"responseMode":"json"},"getEmailStats":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{},"required":[],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"stats":{"type":"object","properties":{"sent":{"type":"integer"},"clicked":{"type":"integer"},"opened":{"type":"integer"},"emailStatsMode":{"type":"string"},"openTrackingEnabled":{"type":"boolean"},"clickTrackingEnabled":{"type":"boolean"},"starting":{"type":"string"},"ending":{"type":"string"},"openRate":{"type":"number","format":"float"},"clickRate":{"type":"number","format":"float"},"unsubscribeRate":{"type":"number","format":"float"},"bounceRate":{"type":"number","format":"float"}},"required":["sent","clicked","opened","emailStatsMode","openTrackingEnabled","clickTrackingEnabled","starting","ending"]}},"required":["stats"]},"outputWireSchema":{"type":"object","properties":{"stats":{"type":"object","properties":{"sent":{"type":"integer"},"clicked":{"type":"integer"},"opened":{"type":"integer"},"email_stats_mode":{"type":"string"},"open_tracking_enabled":{"type":"boolean"},"click_tracking_enabled":{"type":"boolean"},"starting":{"type":"string"},"ending":{"type":"string"},"open_rate":{"type":"number","format":"float"},"click_rate":{"type":"number","format":"float"},"unsubscribe_rate":{"type":"number","format":"float"},"bounce_rate":{"type":"number","format":"float"}},"required":["sent","clicked","opened","email_stats_mode","open_tracking_enabled","click_tracking_enabled","starting","ending"]}},"required":["stats"]},"path":"/v4/account/email_stats","pathParameters":[],"queryParameters":[],"responseMode":"json"},"getGrowthStats":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"ending":{"type":"string"},"starting":{"type":"string"}},"required":[],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"stats":{"type":"object","properties":{"cancellations":{"type":"integer"},"netNewSubscribers":{"type":"integer"},"newSubscribers":{"type":"integer"},"subscribers":{"type":"integer"},"starting":{"type":"string"},"ending":{"type":"string"}},"required":["cancellations","netNewSubscribers","newSubscribers","subscribers","starting","ending"]}},"required":["stats"]},"outputWireSchema":{"type":"object","properties":{"stats":{"type":"object","properties":{"cancellations":{"type":"integer"},"net_new_subscribers":{"type":"integer"},"new_subscribers":{"type":"integer"},"subscribers":{"type":"integer"},"starting":{"type":"string"},"ending":{"type":"string"}},"required":["cancellations","net_new_subscribers","new_subscribers","subscribers","starting","ending"]}},"required":["stats"]},"path":"/v4/account/growth_stats","pathParameters":[],"queryParameters":[{"explode":true,"name":"ending","providerName":"ending","style":"form"},{"explode":true,"name":"starting","providerName":"starting","style":"form"}],"responseMode":"json"},"listBroadcasts":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"after":{"anyOf":[{"type":"string"},{"type":"null"}]},"before":{"anyOf":[{"type":"string"},{"type":"null"}]},"includeTotalCount":{"type":"boolean"},"perPage":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}]},"sentAfter":{"anyOf":[{"type":"string"},{"type":"null"}]},"sentBefore":{"anyOf":[{"type":"string"},{"type":"null"}]},"slim":{"type":"boolean"},"status":{"type":"string","enum":["draft","scheduled","sending","completed","aborted"]}},"required":[],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"broadcasts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"publicationId":{"type":"integer","description":"Identifier of the underlying publication. Broadcasts that are also published as posts share the same `publication_id` — use it to match a broadcast to its post via `GET /v4/posts`."},"createdAt":{"type":"string"},"subject":{"type":"string"},"previewText":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"content":{"anyOf":[{"type":"string"},{"type":"null"}]},"public":{"type":"boolean"},"publishedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"sendAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"thumbnailAlt":{"anyOf":[{"type":"string"},{"type":"null"}]},"thumbnailUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"publicUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailTemplate":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"required":["id","name"]},"subscriberFilter":{"type":"array","items":{"type":"object","properties":{"all":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}}},"required":["all"]}},"status":{"type":"string"}},"required":["id","publicationId","createdAt","subject","previewText","description","public","publishedAt","sendAt","thumbnailAlt","thumbnailUrl","content","publicUrl","emailAddress","emailTemplate","subscriberFilter"]}},"pagination":{"type":"object","properties":{"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"},"startCursor":{"type":"string"},"endCursor":{"type":"string"},"perPage":{"type":"integer"}},"required":["hasPreviousPage","hasNextPage","startCursor","endCursor","perPage"]}},"required":["broadcasts","pagination"]},"outputWireSchema":{"type":"object","properties":{"broadcasts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"publication_id":{"type":"integer","description":"Identifier of the underlying publication. Broadcasts that are also published as posts share the same `publication_id` — use it to match a broadcast to its post via `GET /v4/posts`."},"created_at":{"type":"string"},"subject":{"type":"string"},"preview_text":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"content":{"type":"string","nullable":true},"public":{"type":"boolean"},"published_at":{"type":"string","nullable":true},"send_at":{"type":"string","nullable":true},"thumbnail_alt":{"type":"string","nullable":true},"thumbnail_url":{"type":"string","nullable":true},"public_url":{"type":"string","nullable":true},"email_address":{"type":"string","nullable":true},"email_template":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"required":["id","name"]},"subscriber_filter":{"type":"array","items":{"type":"object","properties":{"all":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}}},"required":["all"]}},"status":{"type":"string"}},"required":["id","publication_id","created_at","subject","preview_text","description","public","published_at","send_at","thumbnail_alt","thumbnail_url","content","public_url","email_address","email_template","subscriber_filter"]}},"pagination":{"type":"object","properties":{"has_previous_page":{"type":"boolean"},"has_next_page":{"type":"boolean"},"start_cursor":{"type":"string"},"end_cursor":{"type":"string"},"per_page":{"type":"integer"}},"required":["has_previous_page","has_next_page","start_cursor","end_cursor","per_page"]}},"required":["broadcasts","pagination"]},"path":"/v4/broadcasts","pathParameters":[],"queryParameters":[{"explode":true,"name":"after","providerName":"after","style":"form"},{"explode":true,"name":"before","providerName":"before","style":"form"},{"explode":true,"name":"includeTotalCount","providerName":"include_total_count","style":"form"},{"explode":true,"name":"perPage","providerName":"per_page","style":"form"},{"explode":true,"name":"sentAfter","providerName":"sent_after","style":"form"},{"explode":true,"name":"sentBefore","providerName":"sent_before","style":"form"},{"explode":true,"name":"slim","providerName":"slim","style":"form"},{"explode":true,"name":"status","providerName":"status","style":"form"}],"responseMode":"json"},"createBroadcast":{"bodyParameters":["emailTemplateId","emailAddress","content","description","public","publishedAt","sendAt","thumbnailAlt","thumbnailUrl","previewText","subject","subscriberFilter"],"bodyWireSchema":{"type":"object","properties":{"email_template_id":{"type":"integer","description":"Id of the email template to use. Uses the account\'s default template if not provided. \'Starting point\' template is not supported."},"email_address":{"type":"string","nullable":true,"description":"The sending email address to use. Uses the account\'s sending email address if not provided."},"content":{"type":"string","description":"The HTML content of the email."},"description":{"type":"string"},"public":{"type":"boolean","description":"`true` to publish this broadcast to the web. The broadcast will appear in a newsletter feed on your Creator Profile and Landing Pages."},"published_at":{"type":"string","description":"The published timestamp to display in ISO8601 format. If no timezone is provided, UTC is assumed."},"send_at":{"type":"string","nullable":true,"description":"The scheduled send time for this broadcast in ISO8601 format. If no timezone is provided, UTC is assumed."},"thumbnail_alt":{"type":"string","nullable":true},"thumbnail_url":{"type":"string","nullable":true},"preview_text":{"type":"string"},"subject":{"type":"string"},"subscriber_filter":{"type":"array","description":"Filters your subscribers. At this time, we only support using only one filter group type via the API (e.g. `all`, `any`, or `none` but no combinations). If nothing is provided, will default to all of your subscribers.","items":{"type":"object","properties":{"all":{"type":"array","description":"Filters your subscribers using a logical AND of all provided segment and tag ids, i.e. a subscriber would have to be part of all segments and tags provided","items":{"type":"object","properties":{"type":{"type":"string","enum":["segment","tag"],"description":"`segment` or `tag`"},"ids":{"type":"array","items":{"type":"integer"}}},"required":["type","ids"]}},"any":{"type":"array","description":"Filters your subscribers using a logical OR of all provided segment and tag ids, i.e. a subscriber would have to be part of at least one of the segments or tags provided","items":{"type":"object","properties":{"type":{"type":"string","enum":["segment","tag"],"description":"`segment` or `tag`"},"ids":{"type":"array","items":{"type":"integer"}}},"required":["type","ids"]},"nullable":true},"none":{"type":"array","description":"Filters your subscribers using a logical NOT of all provided segment and tag ids, i.e. a subscriber would have to be in none of the segments or tags provided","items":{"type":"object","properties":{"type":{"type":"string","enum":["segment","tag"],"description":"`segment` or `tag`"},"ids":{"type":"array","items":{"type":"integer"}}},"required":["type","ids"]},"nullable":true}},"minProperties":1,"required":["all","any","none"]}}},"required":["content","description","public","published_at","preview_text","subject","subscriber_filter"]},"inputSchema":{"additionalProperties":false,"properties":{"emailTemplateId":{"type":"integer","description":"Id of the email template to use. Uses the account\'s default template if not provided. \'Starting point\' template is not supported."},"emailAddress":{"anyOf":[{"type":"string","description":"The sending email address to use. Uses the account\'s sending email address if not provided."},{"type":"null"}]},"content":{"type":"string","description":"The HTML content of the email."},"description":{"type":"string"},"public":{"type":"boolean","description":"`true` to publish this broadcast to the web. The broadcast will appear in a newsletter feed on your Creator Profile and Landing Pages."},"publishedAt":{"type":"string","description":"The published timestamp to display in ISO8601 format. If no timezone is provided, UTC is assumed."},"sendAt":{"anyOf":[{"type":"string","description":"The scheduled send time for this broadcast in ISO8601 format. If no timezone is provided, UTC is assumed."},{"type":"null"}]},"thumbnailAlt":{"anyOf":[{"type":"string"},{"type":"null"}]},"thumbnailUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"previewText":{"type":"string"},"subject":{"type":"string"},"subscriberFilter":{"type":"array","description":"Filters your subscribers. At this time, we only support using only one filter group type via the API (e.g. `all`, `any`, or `none` but no combinations). If nothing is provided, will default to all of your subscribers.","items":{"type":"object","properties":{"all":{"type":"array","description":"Filters your subscribers using a logical AND of all provided segment and tag ids, i.e. a subscriber would have to be part of all segments and tags provided","items":{"type":"object","properties":{"type":{"type":"string","enum":["segment","tag"],"description":"`segment` or `tag`"},"ids":{"type":"array","items":{"type":"integer"}}},"required":["type","ids"]}},"any":{"anyOf":[{"type":"array","description":"Filters your subscribers using a logical OR of all provided segment and tag ids, i.e. a subscriber would have to be part of at least one of the segments or tags provided","items":{"type":"object","properties":{"type":{"type":"string","enum":["segment","tag"],"description":"`segment` or `tag`"},"ids":{"type":"array","items":{"type":"integer"}}},"required":["type","ids"]}},{"type":"null"}]},"none":{"anyOf":[{"type":"array","description":"Filters your subscribers using a logical NOT of all provided segment and tag ids, i.e. a subscriber would have to be in none of the segments or tags provided","items":{"type":"object","properties":{"type":{"type":"string","enum":["segment","tag"],"description":"`segment` or `tag`"},"ids":{"type":"array","items":{"type":"integer"}}},"required":["type","ids"]}},{"type":"null"}]}},"minProperties":1,"required":["all","any","none"]}}},"required":["content","description","public","publishedAt","previewText","subject","subscriberFilter"],"type":"object"},"method":"POST","outputSchema":{"type":"object","properties":{"broadcast":{"type":"object","properties":{"id":{"type":"integer"},"publicationId":{"type":"integer"},"createdAt":{"type":"string"},"subject":{"type":"string"},"previewText":{"type":"string"},"description":{"type":"string"},"content":{"type":"string"},"public":{"type":"boolean"},"publishedAt":{"type":"string"},"sendAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"thumbnailAlt":{"anyOf":[{"type":"string"},{"type":"null"}]},"thumbnailUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"publicUrl":{"type":"string"},"emailAddress":{"type":"string"},"emailTemplate":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"required":["id","name"]},"subscriberFilter":{"type":"array","items":{"type":"object","properties":{"all":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["segment","tag"]},"ids":{"type":"array","items":{"type":"integer"}}},"required":["type","ids"]}}},"required":["all"]}},"status":{"type":"string"}},"required":["id","publicationId","createdAt","subject","previewText","description","public","publishedAt","sendAt","thumbnailAlt","thumbnailUrl","content","publicUrl","emailAddress","emailTemplate","subscriberFilter"]}},"required":["broadcast"]},"outputWireSchema":{"type":"object","properties":{"broadcast":{"type":"object","properties":{"id":{"type":"integer"},"publication_id":{"type":"integer"},"created_at":{"type":"string"},"subject":{"type":"string"},"preview_text":{"type":"string"},"description":{"type":"string"},"content":{"type":"string"},"public":{"type":"boolean"},"published_at":{"type":"string"},"send_at":{"type":"string","nullable":true},"thumbnail_alt":{"type":"string","nullable":true},"thumbnail_url":{"type":"string","nullable":true},"public_url":{"type":"string"},"email_address":{"type":"string"},"email_template":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"required":["id","name"]},"subscriber_filter":{"type":"array","items":{"type":"object","properties":{"all":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["segment","tag"]},"ids":{"type":"array","items":{"type":"integer"}}},"required":["type","ids"]}}},"required":["all"]}},"status":{"type":"string"}},"required":["id","publication_id","created_at","subject","preview_text","description","public","published_at","send_at","thumbnail_alt","thumbnail_url","content","public_url","email_address","email_template","subscriber_filter"]}},"required":["broadcast"]},"path":"/v4/broadcasts","pathParameters":[],"queryParameters":[],"responseMode":"json"},"listBroadcastStats":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"after":{"anyOf":[{"type":"string"},{"type":"null"}]},"before":{"anyOf":[{"type":"string"},{"type":"null"}]},"includeTotalCount":{"type":"boolean"},"perPage":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}]},"sentAfter":{"anyOf":[{"type":"string"},{"type":"null"}]},"sentBefore":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","enum":["draft","scheduled","sending","completed","aborted"]}},"required":[],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"broadcasts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"stats":{"type":"object","properties":{"recipients":{"type":"integer"},"openRate":{"type":"number","format":"float"},"emailsOpened":{"type":"integer"},"clickRate":{"type":"number","format":"float"},"unsubscribeRate":{"type":"number","format":"float"},"unsubscribes":{"type":"integer"},"totalClicks":{"type":"integer"},"showTotalClicks":{"type":"boolean"},"status":{"type":"string"},"progress":{"type":"number","format":"float"},"openTrackingDisabled":{"type":"boolean"},"clickTrackingDisabled":{"type":"boolean"}},"required":["recipients","openRate","emailsOpened","clickRate","unsubscribeRate","unsubscribes","totalClicks","showTotalClicks","status","progress","openTrackingDisabled","clickTrackingDisabled"]},"subject":{"type":"string"},"sendAt":{"anyOf":[{},{"type":"null"}]}},"required":["id","stats"]}},"pagination":{"type":"object","properties":{"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"},"startCursor":{"type":"string"},"endCursor":{"type":"string"},"perPage":{"type":"integer"}},"required":["hasPreviousPage","hasNextPage","startCursor","endCursor","perPage"]}},"required":["broadcasts","pagination"]},"outputWireSchema":{"type":"object","properties":{"broadcasts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"stats":{"type":"object","properties":{"recipients":{"type":"integer"},"open_rate":{"type":"number","format":"float"},"emails_opened":{"type":"integer"},"click_rate":{"type":"number","format":"float"},"unsubscribe_rate":{"type":"number","format":"float"},"unsubscribes":{"type":"integer"},"total_clicks":{"type":"integer"},"show_total_clicks":{"type":"boolean"},"status":{"type":"string"},"progress":{"type":"number","format":"float"},"open_tracking_disabled":{"type":"boolean"},"click_tracking_disabled":{"type":"boolean"}},"required":["recipients","open_rate","emails_opened","click_rate","unsubscribe_rate","unsubscribes","total_clicks","show_total_clicks","status","progress","open_tracking_disabled","click_tracking_disabled"]},"subject":{"type":"string"},"send_at":{"nullable":true}},"required":["id","stats"]}},"pagination":{"type":"object","properties":{"has_previous_page":{"type":"boolean"},"has_next_page":{"type":"boolean"},"start_cursor":{"type":"string"},"end_cursor":{"type":"string"},"per_page":{"type":"integer"}},"required":["has_previous_page","has_next_page","start_cursor","end_cursor","per_page"]}},"required":["broadcasts","pagination"]},"path":"/v4/broadcasts/stats","pathParameters":[],"queryParameters":[{"explode":true,"name":"after","providerName":"after","style":"form"},{"explode":true,"name":"before","providerName":"before","style":"form"},{"explode":true,"name":"includeTotalCount","providerName":"include_total_count","style":"form"},{"explode":true,"name":"perPage","providerName":"per_page","style":"form"},{"explode":true,"name":"sentAfter","providerName":"sent_after","style":"form"},{"explode":true,"name":"sentBefore","providerName":"sent_before","style":"form"},{"explode":true,"name":"status","providerName":"status","style":"form"}],"responseMode":"json"},"listBroadcastLinkClicks":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"broadcastId":{"type":"integer"}},"required":["broadcastId"],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"broadcast":{"type":"object","properties":{"id":{"type":"integer"},"clicks":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"uniqueClicks":{"type":"integer"},"clickToDeliveryRate":{"type":"number","format":"float"},"clickToOpenRate":{"type":"number","format":"float"},"id":{"type":"integer"}},"required":["url","uniqueClicks","clickToDeliveryRate","clickToOpenRate"]}}},"required":["id","clicks"]},"pagination":{"type":"object","properties":{"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"},"startCursor":{"type":"string"},"endCursor":{"type":"string"},"perPage":{"type":"integer"}},"required":["hasPreviousPage","hasNextPage","startCursor","endCursor","perPage"]}},"required":["broadcast","pagination"]},"outputWireSchema":{"type":"object","properties":{"broadcast":{"type":"object","properties":{"id":{"type":"integer"},"clicks":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"unique_clicks":{"type":"integer"},"click_to_delivery_rate":{"type":"number","format":"float"},"click_to_open_rate":{"type":"number","format":"float"},"id":{"type":"integer"}},"required":["url","unique_clicks","click_to_delivery_rate","click_to_open_rate"]}}},"required":["id","clicks"]},"pagination":{"type":"object","properties":{"has_previous_page":{"type":"boolean"},"has_next_page":{"type":"boolean"},"start_cursor":{"type":"string"},"end_cursor":{"type":"string"},"per_page":{"type":"integer"}},"required":["has_previous_page","has_next_page","start_cursor","end_cursor","per_page"]}},"required":["broadcast","pagination"]},"path":"/v4/broadcasts/{broadcast_id}/clicks","pathParameters":[{"explode":true,"name":"broadcastId","providerName":"broadcast_id","style":"form"}],"queryParameters":[],"responseMode":"json"},"getBroadcastStats":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"broadcastId":{"type":"integer"}},"required":["broadcastId"],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"broadcast":{"type":"object","properties":{"id":{"type":"integer"},"stats":{"type":"object","properties":{"recipients":{"type":"integer"},"openRate":{"type":"number","format":"float"},"emailsOpened":{"type":"integer"},"clickRate":{"type":"number","format":"float"},"unsubscribeRate":{"type":"number","format":"float"},"unsubscribes":{"type":"integer"},"totalClicks":{"type":"integer"},"showTotalClicks":{"type":"boolean"},"status":{"type":"string"},"progress":{"type":"number","format":"float"},"openTrackingDisabled":{"type":"boolean"},"clickTrackingDisabled":{"type":"boolean"}},"required":["recipients","openRate","emailsOpened","clickRate","unsubscribeRate","unsubscribes","totalClicks","showTotalClicks","status","progress","openTrackingDisabled","clickTrackingDisabled"]}},"required":["id","stats"]}},"required":["broadcast"]},"outputWireSchema":{"type":"object","properties":{"broadcast":{"type":"object","properties":{"id":{"type":"integer"},"stats":{"type":"object","properties":{"recipients":{"type":"integer"},"open_rate":{"type":"number","format":"float"},"emails_opened":{"type":"integer"},"click_rate":{"type":"number","format":"float"},"unsubscribe_rate":{"type":"number","format":"float"},"unsubscribes":{"type":"integer"},"total_clicks":{"type":"integer"},"show_total_clicks":{"type":"boolean"},"status":{"type":"string"},"progress":{"type":"number","format":"float"},"open_tracking_disabled":{"type":"boolean"},"click_tracking_disabled":{"type":"boolean"}},"required":["recipients","open_rate","emails_opened","click_rate","unsubscribe_rate","unsubscribes","total_clicks","show_total_clicks","status","progress","open_tracking_disabled","click_tracking_disabled"]}},"required":["id","stats"]}},"required":["broadcast"]},"path":"/v4/broadcasts/{broadcast_id}/stats","pathParameters":[{"explode":true,"name":"broadcastId","providerName":"broadcast_id","style":"form"}],"queryParameters":[],"responseMode":"json"},"deleteBroadcast":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"id":{"type":"integer"}},"required":["id"],"type":"object"},"method":"DELETE","outputSchema":{"additionalProperties":false,"properties":{},"type":"object"},"outputWireSchema":{"additionalProperties":false,"properties":{},"type":"object"},"path":"/v4/broadcasts/{id}","pathParameters":[{"explode":true,"name":"id","providerName":"id","style":"form"}],"queryParameters":[],"responseMode":"void"},"getBroadcast":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"[]":{"type":"string"},"id":{"type":"integer"}},"required":["id"],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"broadcast":{"type":"object","properties":{"id":{"type":"integer"},"publicationId":{"type":"integer","description":"Identifier of the underlying publication. Broadcasts that are also published as posts share the same `publication_id` — use it to match a broadcast to its post via `GET /v4/posts`."},"createdAt":{"type":"string"},"subject":{"type":"string"},"previewText":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"content":{"anyOf":[{"type":"string"},{"type":"null"}]},"public":{"type":"boolean"},"publishedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"sendAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"thumbnailAlt":{"anyOf":[{"type":"string"},{"type":"null"}]},"thumbnailUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"publicUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailTemplate":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"required":["id","name"]},"subscriberFilter":{"type":"array","items":{"type":"object","properties":{"all":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}}},"required":["all"]}},"status":{"type":"string"}},"required":["id","publicationId","createdAt","subject","previewText","description","public","publishedAt","sendAt","thumbnailAlt","thumbnailUrl","content","publicUrl","emailAddress","emailTemplate","subscriberFilter"]}},"required":["broadcast"]},"outputWireSchema":{"type":"object","properties":{"broadcast":{"type":"object","properties":{"id":{"type":"integer"},"publication_id":{"type":"integer","description":"Identifier of the underlying publication. Broadcasts that are also published as posts share the same `publication_id` — use it to match a broadcast to its post via `GET /v4/posts`."},"created_at":{"type":"string"},"subject":{"type":"string"},"preview_text":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"content":{"type":"string","nullable":true},"public":{"type":"boolean"},"published_at":{"type":"string","nullable":true},"send_at":{"type":"string","nullable":true},"thumbnail_alt":{"type":"string","nullable":true},"thumbnail_url":{"type":"string","nullable":true},"public_url":{"type":"string","nullable":true},"email_address":{"type":"string","nullable":true},"email_template":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"required":["id","name"]},"subscriber_filter":{"type":"array","items":{"type":"object","properties":{"all":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}}},"required":["all"]}},"status":{"type":"string"}},"required":["id","publication_id","created_at","subject","preview_text","description","public","published_at","send_at","thumbnail_alt","thumbnail_url","content","public_url","email_address","email_template","subscriber_filter"]}},"required":["broadcast"]},"path":"/v4/broadcasts/{id}","pathParameters":[{"explode":true,"name":"id","providerName":"id","style":"form"}],"queryParameters":[{"explode":true,"name":"[]","providerName":"[]","style":"form"}],"responseMode":"json"},"updateBroadcast":{"bodyParameters":["emailTemplateId","emailAddress","content","description","public","publishedAt","sendAt","thumbnailAlt","thumbnailUrl","previewText","subject","subscriberFilter"],"bodyWireSchema":{"type":"object","properties":{"email_template_id":{"type":"integer","description":"Id of the email template to use. Uses the account\'s default template if not provided. \'Starting point\' template is not supported."},"email_address":{"type":"string","nullable":true,"description":"The sending email address to use. Uses the account\'s sending email address if not provided."},"content":{"type":"string","description":"The HTML content of the email."},"description":{"type":"string"},"public":{"type":"boolean","description":"`true` to publish this broadcast to the web. The broadcast will appear in a newsletter feed on your Creator Profile and Landing Pages."},"published_at":{"type":"string","description":"The published timestamp to display in ISO8601 format. If no timezone is provided, UTC is assumed."},"send_at":{"type":"string","description":"The scheduled send time for this broadcast in ISO8601 format. If no timezone is provided, UTC is assumed."},"thumbnail_alt":{"nullable":true},"thumbnail_url":{"nullable":true},"preview_text":{"type":"string"},"subject":{"type":"string"},"subscriber_filter":{"type":"array","description":"Filters your subscribers. At this time, we only support using only one filter group type via the API (e.g. `all`, `any`, or `none` but no combinations). If nothing is provided, will default to all of your subscribers.","items":{"type":"object","properties":{"all":{"type":"array","description":"Filters your subscribers using a logical AND of all provided segment and tag ids, i.e. a subscriber would have to be part of all segments and tags provided","items":{"type":"object","properties":{"type":{"type":"string","description":"`segment` or `tag`"},"ids":{"type":"array","items":{"type":"integer"}}},"required":["type","ids"]}},"any":{"type":"array","description":"Filters your subscribers using a logical OR of all provided segment and tag ids, i.e. a subscriber would have to be part of at least one of the segments or tags provided","items":{"type":"object","properties":{"type":{"type":"string","description":"`segment` or `tag`"},"ids":{"type":"array","items":{"type":"integer"}}},"required":["type","ids"]},"nullable":true},"none":{"type":"array","description":"Filters your subscribers using a logical NOT of all provided segment and tag ids, i.e. a subscriber would have to be in none of the segments or tags provided","items":{"type":"object","properties":{"type":{"type":"string","description":"`segment` or `tag`"},"ids":{"type":"array","items":{"type":"integer"}}},"required":["type","ids"]},"nullable":true}},"minProperties":1,"required":["all","any","none"]}}},"required":["email_template_id","email_address","content","description","public","published_at","send_at","thumbnail_alt","thumbnail_url","preview_text","subject","subscriber_filter"]},"inputSchema":{"additionalProperties":false,"properties":{"id":{"type":"integer"},"emailTemplateId":{"type":"integer","description":"Id of the email template to use. Uses the account\'s default template if not provided. \'Starting point\' template is not supported."},"emailAddress":{"anyOf":[{"type":"string","description":"The sending email address to use. Uses the account\'s sending email address if not provided."},{"type":"null"}]},"content":{"type":"string","description":"The HTML content of the email."},"description":{"type":"string"},"public":{"type":"boolean","description":"`true` to publish this broadcast to the web. The broadcast will appear in a newsletter feed on your Creator Profile and Landing Pages."},"publishedAt":{"type":"string","description":"The published timestamp to display in ISO8601 format. If no timezone is provided, UTC is assumed."},"sendAt":{"type":"string","description":"The scheduled send time for this broadcast in ISO8601 format. If no timezone is provided, UTC is assumed."},"thumbnailAlt":{"anyOf":[{},{"type":"null"}]},"thumbnailUrl":{"anyOf":[{},{"type":"null"}]},"previewText":{"type":"string"},"subject":{"type":"string"},"subscriberFilter":{"type":"array","description":"Filters your subscribers. At this time, we only support using only one filter group type via the API (e.g. `all`, `any`, or `none` but no combinations). If nothing is provided, will default to all of your subscribers.","items":{"type":"object","properties":{"all":{"type":"array","description":"Filters your subscribers using a logical AND of all provided segment and tag ids, i.e. a subscriber would have to be part of all segments and tags provided","items":{"type":"object","properties":{"type":{"type":"string","description":"`segment` or `tag`"},"ids":{"type":"array","items":{"type":"integer"}}},"required":["type","ids"]}},"any":{"anyOf":[{"type":"array","description":"Filters your subscribers using a logical OR of all provided segment and tag ids, i.e. a subscriber would have to be part of at least one of the segments or tags provided","items":{"type":"object","properties":{"type":{"type":"string","description":"`segment` or `tag`"},"ids":{"type":"array","items":{"type":"integer"}}},"required":["type","ids"]}},{"type":"null"}]},"none":{"anyOf":[{"type":"array","description":"Filters your subscribers using a logical NOT of all provided segment and tag ids, i.e. a subscriber would have to be in none of the segments or tags provided","items":{"type":"object","properties":{"type":{"type":"string","description":"`segment` or `tag`"},"ids":{"type":"array","items":{"type":"integer"}}},"required":["type","ids"]}},{"type":"null"}]}},"minProperties":1,"required":["all","any","none"]}}},"required":["id","emailTemplateId","emailAddress","content","description","public","publishedAt","sendAt","thumbnailAlt","thumbnailUrl","previewText","subject","subscriberFilter"],"type":"object"},"method":"PUT","outputSchema":{"type":"object","properties":{"broadcast":{"type":"object","properties":{"id":{"type":"integer"},"publicationId":{"type":"integer"},"createdAt":{"type":"string"},"subject":{"type":"string"},"previewText":{"type":"string"},"description":{"type":"string"},"content":{"type":"string"},"public":{"type":"boolean"},"publishedAt":{"type":"string"},"sendAt":{"type":"string"},"thumbnailAlt":{"anyOf":[{},{"type":"null"}]},"thumbnailUrl":{"anyOf":[{},{"type":"null"}]},"publicUrl":{"type":"string"},"emailAddress":{"type":"string"},"emailTemplate":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"required":["id","name"]},"subscriberFilter":{"type":"array","items":{"type":"object","properties":{"all":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"ids":{"type":"array","items":{"type":"integer"}}},"required":["type","ids"]}}},"required":["all"]}},"status":{"type":"string"}},"required":["id","publicationId","createdAt","subject","previewText","description","public","publishedAt","sendAt","thumbnailAlt","thumbnailUrl","content","publicUrl","emailAddress","emailTemplate","subscriberFilter"]}},"required":["broadcast"]},"outputWireSchema":{"type":"object","properties":{"broadcast":{"type":"object","properties":{"id":{"type":"integer"},"publication_id":{"type":"integer"},"created_at":{"type":"string"},"subject":{"type":"string"},"preview_text":{"type":"string"},"description":{"type":"string"},"content":{"type":"string"},"public":{"type":"boolean"},"published_at":{"type":"string"},"send_at":{"type":"string"},"thumbnail_alt":{"nullable":true},"thumbnail_url":{"nullable":true},"public_url":{"type":"string"},"email_address":{"type":"string"},"email_template":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"required":["id","name"]},"subscriber_filter":{"type":"array","items":{"type":"object","properties":{"all":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"ids":{"type":"array","items":{"type":"integer"}}},"required":["type","ids"]}}},"required":["all"]}},"status":{"type":"string"}},"required":["id","publication_id","created_at","subject","preview_text","description","public","published_at","send_at","thumbnail_alt","thumbnail_url","content","public_url","email_address","email_template","subscriber_filter"]}},"required":["broadcast"]},"path":"/v4/broadcasts/{id}","pathParameters":[{"explode":true,"name":"id","providerName":"id","style":"form"}],"queryParameters":[],"responseMode":"json"},"bulkCreateCustomFields":{"bodyParameters":["customFields","callbackUrl"],"bodyWireSchema":{"type":"object","properties":{"custom_fields":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"]}},"callback_url":{"type":"string","nullable":true}},"required":["custom_fields"]},"inputSchema":{"additionalProperties":false,"properties":{"customFields":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"]}},"callbackUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["customFields"],"type":"object"},"method":"POST","outputSchema":{"anyOf":[{"type":"object","properties":{"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"label":{"type":"string"},"key":{"type":"string"},"name":{"type":"string"},"createdAt":{"type":"string"}},"required":["id","key","label","name","createdAt"]}},"failures":{"type":"array","items":{}}},"required":["customFields","failures"]},{"type":"object","properties":{}}]},"outputWireSchema":{"anyOf":[{"type":"object","properties":{"custom_fields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"label":{"type":"string"},"key":{"type":"string"},"name":{"type":"string"},"created_at":{"type":"string"}},"required":["id","key","label","name","created_at"]}},"failures":{"type":"array","items":{}}},"required":["custom_fields","failures"]},{"type":"object","properties":{}}]},"path":"/v4/bulk/custom_fields","pathParameters":[],"queryParameters":[],"responseMode":"json"},"bulkUpdateSubscriberCustomFieldValues":{"bodyParameters":["customFieldValues","callbackUrl"],"bodyWireSchema":{"type":"object","properties":{"custom_field_values":{"type":"array","items":{"type":"object","properties":{"subscriber_id":{"type":"integer","nullable":true},"subscriber_custom_field_id":{"type":"integer"},"value":{"type":"string"}},"required":["subscriber_id","subscriber_custom_field_id","value"]}},"callback_url":{"nullable":true}},"required":["custom_field_values","callback_url"]},"inputSchema":{"additionalProperties":false,"properties":{"customFieldValues":{"type":"array","items":{"type":"object","properties":{"subscriberId":{"anyOf":[{"type":"integer"},{"type":"null"}]},"subscriberCustomFieldId":{"type":"integer"},"value":{"type":"string"}},"required":["subscriberId","subscriberCustomFieldId","value"]}},"callbackUrl":{"anyOf":[{},{"type":"null"}]}},"required":["customFieldValues","callbackUrl"],"type":"object"},"method":"POST","outputSchema":{"anyOf":[{"type":"object","properties":{"customFieldValues":{"type":"array","items":{"type":"object","properties":{"subscriberId":{"type":"integer"},"subscriberCustomFieldId":{"type":"integer"},"value":{"type":"string"}},"required":["subscriberId","subscriberCustomFieldId","value"]}},"failures":{"type":"array","items":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"customFieldValue":{"type":"object","properties":{"subscriberId":{"anyOf":[{"type":"integer"},{"type":"null"}]},"subscriberCustomFieldId":{"type":"integer"},"value":{"type":"string"}},"required":["subscriberId","subscriberCustomFieldId","value"]}},"required":["errors","customFieldValue"]}}},"required":["customFieldValues","failures"]},{"type":"object","properties":{}}]},"outputWireSchema":{"anyOf":[{"type":"object","properties":{"custom_field_values":{"type":"array","items":{"type":"object","properties":{"subscriber_id":{"type":"integer"},"subscriber_custom_field_id":{"type":"integer"},"value":{"type":"string"}},"required":["subscriber_id","subscriber_custom_field_id","value"]}},"failures":{"type":"array","items":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"custom_field_value":{"type":"object","properties":{"subscriber_id":{"type":"integer","nullable":true},"subscriber_custom_field_id":{"type":"integer"},"value":{"type":"string"}},"required":["subscriber_id","subscriber_custom_field_id","value"]}},"required":["errors","custom_field_value"]}}},"required":["custom_field_values","failures"]},{"type":"object","properties":{}}]},"path":"/v4/bulk/custom_fields/subscribers","pathParameters":[],"queryParameters":[],"responseMode":"json"},"listCustomFields":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"after":{"anyOf":[{"type":"string"},{"type":"null"}]},"before":{"anyOf":[{"type":"string"},{"type":"null"}]},"includeTotalCount":{"type":"boolean"},"perPage":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}]}},"required":[],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"key":{"type":"string"},"label":{"type":"string"}},"required":["id","name","key","label"]}},"pagination":{"type":"object","properties":{"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"},"startCursor":{"type":"string"},"endCursor":{"type":"string"},"perPage":{"type":"integer"}},"required":["hasPreviousPage","hasNextPage","startCursor","endCursor","perPage"]}},"required":["customFields","pagination"]},"outputWireSchema":{"type":"object","properties":{"custom_fields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"key":{"type":"string"},"label":{"type":"string"}},"required":["id","name","key","label"]}},"pagination":{"type":"object","properties":{"has_previous_page":{"type":"boolean"},"has_next_page":{"type":"boolean"},"start_cursor":{"type":"string"},"end_cursor":{"type":"string"},"per_page":{"type":"integer"}},"required":["has_previous_page","has_next_page","start_cursor","end_cursor","per_page"]}},"required":["custom_fields","pagination"]},"path":"/v4/custom_fields","pathParameters":[],"queryParameters":[{"explode":true,"name":"after","providerName":"after","style":"form"},{"explode":true,"name":"before","providerName":"before","style":"form"},{"explode":true,"name":"includeTotalCount","providerName":"include_total_count","style":"form"},{"explode":true,"name":"perPage","providerName":"per_page","style":"form"}],"responseMode":"json"},"createCustomField":{"bodyParameters":["label"],"bodyWireSchema":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"]},"inputSchema":{"additionalProperties":false,"properties":{"label":{"type":"string"}},"required":["label"],"type":"object"},"method":"POST","outputSchema":{"anyOf":[{"type":"object","properties":{"customField":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"key":{"type":"string"},"label":{"type":"string"}},"required":["id","name","key","label"]}},"required":["customField"]},{"type":"object","properties":{"customField":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"key":{"type":"string"},"label":{"type":"string"}},"required":["id","name","key","label"]}},"required":["customField"]}]},"outputWireSchema":{"anyOf":[{"type":"object","properties":{"custom_field":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"key":{"type":"string"},"label":{"type":"string"}},"required":["id","name","key","label"]}},"required":["custom_field"]},{"type":"object","properties":{"custom_field":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"key":{"type":"string"},"label":{"type":"string"}},"required":["id","name","key","label"]}},"required":["custom_field"]}]},"path":"/v4/custom_fields","pathParameters":[],"queryParameters":[],"responseMode":"json"},"deleteCustomField":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"id":{"type":"integer"}},"required":["id"],"type":"object"},"method":"DELETE","outputSchema":{"additionalProperties":false,"properties":{},"type":"object"},"outputWireSchema":{"additionalProperties":false,"properties":{},"type":"object"},"path":"/v4/custom_fields/{id}","pathParameters":[{"explode":true,"name":"id","providerName":"id","style":"form"}],"queryParameters":[],"responseMode":"void"},"updateCustomField":{"bodyParameters":["label"],"bodyWireSchema":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"]},"inputSchema":{"additionalProperties":false,"properties":{"id":{"type":"integer"},"label":{"type":"string"}},"required":["id","label"],"type":"object"},"method":"PUT","outputSchema":{"type":"object","properties":{"customField":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"key":{"type":"string"},"label":{"type":"string"}},"required":["id","name","key","label"]}},"required":["customField"]},"outputWireSchema":{"type":"object","properties":{"custom_field":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"key":{"type":"string"},"label":{"type":"string"}},"required":["id","name","key","label"]}},"required":["custom_field"]},"path":"/v4/custom_fields/{id}","pathParameters":[{"explode":true,"name":"id","providerName":"id","style":"form"}],"queryParameters":[],"responseMode":"json"},"listEmailTemplates":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"after":{"anyOf":[{"type":"string"},{"type":"null"}]},"before":{"anyOf":[{"type":"string"},{"type":"null"}]},"includeTotalCount":{"type":"boolean"},"perPage":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}]}},"required":[],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"emailTemplates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"isDefault":{"type":"boolean"},"category":{"type":"string"}},"required":["id","name","isDefault","category"]}},"pagination":{"type":"object","properties":{"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"},"startCursor":{"type":"string"},"endCursor":{"type":"string"},"perPage":{"type":"integer"}},"required":["hasPreviousPage","hasNextPage","startCursor","endCursor","perPage"]}},"required":["emailTemplates","pagination"]},"outputWireSchema":{"type":"object","properties":{"email_templates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"is_default":{"type":"boolean"},"category":{"type":"string"}},"required":["id","name","is_default","category"]}},"pagination":{"type":"object","properties":{"has_previous_page":{"type":"boolean"},"has_next_page":{"type":"boolean"},"start_cursor":{"type":"string"},"end_cursor":{"type":"string"},"per_page":{"type":"integer"}},"required":["has_previous_page","has_next_page","start_cursor","end_cursor","per_page"]}},"required":["email_templates","pagination"]},"path":"/v4/email_templates","pathParameters":[],"queryParameters":[{"explode":true,"name":"after","providerName":"after","style":"form"},{"explode":true,"name":"before","providerName":"before","style":"form"},{"explode":true,"name":"includeTotalCount","providerName":"include_total_count","style":"form"},{"explode":true,"name":"perPage","providerName":"per_page","style":"form"}],"responseMode":"json"},"bulkAddSubscribersToForms":{"bodyParameters":["additions","callbackUrl"],"bodyWireSchema":{"type":"object","properties":{"additions":{"type":"array","items":{"type":"object","properties":{"form_id":{"type":"integer","nullable":true},"subscriber_id":{"type":"integer","nullable":true},"referrer":{"type":"string"}},"required":["form_id","subscriber_id"]}},"callback_url":{"type":"string","nullable":true}},"required":["additions"]},"inputSchema":{"additionalProperties":false,"properties":{"additions":{"type":"array","items":{"type":"object","properties":{"formId":{"anyOf":[{"type":"integer"},{"type":"null"}]},"subscriberId":{"anyOf":[{"type":"integer"},{"type":"null"}]},"referrer":{"type":"string"}},"required":["formId","subscriberId"]}},"callbackUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["additions"],"type":"object"},"method":"POST","outputSchema":{"anyOf":[{"type":"object","properties":{"subscribers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"type":"string"},"emailAddress":{"type":"string"},"createdAt":{"type":"string"},"addedAt":{"type":"string"},"referrer":{"type":"string"},"referrerUtmParameters":{"type":"object","properties":{"source":{"type":"string"},"medium":{"type":"string"},"campaign":{"type":"string"},"term":{"type":"string"},"content":{"type":"string"}},"required":["source","medium","campaign","term","content"]}},"required":["id","firstName","emailAddress","createdAt","addedAt","referrer","referrerUtmParameters"]}},"failures":{"type":"array","items":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"subscription":{"type":"object","properties":{"formId":{"anyOf":[{"type":"integer"},{"type":"null"}]},"subscriberId":{"anyOf":[{"type":"integer"},{"type":"null"}]},"referrer":{"type":"string"}},"required":["formId","subscriberId","referrer"]}},"required":["errors","subscription"]}}},"required":["subscribers","failures"]},{"type":"object","properties":{}}]},"outputWireSchema":{"anyOf":[{"type":"object","properties":{"subscribers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string"},"email_address":{"type":"string"},"created_at":{"type":"string"},"added_at":{"type":"string"},"referrer":{"type":"string"},"referrer_utm_parameters":{"type":"object","properties":{"source":{"type":"string"},"medium":{"type":"string"},"campaign":{"type":"string"},"term":{"type":"string"},"content":{"type":"string"}},"required":["source","medium","campaign","term","content"]}},"required":["id","first_name","email_address","created_at","added_at","referrer","referrer_utm_parameters"]}},"failures":{"type":"array","items":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"subscription":{"type":"object","properties":{"form_id":{"type":"integer","nullable":true},"subscriber_id":{"nullable":true,"type":"integer"},"referrer":{"type":"string"}},"required":["form_id","subscriber_id","referrer"]}},"required":["errors","subscription"]}}},"required":["subscribers","failures"]},{"type":"object","properties":{}}]},"path":"/v4/bulk/forms/subscribers","pathParameters":[],"queryParameters":[],"responseMode":"json"},"listForms":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"after":{"anyOf":[{"type":"string"},{"type":"null"}]},"before":{"anyOf":[{"type":"string"},{"type":"null"}]},"includeTotalCount":{"type":"boolean"},"perPage":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["active","archived","trashed","all"]},{"type":"null"}]},"type":{"anyOf":[{"enum":["embed","hosted"],"type":"string"},{"type":"null"}]},"include":{"type":"string"}},"required":[],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"forms":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"createdAt":{"type":"string"},"type":{"type":"string"},"format":{"anyOf":[{},{"type":"null"}]},"embedJs":{"type":"string"},"embedUrl":{"type":"string"},"archived":{"type":"boolean"},"uid":{"type":"string"},"subscriberCount":{"type":"integer","description":"Returned when `include` contains `subscriber_count`. The number of active subscribers who subscribed via this form."}},"required":["id","name","createdAt","type","format","embedJs","embedUrl","archived","uid"]}},"pagination":{"type":"object","properties":{"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"},"startCursor":{"type":"string"},"endCursor":{"type":"string"},"perPage":{"type":"integer"}},"required":["hasPreviousPage","hasNextPage","startCursor","endCursor","perPage"]}},"required":["forms","pagination"]},"outputWireSchema":{"type":"object","properties":{"forms":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"created_at":{"type":"string"},"type":{"type":"string"},"format":{"nullable":true},"embed_js":{"type":"string"},"embed_url":{"type":"string"},"archived":{"type":"boolean"},"uid":{"type":"string"},"subscriber_count":{"type":"integer","description":"Returned when `include` contains `subscriber_count`. The number of active subscribers who subscribed via this form."}},"required":["id","name","created_at","type","format","embed_js","embed_url","archived","uid"]}},"pagination":{"type":"object","properties":{"has_previous_page":{"type":"boolean"},"has_next_page":{"type":"boolean"},"start_cursor":{"type":"string"},"end_cursor":{"type":"string"},"per_page":{"type":"integer"}},"required":["has_previous_page","has_next_page","start_cursor","end_cursor","per_page"]}},"required":["forms","pagination"]},"path":"/v4/forms","pathParameters":[],"queryParameters":[{"explode":true,"name":"after","providerName":"after","style":"form"},{"explode":true,"name":"before","providerName":"before","style":"form"},{"explode":true,"name":"includeTotalCount","providerName":"include_total_count","style":"form"},{"explode":true,"name":"perPage","providerName":"per_page","style":"form"},{"explode":true,"name":"status","providerName":"status","style":"form"},{"explode":true,"name":"type","providerName":"type","style":"form"},{"explode":true,"name":"include","providerName":"include","style":"form"}],"responseMode":"json"},"listFormSubscribers":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"addedAfter":{"anyOf":[{"type":"string"},{"type":"null"}]},"addedBefore":{"anyOf":[{"type":"string"},{"type":"null"}]},"after":{"anyOf":[{"type":"string"},{"type":"null"}]},"before":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAfter":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdBefore":{"anyOf":[{"type":"string"},{"type":"null"}]},"formId":{"type":"integer"},"includeTotalCount":{"type":"boolean"},"perPage":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}]},"slim":{"type":"boolean"},"status":{"type":"string","enum":["active","inactive","bounced","complained","cancelled","all"]}},"required":["formId"],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"subscribers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"createdAt":{"type":"string"},"addedAt":{"type":"string"},"fields":{"type":"object","required":["category"],"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"referrer":{"type":"string"},"referrerUtmParameters":{"type":"object","properties":{"source":{"type":"string"},"medium":{"type":"string"},"campaign":{"type":"string"},"term":{"type":"string"},"content":{"type":"string"}},"required":["source","medium","campaign","term","content"]}},"required":["id","firstName","emailAddress","state","createdAt","addedAt","referrer","referrerUtmParameters","fields"]}},"pagination":{"type":"object","properties":{"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"},"startCursor":{"type":"string"},"endCursor":{"type":"string"},"perPage":{"type":"integer"}},"required":["hasPreviousPage","hasNextPage","startCursor","endCursor","perPage"]}},"required":["subscribers","pagination"]},"outputWireSchema":{"type":"object","properties":{"subscribers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"created_at":{"type":"string"},"added_at":{"type":"string"},"fields":{"type":"object","required":["category"],"additionalProperties":{"nullable":true,"type":"string"}},"referrer":{"type":"string"},"referrer_utm_parameters":{"type":"object","properties":{"source":{"type":"string"},"medium":{"type":"string"},"campaign":{"type":"string"},"term":{"type":"string"},"content":{"type":"string"}},"required":["source","medium","campaign","term","content"]}},"required":["id","first_name","email_address","state","created_at","added_at","referrer","referrer_utm_parameters","fields"]}},"pagination":{"type":"object","properties":{"has_previous_page":{"type":"boolean"},"has_next_page":{"type":"boolean"},"start_cursor":{"type":"string"},"end_cursor":{"type":"string"},"per_page":{"type":"integer"}},"required":["has_previous_page","has_next_page","start_cursor","end_cursor","per_page"]}},"required":["subscribers","pagination"]},"path":"/v4/forms/{form_id}/subscribers","pathParameters":[{"explode":true,"name":"formId","providerName":"form_id","style":"form"}],"queryParameters":[{"explode":true,"name":"addedAfter","providerName":"added_after","style":"form"},{"explode":true,"name":"addedBefore","providerName":"added_before","style":"form"},{"explode":true,"name":"after","providerName":"after","style":"form"},{"explode":true,"name":"before","providerName":"before","style":"form"},{"explode":true,"name":"createdAfter","providerName":"created_after","style":"form"},{"explode":true,"name":"createdBefore","providerName":"created_before","style":"form"},{"explode":true,"name":"includeTotalCount","providerName":"include_total_count","style":"form"},{"explode":true,"name":"perPage","providerName":"per_page","style":"form"},{"explode":true,"name":"slim","providerName":"slim","style":"form"},{"explode":true,"name":"status","providerName":"status","style":"form"}],"responseMode":"json"},"addSubscriberToFormByEmailAddress":{"bodyParameters":["emailAddress","referrer"],"bodyWireSchema":{"type":"object","properties":{"email_address":{"type":"string"},"referrer":{"type":"string","nullable":true}},"required":["email_address"]},"inputSchema":{"additionalProperties":false,"properties":{"formId":{"type":"integer"},"emailAddress":{"type":"string"},"referrer":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["formId","emailAddress"],"type":"object"},"method":"POST","outputSchema":{"anyOf":[{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"createdAt":{"type":"string"},"addedAt":{"type":"string"},"fields":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"referrer":{"type":"string"},"referrerUtmParameters":{"type":"object","properties":{"source":{"type":"string"},"medium":{"type":"string"},"campaign":{"type":"string"},"term":{"type":"string"},"content":{"type":"string"}},"required":["source","medium","campaign","term","content"]}},"required":["id","firstName","emailAddress","state","createdAt","addedAt","referrer","referrerUtmParameters","fields"]}},"required":["subscriber"]},{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"createdAt":{"type":"string"},"addedAt":{"type":"string"},"fields":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"referrer":{"type":"string"},"referrerUtmParameters":{"type":"object","properties":{"source":{"type":"string"},"medium":{"type":"string"},"campaign":{"type":"string"},"term":{"type":"string"},"content":{"type":"string"}},"required":["source","medium","campaign","term","content"]}},"required":["id","firstName","emailAddress","state","createdAt","addedAt","referrer","referrerUtmParameters","fields"]}},"required":["subscriber"]}]},"outputWireSchema":{"anyOf":[{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"created_at":{"type":"string"},"added_at":{"type":"string"},"fields":{"type":"object","additionalProperties":{"nullable":true,"type":"string"}},"referrer":{"type":"string"},"referrer_utm_parameters":{"type":"object","properties":{"source":{"type":"string"},"medium":{"type":"string"},"campaign":{"type":"string"},"term":{"type":"string"},"content":{"type":"string"}},"required":["source","medium","campaign","term","content"]}},"required":["id","first_name","email_address","state","created_at","added_at","referrer","referrer_utm_parameters","fields"]}},"required":["subscriber"]},{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"created_at":{"type":"string"},"added_at":{"type":"string"},"fields":{"type":"object","additionalProperties":{"nullable":true,"type":"string"}},"referrer":{"type":"string"},"referrer_utm_parameters":{"type":"object","properties":{"source":{"type":"string"},"medium":{"type":"string"},"campaign":{"type":"string"},"term":{"type":"string"},"content":{"type":"string"}},"required":["source","medium","campaign","term","content"]}},"required":["id","first_name","email_address","state","created_at","added_at","referrer","referrer_utm_parameters","fields"]}},"required":["subscriber"]}]},"path":"/v4/forms/{form_id}/subscribers","pathParameters":[{"explode":true,"name":"formId","providerName":"form_id","style":"form"}],"queryParameters":[],"responseMode":"json"},"addSubscriberToForm":{"bodyParameters":["referrer"],"bodyWireSchema":{"type":"object","properties":{"referrer":{"type":"string"}},"required":["referrer"]},"inputSchema":{"additionalProperties":false,"properties":{"formId":{"type":"integer"},"id":{"type":"integer"},"referrer":{"type":"string"}},"required":["formId","id","referrer"],"type":"object"},"method":"POST","outputSchema":{"anyOf":[{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"createdAt":{"type":"string"},"addedAt":{"type":"string"},"fields":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"referrer":{"type":"string"},"referrerUtmParameters":{"type":"object","properties":{"source":{"type":"string"},"medium":{"type":"string"},"campaign":{"type":"string"},"term":{"type":"string"},"content":{"type":"string"}},"required":["source","medium","campaign","term","content"]}},"required":["id","firstName","emailAddress","state","createdAt","addedAt","referrer","referrerUtmParameters","fields"]}},"required":["subscriber"]},{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"state":{"anyOf":[{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},{"type":"null"}]},"createdAt":{"type":"string"},"addedAt":{"type":"string"},"fields":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"referrer":{"type":"string"},"referrerUtmParameters":{"type":"object","properties":{"source":{"type":"string"},"medium":{"type":"string"},"campaign":{"type":"string"},"term":{"type":"string"},"content":{"type":"string"}},"required":["source","medium","campaign","term","content"]}},"required":["id","firstName","emailAddress","state","createdAt","addedAt","referrer","referrerUtmParameters","fields"]}},"required":["subscriber"]}]},"outputWireSchema":{"anyOf":[{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"created_at":{"type":"string"},"added_at":{"type":"string"},"fields":{"type":"object","additionalProperties":{"nullable":true,"type":"string"}},"referrer":{"type":"string"},"referrer_utm_parameters":{"type":"object","properties":{"source":{"type":"string"},"medium":{"type":"string"},"campaign":{"type":"string"},"term":{"type":"string"},"content":{"type":"string"}},"required":["source","medium","campaign","term","content"]}},"required":["id","first_name","email_address","state","created_at","added_at","referrer","referrer_utm_parameters","fields"]}},"required":["subscriber"]},{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"state":{"type":"string","nullable":true,"enum":["active","cancelled","bounced","complained","inactive"]},"created_at":{"type":"string"},"added_at":{"type":"string"},"fields":{"type":"object","additionalProperties":{"nullable":true,"type":"string"}},"referrer":{"type":"string"},"referrer_utm_parameters":{"type":"object","properties":{"source":{"type":"string"},"medium":{"type":"string"},"campaign":{"type":"string"},"term":{"type":"string"},"content":{"type":"string"}},"required":["source","medium","campaign","term","content"]}},"required":["id","first_name","email_address","state","created_at","added_at","referrer","referrer_utm_parameters","fields"]}},"required":["subscriber"]}]},"path":"/v4/forms/{form_id}/subscribers/{id}","pathParameters":[{"explode":true,"name":"formId","providerName":"form_id","style":"form"},{"explode":true,"name":"id","providerName":"id","style":"form"}],"queryParameters":[],"responseMode":"json"},"listPosts":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"after":{"anyOf":[{"type":"string"},{"type":"null"}]},"before":{"anyOf":[{"type":"string"},{"type":"null"}]},"includeContent":{"type":"boolean"},"includeTotalCount":{"type":"boolean"},"perPage":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}]}},"required":[],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"posts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"publicationId":{"type":"integer","description":"Identifier of the underlying publication. Posts that were also sent as broadcasts share the same `publication_id` — use it to match a post to its broadcast via `GET /v4/broadcasts`."},"createdAt":{"type":"string"},"title":{"type":"string"},"slug":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{},{"type":"null"}]},"metaDescription":{"anyOf":[{},{"type":"null"}]},"status":{"type":"string"},"publishedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"sentAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"thumbnailAlt":{"anyOf":[{},{"type":"null"}]},"thumbnailUrl":{"anyOf":[{},{"type":"null"}]},"isPaid":{"type":"boolean"},"publicUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","publicationId","createdAt","title","slug","description","metaDescription","status","publishedAt","sentAt","thumbnailAlt","thumbnailUrl","isPaid","publicUrl"]}},"pagination":{"type":"object","properties":{"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"},"startCursor":{"type":"string"},"endCursor":{"type":"string"},"perPage":{"type":"integer"}},"required":["hasPreviousPage","hasNextPage","startCursor","endCursor","perPage"]}},"required":["posts","pagination"]},"outputWireSchema":{"type":"object","properties":{"posts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"publication_id":{"type":"integer","description":"Identifier of the underlying publication. Posts that were also sent as broadcasts share the same `publication_id` — use it to match a post to its broadcast via `GET /v4/broadcasts`."},"created_at":{"type":"string"},"title":{"type":"string"},"slug":{"type":"string","nullable":true},"description":{"nullable":true},"meta_description":{"nullable":true},"status":{"type":"string"},"published_at":{"type":"string","nullable":true},"sent_at":{"type":"string","nullable":true},"thumbnail_alt":{"nullable":true},"thumbnail_url":{"nullable":true},"is_paid":{"type":"boolean"},"public_url":{"type":"string","nullable":true}},"required":["id","publication_id","created_at","title","slug","description","meta_description","status","published_at","sent_at","thumbnail_alt","thumbnail_url","is_paid","public_url"]}},"pagination":{"type":"object","properties":{"has_previous_page":{"type":"boolean"},"has_next_page":{"type":"boolean"},"start_cursor":{"type":"string"},"end_cursor":{"type":"string"},"per_page":{"type":"integer"}},"required":["has_previous_page","has_next_page","start_cursor","end_cursor","per_page"]}},"required":["posts","pagination"]},"path":"/v4/posts","pathParameters":[],"queryParameters":[{"explode":true,"name":"after","providerName":"after","style":"form"},{"explode":true,"name":"before","providerName":"before","style":"form"},{"explode":true,"name":"includeContent","providerName":"include_content","style":"form"},{"explode":true,"name":"includeTotalCount","providerName":"include_total_count","style":"form"},{"explode":true,"name":"perPage","providerName":"per_page","style":"form"}],"responseMode":"json"},"getPost":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"id":{"type":"integer"}},"required":["id"],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"post":{"type":"object","properties":{"id":{"type":"integer"},"publicationId":{"type":"integer","description":"Identifier of the underlying publication. Posts that were also sent as broadcasts share the same `publication_id` — use it to match a post to its broadcast via `GET /v4/broadcasts`."},"createdAt":{"type":"string"},"title":{"type":"string"},"slug":{"type":"string"},"description":{"anyOf":[{},{"type":"null"}]},"metaDescription":{"anyOf":[{},{"type":"null"}]},"status":{"type":"string"},"publishedAt":{"type":"string"},"sentAt":{"anyOf":[{},{"type":"null"}]},"thumbnailAlt":{"anyOf":[{},{"type":"null"}]},"thumbnailUrl":{"anyOf":[{},{"type":"null"}]},"isPaid":{"type":"boolean"},"publicUrl":{"type":"string"},"content":{"type":"string"}},"required":["id","publicationId","createdAt","title","slug","description","metaDescription","status","publishedAt","sentAt","thumbnailAlt","thumbnailUrl","isPaid","publicUrl","content"]}},"required":["post"]},"outputWireSchema":{"type":"object","properties":{"post":{"type":"object","properties":{"id":{"type":"integer"},"publication_id":{"type":"integer","description":"Identifier of the underlying publication. Posts that were also sent as broadcasts share the same `publication_id` — use it to match a post to its broadcast via `GET /v4/broadcasts`."},"created_at":{"type":"string"},"title":{"type":"string"},"slug":{"type":"string"},"description":{"nullable":true},"meta_description":{"nullable":true},"status":{"type":"string"},"published_at":{"type":"string"},"sent_at":{"nullable":true},"thumbnail_alt":{"nullable":true},"thumbnail_url":{"nullable":true},"is_paid":{"type":"boolean"},"public_url":{"type":"string"},"content":{"type":"string"}},"required":["id","publication_id","created_at","title","slug","description","meta_description","status","published_at","sent_at","thumbnail_alt","thumbnail_url","is_paid","public_url","content"]}},"required":["post"]},"path":"/v4/posts/{id}","pathParameters":[{"explode":true,"name":"id","providerName":"id","style":"form"}],"queryParameters":[],"responseMode":"json"},"listPurchases":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"after":{"anyOf":[{"type":"string"},{"type":"null"}]},"before":{"anyOf":[{"type":"string"},{"type":"null"}]},"includeTotalCount":{"type":"boolean"},"perPage":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}]}},"required":[],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"purchases":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"transactionId":{"type":"string"},"subscriberId":{"type":"integer"},"status":{"type":"string"},"emailAddress":{"type":"string","description":"The subscriber that the purchase belongs to"},"currency":{"type":"string","description":"3 letter currency code (e.g. `USD`)"},"transactionTime":{"type":"string"},"subtotal":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"tax":{"type":"number","format":"float"},"total":{"type":"number","format":"float"},"products":{"type":"array","description":"Array of purchased products","items":{"type":"object","properties":{"quantity":{"type":"integer","description":"Product quantity"},"lid":{"type":"string","description":"Each product should have a unique `lid` (i.e., line item identifier) for this purchase."},"unitPrice":{"type":"number","format":"float","description":"Product price"},"sku":{"anyOf":[{"description":"Product sku"},{"type":"null"}]},"name":{"type":"string","description":"Product name"},"pid":{"type":"string","description":"This is your identifier for a product. Each product provided in the `products` array must have a unique pid. Variants of the same product should have the same pid."}},"required":["quantity","lid","unitPrice","sku","name","pid"]}},"source":{"type":"string"}},"required":["id","transactionId","status","emailAddress","subscriberId","currency","transactionTime","subtotal","discount","tax","total","products"]}},"pagination":{"type":"object","properties":{"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"},"startCursor":{"type":"string"},"endCursor":{"type":"string"},"perPage":{"type":"integer"}},"required":["hasPreviousPage","hasNextPage","startCursor","endCursor","perPage"]}},"required":["purchases","pagination"]},"outputWireSchema":{"type":"object","properties":{"purchases":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"transaction_id":{"type":"string"},"subscriber_id":{"type":"integer"},"status":{"type":"string"},"email_address":{"type":"string","description":"The subscriber that the purchase belongs to"},"currency":{"type":"string","description":"3 letter currency code (e.g. `USD`)"},"transaction_time":{"type":"string"},"subtotal":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"tax":{"type":"number","format":"float"},"total":{"type":"number","format":"float"},"products":{"type":"array","description":"Array of purchased products","items":{"type":"object","properties":{"quantity":{"type":"integer","description":"Product quantity"},"lid":{"type":"string","description":"Each product should have a unique `lid` (i.e., line item identifier) for this purchase."},"unit_price":{"type":"number","format":"float","description":"Product price"},"sku":{"nullable":true,"description":"Product sku"},"name":{"type":"string","description":"Product name"},"pid":{"type":"string","description":"This is your identifier for a product. Each product provided in the `products` array must have a unique pid. Variants of the same product should have the same pid."}},"required":["quantity","lid","unit_price","sku","name","pid"]}},"source":{"type":"string"}},"required":["id","transaction_id","status","email_address","subscriber_id","currency","transaction_time","subtotal","discount","tax","total","products"]}},"pagination":{"type":"object","properties":{"has_previous_page":{"type":"boolean"},"has_next_page":{"type":"boolean"},"start_cursor":{"type":"string"},"end_cursor":{"type":"string"},"per_page":{"type":"integer"}},"required":["has_previous_page","has_next_page","start_cursor","end_cursor","per_page"]}},"required":["purchases","pagination"]},"path":"/v4/purchases","pathParameters":[],"queryParameters":[{"explode":true,"name":"after","providerName":"after","style":"form"},{"explode":true,"name":"before","providerName":"before","style":"form"},{"explode":true,"name":"includeTotalCount","providerName":"include_total_count","style":"form"},{"explode":true,"name":"perPage","providerName":"per_page","style":"form"}],"responseMode":"json"},"createPurchase":{"bodyParameters":["purchase"],"bodyWireSchema":{"type":"object","properties":{"purchase":{"type":"object","properties":{"email_address":{"type":"string","description":"The subscriber that the purchase belongs to"},"transaction_id":{"type":"string"},"status":{"type":"string"},"subtotal":{"type":"number","format":"float"},"tax":{"type":"number","format":"float"},"shipping":{"type":"integer"},"discount":{"type":"number","format":"float"},"total":{"type":"number","format":"float"},"currency":{"type":"string","description":"3 letter currency code (e.g. `USD`)"},"transaction_time":{"type":"string"},"products":{"type":"array","description":"Array of purchased products","items":{"type":"object","properties":{"name":{"type":"string","description":"Product name"},"pid":{"type":"string","description":"This is your identifier for a product. Each product provided in the `products` array must have a unique pid. Variants of the same product should have the same pid."},"lid":{"type":"string","description":"Each product should have a unique `lid` (i.e., line item identifier) for this purchase."},"quantity":{"type":"integer","description":"Product quantity"},"unit_price":{"type":"number","format":"float","description":"Product price"},"sku":{"type":"string","description":"Product sku"}},"required":["name","pid","lid","quantity","unit_price","sku"]}}},"required":["email_address","transaction_id","status","subtotal","tax","shipping","discount","total","currency","transaction_time","products"]}},"required":["purchase"]},"inputSchema":{"additionalProperties":false,"properties":{"purchase":{"type":"object","properties":{"emailAddress":{"type":"string","description":"The subscriber that the purchase belongs to"},"transactionId":{"type":"string"},"status":{"type":"string"},"subtotal":{"type":"number","format":"float"},"tax":{"type":"number","format":"float"},"shipping":{"type":"integer"},"discount":{"type":"number","format":"float"},"total":{"type":"number","format":"float"},"currency":{"type":"string","description":"3 letter currency code (e.g. `USD`)"},"transactionTime":{"type":"string"},"products":{"type":"array","description":"Array of purchased products","items":{"type":"object","properties":{"name":{"type":"string","description":"Product name"},"pid":{"type":"string","description":"This is your identifier for a product. Each product provided in the `products` array must have a unique pid. Variants of the same product should have the same pid."},"lid":{"type":"string","description":"Each product should have a unique `lid` (i.e., line item identifier) for this purchase."},"quantity":{"type":"integer","description":"Product quantity"},"unitPrice":{"type":"number","format":"float","description":"Product price"},"sku":{"type":"string","description":"Product sku"}},"required":["name","pid","lid","quantity","unitPrice","sku"]}}},"required":["emailAddress","transactionId","status","subtotal","tax","shipping","discount","total","currency","transactionTime","products"]}},"required":["purchase"],"type":"object"},"method":"POST","outputSchema":{"type":"object","properties":{"purchase":{"type":"object","properties":{"id":{"type":"integer"},"transactionId":{"type":"string"},"subscriberId":{"type":"integer"},"status":{"type":"string"},"emailAddress":{"type":"string","description":"The subscriber that the purchase belongs to"},"currency":{"type":"string","description":"3 letter currency code (e.g. `USD`)"},"transactionTime":{"type":"string"},"subtotal":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"tax":{"type":"number","format":"float"},"total":{"type":"number","format":"float"},"products":{"type":"array","items":{"type":"object","properties":{"quantity":{"type":"integer","description":"Product quantity"},"lid":{"type":"string","description":"Each product should have a unique `lid` (i.e., line item identifier) for this purchase."},"unitPrice":{"type":"number","format":"float","description":"Product price"},"sku":{"type":"string","description":"Product sku"},"name":{"type":"string","description":"Product name"},"pid":{"type":"string","description":"This is your identifier for a product. Each product provided in the `products` array must have a unique pid. Variants of the same product should have the same pid."}},"required":["quantity","lid","unitPrice","sku","name","pid"]}},"source":{"type":"string"}},"required":["id","transactionId","status","emailAddress","subscriberId","currency","transactionTime","subtotal","discount","tax","total","products"]}},"required":["purchase"]},"outputWireSchema":{"type":"object","properties":{"purchase":{"type":"object","properties":{"id":{"type":"integer"},"transaction_id":{"type":"string"},"subscriber_id":{"type":"integer"},"status":{"type":"string"},"email_address":{"type":"string","description":"The subscriber that the purchase belongs to"},"currency":{"type":"string","description":"3 letter currency code (e.g. `USD`)"},"transaction_time":{"type":"string"},"subtotal":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"tax":{"type":"number","format":"float"},"total":{"type":"number","format":"float"},"products":{"type":"array","items":{"type":"object","properties":{"quantity":{"type":"integer","description":"Product quantity"},"lid":{"type":"string","description":"Each product should have a unique `lid` (i.e., line item identifier) for this purchase."},"unit_price":{"type":"number","format":"float","description":"Product price"},"sku":{"type":"string","description":"Product sku"},"name":{"type":"string","description":"Product name"},"pid":{"type":"string","description":"This is your identifier for a product. Each product provided in the `products` array must have a unique pid. Variants of the same product should have the same pid."}},"required":["quantity","lid","unit_price","sku","name","pid"]}},"source":{"type":"string"}},"required":["id","transaction_id","status","email_address","subscriber_id","currency","transaction_time","subtotal","discount","tax","total","products"]}},"required":["purchase"]},"path":"/v4/purchases","pathParameters":[],"queryParameters":[],"responseMode":"json"},"getPurchase":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"id":{"type":"integer"}},"required":["id"],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"purchase":{"type":"object","properties":{"id":{"type":"integer"},"transactionId":{"type":"string"},"subscriberId":{"type":"integer"},"status":{"type":"string"},"emailAddress":{"type":"string"},"currency":{"type":"string"},"transactionTime":{"type":"string"},"subtotal":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"tax":{"type":"number","format":"float"},"total":{"type":"number","format":"float"},"products":{"type":"array","items":{"type":"object","properties":{"quantity":{"type":"integer","description":"Product quantity"},"lid":{"type":"string","description":"Each product should have a unique `lid` (i.e., line item identifier) for this purchase."},"unitPrice":{"type":"number","format":"float","description":"Product price"},"sku":{"anyOf":[{},{"type":"null"}]},"name":{"type":"string","description":"Product name"},"pid":{"type":"string","description":"This is your identifier for a product. Each product provided in the `products` array must have a unique pid. Variants of the same product should have the same pid."}},"required":["quantity","lid","unitPrice","sku","name","pid"]}},"source":{"type":"string"}},"required":["id","transactionId","status","emailAddress","subscriberId","currency","transactionTime","subtotal","discount","tax","total","products"]}},"required":["purchase"]},"outputWireSchema":{"type":"object","properties":{"purchase":{"type":"object","properties":{"id":{"type":"integer"},"transaction_id":{"type":"string"},"subscriber_id":{"type":"integer"},"status":{"type":"string"},"email_address":{"type":"string"},"currency":{"type":"string"},"transaction_time":{"type":"string"},"subtotal":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"tax":{"type":"number","format":"float"},"total":{"type":"number","format":"float"},"products":{"type":"array","items":{"type":"object","properties":{"quantity":{"type":"integer","description":"Product quantity"},"lid":{"type":"string","description":"Each product should have a unique `lid` (i.e., line item identifier) for this purchase."},"unit_price":{"type":"number","format":"float","description":"Product price"},"sku":{"nullable":true},"name":{"type":"string","description":"Product name"},"pid":{"type":"string","description":"This is your identifier for a product. Each product provided in the `products` array must have a unique pid. Variants of the same product should have the same pid."}},"required":["quantity","lid","unit_price","sku","name","pid"]}},"source":{"type":"string"}},"required":["id","transaction_id","status","email_address","subscriber_id","currency","transaction_time","subtotal","discount","tax","total","products"]}},"required":["purchase"]},"path":"/v4/purchases/{id}","pathParameters":[{"explode":true,"name":"id","providerName":"id","style":"form"}],"queryParameters":[],"responseMode":"json"},"listSegments":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"after":{"anyOf":[{"type":"string"},{"type":"null"}]},"before":{"anyOf":[{"type":"string"},{"type":"null"}]},"includeTotalCount":{"type":"boolean"},"perPage":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}]}},"required":[],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"segments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"createdAt":{"type":"string"}},"required":["id","name","createdAt"]}},"pagination":{"type":"object","properties":{"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"},"startCursor":{"type":"string"},"endCursor":{"type":"string"},"perPage":{"type":"integer"}},"required":["hasPreviousPage","hasNextPage","startCursor","endCursor","perPage"]}},"required":["segments","pagination"]},"outputWireSchema":{"type":"object","properties":{"segments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"created_at":{"type":"string"}},"required":["id","name","created_at"]}},"pagination":{"type":"object","properties":{"has_previous_page":{"type":"boolean"},"has_next_page":{"type":"boolean"},"start_cursor":{"type":"string"},"end_cursor":{"type":"string"},"per_page":{"type":"integer"}},"required":["has_previous_page","has_next_page","start_cursor","end_cursor","per_page"]}},"required":["segments","pagination"]},"path":"/v4/segments","pathParameters":[],"queryParameters":[{"explode":true,"name":"after","providerName":"after","style":"form"},{"explode":true,"name":"before","providerName":"before","style":"form"},{"explode":true,"name":"includeTotalCount","providerName":"include_total_count","style":"form"},{"explode":true,"name":"perPage","providerName":"per_page","style":"form"}],"responseMode":"json"},"listSequenceEmails":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"after":{"anyOf":[{"type":"string"},{"type":"null"}]},"before":{"anyOf":[{"type":"string"},{"type":"null"}]},"includeContent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"includeTotalCount":{"type":"boolean"},"perPage":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}]},"sequenceId":{"type":"integer"},"include":{"type":"string"}},"required":["sequenceId"],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"sequenceId":{"type":"integer"},"subject":{"type":"string"},"previewText":{"type":"string"},"emailAddress":{"type":"string"},"emailTemplateId":{"anyOf":[{},{"type":"null"}]},"published":{"type":"boolean"},"position":{"type":"integer"},"delayValue":{"type":"integer"},"delayUnit":{"type":"string"},"sendDays":{"type":"array","items":{"type":"string"}},"stats":{"type":"object","description":"Returned only when `include` contains `stats`. Deliverability counts and rates for this email, matching the numbers shown on the sequence report. All fields are 0 when the email has no deliverability data.","properties":{"recipients":{"type":"integer","description":"Number of times this email was sent. Denominator for the rate fields."},"opens":{"type":"integer","description":"Number of sent emails that were opened."},"clicks":{"type":"integer","description":"Number of sent emails that had a link clicked."},"emailUnsubscribes":{"type":"integer","description":"Number of unsubscribe events on this email (email-level events, not current subscription state)."},"bounces":{"type":"integer","description":"Number of sent emails that bounced."},"complaints":{"type":"integer","description":"Number of sent emails that were marked as spam."},"openRate":{"type":"number","description":"Percentage of sent emails that were opened."},"clickRate":{"type":"number","description":"Percentage of sent emails that had a link clicked."},"clickToOpenRate":{"type":"number","description":"Percentage of opened emails that had a link clicked."},"unsubscribeRate":{"type":"number","description":"Percentage of sent emails that resulted in an unsubscribe."},"bounceRate":{"type":"number","description":"Percentage of sent emails that bounced."},"complaintRate":{"type":"number","description":"Percentage of sent emails marked as spam."}}}},"required":["id","sequenceId","subject","previewText","emailAddress","emailTemplateId","published","position","delayValue","delayUnit","sendDays"]}},"pagination":{"type":"object","properties":{"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"},"startCursor":{"type":"string"},"endCursor":{"type":"string"},"perPage":{"type":"integer"}},"required":["hasPreviousPage","hasNextPage","startCursor","endCursor","perPage"]}},"required":["emails","pagination"]},"outputWireSchema":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"sequence_id":{"type":"integer"},"subject":{"type":"string"},"preview_text":{"type":"string"},"email_address":{"type":"string"},"email_template_id":{"nullable":true},"published":{"type":"boolean"},"position":{"type":"integer"},"delay_value":{"type":"integer"},"delay_unit":{"type":"string"},"send_days":{"type":"array","items":{"type":"string"}},"stats":{"type":"object","description":"Returned only when `include` contains `stats`. Deliverability counts and rates for this email, matching the numbers shown on the sequence report. All fields are 0 when the email has no deliverability data.","properties":{"recipients":{"type":"integer","description":"Number of times this email was sent. Denominator for the rate fields."},"opens":{"type":"integer","description":"Number of sent emails that were opened."},"clicks":{"type":"integer","description":"Number of sent emails that had a link clicked."},"email_unsubscribes":{"type":"integer","description":"Number of unsubscribe events on this email (email-level events, not current subscription state)."},"bounces":{"type":"integer","description":"Number of sent emails that bounced."},"complaints":{"type":"integer","description":"Number of sent emails that were marked as spam."},"open_rate":{"type":"number","description":"Percentage of sent emails that were opened."},"click_rate":{"type":"number","description":"Percentage of sent emails that had a link clicked."},"click_to_open_rate":{"type":"number","description":"Percentage of opened emails that had a link clicked."},"unsubscribe_rate":{"type":"number","description":"Percentage of sent emails that resulted in an unsubscribe."},"bounce_rate":{"type":"number","description":"Percentage of sent emails that bounced."},"complaint_rate":{"type":"number","description":"Percentage of sent emails marked as spam."}}}},"required":["id","sequence_id","subject","preview_text","email_address","email_template_id","published","position","delay_value","delay_unit","send_days"]}},"pagination":{"type":"object","properties":{"has_previous_page":{"type":"boolean"},"has_next_page":{"type":"boolean"},"start_cursor":{"type":"string"},"end_cursor":{"type":"string"},"per_page":{"type":"integer"}},"required":["has_previous_page","has_next_page","start_cursor","end_cursor","per_page"]}},"required":["emails","pagination"]},"path":"/v4/sequences/{sequence_id}/emails","pathParameters":[{"explode":true,"name":"sequenceId","providerName":"sequence_id","style":"form"}],"queryParameters":[{"explode":true,"name":"after","providerName":"after","style":"form"},{"explode":true,"name":"before","providerName":"before","style":"form"},{"explode":true,"name":"includeContent","providerName":"include_content","style":"form"},{"explode":true,"name":"includeTotalCount","providerName":"include_total_count","style":"form"},{"explode":true,"name":"perPage","providerName":"per_page","style":"form"},{"explode":true,"name":"include","providerName":"include","style":"form"}],"responseMode":"json"},"createSequenceEmail":{"bodyParameters":["subject","previewText","content","delayValue","delayUnit","emailTemplateId","published","sendDays","position"],"bodyWireSchema":{"type":"object","required":["subject","delay_value","delay_unit"],"properties":{"subject":{"type":"string","description":"Subject line of the email"},"preview_text":{"type":"string","nullable":true,"description":"Preview text shown in email clients before the email is opened"},"content":{"type":"string","nullable":true,"description":"HTML body content of the email"},"delay_value":{"type":"integer","description":"Number of days or hours to wait before sending this email after the previous one"},"delay_unit":{"type":"string","enum":["days","hours"],"description":"Unit for the send delay. Use `days` for schedule-aware delivery, `hours` for a fixed hourly delay"},"email_template_id":{"type":"integer","nullable":true,"description":"ID of the email template to use for layout and styling"},"published":{"type":"boolean","description":"Whether the email is active and will be sent to subscribers. Defaults to `false` (draft)"},"send_days":{"type":"array","nullable":true,"items":{"type":"string"},"description":"Days of the week this email may be sent. Defaults to all 7 days (inherits the sequence schedule). Pass a subset to restrict delivery, or `null` to reset to all days"},"position":{"type":"integer","nullable":true,"description":"Zero-based position of the email in the sequence. Assigned automatically after the last email if omitted"}}},"inputSchema":{"additionalProperties":false,"properties":{"sequenceId":{"type":"integer"},"subject":{"type":"string","description":"Subject line of the email"},"previewText":{"anyOf":[{"type":"string","description":"Preview text shown in email clients before the email is opened"},{"type":"null"}]},"content":{"anyOf":[{"type":"string","description":"HTML body content of the email"},{"type":"null"}]},"delayValue":{"type":"integer","description":"Number of days or hours to wait before sending this email after the previous one"},"delayUnit":{"type":"string","enum":["days","hours"],"description":"Unit for the send delay. Use `days` for schedule-aware delivery, `hours` for a fixed hourly delay"},"emailTemplateId":{"anyOf":[{"type":"integer","description":"ID of the email template to use for layout and styling"},{"type":"null"}]},"published":{"type":"boolean","description":"Whether the email is active and will be sent to subscribers. Defaults to `false` (draft)"},"sendDays":{"anyOf":[{"type":"array","items":{"type":"string"},"description":"Days of the week this email may be sent. Defaults to all 7 days (inherits the sequence schedule). Pass a subset to restrict delivery, or `null` to reset to all days"},{"type":"null"}]},"position":{"anyOf":[{"type":"integer","description":"Zero-based position of the email in the sequence. Assigned automatically after the last email if omitted"},{"type":"null"}]}},"required":["sequenceId","subject","delayValue","delayUnit"],"type":"object"},"method":"POST","outputSchema":{"type":"object","properties":{"email":{"type":"object","properties":{"id":{"type":"integer"},"sequenceId":{"type":"integer"},"subject":{"type":"string"},"previewText":{"anyOf":[{},{"type":"null"}]},"emailAddress":{"type":"string"},"emailTemplateId":{"anyOf":[{},{"type":"null"}]},"published":{"type":"boolean"},"position":{"anyOf":[{"type":"integer"},{"type":"null"}]},"delayValue":{"type":"integer"},"delayUnit":{"type":"string"},"sendDays":{"type":"array","items":{"type":"string"}},"content":{"anyOf":[{},{"type":"null"}]}},"required":["id","sequenceId","subject","previewText","emailAddress","emailTemplateId","published","position","delayValue","delayUnit","sendDays","content"]}},"required":["email"]},"outputWireSchema":{"type":"object","properties":{"email":{"type":"object","properties":{"id":{"type":"integer"},"sequence_id":{"type":"integer"},"subject":{"type":"string"},"preview_text":{"nullable":true},"email_address":{"type":"string"},"email_template_id":{"nullable":true},"published":{"type":"boolean"},"position":{"nullable":true,"type":"integer"},"delay_value":{"type":"integer"},"delay_unit":{"type":"string"},"send_days":{"type":"array","items":{"type":"string"}},"content":{"nullable":true}},"required":["id","sequence_id","subject","preview_text","email_address","email_template_id","published","position","delay_value","delay_unit","send_days","content"]}},"required":["email"]},"path":"/v4/sequences/{sequence_id}/emails","pathParameters":[{"explode":true,"name":"sequenceId","providerName":"sequence_id","style":"form"}],"queryParameters":[],"responseMode":"json"},"deleteSequenceEmail":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"id":{"type":"integer"},"sequenceId":{"type":"integer"}},"required":["id","sequenceId"],"type":"object"},"method":"DELETE","outputSchema":{"additionalProperties":false,"properties":{},"type":"object"},"outputWireSchema":{"additionalProperties":false,"properties":{},"type":"object"},"path":"/v4/sequences/{sequence_id}/emails/{id}","pathParameters":[{"explode":true,"name":"id","providerName":"id","style":"form"},{"explode":true,"name":"sequenceId","providerName":"sequence_id","style":"form"}],"queryParameters":[],"responseMode":"void"},"getSequenceEmail":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"id":{"type":"integer"},"sequenceId":{"type":"integer"},"include":{"type":"string"}},"required":["id","sequenceId"],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"email":{"type":"object","properties":{"id":{"type":"integer"},"sequenceId":{"type":"integer"},"subject":{"type":"string"},"previewText":{"type":"string"},"emailAddress":{"type":"string"},"emailTemplateId":{"anyOf":[{},{"type":"null"}]},"published":{"type":"boolean"},"position":{"type":"integer"},"delayValue":{"type":"integer"},"delayUnit":{"type":"string"},"sendDays":{"type":"array","items":{"type":"string"}},"content":{"type":"string"},"stats":{"type":"object","description":"Returned only when `include` contains `stats`. Deliverability counts and rates for this email, matching the numbers shown on the sequence report. All fields are 0 when the email has no deliverability data.","properties":{"recipients":{"type":"integer","description":"Number of times this email was sent. Denominator for the rate fields."},"opens":{"type":"integer","description":"Number of sent emails that were opened."},"clicks":{"type":"integer","description":"Number of sent emails that had a link clicked."},"emailUnsubscribes":{"type":"integer","description":"Number of unsubscribe events on this email (email-level events, not current subscription state)."},"bounces":{"type":"integer","description":"Number of sent emails that bounced."},"complaints":{"type":"integer","description":"Number of sent emails that were marked as spam."},"openRate":{"type":"number","description":"Percentage of sent emails that were opened."},"clickRate":{"type":"number","description":"Percentage of sent emails that had a link clicked."},"clickToOpenRate":{"type":"number","description":"Percentage of opened emails that had a link clicked."},"unsubscribeRate":{"type":"number","description":"Percentage of sent emails that resulted in an unsubscribe."},"bounceRate":{"type":"number","description":"Percentage of sent emails that bounced."},"complaintRate":{"type":"number","description":"Percentage of sent emails marked as spam."}}}},"required":["id","sequenceId","subject","previewText","emailAddress","emailTemplateId","published","position","delayValue","delayUnit","sendDays","content"]}},"required":["email"]},"outputWireSchema":{"type":"object","properties":{"email":{"type":"object","properties":{"id":{"type":"integer"},"sequence_id":{"type":"integer"},"subject":{"type":"string"},"preview_text":{"type":"string"},"email_address":{"type":"string"},"email_template_id":{"nullable":true},"published":{"type":"boolean"},"position":{"type":"integer"},"delay_value":{"type":"integer"},"delay_unit":{"type":"string"},"send_days":{"type":"array","items":{"type":"string"}},"content":{"type":"string"},"stats":{"type":"object","description":"Returned only when `include` contains `stats`. Deliverability counts and rates for this email, matching the numbers shown on the sequence report. All fields are 0 when the email has no deliverability data.","properties":{"recipients":{"type":"integer","description":"Number of times this email was sent. Denominator for the rate fields."},"opens":{"type":"integer","description":"Number of sent emails that were opened."},"clicks":{"type":"integer","description":"Number of sent emails that had a link clicked."},"email_unsubscribes":{"type":"integer","description":"Number of unsubscribe events on this email (email-level events, not current subscription state)."},"bounces":{"type":"integer","description":"Number of sent emails that bounced."},"complaints":{"type":"integer","description":"Number of sent emails that were marked as spam."},"open_rate":{"type":"number","description":"Percentage of sent emails that were opened."},"click_rate":{"type":"number","description":"Percentage of sent emails that had a link clicked."},"click_to_open_rate":{"type":"number","description":"Percentage of opened emails that had a link clicked."},"unsubscribe_rate":{"type":"number","description":"Percentage of sent emails that resulted in an unsubscribe."},"bounce_rate":{"type":"number","description":"Percentage of sent emails that bounced."},"complaint_rate":{"type":"number","description":"Percentage of sent emails marked as spam."}}}},"required":["id","sequence_id","subject","preview_text","email_address","email_template_id","published","position","delay_value","delay_unit","send_days","content"]}},"required":["email"]},"path":"/v4/sequences/{sequence_id}/emails/{id}","pathParameters":[{"explode":true,"name":"id","providerName":"id","style":"form"},{"explode":true,"name":"sequenceId","providerName":"sequence_id","style":"form"}],"queryParameters":[{"explode":true,"name":"include","providerName":"include","style":"form"}],"responseMode":"json"},"updateSequenceEmail":{"bodyParameters":["subject","previewText","content","delayValue","delayUnit","emailTemplateId","published","sendDays","position"],"bodyWireSchema":{"type":"object","properties":{"subject":{"type":"string","description":"New subject line for the email"},"preview_text":{"type":"string","nullable":true,"description":"New preview text shown in email clients before the email is opened"},"content":{"type":"string","nullable":true,"description":"New HTML body content of the email"},"delay_value":{"type":"integer","description":"New delay value"},"delay_unit":{"type":"string","enum":["days","hours"],"description":"New delay unit. Use `days` for schedule-aware delivery, `hours` for a fixed hourly delay"},"email_template_id":{"type":"integer","nullable":true,"description":"New email template ID for layout and styling. Pass `null` to clear"},"published":{"type":"boolean","description":"Pass `true` to publish a draft email or `false` to unpublish it"},"send_days":{"type":"array","nullable":true,"items":{"type":"string"},"description":"Days of the week this email may be sent. Pass a subset to restrict delivery, or `null` to reset to all days (inherits the sequence schedule)"},"position":{"type":"integer","nullable":true,"description":"New zero-based position of the email in the sequence"}}},"inputSchema":{"additionalProperties":false,"properties":{"id":{"type":"integer"},"sequenceId":{"type":"integer"},"subject":{"type":"string","description":"New subject line for the email"},"previewText":{"anyOf":[{"type":"string","description":"New preview text shown in email clients before the email is opened"},{"type":"null"}]},"content":{"anyOf":[{"type":"string","description":"New HTML body content of the email"},{"type":"null"}]},"delayValue":{"type":"integer","description":"New delay value"},"delayUnit":{"type":"string","enum":["days","hours"],"description":"New delay unit. Use `days` for schedule-aware delivery, `hours` for a fixed hourly delay"},"emailTemplateId":{"anyOf":[{"type":"integer","description":"New email template ID for layout and styling. Pass `null` to clear"},{"type":"null"}]},"published":{"type":"boolean","description":"Pass `true` to publish a draft email or `false` to unpublish it"},"sendDays":{"anyOf":[{"type":"array","items":{"type":"string"},"description":"Days of the week this email may be sent. Pass a subset to restrict delivery, or `null` to reset to all days (inherits the sequence schedule)"},{"type":"null"}]},"position":{"anyOf":[{"type":"integer","description":"New zero-based position of the email in the sequence"},{"type":"null"}]}},"required":["id","sequenceId"],"type":"object"},"method":"PUT","outputSchema":{"type":"object","properties":{"email":{"type":"object","properties":{"id":{"type":"integer"},"sequenceId":{"type":"integer"},"subject":{"type":"string"},"previewText":{"type":"string"},"emailAddress":{"type":"string"},"emailTemplateId":{"anyOf":[{},{"type":"null"}]},"published":{"type":"boolean"},"position":{"anyOf":[{},{"type":"null"}]},"delayValue":{"type":"integer"},"delayUnit":{"type":"string"},"sendDays":{"type":"array","items":{"type":"string"}},"content":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","sequenceId","subject","previewText","emailAddress","emailTemplateId","published","position","delayValue","delayUnit","sendDays","content"]}},"required":["email"]},"outputWireSchema":{"type":"object","properties":{"email":{"type":"object","properties":{"id":{"type":"integer"},"sequence_id":{"type":"integer"},"subject":{"type":"string"},"preview_text":{"type":"string"},"email_address":{"type":"string"},"email_template_id":{"nullable":true},"published":{"type":"boolean"},"position":{"nullable":true},"delay_value":{"type":"integer"},"delay_unit":{"type":"string"},"send_days":{"type":"array","items":{"type":"string"}},"content":{"nullable":true,"type":"string"}},"required":["id","sequence_id","subject","preview_text","email_address","email_template_id","published","position","delay_value","delay_unit","send_days","content"]}},"required":["email"]},"path":"/v4/sequences/{sequence_id}/emails/{id}","pathParameters":[{"explode":true,"name":"id","providerName":"id","style":"form"},{"explode":true,"name":"sequenceId","providerName":"sequence_id","style":"form"}],"queryParameters":[],"responseMode":"json"},"listSequences":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"after":{"anyOf":[{"type":"string"},{"type":"null"}]},"before":{"anyOf":[{"type":"string"},{"type":"null"}]},"includeTotalCount":{"type":"boolean"},"perPage":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}]},"include":{"type":"string"}},"required":[],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"sequences":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"hold":{"type":"boolean"},"repeat":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"emailAddress":{"anyOf":[{},{"type":"null"}]},"emailTemplateId":{"anyOf":[{},{"type":"null"}]},"sendDays":{"type":"array","items":{"type":"string"}},"sendHour":{"type":"integer"},"timeZone":{"type":"string"},"active":{"type":"boolean"},"excludeSubscriberSources":{"type":"array","items":{}},"emailCount":{"type":"integer"},"subscriberCount":{"type":"integer"},"stats":{"type":"object","description":"Returned only when `include` contains `stats`. Performance stats matching the sequences dashboard. All deliverability fields (everything except `unsubscribers`) are null when the sequence has no deliverability data.","properties":{"unsubscribers":{"type":"integer","description":"Number of subscribers who have unsubscribed from (cancelled) this sequence. Reflects current subscription state (distinct from the email-event `email_unsubscribes` count)."},"recipients":{"anyOf":[{"type":"integer","description":"Number of emails sent across the sequence. Denominator for the rate fields."},{"type":"null"}]},"opens":{"anyOf":[{"type":"integer","description":"Number of sent emails that were opened."},{"type":"null"}]},"clicks":{"anyOf":[{"type":"integer","description":"Number of sent emails that had a link clicked."},{"type":"null"}]},"emailUnsubscribes":{"anyOf":[{"type":"integer","description":"Number of unsubscribe events on emails sent by this sequence (email-level events, not current subscription state)."},{"type":"null"}]},"bounces":{"anyOf":[{"type":"integer","description":"Number of sent emails that bounced."},{"type":"null"}]},"complaints":{"anyOf":[{"type":"integer","description":"Number of sent emails that were marked as spam."},{"type":"null"}]},"openRate":{"anyOf":[{"type":"number","description":"Percentage of sent emails that were opened."},{"type":"null"}]},"clickRate":{"anyOf":[{"type":"number","description":"Percentage of sent emails that had a link clicked."},{"type":"null"}]},"clickToOpenRate":{"anyOf":[{"type":"number","description":"Percentage of opened emails that had a link clicked."},{"type":"null"}]},"unsubscribeRate":{"anyOf":[{"type":"number","description":"Percentage of sent emails that resulted in an unsubscribe."},{"type":"null"}]},"bounceRate":{"anyOf":[{"type":"number","description":"Percentage of sent emails that bounced."},{"type":"null"}]},"complaintRate":{"anyOf":[{"type":"number","description":"Percentage of sent emails marked as spam."},{"type":"null"}]}}}},"required":["id","name","hold","repeat","createdAt"]}},"pagination":{"type":"object","properties":{"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"},"startCursor":{"type":"string"},"endCursor":{"type":"string"},"perPage":{"type":"integer"}},"required":["hasPreviousPage","hasNextPage","startCursor","endCursor","perPage"]}},"required":["sequences","pagination"]},"outputWireSchema":{"type":"object","properties":{"sequences":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"hold":{"type":"boolean"},"repeat":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"email_address":{"nullable":true},"email_template_id":{"nullable":true},"send_days":{"type":"array","items":{"type":"string"}},"send_hour":{"type":"integer"},"time_zone":{"type":"string"},"active":{"type":"boolean"},"exclude_subscriber_sources":{"type":"array","items":{}},"email_count":{"type":"integer"},"subscriber_count":{"type":"integer"},"stats":{"type":"object","description":"Returned only when `include` contains `stats`. Performance stats matching the sequences dashboard. All deliverability fields (everything except `unsubscribers`) are null when the sequence has no deliverability data.","properties":{"unsubscribers":{"type":"integer","description":"Number of subscribers who have unsubscribed from (cancelled) this sequence. Reflects current subscription state (distinct from the email-event `email_unsubscribes` count)."},"recipients":{"type":"integer","nullable":true,"description":"Number of emails sent across the sequence. Denominator for the rate fields."},"opens":{"type":"integer","nullable":true,"description":"Number of sent emails that were opened."},"clicks":{"type":"integer","nullable":true,"description":"Number of sent emails that had a link clicked."},"email_unsubscribes":{"type":"integer","nullable":true,"description":"Number of unsubscribe events on emails sent by this sequence (email-level events, not current subscription state)."},"bounces":{"type":"integer","nullable":true,"description":"Number of sent emails that bounced."},"complaints":{"type":"integer","nullable":true,"description":"Number of sent emails that were marked as spam."},"open_rate":{"type":"number","nullable":true,"description":"Percentage of sent emails that were opened."},"click_rate":{"type":"number","nullable":true,"description":"Percentage of sent emails that had a link clicked."},"click_to_open_rate":{"type":"number","nullable":true,"description":"Percentage of opened emails that had a link clicked."},"unsubscribe_rate":{"type":"number","nullable":true,"description":"Percentage of sent emails that resulted in an unsubscribe."},"bounce_rate":{"type":"number","nullable":true,"description":"Percentage of sent emails that bounced."},"complaint_rate":{"type":"number","nullable":true,"description":"Percentage of sent emails marked as spam."}}}},"required":["id","name","hold","repeat","created_at"]}},"pagination":{"type":"object","properties":{"has_previous_page":{"type":"boolean"},"has_next_page":{"type":"boolean"},"start_cursor":{"type":"string"},"end_cursor":{"type":"string"},"per_page":{"type":"integer"}},"required":["has_previous_page","has_next_page","start_cursor","end_cursor","per_page"]}},"required":["sequences","pagination"]},"path":"/v4/sequences","pathParameters":[],"queryParameters":[{"explode":true,"name":"after","providerName":"after","style":"form"},{"explode":true,"name":"before","providerName":"before","style":"form"},{"explode":true,"name":"includeTotalCount","providerName":"include_total_count","style":"form"},{"explode":true,"name":"perPage","providerName":"per_page","style":"form"},{"explode":true,"name":"include","providerName":"include","style":"form"}],"responseMode":"json"},"createSequence":{"bodyParameters":["name","emailAddress","emailTemplateId","sendDays","sendHour","timeZone","active","repeat","hold","excludeSubscriberSources"],"bodyWireSchema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the sequence."},"email_address":{"type":"string","description":"The sending email address to use. Uses the account\'s sending email address if not provided."},"email_template_id":{"type":"integer","description":"Id of the email template to use."},"send_days":{"type":"array","items":{"type":"string"},"description":"The days of the week to send the sequence on. Must be one of: `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, `sunday`."},"send_hour":{"type":"integer","description":"The hour of the day to send the sequence at. Must be an integer between 0 and 23."},"time_zone":{"type":"string","description":"The timezone to use for the sequence. Must be a valid IANA timezone string."},"active":{"type":"boolean","description":"`true` to activate the sequence, `false` to deactivate it."},"repeat":{"type":"boolean","description":"When `true`, subscribers can restart the sequence multiple times."},"hold":{"type":"boolean","description":"When `true`, subscribers added via Visual Automations stay in the sequence after receiving the last email."},"exclude_subscriber_sources":{"type":"array","description":"The subscriber sources to exclude from the sequence.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of subscriber source to exclude. Must be one of: `tag`, `sequence`, `form`, `segment`."},"ids":{"type":"array","items":{"type":"integer","description":"The ids of the subscriber sources to exclude."}}},"required":["type","ids"]}}}},"inputSchema":{"additionalProperties":false,"properties":{"name":{"type":"string","description":"The name of the sequence."},"emailAddress":{"type":"string","description":"The sending email address to use. Uses the account\'s sending email address if not provided."},"emailTemplateId":{"type":"integer","description":"Id of the email template to use."},"sendDays":{"type":"array","items":{"type":"string"},"description":"The days of the week to send the sequence on. Must be one of: `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, `sunday`."},"sendHour":{"type":"integer","description":"The hour of the day to send the sequence at. Must be an integer between 0 and 23."},"timeZone":{"type":"string","description":"The timezone to use for the sequence. Must be a valid IANA timezone string."},"active":{"type":"boolean","description":"`true` to activate the sequence, `false` to deactivate it."},"repeat":{"type":"boolean","description":"When `true`, subscribers can restart the sequence multiple times."},"hold":{"type":"boolean","description":"When `true`, subscribers added via Visual Automations stay in the sequence after receiving the last email."},"excludeSubscriberSources":{"type":"array","description":"The subscriber sources to exclude from the sequence.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of subscriber source to exclude. Must be one of: `tag`, `sequence`, `form`, `segment`."},"ids":{"type":"array","items":{"type":"integer","description":"The ids of the subscriber sources to exclude."}}},"required":["type","ids"]}}},"required":[],"type":"object"},"method":"POST","outputSchema":{"type":"object","properties":{"sequence":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"hold":{"type":"boolean"},"repeat":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"emailAddress":{"type":"string"},"emailTemplateId":{"type":"integer"},"sendDays":{"type":"array","items":{"type":"string"}},"sendHour":{"type":"integer"},"timeZone":{"type":"string"},"active":{"type":"boolean"},"excludeSubscriberSources":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"ids":{"type":"array","items":{"type":"integer"}}},"required":["type","ids"]}},"emailCount":{"type":"integer"},"subscriberCount":{"type":"integer"}},"required":["id","name","hold","repeat","createdAt","updatedAt","emailAddress","emailTemplateId","sendDays","sendHour","timeZone","active","excludeSubscriberSources"]}},"required":["sequence"]},"outputWireSchema":{"type":"object","properties":{"sequence":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"hold":{"type":"boolean"},"repeat":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"email_address":{"type":"string"},"email_template_id":{"type":"integer"},"send_days":{"type":"array","items":{"type":"string"}},"send_hour":{"type":"integer"},"time_zone":{"type":"string"},"active":{"type":"boolean"},"exclude_subscriber_sources":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"ids":{"type":"array","items":{"type":"integer"}}},"required":["type","ids"]}},"email_count":{"type":"integer"},"subscriber_count":{"type":"integer"}},"required":["id","name","hold","repeat","created_at","updated_at","email_address","email_template_id","send_days","send_hour","time_zone","active","exclude_subscriber_sources"]}},"required":["sequence"]},"path":"/v4/sequences","pathParameters":[],"queryParameters":[],"responseMode":"json"},"deleteSequence":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"id":{"type":"integer"}},"required":["id"],"type":"object"},"method":"DELETE","outputSchema":{"additionalProperties":false,"properties":{},"type":"object"},"outputWireSchema":{"additionalProperties":false,"properties":{},"type":"object"},"path":"/v4/sequences/{id}","pathParameters":[{"explode":true,"name":"id","providerName":"id","style":"form"}],"queryParameters":[],"responseMode":"void"},"getSequence":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"id":{"type":"integer"},"include":{"type":"string"}},"required":["id"],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"sequence":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"hold":{"type":"boolean"},"repeat":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"emailAddress":{"anyOf":[{},{"type":"null"}]},"emailTemplateId":{"anyOf":[{},{"type":"null"}]},"sendDays":{"type":"array","items":{"type":"string"}},"sendHour":{"type":"integer"},"timeZone":{"type":"string"},"active":{"type":"boolean"},"excludeSubscriberSources":{"type":"array","items":{}},"emailCount":{"type":"integer"},"subscriberCount":{"type":"integer"},"stats":{"type":"object","description":"Returned only when `include` contains `stats`. Performance stats matching the sequences dashboard. All deliverability fields (everything except `unsubscribers`) are null when the sequence has no deliverability data.","properties":{"unsubscribers":{"type":"integer","description":"Number of subscribers who have unsubscribed from (cancelled) this sequence. Reflects current subscription state (distinct from the email-event `email_unsubscribes` count)."},"recipients":{"anyOf":[{"type":"integer","description":"Number of emails sent across the sequence. Denominator for the rate fields."},{"type":"null"}]},"opens":{"anyOf":[{"type":"integer","description":"Number of sent emails that were opened."},{"type":"null"}]},"clicks":{"anyOf":[{"type":"integer","description":"Number of sent emails that had a link clicked."},{"type":"null"}]},"emailUnsubscribes":{"anyOf":[{"type":"integer","description":"Number of unsubscribe events on emails sent by this sequence (email-level events, not current subscription state)."},{"type":"null"}]},"bounces":{"anyOf":[{"type":"integer","description":"Number of sent emails that bounced."},{"type":"null"}]},"complaints":{"anyOf":[{"type":"integer","description":"Number of sent emails that were marked as spam."},{"type":"null"}]},"openRate":{"anyOf":[{"type":"number","description":"Percentage of sent emails that were opened."},{"type":"null"}]},"clickRate":{"anyOf":[{"type":"number","description":"Percentage of sent emails that had a link clicked."},{"type":"null"}]},"clickToOpenRate":{"anyOf":[{"type":"number","description":"Percentage of opened emails that had a link clicked."},{"type":"null"}]},"unsubscribeRate":{"anyOf":[{"type":"number","description":"Percentage of sent emails that resulted in an unsubscribe."},{"type":"null"}]},"bounceRate":{"anyOf":[{"type":"number","description":"Percentage of sent emails that bounced."},{"type":"null"}]},"complaintRate":{"anyOf":[{"type":"number","description":"Percentage of sent emails marked as spam."},{"type":"null"}]}}}},"required":["id","name","hold","repeat","createdAt","updatedAt","emailAddress","emailTemplateId","sendDays","sendHour","timeZone","active","excludeSubscriberSources"]}},"required":["sequence"]},"outputWireSchema":{"type":"object","properties":{"sequence":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"hold":{"type":"boolean"},"repeat":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"email_address":{"nullable":true},"email_template_id":{"nullable":true},"send_days":{"type":"array","items":{"type":"string"}},"send_hour":{"type":"integer"},"time_zone":{"type":"string"},"active":{"type":"boolean"},"exclude_subscriber_sources":{"type":"array","items":{}},"email_count":{"type":"integer"},"subscriber_count":{"type":"integer"},"stats":{"type":"object","description":"Returned only when `include` contains `stats`. Performance stats matching the sequences dashboard. All deliverability fields (everything except `unsubscribers`) are null when the sequence has no deliverability data.","properties":{"unsubscribers":{"type":"integer","description":"Number of subscribers who have unsubscribed from (cancelled) this sequence. Reflects current subscription state (distinct from the email-event `email_unsubscribes` count)."},"recipients":{"type":"integer","nullable":true,"description":"Number of emails sent across the sequence. Denominator for the rate fields."},"opens":{"type":"integer","nullable":true,"description":"Number of sent emails that were opened."},"clicks":{"type":"integer","nullable":true,"description":"Number of sent emails that had a link clicked."},"email_unsubscribes":{"type":"integer","nullable":true,"description":"Number of unsubscribe events on emails sent by this sequence (email-level events, not current subscription state)."},"bounces":{"type":"integer","nullable":true,"description":"Number of sent emails that bounced."},"complaints":{"type":"integer","nullable":true,"description":"Number of sent emails that were marked as spam."},"open_rate":{"type":"number","nullable":true,"description":"Percentage of sent emails that were opened."},"click_rate":{"type":"number","nullable":true,"description":"Percentage of sent emails that had a link clicked."},"click_to_open_rate":{"type":"number","nullable":true,"description":"Percentage of opened emails that had a link clicked."},"unsubscribe_rate":{"type":"number","nullable":true,"description":"Percentage of sent emails that resulted in an unsubscribe."},"bounce_rate":{"type":"number","nullable":true,"description":"Percentage of sent emails that bounced."},"complaint_rate":{"type":"number","nullable":true,"description":"Percentage of sent emails marked as spam."}}}},"required":["id","name","hold","repeat","created_at","updated_at","email_address","email_template_id","send_days","send_hour","time_zone","active","exclude_subscriber_sources"]}},"required":["sequence"]},"path":"/v4/sequences/{id}","pathParameters":[{"explode":true,"name":"id","providerName":"id","style":"form"}],"queryParameters":[{"explode":true,"name":"include","providerName":"include","style":"form"}],"responseMode":"json"},"updateSequence":{"bodyParameters":["name","emailAddress","emailTemplateId","sendDays","sendHour","timeZone","active","repeat","hold","excludeSubscriberSources"],"bodyWireSchema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the sequence."},"email_address":{"type":"string","description":"The sending email address to use. Uses the account\'s sending email address if not provided."},"email_template_id":{"type":"integer","description":"Id of the email template to use."},"send_days":{"type":"array","items":{"type":"string"},"description":"The days of the week to send the sequence on. Must be one of: `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, `sunday`."},"send_hour":{"type":"integer","description":"The hour of the day to send the sequence at. Must be an integer between 0 and 23."},"time_zone":{"type":"string","description":"The timezone to use for the sequence. Must be a valid IANA timezone string."},"active":{"type":"boolean","description":"`true` to activate the sequence, `false` to deactivate it."},"repeat":{"type":"boolean","description":"When `true`, subscribers can restart the sequence multiple times."},"hold":{"type":"boolean","description":"When `true`, subscribers added via Visual Automations stay in the sequence after receiving the last email."},"exclude_subscriber_sources":{"type":"array","description":"The subscriber sources to exclude from the sequence.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of subscriber source to exclude. Must be one of: `tag`, `sequence`, `form`, `segment`."},"ids":{"type":"array","items":{"type":"integer","description":"The ids of the subscriber sources to exclude."}}},"required":["type","ids"]}}}},"inputSchema":{"additionalProperties":false,"properties":{"id":{"type":"integer"},"name":{"type":"string","description":"The name of the sequence."},"emailAddress":{"type":"string","description":"The sending email address to use. Uses the account\'s sending email address if not provided."},"emailTemplateId":{"type":"integer","description":"Id of the email template to use."},"sendDays":{"type":"array","items":{"type":"string"},"description":"The days of the week to send the sequence on. Must be one of: `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, `sunday`."},"sendHour":{"type":"integer","description":"The hour of the day to send the sequence at. Must be an integer between 0 and 23."},"timeZone":{"type":"string","description":"The timezone to use for the sequence. Must be a valid IANA timezone string."},"active":{"type":"boolean","description":"`true` to activate the sequence, `false` to deactivate it."},"repeat":{"type":"boolean","description":"When `true`, subscribers can restart the sequence multiple times."},"hold":{"type":"boolean","description":"When `true`, subscribers added via Visual Automations stay in the sequence after receiving the last email."},"excludeSubscriberSources":{"type":"array","description":"The subscriber sources to exclude from the sequence.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of subscriber source to exclude. Must be one of: `tag`, `sequence`, `form`, `segment`."},"ids":{"type":"array","items":{"type":"integer","description":"The ids of the subscriber sources to exclude."}}},"required":["type","ids"]}}},"required":["id"],"type":"object"},"method":"PUT","outputSchema":{"type":"object","properties":{"sequence":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"hold":{"type":"boolean"},"repeat":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"emailAddress":{"type":"string"},"emailTemplateId":{"type":"integer"},"sendDays":{"type":"array","items":{"type":"string"}},"sendHour":{"type":"integer"},"timeZone":{"type":"string"},"active":{"type":"boolean"},"excludeSubscriberSources":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"ids":{"type":"array","items":{"type":"integer"}}},"required":["type","ids"]}},"emailCount":{"type":"integer"},"subscriberCount":{"type":"integer"}},"required":["id","name","hold","repeat","createdAt","updatedAt","emailAddress","emailTemplateId","sendDays","sendHour","timeZone","active","excludeSubscriberSources"]}},"required":["sequence"]},"outputWireSchema":{"type":"object","properties":{"sequence":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"hold":{"type":"boolean"},"repeat":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"email_address":{"type":"string"},"email_template_id":{"type":"integer"},"send_days":{"type":"array","items":{"type":"string"}},"send_hour":{"type":"integer"},"time_zone":{"type":"string"},"active":{"type":"boolean"},"exclude_subscriber_sources":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"ids":{"type":"array","items":{"type":"integer"}}},"required":["type","ids"]}},"email_count":{"type":"integer"},"subscriber_count":{"type":"integer"}},"required":["id","name","hold","repeat","created_at","updated_at","email_address","email_template_id","send_days","send_hour","time_zone","active","exclude_subscriber_sources"]}},"required":["sequence"]},"path":"/v4/sequences/{id}","pathParameters":[{"explode":true,"name":"id","providerName":"id","style":"form"}],"queryParameters":[],"responseMode":"json"},"listSequenceSubscribers":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"addedAfter":{"anyOf":[{"type":"string"},{"type":"null"}]},"addedBefore":{"anyOf":[{"type":"string"},{"type":"null"}]},"after":{"anyOf":[{"type":"string"},{"type":"null"}]},"before":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAfter":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdBefore":{"anyOf":[{"type":"string"},{"type":"null"}]},"includeTotalCount":{"type":"boolean"},"perPage":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}]},"sequenceId":{"type":"integer"},"status":{"type":"string","enum":["active","inactive","bounced","complained","cancelled","all"]}},"required":["sequenceId"],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"subscribers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"createdAt":{"type":"string"},"addedAt":{"type":"string"},"fields":{"type":"object","required":["category"],"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"required":["id","firstName","emailAddress","state","createdAt","addedAt","fields"]}},"pagination":{"type":"object","properties":{"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"},"startCursor":{"type":"string"},"endCursor":{"type":"string"},"perPage":{"type":"integer"}},"required":["hasPreviousPage","hasNextPage","startCursor","endCursor","perPage"]}},"required":["subscribers","pagination"]},"outputWireSchema":{"type":"object","properties":{"subscribers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"created_at":{"type":"string"},"added_at":{"type":"string"},"fields":{"type":"object","required":["category"],"additionalProperties":{"nullable":true,"type":"string"}}},"required":["id","first_name","email_address","state","created_at","added_at","fields"]}},"pagination":{"type":"object","properties":{"has_previous_page":{"type":"boolean"},"has_next_page":{"type":"boolean"},"start_cursor":{"type":"string"},"end_cursor":{"type":"string"},"per_page":{"type":"integer"}},"required":["has_previous_page","has_next_page","start_cursor","end_cursor","per_page"]}},"required":["subscribers","pagination"]},"path":"/v4/sequences/{sequence_id}/subscribers","pathParameters":[{"explode":true,"name":"sequenceId","providerName":"sequence_id","style":"form"}],"queryParameters":[{"explode":true,"name":"addedAfter","providerName":"added_after","style":"form"},{"explode":true,"name":"addedBefore","providerName":"added_before","style":"form"},{"explode":true,"name":"after","providerName":"after","style":"form"},{"explode":true,"name":"before","providerName":"before","style":"form"},{"explode":true,"name":"createdAfter","providerName":"created_after","style":"form"},{"explode":true,"name":"createdBefore","providerName":"created_before","style":"form"},{"explode":true,"name":"includeTotalCount","providerName":"include_total_count","style":"form"},{"explode":true,"name":"perPage","providerName":"per_page","style":"form"},{"explode":true,"name":"status","providerName":"status","style":"form"}],"responseMode":"json"},"addSubscriberToSequenceByEmailAddress":{"bodyParameters":["emailAddress"],"bodyWireSchema":{"type":"object","properties":{"email_address":{"type":"string"}},"required":["email_address"]},"inputSchema":{"additionalProperties":false,"properties":{"sequenceId":{"type":"integer"},"emailAddress":{"type":"string"}},"required":["sequenceId","emailAddress"],"type":"object"},"method":"POST","outputSchema":{"anyOf":[{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"createdAt":{"type":"string"},"addedAt":{"type":"string"},"fields":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"required":["id","firstName","emailAddress","state","createdAt","addedAt","fields"]}},"required":["subscriber"]},{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"createdAt":{"type":"string"},"addedAt":{"type":"string"},"fields":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"required":["id","firstName","emailAddress","state","createdAt","addedAt","fields"]}},"required":["subscriber"]}]},"outputWireSchema":{"anyOf":[{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"created_at":{"type":"string"},"added_at":{"type":"string"},"fields":{"type":"object","additionalProperties":{"nullable":true,"type":"string"}}},"required":["id","first_name","email_address","state","created_at","added_at","fields"]}},"required":["subscriber"]},{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"created_at":{"type":"string"},"added_at":{"type":"string"},"fields":{"type":"object","additionalProperties":{"nullable":true,"type":"string"}}},"required":["id","first_name","email_address","state","created_at","added_at","fields"]}},"required":["subscriber"]}]},"path":"/v4/sequences/{sequence_id}/subscribers","pathParameters":[{"explode":true,"name":"sequenceId","providerName":"sequence_id","style":"form"}],"queryParameters":[],"responseMode":"json"},"addSubscriberToSequence":{"bodyParameters":[],"bodyWireSchema":{"type":"object","properties":{}},"inputSchema":{"additionalProperties":false,"properties":{"id":{"type":"integer"},"sequenceId":{"type":"integer"}},"required":["id","sequenceId"],"type":"object"},"method":"POST","outputSchema":{"anyOf":[{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"createdAt":{"type":"string"},"addedAt":{"type":"string"},"fields":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"required":["id","firstName","emailAddress","state","createdAt","addedAt","fields"]}},"required":["subscriber"]},{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"createdAt":{"type":"string"},"addedAt":{"type":"string"},"fields":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"required":["id","firstName","emailAddress","state","createdAt","addedAt","fields"]}},"required":["subscriber"]}]},"outputWireSchema":{"anyOf":[{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"created_at":{"type":"string"},"added_at":{"type":"string"},"fields":{"type":"object","additionalProperties":{"nullable":true,"type":"string"}}},"required":["id","first_name","email_address","state","created_at","added_at","fields"]}},"required":["subscriber"]},{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"created_at":{"type":"string"},"added_at":{"type":"string"},"fields":{"type":"object","additionalProperties":{"nullable":true,"type":"string"}}},"required":["id","first_name","email_address","state","created_at","added_at","fields"]}},"required":["subscriber"]}]},"path":"/v4/sequences/{sequence_id}/subscribers/{id}","pathParameters":[{"explode":true,"name":"id","providerName":"id","style":"form"},{"explode":true,"name":"sequenceId","providerName":"sequence_id","style":"form"}],"queryParameters":[],"responseMode":"json"},"listSnippets":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"after":{"anyOf":[{"type":"string"},{"type":"null"}]},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"before":{"anyOf":[{"type":"string"},{"type":"null"}]},"includeContent":{"type":"boolean"},"includeTotalCount":{"type":"boolean"},"perPage":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}]},"snippetType":{"anyOf":[{"enum":["block","inline"],"type":"string"},{"type":"null"}]}},"required":[],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"snippets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"snippetType":{"type":"string"},"archived":{"type":"boolean"},"key":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"content":{"type":"string"},"document":{"type":"object","properties":{"id":{"type":"integer"},"value":{"anyOf":[{},{"type":"null"}]},"valueHtml":{"type":"string"},"valuePlain":{"anyOf":[{},{"type":"null"}]},"version":{"type":"integer"}},"required":["id","value","valueHtml","valuePlain","version"]}},"required":["id","name","snippetType","archived","key","createdAt","updatedAt","content","document"]}},"pagination":{"type":"object","properties":{"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"},"startCursor":{"type":"string"},"endCursor":{"type":"string"},"perPage":{"type":"integer"}},"required":["hasPreviousPage","hasNextPage","startCursor","endCursor","perPage"]}},"required":["snippets","pagination"]},"outputWireSchema":{"type":"object","properties":{"snippets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"snippet_type":{"type":"string"},"archived":{"type":"boolean"},"key":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"content":{"type":"string"},"document":{"type":"object","properties":{"id":{"type":"integer"},"value":{"nullable":true},"value_html":{"type":"string"},"value_plain":{"nullable":true},"version":{"type":"integer"}},"required":["id","value","value_html","value_plain","version"]}},"required":["id","name","snippet_type","archived","key","created_at","updated_at","content","document"]}},"pagination":{"type":"object","properties":{"has_previous_page":{"type":"boolean"},"has_next_page":{"type":"boolean"},"start_cursor":{"type":"string"},"end_cursor":{"type":"string"},"per_page":{"type":"integer"}},"required":["has_previous_page","has_next_page","start_cursor","end_cursor","per_page"]}},"required":["snippets","pagination"]},"path":"/v4/snippets","pathParameters":[],"queryParameters":[{"explode":true,"name":"after","providerName":"after","style":"form"},{"explode":true,"name":"archived","providerName":"archived","style":"form"},{"explode":true,"name":"before","providerName":"before","style":"form"},{"explode":true,"name":"includeContent","providerName":"include_content","style":"form"},{"explode":true,"name":"includeTotalCount","providerName":"include_total_count","style":"form"},{"explode":true,"name":"perPage","providerName":"per_page","style":"form"},{"explode":true,"name":"snippetType","providerName":"snippet_type","style":"form"}],"responseMode":"json"},"createSnippet":{"bodyParameters":["name","snippetType","content","documentAttributes"],"bodyWireSchema":{"oneOf":[{"title":"Inline snippet","type":"object","properties":{"name":{"type":"string","description":"Name of the snippet"},"snippet_type":{"type":"string","enum":["inline"],"description":"Must be \'inline\'"},"content":{"type":"string","description":"Liquid-enabled text content for the snippet"}},"required":["name","snippet_type","content"]},{"title":"Block snippet","type":"object","properties":{"name":{"type":"string","description":"Name of the snippet"},"snippet_type":{"type":"string","enum":["block"],"description":"Must be \'block\'"},"document_attributes":{"type":"object","description":"Rich-text document for the snippet","properties":{"value_html":{"type":"string","description":"HTML content for the block snippet"}},"required":["value_html"]}},"required":["name","snippet_type","document_attributes"]}]},"inputSchema":{"anyOf":[{"additionalProperties":false,"properties":{"name":{"type":"string","description":"Name of the snippet"},"snippetType":{"type":"string","enum":["inline"],"description":"Must be \'inline\'"},"content":{"type":"string","description":"Liquid-enabled text content for the snippet"}},"required":["name","snippetType","content"],"type":"object"},{"additionalProperties":false,"properties":{"name":{"type":"string","description":"Name of the snippet"},"snippetType":{"type":"string","enum":["block"],"description":"Must be \'block\'"},"documentAttributes":{"type":"object","description":"Rich-text document for the snippet","properties":{"valueHtml":{"type":"string","description":"HTML content for the block snippet"}},"required":["valueHtml"]}},"required":["name","snippetType","documentAttributes"],"type":"object"}]},"method":"POST","outputSchema":{"type":"object","properties":{"snippet":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"snippetType":{"type":"string"},"archived":{"type":"boolean"},"key":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"content":{"type":"string"},"document":{"type":"object","properties":{"id":{"type":"integer"},"value":{"anyOf":[{},{"type":"null"}]},"valueHtml":{"anyOf":[{},{"type":"null"}]},"valuePlain":{"anyOf":[{},{"type":"null"}]},"version":{"type":"integer"}},"required":["id","value","valueHtml","valuePlain","version"]}},"required":["id","name","snippetType","archived","key","createdAt","updatedAt","content","document"]}},"required":["snippet"]},"outputWireSchema":{"type":"object","properties":{"snippet":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"snippet_type":{"type":"string"},"archived":{"type":"boolean"},"key":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"content":{"type":"string"},"document":{"type":"object","properties":{"id":{"type":"integer"},"value":{"nullable":true},"value_html":{"nullable":true},"value_plain":{"nullable":true},"version":{"type":"integer"}},"required":["id","value","value_html","value_plain","version"]}},"required":["id","name","snippet_type","archived","key","created_at","updated_at","content","document"]}},"required":["snippet"]},"path":"/v4/snippets","pathParameters":[],"queryParameters":[],"responseMode":"json"},"getSnippet":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"id":{"type":"integer"}},"required":["id"],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"snippet":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"snippetType":{"type":"string"},"archived":{"type":"boolean"},"key":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"content":{"type":"string"},"document":{"type":"object","properties":{"id":{"type":"integer"},"value":{"anyOf":[{},{"type":"null"}]},"valueHtml":{"type":"string"},"valuePlain":{"anyOf":[{},{"type":"null"}]},"version":{"type":"integer"}},"required":["id","value","valueHtml","valuePlain","version"]}},"required":["id","name","snippetType","archived","key","createdAt","updatedAt","content","document"]}},"required":["snippet"]},"outputWireSchema":{"type":"object","properties":{"snippet":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"snippet_type":{"type":"string"},"archived":{"type":"boolean"},"key":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"content":{"type":"string"},"document":{"type":"object","properties":{"id":{"type":"integer"},"value":{"nullable":true},"value_html":{"type":"string"},"value_plain":{"nullable":true},"version":{"type":"integer"}},"required":["id","value","value_html","value_plain","version"]}},"required":["id","name","snippet_type","archived","key","created_at","updated_at","content","document"]}},"required":["snippet"]},"path":"/v4/snippets/{id}","pathParameters":[{"explode":true,"name":"id","providerName":"id","style":"form"}],"queryParameters":[],"responseMode":"json"},"updateSnippet":{"bodyParameters":["name","snippetType","archived","content","documentAttributes"],"bodyWireSchema":{"oneOf":[{"title":"Inline snippet","type":"object","properties":{"name":{"type":"string","description":"New name for the snippet"},"snippet_type":{"type":"string","description":"Cannot be changed — must match the existing type if provided"},"archived":{"type":"boolean","description":"Pass `true` to archive or `false` to restore the snippet"},"content":{"type":"string","description":"New Liquid-enabled text content"}}},{"title":"Block snippet","type":"object","properties":{"name":{"type":"string","description":"New name for the snippet"},"snippet_type":{"type":"string","description":"Cannot be changed — must match the existing type if provided"},"archived":{"type":"boolean","description":"Pass `true` to archive or `false` to restore the snippet"},"document_attributes":{"type":"object","description":"Updated rich-text document","properties":{"value_html":{"type":"string","description":"New HTML content for the block snippet"}},"required":["value_html"]}}}]},"inputSchema":{"anyOf":[{"additionalProperties":false,"properties":{"id":{"type":"integer"},"name":{"type":"string","description":"New name for the snippet"},"snippetType":{"type":"string","description":"Cannot be changed — must match the existing type if provided"},"archived":{"type":"boolean","description":"Pass `true` to archive or `false` to restore the snippet"},"content":{"type":"string","description":"New Liquid-enabled text content"}},"required":["id"],"type":"object"},{"additionalProperties":false,"properties":{"id":{"type":"integer"},"name":{"type":"string","description":"New name for the snippet"},"snippetType":{"type":"string","description":"Cannot be changed — must match the existing type if provided"},"archived":{"type":"boolean","description":"Pass `true` to archive or `false` to restore the snippet"},"documentAttributes":{"type":"object","description":"Updated rich-text document","properties":{"valueHtml":{"type":"string","description":"New HTML content for the block snippet"}},"required":["valueHtml"]}},"required":["id"],"type":"object"}]},"method":"PUT","outputSchema":{"type":"object","properties":{"snippet":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"snippetType":{"type":"string"},"archived":{"type":"boolean"},"key":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"content":{"type":"string"},"document":{"type":"object","properties":{"id":{"type":"integer"},"value":{"anyOf":[{},{"type":"null"}]},"valueHtml":{"type":"string"},"valuePlain":{"anyOf":[{},{"type":"null"}]},"version":{"type":"integer"}},"required":["id","value","valueHtml","valuePlain","version"]}},"required":["id","name","snippetType","archived","key","createdAt","updatedAt","content","document"]}},"required":["snippet"]},"outputWireSchema":{"type":"object","properties":{"snippet":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"snippet_type":{"type":"string"},"archived":{"type":"boolean"},"key":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"content":{"type":"string"},"document":{"type":"object","properties":{"id":{"type":"integer"},"value":{"nullable":true},"value_html":{"type":"string"},"value_plain":{"nullable":true},"version":{"type":"integer"}},"required":["id","value","value_html","value_plain","version"]}},"required":["id","name","snippet_type","archived","key","created_at","updated_at","content","document"]}},"required":["snippet"]},"path":"/v4/snippets/{id}","pathParameters":[{"explode":true,"name":"id","providerName":"id","style":"form"}],"queryParameters":[],"responseMode":"json"},"bulkCreateSubscribers":{"bodyParameters":["subscribers","callbackUrl"],"bodyWireSchema":{"type":"object","properties":{"subscribers":{"type":"array","items":{"type":"object","properties":{"first_name":{"type":"string","nullable":true},"email_address":{"type":"string","nullable":true},"state":{"type":"string","nullable":true,"enum":["active","cancelled","bounced","complained","inactive"]}}}},"callback_url":{"type":"string","nullable":true}},"required":["subscribers"]},"inputSchema":{"additionalProperties":false,"properties":{"subscribers":{"type":"array","items":{"type":"object","properties":{"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},{"type":"null"}]}}}},"callbackUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["subscribers"],"type":"object"},"method":"POST","outputSchema":{"anyOf":[{"type":"object","properties":{"subscribers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"createdAt":{"type":"string"}},"required":["id","firstName","emailAddress","state","createdAt"]}},"failures":{"type":"array","items":{"type":"object","properties":{"subscriber":{"type":"object","properties":{"firstName":{"type":"string"},"emailAddress":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["firstName","emailAddress","state","createdAt"]},"errors":{"type":"array","items":{"type":"string"}}},"required":["subscriber","errors"]}}},"required":["subscribers","failures"]},{"type":"object","properties":{}}]},"outputWireSchema":{"anyOf":[{"type":"object","properties":{"subscribers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"created_at":{"type":"string"}},"required":["id","first_name","email_address","state","created_at"]}},"failures":{"type":"array","items":{"type":"object","properties":{"subscriber":{"type":"object","properties":{"first_name":{"type":"string"},"email_address":{"type":"string","nullable":true},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"created_at":{"type":"string","nullable":true}},"required":["first_name","email_address","state","created_at"]},"errors":{"type":"array","items":{"type":"string"}}},"required":["subscriber","errors"]}}},"required":["subscribers","failures"]},{"type":"object","properties":{}}]},"path":"/v4/bulk/subscribers","pathParameters":[],"queryParameters":[],"responseMode":"json"},"listSubscribers":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"after":{"anyOf":[{"type":"string"},{"type":"null"}]},"before":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAfter":{"type":"string"},"createdBefore":{"type":"string"},"emailAddress":{"type":"string"},"include":{"type":"string"},"includeTotalCount":{"type":"boolean"},"perPage":{"anyOf":[{"type":"integer","maximum":1000,"minimum":1},{"type":"null"}]},"slim":{"type":"boolean"},"sortField":{"type":"string","enum":["id","created_at","updated_at","cancelled_at","canceled_at","engagement__sent","engagement__opens","engagement__clicks","engagement__open_rate","engagement__click_rate"]},"sortOrder":{"type":"string","enum":["asc","desc"]},"status":{"type":"string","enum":["active","inactive","bounced","complained","cancelled","all"]},"updatedAfter":{"type":"string"},"updatedBefore":{"type":"string"}},"required":[],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"subscribers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"createdAt":{"type":"string"},"fields":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"attribution":{"anyOf":[{"type":"object","description":"Returned when `include` contains `attribution`.","properties":{"referrer":{"anyOf":[{"type":"string"},{"type":"null"}]},"utmSource":{"anyOf":[{"type":"string"},{"type":"null"}]},"utmMedium":{"anyOf":[{"type":"string"},{"type":"null"}]},"utmCampaign":{"anyOf":[{"type":"string"},{"type":"null"}]},"utmTerm":{"anyOf":[{"type":"string"},{"type":"null"}]},"utmContent":{"anyOf":[{"type":"string"},{"type":"null"}]},"sourceType":{"anyOf":[{"type":"string"},{"type":"null"}]},"sourceName":{"anyOf":[{"type":"string"},{"type":"null"}]},"sourceMechanism":{"anyOf":[{"type":"string"},{"type":"null"}]},"sourceMechanismId":{"anyOf":[{"type":"integer"},{"type":"null"}]}},"required":["referrer","utmSource","utmMedium","utmCampaign","utmTerm","utmContent","sourceType","sourceName","sourceMechanism","sourceMechanismId"]},{"type":"null"}]},"tags":{"type":"array","description":"Returned when `include` contains `tags`.","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"integer"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}}}},"location":{"anyOf":[{"type":"object","description":"Returned when `include` contains `location`.","properties":{"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","format":"float"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","format":"float"},{"type":"null"}]},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["city","state","country","latitude","longitude","timezone"]},{"type":"null"}]},"canceledAt":{"anyOf":[{"type":"string","format":"date-time","description":"Returned when `include` contains `canceled_at`. Requires `status=cancelled`."},{"type":"null"}]}},"required":["id","state","firstName","emailAddress","createdAt","fields"]}},"pagination":{"type":"object","properties":{"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"},"startCursor":{"type":"string"},"endCursor":{"type":"string"},"perPage":{"type":"integer"}},"required":["hasPreviousPage","hasNextPage","startCursor","endCursor","perPage"]}},"required":["subscribers","pagination"]},"outputWireSchema":{"type":"object","properties":{"subscribers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"created_at":{"type":"string"},"fields":{"type":"object","additionalProperties":{"nullable":true,"type":"string"}},"attribution":{"type":"object","description":"Returned when `include` contains `attribution`.","nullable":true,"properties":{"referrer":{"type":"string","nullable":true},"utm_source":{"type":"string","nullable":true},"utm_medium":{"type":"string","nullable":true},"utm_campaign":{"type":"string","nullable":true},"utm_term":{"type":"string","nullable":true},"utm_content":{"type":"string","nullable":true},"source_type":{"type":"string","nullable":true},"source_name":{"type":"string","nullable":true},"source_mechanism":{"type":"string","nullable":true},"source_mechanism_id":{"type":"integer","nullable":true}},"required":["referrer","utm_source","utm_medium","utm_campaign","utm_term","utm_content","source_type","source_name","source_mechanism","source_mechanism_id"]},"tags":{"type":"array","description":"Returned when `include` contains `tags`.","items":{"type":"object","properties":{"id":{"type":"integer","nullable":true},"name":{"type":"string","nullable":true}}}},"location":{"type":"object","description":"Returned when `include` contains `location`.","nullable":true,"properties":{"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"latitude":{"type":"number","nullable":true,"format":"float"},"longitude":{"type":"number","nullable":true,"format":"float"},"timezone":{"type":"string","nullable":true}},"required":["city","state","country","latitude","longitude","timezone"]},"canceled_at":{"type":"string","format":"date-time","nullable":true,"description":"Returned when `include` contains `canceled_at`. Requires `status=cancelled`."}},"required":["id","state","first_name","email_address","created_at","fields"]}},"pagination":{"type":"object","properties":{"has_previous_page":{"type":"boolean"},"has_next_page":{"type":"boolean"},"start_cursor":{"type":"string"},"end_cursor":{"type":"string"},"per_page":{"type":"integer"}},"required":["has_previous_page","has_next_page","start_cursor","end_cursor","per_page"]}},"required":["subscribers","pagination"]},"path":"/v4/subscribers","pathParameters":[],"queryParameters":[{"explode":true,"name":"after","providerName":"after","style":"form"},{"explode":true,"name":"before","providerName":"before","style":"form"},{"explode":true,"name":"createdAfter","providerName":"created_after","style":"form"},{"explode":true,"name":"createdBefore","providerName":"created_before","style":"form"},{"explode":true,"name":"emailAddress","providerName":"email_address","style":"form"},{"explode":true,"name":"include","providerName":"include","style":"form"},{"explode":true,"name":"includeTotalCount","providerName":"include_total_count","style":"form"},{"explode":true,"name":"perPage","providerName":"per_page","style":"form"},{"explode":true,"name":"slim","providerName":"slim","style":"form"},{"explode":true,"name":"sortField","providerName":"sort_field","style":"form"},{"explode":true,"name":"sortOrder","providerName":"sort_order","style":"form"},{"explode":true,"name":"status","providerName":"status","style":"form"},{"explode":true,"name":"updatedAfter","providerName":"updated_after","style":"form"},{"explode":true,"name":"updatedBefore","providerName":"updated_before","style":"form"}],"responseMode":"json"},"createSubscriber":{"bodyParameters":["firstName","emailAddress","state","fields"],"bodyWireSchema":{"type":"object","properties":{"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"state":{"type":"string","nullable":true,"enum":["active","cancelled","bounced","complained","inactive"],"description":"Create subscriber in this state (`active`, `bounced`, `cancelled`, `complained` or `inactive`). Defaults to `active`."},"fields":{"type":"object","additionalProperties":{"type":"string"},"description":"Custom field values keyed by the custom field\'s `key` (e.g. `last_name`, not `Last Name`). Unknown keys are ignored and reported in the response `warnings` array."}},"required":["email_address"]},"inputSchema":{"additionalProperties":false,"properties":{"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"state":{"anyOf":[{"type":"string","enum":["active","cancelled","bounced","complained","inactive"],"description":"Create subscriber in this state (`active`, `bounced`, `cancelled`, `complained` or `inactive`). Defaults to `active`."},{"type":"null"}]},"fields":{"type":"object","additionalProperties":{"type":"string"},"description":"Custom field values keyed by the custom field\'s `key` (e.g. `last_name`, not `Last Name`). Unknown keys are ignored and reported in the response `warnings` array."}},"required":["emailAddress"],"type":"object"},"method":"POST","outputSchema":{"anyOf":[{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"createdAt":{"type":"string"},"fields":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"required":["id","firstName","emailAddress","state","createdAt","fields"]}},"required":["subscriber"]},{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"createdAt":{"type":"string"},"fields":{"type":"object","additionalProperties":{"type":"string"},"description":"Custom field values for the subscriber, keyed by the custom field\'s `key`."}},"required":["id","firstName","emailAddress","state","createdAt","fields"]},"warnings":{"type":"array","items":{"type":"string"},"description":"Present only when the request referenced custom field keys that don\'t exist on the account. Each entry names an unknown key that was ignored; the subscriber is still created or updated."}},"required":["subscriber"]},{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"createdAt":{"type":"string"},"fields":{"type":"object","properties":{"company":{"anyOf":[{},{"type":"null"}]},"coupon":{"anyOf":[{},{"type":"null"}]},"enrolledInCoaching":{"anyOf":[{},{"type":"null"}]},"howDidYouHearAboutUs":{"anyOf":[{},{"type":"null"}]},"interests":{"anyOf":[{},{"type":"null"}]},"leadScore":{"anyOf":[{},{"type":"null"}]},"phoneNumber":{"anyOf":[{},{"type":"null"}]},"postalCode":{"anyOf":[{},{"type":"null"}]},"role":{"anyOf":[{},{"type":"null"}]},"socialMedia":{"anyOf":[{},{"type":"null"}]},"website":{"anyOf":[{},{"type":"null"}]}},"required":["company","coupon","enrolledInCoaching","howDidYouHearAboutUs","interests","leadScore","phoneNumber","postalCode","role","socialMedia","website"]}},"required":["id","firstName","emailAddress","state","createdAt","fields"]}},"required":["subscriber"]}]},"outputWireSchema":{"anyOf":[{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"created_at":{"type":"string"},"fields":{"type":"object","additionalProperties":{"nullable":true,"type":"string"}}},"required":["id","first_name","email_address","state","created_at","fields"]}},"required":["subscriber"]},{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"created_at":{"type":"string"},"fields":{"type":"object","additionalProperties":{"type":"string"},"description":"Custom field values for the subscriber, keyed by the custom field\'s `key`."}},"required":["id","first_name","email_address","state","created_at","fields"]},"warnings":{"type":"array","items":{"type":"string"},"description":"Present only when the request referenced custom field keys that don\'t exist on the account. Each entry names an unknown key that was ignored; the subscriber is still created or updated."}},"required":["subscriber"]},{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"created_at":{"type":"string"},"fields":{"type":"object","properties":{"company":{"nullable":true},"coupon":{"nullable":true},"enrolled_in_coaching":{"nullable":true},"how_did_you_hear_about_us":{"nullable":true},"interests":{"nullable":true},"lead_score":{"nullable":true},"phone_number":{"nullable":true},"postal_code":{"nullable":true},"role":{"nullable":true},"social_media":{"nullable":true},"website":{"nullable":true}},"required":["company","coupon","enrolled_in_coaching","how_did_you_hear_about_us","interests","lead_score","phone_number","postal_code","role","social_media","website"]}},"required":["id","first_name","email_address","state","created_at","fields"]}},"required":["subscriber"]}]},"path":"/v4/subscribers","pathParameters":[],"queryParameters":[],"responseMode":"json"},"filterSubscribers":{"bodyParameters":["countingMode","all","include","sortField","sortOrder"],"bodyWireSchema":{"$ref":"#/components/schemas/SubscriberFilterRequest"},"inputSchema":{"additionalProperties":false,"properties":{"countingMode":{"type":"string","enum":["raw","unique_email"],"description":"Controls how engagement-filter count thresholds are tallied. `raw` (default) counts every event — five opens of the same email = five. `unique_email` counts distinct emails on which the action occurred — five opens of the same email = one. Applies to every engagement filter (opens, clicks, sent, delivered) in the request; ignored for other filter types."},"all":{"type":"array","description":"Array of filter conditions where ALL must be met (AND logic)","items":{"$ref":"#/$defs/FilterCondition"}},"include":{"type":"array","description":"Optional. Array of `{ type, ...config }` objects naming additional fields to embed on each subscriber row. Valid types: `attribution`, `tags`, `location`, `canceled_at`, `stats`, `custom_fields`. The `stats` type accepts an optional `range: { start, end }` (YYYY-MM-DD dates, defaulting to the last 90 days). The `custom_fields` type adds a `fields` object with all account custom field values (null for fields the subscriber has not set).","example":[{"type":"tags"},{"type":"stats","range":{"start":"2026-05-01","end":"2026-06-30"}}],"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["attribution","tags","location","canceled_at","stats","custom_fields"]},"range":{"type":"object","description":"Only used by the `stats` type. Date window for the engagement stats. Defaults to the last 90 days; clamped to the account\'s data-retention window.","properties":{"start":{"type":"string","format":"date"},"end":{"type":"string","format":"date"}}}}}},"sortField":{"type":"string","default":"created_at","enum":["id","first_name","email_address","created_at","engagement__sent","engagement__opens","engagement__clicks","engagement__open_rate","engagement__click_rate","location__distance"],"description":"Field to order results by. Base columns (`id`, `first_name`, `email_address`, `created_at`) order by that subscriber attribute. `engagement__<metric>` orders by an engagement stat over the trailing 90 days: counts (`sent`, `opens`, `clicks`) and rates (`open_rate`, `click_rate`); subscribers with no sends order as 0. `location__distance` orders by great-circle distance and requires a `location` filter in the same request — its `latitude`/`longitude` supply the origin, and subscribers without a primary location are excluded. Distance defaults to nearest-first (`sort_order` defaults to `asc` for this field); pass `sort_order=desc` for farthest-first."},"sortOrder":{"type":"string","enum":["asc","desc"],"description":"Sort direction (default: desc)."}},"required":["all"],"type":"object"},"method":"POST","outputSchema":{"type":"object","properties":{"subscribers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"createdAt":{"type":"string"},"tagNames":{"type":"array","items":{"type":"string"}},"tagIds":{"type":"array","items":{"type":"string"}},"attribution":{"anyOf":[{"type":"object","description":"Returned when `include` contains `attribution`.","properties":{"referrer":{"anyOf":[{"type":"string"},{"type":"null"}]},"utmSource":{"anyOf":[{"type":"string"},{"type":"null"}]},"utmMedium":{"anyOf":[{"type":"string"},{"type":"null"}]},"utmCampaign":{"anyOf":[{"type":"string"},{"type":"null"}]},"utmTerm":{"anyOf":[{"type":"string"},{"type":"null"}]},"utmContent":{"anyOf":[{"type":"string"},{"type":"null"}]},"sourceType":{"anyOf":[{"type":"string"},{"type":"null"}]},"sourceName":{"anyOf":[{"type":"string"},{"type":"null"}]},"sourceMechanism":{"anyOf":[{"type":"string"},{"type":"null"}]},"sourceMechanismId":{"anyOf":[{"type":"integer"},{"type":"null"}]}}},{"type":"null"}]},"tags":{"type":"array","description":"Returned when `include` contains `tags`.","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}},"location":{"anyOf":[{"type":"object","description":"Returned when `include` contains `location`.","properties":{"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","format":"float"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","format":"float"},{"type":"null"}]},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}]}}},{"type":"null"}]},"canceledAt":{"anyOf":[{"type":"string","format":"date-time","description":"Returned when `include` contains `canceled_at`. Reflects the timestamp of the subscriber\'s most recent state transition."},{"type":"null"}]},"stats":{"type":"object","description":"Returned when `include` contains `stats`. Per-subscriber email engagement over the requested date range (defaults to the last 90 days). Counts cover broadcasts, sequences, and email templates. Subscribers with no sends in the range come back with zeroed counts and null timestamps.","properties":{"sent":{"type":"integer"},"opened":{"type":"integer"},"clicked":{"type":"integer"},"bounced":{"type":"integer"},"openRate":{"type":"number","format":"float","description":"opened / sent, rounded to 3 decimals (0.0 when nothing was sent)."},"clickRate":{"type":"number","format":"float","description":"clicked / sent, rounded to 3 decimals (0.0 when nothing was sent)."},"lastSent":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"lastOpened":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"lastClicked":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"sendsSinceLastOpen":{"type":"integer"},"sendsSinceLastClick":{"type":"integer"}}},"fields":{"type":"object","description":"Returned when `include` contains `custom_fields`. All account custom field keys, with the subscriber\'s value or null for fields that have not been set.","additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"required":["id","firstName","emailAddress","createdAt"]}},"pagination":{"type":"object","properties":{"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"},"startCursor":{"type":"string"},"endCursor":{"type":"string"},"perPage":{"type":"integer"},"totalCount":{"type":"integer"}},"required":["hasPreviousPage","hasNextPage","startCursor","endCursor","perPage"]}},"required":["subscribers","pagination"]},"outputWireSchema":{"type":"object","properties":{"subscribers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"created_at":{"type":"string"},"tag_names":{"type":"array","items":{"type":"string"}},"tag_ids":{"type":"array","items":{"type":"string"}},"attribution":{"type":"object","nullable":true,"description":"Returned when `include` contains `attribution`.","properties":{"referrer":{"type":"string","nullable":true},"utm_source":{"type":"string","nullable":true},"utm_medium":{"type":"string","nullable":true},"utm_campaign":{"type":"string","nullable":true},"utm_term":{"type":"string","nullable":true},"utm_content":{"type":"string","nullable":true},"source_type":{"type":"string","nullable":true},"source_name":{"type":"string","nullable":true},"source_mechanism":{"type":"string","nullable":true},"source_mechanism_id":{"type":"integer","nullable":true}}},"tags":{"type":"array","description":"Returned when `include` contains `tags`.","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}},"location":{"type":"object","nullable":true,"description":"Returned when `include` contains `location`.","properties":{"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"latitude":{"type":"number","format":"float","nullable":true},"longitude":{"type":"number","format":"float","nullable":true},"timezone":{"type":"string","nullable":true}}},"canceled_at":{"type":"string","format":"date-time","nullable":true,"description":"Returned when `include` contains `canceled_at`. Reflects the timestamp of the subscriber\'s most recent state transition."},"stats":{"type":"object","description":"Returned when `include` contains `stats`. Per-subscriber email engagement over the requested date range (defaults to the last 90 days). Counts cover broadcasts, sequences, and email templates. Subscribers with no sends in the range come back with zeroed counts and null timestamps.","properties":{"sent":{"type":"integer"},"opened":{"type":"integer"},"clicked":{"type":"integer"},"bounced":{"type":"integer"},"open_rate":{"type":"number","format":"float","description":"opened / sent, rounded to 3 decimals (0.0 when nothing was sent)."},"click_rate":{"type":"number","format":"float","description":"clicked / sent, rounded to 3 decimals (0.0 when nothing was sent)."},"last_sent":{"type":"string","format":"date-time","nullable":true},"last_opened":{"type":"string","format":"date-time","nullable":true},"last_clicked":{"type":"string","format":"date-time","nullable":true},"sends_since_last_open":{"type":"integer"},"sends_since_last_click":{"type":"integer"}}},"fields":{"type":"object","description":"Returned when `include` contains `custom_fields`. All account custom field keys, with the subscriber\'s value or null for fields that have not been set.","additionalProperties":{"type":"string","nullable":true}}},"required":["id","first_name","email_address","created_at"]}},"pagination":{"type":"object","properties":{"has_previous_page":{"type":"boolean"},"has_next_page":{"type":"boolean"},"start_cursor":{"type":"string"},"end_cursor":{"type":"string"},"per_page":{"type":"integer"},"total_count":{"type":"integer"}},"required":["has_previous_page","has_next_page","start_cursor","end_cursor","per_page"]}},"required":["subscribers","pagination"]},"path":"/v4/subscribers/filter","pathParameters":[],"queryParameters":[],"responseMode":"json"},"getSubscriber":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"id":{"type":"integer"}},"required":["id"],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"createdAt":{"type":"string"},"fields":{"type":"object","required":["category"],"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"canceledAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"location":{"type":"object","description":"The subscriber\'s primary location. Individual fields are `null` when not yet determined.","properties":{"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","format":"float"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","format":"float"},{"type":"null"}]},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}]}}}},"required":["id","firstName","emailAddress","state","createdAt","fields"]}},"required":["subscriber"]},"outputWireSchema":{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"created_at":{"type":"string"},"fields":{"type":"object","required":["category"],"additionalProperties":{"nullable":true,"type":"string"}},"canceled_at":{"type":"string","nullable":true},"location":{"type":"object","description":"The subscriber\'s primary location. Individual fields are `null` when not yet determined.","properties":{"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"latitude":{"type":"number","format":"float","nullable":true},"longitude":{"type":"number","format":"float","nullable":true},"timezone":{"type":"string","nullable":true}}}},"required":["id","first_name","email_address","state","created_at","fields"]}},"required":["subscriber"]},"path":"/v4/subscribers/{id}","pathParameters":[{"explode":true,"name":"id","providerName":"id","style":"form"}],"queryParameters":[],"responseMode":"json"},"updateSubscriber":{"bodyParameters":["firstName","emailAddress","fields"],"bodyWireSchema":{"type":"object","properties":{"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"fields":{"type":"object","additionalProperties":{"type":"string"},"description":"Custom field values keyed by the custom field\'s `key` (e.g. `last_name`, not `Last Name`). Unknown keys are ignored and reported in the response `warnings` array."}},"required":["email_address"]},"inputSchema":{"additionalProperties":false,"properties":{"id":{"type":"integer"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"fields":{"type":"object","additionalProperties":{"type":"string"},"description":"Custom field values keyed by the custom field\'s `key` (e.g. `last_name`, not `Last Name`). Unknown keys are ignored and reported in the response `warnings` array."}},"required":["id","emailAddress"],"type":"object"},"method":"PUT","outputSchema":{"anyOf":[{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"createdAt":{"type":"string"},"fields":{"type":"object","additionalProperties":{"type":"string"},"description":"Custom field values for the subscriber, keyed by the custom field\'s `key`."}},"required":["id","firstName","emailAddress","state","createdAt","fields"]},"warnings":{"type":"array","items":{"type":"string"},"description":"Present only when the request referenced custom field keys that don\'t exist on the account. Each entry names an unknown key that was ignored; the subscriber is still created or updated."}},"required":["subscriber"]},{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"createdAt":{"type":"string"},"fields":{"type":"object","properties":{"birthday":{"anyOf":[{},{"type":"null"}]},"company":{"anyOf":[{},{"type":"null"}]},"coupon":{"anyOf":[{},{"type":"null"}]},"howDidYouHearAboutUs":{"anyOf":[{},{"type":"null"}]},"interests":{"anyOf":[{},{"type":"null"}]},"lastName":{"anyOf":[{},{"type":"null"}]},"postalCode":{"anyOf":[{},{"type":"null"}]},"role":{"anyOf":[{},{"type":"null"}]},"socialMedia":{"anyOf":[{},{"type":"null"}]},"source":{"anyOf":[{},{"type":"null"}]},"website":{"anyOf":[{},{"type":"null"}]}},"required":["birthday","company","coupon","howDidYouHearAboutUs","interests","lastName","postalCode","role","socialMedia","source","website"]}},"required":["id","firstName","emailAddress","state","createdAt","fields"]}},"required":["subscriber"]}]},"outputWireSchema":{"anyOf":[{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"created_at":{"type":"string"},"fields":{"type":"object","additionalProperties":{"type":"string"},"description":"Custom field values for the subscriber, keyed by the custom field\'s `key`."}},"required":["id","first_name","email_address","state","created_at","fields"]},"warnings":{"type":"array","items":{"type":"string"},"description":"Present only when the request referenced custom field keys that don\'t exist on the account. Each entry names an unknown key that was ignored; the subscriber is still created or updated."}},"required":["subscriber"]},{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"created_at":{"type":"string"},"fields":{"type":"object","properties":{"birthday":{"nullable":true},"company":{"nullable":true},"coupon":{"nullable":true},"how_did_you_hear_about_us":{"nullable":true},"interests":{"nullable":true},"last_name":{"nullable":true},"postal_code":{"nullable":true},"role":{"nullable":true},"social_media":{"nullable":true},"source":{"nullable":true},"website":{"nullable":true}},"required":["birthday","company","coupon","how_did_you_hear_about_us","interests","last_name","postal_code","role","social_media","source","website"]}},"required":["id","first_name","email_address","state","created_at","fields"]}},"required":["subscriber"]}]},"path":"/v4/subscribers/{id}","pathParameters":[{"explode":true,"name":"id","providerName":"id","style":"form"}],"queryParameters":[],"responseMode":"json"},"unsubscribeSubscriber":{"bodyParameters":[],"bodyWireSchema":{"type":"object","properties":{}},"inputSchema":{"additionalProperties":false,"properties":{"id":{"type":"integer"}},"required":["id"],"type":"object"},"method":"POST","outputSchema":{"additionalProperties":false,"properties":{},"type":"object"},"outputWireSchema":{"additionalProperties":false,"properties":{},"type":"object"},"path":"/v4/subscribers/{id}/unsubscribe","pathParameters":[{"explode":true,"name":"id","providerName":"id","style":"form"}],"queryParameters":[],"responseMode":"void"},"deleteSubscriberLocation":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"subscriberId":{"type":"integer"}},"required":["subscriberId"],"type":"object"},"method":"DELETE","outputSchema":{"additionalProperties":false,"properties":{},"type":"object"},"outputWireSchema":{"additionalProperties":false,"properties":{},"type":"object"},"path":"/v4/subscribers/{subscriber_id}/location","pathParameters":[{"explode":true,"name":"subscriberId","providerName":"subscriber_id","style":"form"}],"queryParameters":[],"responseMode":"void"},"updateSubscriberLocation":{"bodyParameters":["location"],"bodyWireSchema":{"type":"object","properties":{"location":{"type":"object","properties":{"city":{"type":"string"},"state_province":{"type":"string"},"country_code":{"type":"string"},"latitude":{"type":"number","format":"float"},"longitude":{"type":"number","format":"float"},"timezone":{"type":"string"}},"required":["city","state_province","country_code","latitude","longitude","timezone"]}},"required":["location"]},"inputSchema":{"additionalProperties":false,"properties":{"subscriberId":{"type":"integer"},"location":{"type":"object","properties":{"city":{"type":"string"},"stateProvince":{"type":"string"},"countryCode":{"type":"string"},"latitude":{"type":"number","format":"float"},"longitude":{"type":"number","format":"float"},"timezone":{"type":"string"}},"required":["city","stateProvince","countryCode","latitude","longitude","timezone"]}},"required":["subscriberId","location"],"type":"object"},"method":"PATCH","outputSchema":{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"location":{"type":"object","properties":{"city":{"type":"string"},"stateProvince":{"type":"string"},"countryCode":{"type":"string"},"latitude":{"type":"number","format":"float"},"longitude":{"type":"number","format":"float"},"timezone":{"type":"string"}},"required":["city","stateProvince","countryCode","latitude","longitude","timezone"]}},"required":["id","location"]}},"required":["subscriber"]},"outputWireSchema":{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"location":{"type":"object","properties":{"city":{"type":"string"},"state_province":{"type":"string"},"country_code":{"type":"string"},"latitude":{"type":"number","format":"float"},"longitude":{"type":"number","format":"float"},"timezone":{"type":"string"}},"required":["city","state_province","country_code","latitude","longitude","timezone"]}},"required":["id","location"]}},"required":["subscriber"]},"path":"/v4/subscribers/{subscriber_id}/location","pathParameters":[{"explode":true,"name":"subscriberId","providerName":"subscriber_id","style":"form"}],"queryParameters":[],"responseMode":"json"},"pinSubscriberLocation":{"bodyParameters":["location"],"bodyWireSchema":{"type":"object","properties":{"location":{"type":"object","properties":{"city":{"type":"string"},"state_province":{"type":"string"},"country_code":{"type":"string"},"latitude":{"type":"number","format":"float"},"longitude":{"type":"number","format":"float"},"timezone":{"type":"string"}},"required":["city","state_province","country_code","latitude","longitude","timezone"]}},"required":["location"]},"inputSchema":{"additionalProperties":false,"properties":{"subscriberId":{"type":"integer"},"location":{"type":"object","properties":{"city":{"type":"string"},"stateProvince":{"type":"string"},"countryCode":{"type":"string"},"latitude":{"type":"number","format":"float"},"longitude":{"type":"number","format":"float"},"timezone":{"type":"string"}},"required":["city","stateProvince","countryCode","latitude","longitude","timezone"]}},"required":["subscriberId","location"],"type":"object"},"method":"POST","outputSchema":{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"location":{"type":"object","properties":{"city":{"type":"string"},"stateProvince":{"type":"string"},"countryCode":{"type":"string"},"latitude":{"type":"number","format":"float"},"longitude":{"type":"number","format":"float"},"timezone":{"type":"string"}},"required":["city","stateProvince","countryCode","latitude","longitude","timezone"]}},"required":["id","location"]}},"required":["subscriber"]},"outputWireSchema":{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"location":{"type":"object","properties":{"city":{"type":"string"},"state_province":{"type":"string"},"country_code":{"type":"string"},"latitude":{"type":"number","format":"float"},"longitude":{"type":"number","format":"float"},"timezone":{"type":"string"}},"required":["city","state_province","country_code","latitude","longitude","timezone"]}},"required":["id","location"]}},"required":["subscriber"]},"path":"/v4/subscribers/{subscriber_id}/location","pathParameters":[{"explode":true,"name":"subscriberId","providerName":"subscriber_id","style":"form"}],"queryParameters":[],"responseMode":"json"},"getSubscriberStats":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"emailSentAfter":{"type":"string"},"emailSentBefore":{"type":"string"},"subscriberId":{"type":"integer"}},"required":["subscriberId"],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"stats":{"type":"object","properties":{"sent":{"type":"integer"},"opened":{"type":"integer"},"clicked":{"type":"integer"},"bounced":{"type":"integer"},"openRate":{"type":"number","format":"float"},"clickRate":{"type":"number","format":"float"},"lastSent":{"type":"string"},"lastOpened":{"type":"string"},"lastClicked":{"type":"string"},"sendsSinceLastOpen":{"type":"integer"},"sendsSinceLastClick":{"type":"integer"}},"required":["sent","opened","clicked","bounced","openRate","clickRate","lastSent","lastOpened","lastClicked","sendsSinceLastOpen","sendsSinceLastClick"]}},"required":["id","stats"]}},"required":["subscriber"]},"outputWireSchema":{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"stats":{"type":"object","properties":{"sent":{"type":"integer"},"opened":{"type":"integer"},"clicked":{"type":"integer"},"bounced":{"type":"integer"},"open_rate":{"type":"number","format":"float"},"click_rate":{"type":"number","format":"float"},"last_sent":{"type":"string"},"last_opened":{"type":"string"},"last_clicked":{"type":"string"},"sends_since_last_open":{"type":"integer"},"sends_since_last_click":{"type":"integer"}},"required":["sent","opened","clicked","bounced","open_rate","click_rate","last_sent","last_opened","last_clicked","sends_since_last_open","sends_since_last_click"]}},"required":["id","stats"]}},"required":["subscriber"]},"path":"/v4/subscribers/{subscriber_id}/stats","pathParameters":[{"explode":true,"name":"subscriberId","providerName":"subscriber_id","style":"form"}],"queryParameters":[{"explode":true,"name":"emailSentAfter","providerName":"email_sent_after","style":"form"},{"explode":true,"name":"emailSentBefore","providerName":"email_sent_before","style":"form"}],"responseMode":"json"},"listSubscriberTags":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"after":{"anyOf":[{"type":"string"},{"type":"null"}]},"before":{"anyOf":[{"type":"string"},{"type":"null"}]},"includeTotalCount":{"type":"boolean"},"perPage":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}]},"subscriberId":{"type":"integer"}},"required":["subscriberId"],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"taggedAt":{"type":"string"}},"required":["id","name","taggedAt"]}},"pagination":{"type":"object","properties":{"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"},"startCursor":{"type":"string"},"endCursor":{"type":"string"},"perPage":{"type":"integer"}},"required":["hasPreviousPage","hasNextPage","startCursor","endCursor","perPage"]}},"required":["tags","pagination"]},"outputWireSchema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"tagged_at":{"type":"string"}},"required":["id","name","tagged_at"]}},"pagination":{"type":"object","properties":{"has_previous_page":{"type":"boolean"},"has_next_page":{"type":"boolean"},"start_cursor":{"type":"string"},"end_cursor":{"type":"string"},"per_page":{"type":"integer"}},"required":["has_previous_page","has_next_page","start_cursor","end_cursor","per_page"]}},"required":["tags","pagination"]},"path":"/v4/subscribers/{subscriber_id}/tags","pathParameters":[{"explode":true,"name":"subscriberId","providerName":"subscriber_id","style":"form"}],"queryParameters":[{"explode":true,"name":"after","providerName":"after","style":"form"},{"explode":true,"name":"before","providerName":"before","style":"form"},{"explode":true,"name":"includeTotalCount","providerName":"include_total_count","style":"form"},{"explode":true,"name":"perPage","providerName":"per_page","style":"form"}],"responseMode":"json"},"bulkDeleteTags":{"bodyParameters":["tags","callbackUrl"],"bodyWireSchema":{"type":"object","required":["tags"],"properties":{"tags":{"type":"array","description":"Tags to delete, identified by `id`. Batches of 100 or fewer are processed synchronously (200); larger batches are queued and processed asynchronously (202).","items":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The id of the tag to delete."}}}},"callback_url":{"type":"string","nullable":true,"description":"Optional. When the batch is processed asynchronously (more than 100 tags), the results are POSTed to this URL on completion."}}},"inputSchema":{"additionalProperties":false,"properties":{"tags":{"type":"array","description":"Tags to delete, identified by `id`. Batches of 100 or fewer are processed synchronously (200); larger batches are queued and processed asynchronously (202).","items":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The id of the tag to delete."}}}},"callbackUrl":{"anyOf":[{"type":"string","description":"Optional. When the batch is processed asynchronously (more than 100 tags), the results are POSTed to this URL on completion."},{"type":"null"}]}},"required":["tags"],"type":"object"},"method":"DELETE","outputSchema":{"anyOf":[{"type":"object","properties":{"failures":{"type":"array","items":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"tag":{"type":"object","properties":{"id":{"type":"integer"}},"required":["id"]}},"required":["errors","tag"]}}},"required":["failures"]},{"type":"object","properties":{}}]},"outputWireSchema":{"anyOf":[{"type":"object","properties":{"failures":{"type":"array","items":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"tag":{"type":"object","properties":{"id":{"type":"integer"}},"required":["id"]}},"required":["errors","tag"]}}},"required":["failures"]},{"type":"object","properties":{}}]},"path":"/v4/bulk/tags","pathParameters":[],"queryParameters":[],"responseMode":"json"},"bulkCreateTags":{"bodyParameters":["tags","callbackUrl"],"bodyWireSchema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}},"callback_url":{"type":"string","nullable":true}},"required":["tags"]},"inputSchema":{"additionalProperties":false,"properties":{"tags":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}},"callbackUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["tags"],"type":"object"},"method":"POST","outputSchema":{"anyOf":[{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"createdAt":{"type":"string"}},"required":["id","name","createdAt"]}},"failures":{"type":"array","items":{}}},"required":["tags","failures"]},{"type":"object","properties":{}}]},"outputWireSchema":{"anyOf":[{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"created_at":{"type":"string"}},"required":["id","name","created_at"]}},"failures":{"type":"array","items":{}}},"required":["tags","failures"]},{"type":"object","properties":{}}]},"path":"/v4/bulk/tags","pathParameters":[],"queryParameters":[],"responseMode":"json"},"bulkTagSubscribers":{"bodyParameters":["taggings","callbackUrl"],"bodyWireSchema":{"type":"object","properties":{"taggings":{"type":"array","items":{"type":"object","properties":{"tag_id":{"type":"integer","nullable":true},"subscriber_id":{"type":"integer","nullable":true}},"required":["tag_id","subscriber_id"]}},"callback_url":{"type":"string","nullable":true}},"required":["taggings"]},"inputSchema":{"additionalProperties":false,"properties":{"taggings":{"type":"array","items":{"type":"object","properties":{"tagId":{"anyOf":[{"type":"integer"},{"type":"null"}]},"subscriberId":{"anyOf":[{"type":"integer"},{"type":"null"}]}},"required":["tagId","subscriberId"]}},"callbackUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["taggings"],"type":"object"},"method":"POST","outputSchema":{"anyOf":[{"type":"object","properties":{"subscribers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"type":"string"},"emailAddress":{"type":"string"},"createdAt":{"type":"string"},"taggedAt":{"type":"string"}},"required":["id","firstName","emailAddress","createdAt","taggedAt"]}},"failures":{"type":"array","items":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"tagging":{"type":"object","properties":{"tagId":{"anyOf":[{"type":"integer"},{"type":"null"}]},"subscriberId":{"anyOf":[{"type":"integer"},{"type":"null"}]}},"required":["tagId","subscriberId"]}},"required":["errors","tagging"]}}},"required":["subscribers","failures"]},{"type":"object","properties":{}}]},"outputWireSchema":{"anyOf":[{"type":"object","properties":{"subscribers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string"},"email_address":{"type":"string"},"created_at":{"type":"string"},"tagged_at":{"type":"string"}},"required":["id","first_name","email_address","created_at","tagged_at"]}},"failures":{"type":"array","items":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"tagging":{"type":"object","properties":{"tag_id":{"type":"integer","nullable":true},"subscriber_id":{"nullable":true,"type":"integer"}},"required":["tag_id","subscriber_id"]}},"required":["errors","tagging"]}}},"required":["subscribers","failures"]},{"type":"object","properties":{}}]},"path":"/v4/bulk/tags/subscribers","pathParameters":[],"queryParameters":[],"responseMode":"json"},"listTags":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"after":{"anyOf":[{"type":"string"},{"type":"null"}]},"before":{"anyOf":[{"type":"string"},{"type":"null"}]},"includeTotalCount":{"type":"boolean"},"perPage":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}]},"include":{"type":"string"}},"required":[],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"createdAt":{"type":"string"},"subscriberCount":{"type":"integer","description":"Returned when `include` contains `subscriber_count`. The number of active subscribers with this tag."}},"required":["id","name","createdAt"]}},"pagination":{"type":"object","properties":{"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"},"startCursor":{"type":"string"},"endCursor":{"type":"string"},"perPage":{"type":"integer"}},"required":["hasPreviousPage","hasNextPage","startCursor","endCursor","perPage"]}},"required":["tags","pagination"]},"outputWireSchema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"created_at":{"type":"string"},"subscriber_count":{"type":"integer","description":"Returned when `include` contains `subscriber_count`. The number of active subscribers with this tag."}},"required":["id","name","created_at"]}},"pagination":{"type":"object","properties":{"has_previous_page":{"type":"boolean"},"has_next_page":{"type":"boolean"},"start_cursor":{"type":"string"},"end_cursor":{"type":"string"},"per_page":{"type":"integer"}},"required":["has_previous_page","has_next_page","start_cursor","end_cursor","per_page"]}},"required":["tags","pagination"]},"path":"/v4/tags","pathParameters":[],"queryParameters":[{"explode":true,"name":"after","providerName":"after","style":"form"},{"explode":true,"name":"before","providerName":"before","style":"form"},{"explode":true,"name":"includeTotalCount","providerName":"include_total_count","style":"form"},{"explode":true,"name":"perPage","providerName":"per_page","style":"form"},{"explode":true,"name":"include","providerName":"include","style":"form"}],"responseMode":"json"},"createTag":{"bodyParameters":["name"],"bodyWireSchema":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"inputSchema":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"method":"POST","outputSchema":{"anyOf":[{"type":"object","properties":{"tag":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"createdAt":{"type":"string"}},"required":["id","name","createdAt"]}},"required":["tag"]},{"type":"object","properties":{"tag":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"createdAt":{"type":"string"}},"required":["id","name","createdAt"]}},"required":["tag"]}]},"outputWireSchema":{"anyOf":[{"type":"object","properties":{"tag":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"created_at":{"type":"string"}},"required":["id","name","created_at"]}},"required":["tag"]},{"type":"object","properties":{"tag":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"created_at":{"type":"string"}},"required":["id","name","created_at"]}},"required":["tag"]}]},"path":"/v4/tags","pathParameters":[],"queryParameters":[],"responseMode":"json"},"updateTag":{"bodyParameters":["name"],"bodyWireSchema":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"inputSchema":{"additionalProperties":false,"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"method":"PUT","outputSchema":{"type":"object","properties":{"tag":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"createdAt":{"type":"string"}},"required":["id","name","createdAt"]}},"required":["tag"]},"outputWireSchema":{"type":"object","properties":{"tag":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"created_at":{"type":"string"}},"required":["id","name","created_at"]}},"required":["tag"]},"path":"/v4/tags/{id}","pathParameters":[{"explode":true,"name":"id","providerName":"id","style":"form"}],"queryParameters":[],"responseMode":"json"},"listTagSubscribers":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"after":{"anyOf":[{"type":"string"},{"type":"null"}]},"before":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAfter":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdBefore":{"anyOf":[{"type":"string"},{"type":"null"}]},"includeTotalCount":{"type":"boolean"},"perPage":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}]},"slim":{"type":"boolean"},"status":{"type":"string","enum":["active","inactive","bounced","complained","cancelled","all"]},"tagId":{"type":"integer"},"taggedAfter":{"anyOf":[{"type":"string"},{"type":"null"}]},"taggedBefore":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["tagId"],"type":"object"},"method":"GET","outputSchema":{"type":"object","properties":{"subscribers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"createdAt":{"type":"string"},"taggedAt":{"type":"string"},"fields":{"type":"object","required":["category"],"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"required":["id","firstName","emailAddress","state","createdAt","taggedAt","fields"]}},"pagination":{"type":"object","properties":{"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"},"startCursor":{"type":"string"},"endCursor":{"type":"string"},"perPage":{"type":"integer"}},"required":["hasPreviousPage","hasNextPage","startCursor","endCursor","perPage"]}},"required":["subscribers","pagination"]},"outputWireSchema":{"type":"object","properties":{"subscribers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"created_at":{"type":"string"},"tagged_at":{"type":"string"},"fields":{"type":"object","required":["category"],"additionalProperties":{"nullable":true,"type":"string"}}},"required":["id","first_name","email_address","state","created_at","tagged_at","fields"]}},"pagination":{"type":"object","properties":{"has_previous_page":{"type":"boolean"},"has_next_page":{"type":"boolean"},"start_cursor":{"type":"string"},"end_cursor":{"type":"string"},"per_page":{"type":"integer"}},"required":["has_previous_page","has_next_page","start_cursor","end_cursor","per_page"]}},"required":["subscribers","pagination"]},"path":"/v4/tags/{tag_id}/subscribers","pathParameters":[{"explode":true,"name":"tagId","providerName":"tag_id","style":"form"}],"queryParameters":[{"explode":true,"name":"after","providerName":"after","style":"form"},{"explode":true,"name":"before","providerName":"before","style":"form"},{"explode":true,"name":"createdAfter","providerName":"created_after","style":"form"},{"explode":true,"name":"createdBefore","providerName":"created_before","style":"form"},{"explode":true,"name":"includeTotalCount","providerName":"include_total_count","style":"form"},{"explode":true,"name":"perPage","providerName":"per_page","style":"form"},{"explode":true,"name":"slim","providerName":"slim","style":"form"},{"explode":true,"name":"status","providerName":"status","style":"form"},{"explode":true,"name":"taggedAfter","providerName":"tagged_after","style":"form"},{"explode":true,"name":"taggedBefore","providerName":"tagged_before","style":"form"}],"responseMode":"json"},"tagSubscriberByEmailAddress":{"bodyParameters":["emailAddress"],"bodyWireSchema":{"type":"object","properties":{"email_address":{"type":"string"}},"required":["email_address"]},"inputSchema":{"additionalProperties":false,"properties":{"tagId":{"type":"integer"},"emailAddress":{"type":"string"}},"required":["tagId","emailAddress"],"type":"object"},"method":"POST","outputSchema":{"anyOf":[{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"createdAt":{"type":"string"},"taggedAt":{"type":"string"},"fields":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"required":["id","firstName","emailAddress","state","createdAt","taggedAt","fields"]}},"required":["subscriber"]},{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"createdAt":{"type":"string"},"taggedAt":{"type":"string"},"fields":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"required":["id","firstName","emailAddress","state","createdAt","taggedAt","fields"]}},"required":["subscriber"]}]},"outputWireSchema":{"anyOf":[{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"created_at":{"type":"string"},"tagged_at":{"type":"string"},"fields":{"type":"object","additionalProperties":{"nullable":true,"type":"string"}}},"required":["id","first_name","email_address","state","created_at","tagged_at","fields"]}},"required":["subscriber"]},{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"created_at":{"type":"string"},"tagged_at":{"type":"string"},"fields":{"type":"object","additionalProperties":{"nullable":true,"type":"string"}}},"required":["id","first_name","email_address","state","created_at","tagged_at","fields"]}},"required":["subscriber"]}]},"path":"/v4/tags/{tag_id}/subscribers","pathParameters":[{"explode":true,"name":"tagId","providerName":"tag_id","style":"form"}],"queryParameters":[],"responseMode":"json"},"removeTagFromSubscriber":{"bodyParameters":[],"inputSchema":{"additionalProperties":false,"properties":{"id":{"type":"integer"},"tagId":{"type":"integer"}},"required":["id","tagId"],"type":"object"},"method":"DELETE","outputSchema":{"additionalProperties":false,"properties":{},"type":"object"},"outputWireSchema":{"additionalProperties":false,"properties":{},"type":"object"},"path":"/v4/tags/{tag_id}/subscribers/{id}","pathParameters":[{"explode":true,"name":"id","providerName":"id","style":"form"},{"explode":true,"name":"tagId","providerName":"tag_id","style":"form"}],"queryParameters":[],"responseMode":"void"},"tagSubscriber":{"bodyParameters":[],"bodyWireSchema":{"type":"object","properties":{}},"inputSchema":{"additionalProperties":false,"properties":{"id":{"type":"integer"},"tagId":{"type":"integer"}},"required":["id","tagId"],"type":"object"},"method":"POST","outputSchema":{"anyOf":[{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"createdAt":{"type":"string"},"taggedAt":{"type":"string"},"fields":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"required":["id","firstName","emailAddress","state","createdAt","taggedAt","fields"]}},"required":["subscriber"]},{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailAddress":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"createdAt":{"type":"string"},"taggedAt":{"type":"string"},"fields":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"required":["id","firstName","emailAddress","state","createdAt","taggedAt","fields"]}},"required":["subscriber"]}]},"outputWireSchema":{"anyOf":[{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"created_at":{"type":"string"},"tagged_at":{"type":"string"},"fields":{"type":"object","additionalProperties":{"nullable":true,"type":"string"}}},"required":["id","first_name","email_address","state","created_at","tagged_at","fields"]}},"required":["subscriber"]},{"type":"object","properties":{"subscriber":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string","nullable":true},"email_address":{"type":"string"},"state":{"type":"string","enum":["active","cancelled","bounced","complained","inactive"]},"created_at":{"type":"string"},"tagged_at":{"type":"string"},"fields":{"type":"object","additionalProperties":{"nullable":true,"type":"string"}}},"required":["id","first_name","email_address","state","created_at","tagged_at","fields"]}},"required":["subscriber"]}]},"path":"/v4/tags/{tag_id}/subscribers/{id}","pathParameters":[{"explode":true,"name":"id","providerName":"id","style":"form"},{"explode":true,"name":"tagId","providerName":"tag_id","style":"form"}],"queryParameters":[],"responseMode":"json"}},"source":{"sha256":"a8edeb6df018764cb7b7126185ac9bcf0d9c75bbb3917f2d0665adb4135c5e76","url":"https://developers.kit.com/api-reference/v4.json"},"wireDefinitions":{"BroadcastAnyCondition":{"type":"object","description":"Filter by specific broadcast IDs. Subscriber must have interacted with ANY of the specified broadcasts.","properties":{"type":{"type":"string","enum":["broadcasts"],"description":"Must be \'broadcasts\'"},"ids":{"type":"array","items":{"type":"integer"},"description":"Array of broadcast IDs. Subscriber must match ANY of these."}},"required":["type","ids"]},"FilterCondition":{"type":"object","description":"A filter condition with type and optional parameters. Used within the \'all\' array for complex filtering where multiple conditions must be met.","properties":{"type":{"type":"string","enum":["opens","clicks","sent","delivered","subscribed","subscriber_state","tags","attribution","custom_field","location"],"description":"Type of filter condition. `attribution` matches subscribers by their *original signup attribution* — supports two sub-conditions: `forms` matches by the form / landing-page id the subscriber signed up through, and `kit_source` matches by any combination of the underlying Kit source fields (source type, source id, source name, mechanism, mechanism id). Attribution is the original signup source; it does not track current subscription state. `custom_field` matches subscribers by the value they have stored for a particular custom field, identified by `subscriber_custom_field_id`. `location` matches subscribers whose primary location falls within a `radius` (miles) of (`latitude`, `longitude`). All three fields are required."},"count_greater_than":{"type":"integer","description":"Minimum count (exclusive). Only applicable for engagement types (\'opens\', \'clicks\', \'sent\', \'delivered\')."},"count_greater_than_or_equal":{"type":"integer","description":"Minimum count (inclusive). Only applicable for engagement types (\'opens\', \'clicks\', \'sent\', \'delivered\')."},"count_less_than":{"type":"integer","description":"Maximum count (exclusive). Only applicable for engagement types (\'opens\', \'clicks\', \'sent\', \'delivered\')."},"count_less_than_or_equal":{"type":"integer","description":"Maximum count (inclusive). Only applicable for engagement types (\'opens\', \'clicks\', \'sent\', \'delivered\')."},"after":{"type":"string","format":"date","description":"Start date (YYYY-MM-DD). For \'subscribed\' type, filters by subscriber_created_at. For engagement types, filters by event date. Not applicable for \'tags\', \'subscriber_state\', \'attribution\', or \'custom_field\' types."},"before":{"type":"string","format":"date","description":"End date (YYYY-MM-DD). For \'subscribed\' type, filters by subscriber_created_at. For engagement types, filters by event date. Not applicable for \'tags\', \'subscriber_state\', \'attribution\', or \'custom_field\' types."},"states":{"type":"array","items":{"type":"string","enum":["active","inactive","bounced","cancelled","complained"]},"description":"Subscriber lifecycle states. Required for \'subscriber_state\' type; ignored for other types. Subscribers matching any of the listed states pass the filter. Strongly recommended to use `[\'active\']` unless you specifically need other states — most subscriber-facing queries elsewhere in the app scope to active subscribers by default."},"subscriber_custom_field_id":{"type":"integer","description":"Id of the custom field whose stored value is being filtered on. Required for \'custom_field\' type; ignored for other types."},"value":{"type":"string","description":"Value to compare against. Used by \'custom_field\' type together with `comparison`. For the numeric comparisons (`greater_than`, `greater_than_or_equal`, `less_than`, `less_than_or_equal`) the value is parsed as a number; non-numeric stored values are excluded. Ignored when `comparison` is `has_value`."},"comparison":{"type":"string","enum":["is","contains","has_value","greater_than","greater_than_or_equal","less_than","less_than_or_equal"],"description":"How `value` is matched against the stored custom-field value. `is` is exact equality, `contains` is a case-insensitive substring (blank `value` matches any subscriber that has a value stored for the field), `has_value` matches any non-empty stored value (ignores `value`), `greater_than` / `greater_than_or_equal` / `less_than` / `less_than_or_equal` compare numerically. Only applicable for \'custom_field\' type."},"latitude":{"type":"number","format":"float","description":"Center latitude (decimal degrees). Required for the \'location\' type. Combined with `longitude` and `radius` to form a bounding box around the point."},"longitude":{"type":"number","format":"float","description":"Center longitude (decimal degrees). Required for the \'location\' type."},"radius":{"type":"number","description":"Radius around (`latitude`, `longitude`) in miles. Required for the \'location\' type. Subscribers whose primary location falls inside the bounding box pass the filter."},"any":{"type":"array","description":"Array of OR conditions. Subscriber activity must match ANY of these conditions. Engagement types accept broadcasts/URLs; \'tags\' accepts tag id matchers; \'attribution\' accepts attribution sub-conditions (\'forms\' or \'kit_source\'). Not applicable for \'subscribed\', \'subscriber_state\', \'custom_field\', or \'location\' types.","items":{"oneOf":[{"title":"Broadcasts","$ref":"#/components/schemas/BroadcastAnyCondition"},{"title":"URLs (clicks only)","$ref":"#/components/schemas/UrlAnyCondition"},{"title":"Tag ids (tags only)","$ref":"#/components/schemas/IdsAnyCondition"},{"title":"Forms (attribution only)","$ref":"#/components/schemas/FormsAnyCondition"},{"title":"Kit source (attribution only)","$ref":"#/components/schemas/KitSourceAnyCondition"}]}}},"required":["type"]},"FormsAnyCondition":{"type":"object","description":"Attribution sub-condition: matches subscribers whose original signup attribution points at one of the given form / landing-page ids. Ids may refer to either a form or a legacy landing page — the attribution source does not distinguish between the two.","properties":{"type":{"type":"string","enum":["forms"],"description":"Must be \'forms\'"},"ids":{"type":"array","items":{"type":"integer"},"description":"Form / landing-page ids the subscriber\'s attribution should match."}},"required":["type","ids"]},"IdsAnyCondition":{"type":"object","description":"Match a list of ids. Used by the \'tags\' filter to select tag ids.","properties":{"type":{"type":"string","enum":["ids"],"description":"Must be \'ids\'"},"matching":{"type":"array","items":{"type":"integer"},"description":"Ids the filter should match against."}},"required":["type","matching"]},"KitSourceAnyCondition":{"type":"object","description":"Attribution sub-condition: matches subscribers whose original signup attribution row matches any combination of the supplied Kit source fields. All fields are optional; supplied fields are ANDed together against the same attribution row, and array fields (`source_ids`, `source_names`, `mechanism_ids`) match any value in the array. Known `source_type` values include `form_subscription` (form / landing-page signup), `api_subscription` (added via the API), and `manual` (added by the creator). Multiple entries in the parent `attribution` filter\'s `any` array are OR-ed together (consistent with `any` semantics elsewhere in this endpoint), so use separate entries to express \\"kit_source A OR kit_source B\\".","properties":{"type":{"type":"string","enum":["kit_source"],"description":"Must be \'kit_source\'"},"source_type":{"type":"string","description":"Match attribution rows whose `kit_source_type` equals this value."},"source_ids":{"type":"array","items":{"type":"integer"},"description":"Match attribution rows whose `kit_source_id` is in this list."},"source_names":{"type":"array","items":{"type":"string"},"description":"Match attribution rows whose `kit_source_name` is in this list."},"mechanism":{"type":"string","description":"Match attribution rows whose `kit_source_mechanism` equals this value."},"mechanism_ids":{"type":"array","items":{"type":"integer"},"description":"Match attribution rows whose `kit_source_mechanism_id` is in this list."}},"required":["type"]},"SubscriberFilterRequest":{"type":"object","description":"Filter subscribers based on engagement and subscription criteria using the \'all\' array with filter conditions that must all be met (AND logic).","properties":{"counting_mode":{"type":"string","enum":["raw","unique_email"],"description":"Controls how engagement-filter count thresholds are tallied. `raw` (default) counts every event — five opens of the same email = five. `unique_email` counts distinct emails on which the action occurred — five opens of the same email = one. Applies to every engagement filter (opens, clicks, sent, delivered) in the request; ignored for other filter types."},"all":{"type":"array","description":"Array of filter conditions where ALL must be met (AND logic)","items":{"$ref":"#/components/schemas/FilterCondition"}},"include":{"type":"array","description":"Optional. Array of `{ type, ...config }` objects naming additional fields to embed on each subscriber row. Valid types: `attribution`, `tags`, `location`, `canceled_at`, `stats`, `custom_fields`. The `stats` type accepts an optional `range: { start, end }` (YYYY-MM-DD dates, defaulting to the last 90 days). The `custom_fields` type adds a `fields` object with all account custom field values (null for fields the subscriber has not set).","example":[{"type":"tags"},{"type":"stats","range":{"start":"2026-05-01","end":"2026-06-30"}}],"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["attribution","tags","location","canceled_at","stats","custom_fields"]},"range":{"type":"object","description":"Only used by the `stats` type. Date window for the engagement stats. Defaults to the last 90 days; clamped to the account\'s data-retention window.","properties":{"start":{"type":"string","format":"date"},"end":{"type":"string","format":"date"}}}}}},"sort_field":{"type":"string","default":"created_at","enum":["id","first_name","email_address","created_at","engagement__sent","engagement__opens","engagement__clicks","engagement__open_rate","engagement__click_rate","location__distance"],"description":"Field to order results by. Base columns (`id`, `first_name`, `email_address`, `created_at`) order by that subscriber attribute. `engagement__<metric>` orders by an engagement stat over the trailing 90 days: counts (`sent`, `opens`, `clicks`) and rates (`open_rate`, `click_rate`); subscribers with no sends order as 0. `location__distance` orders by great-circle distance and requires a `location` filter in the same request — its `latitude`/`longitude` supply the origin, and subscribers without a primary location are excluded. Distance defaults to nearest-first (`sort_order` defaults to `asc` for this field); pass `sort_order=desc` for farthest-first."},"sort_order":{"type":"string","enum":["asc","desc"],"description":"Sort direction (default: desc)."}},"required":["all"]},"UrlAnyCondition":{"type":"object","description":"Filter by URL patterns. Only applicable for \'clicks\' type. Subscriber must have clicked ANY of the specified URLs.","properties":{"type":{"type":"string","enum":["urls"],"description":"Must be \'urls\'"},"ids":{"type":"array","items":{"type":"integer"},"description":"Array of URL IDs. Subscriber must have clicked ANY of these."},"urls":{"type":"array","items":{"type":"string"},"description":"Array of URL patterns. Subscriber must have clicked ANY of these."},"matching":{"type":"string","enum":["exact","contains","starts_with","ends_with"],"description":"URL matching strategy","default":"exact"}},"required":["type"]}}}',
+)