dtc-mcp 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/data/docs.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
- "version": "v2026-05-23",
3
- "generatedAt": "2026-05-23T03:52:41.912Z",
2
+ "version": "v2026-05-25",
3
+ "generatedAt": "2026-05-25T02:57:04.731Z",
4
4
  "chunks": [
5
5
  {
6
6
  "id": "guide.output-discipline",
@@ -213,7 +213,7 @@
213
213
  "platform": "klaviyo",
214
214
  "category": "method",
215
215
  "summary": "Add Categories to Catalog Item",
216
- "content": "## POST /api/catalog-items/{id}/relationships/categories\n\nCreate a new catalog category relationship for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/add_categories_to_catalog_item.json)\n\n**Parameters:**\n- `id` (required) — The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n\nUse `klaviyo.post('api/catalog-items/{id}/relationships/categories', ...)` to call this endpoint.",
216
+ "content": "## POST /api/catalog-items/{id}/relationships/categories\n\nCreate a new catalog category relationship for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/add_categories_to_catalog_item.json)\n\n**Parameters:**\n- `id` (required) — The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n\nUse `klaviyo.post('catalog-items/{id}/relationships/categories', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
217
217
  "tags": [
218
218
  "klaviyo",
219
219
  "openapi",
@@ -226,7 +226,7 @@
226
226
  "platform": "klaviyo",
227
227
  "category": "method",
228
228
  "summary": "Add Items to Catalog Category",
229
- "content": "## POST /api/catalog-categories/{id}/relationships/items\n\nCreate a new item relationship for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/add_items_to_catalog_category.json)\n\n**Parameters:**\n- `id` (required) — The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n\nUse `klaviyo.post('api/catalog-categories/{id}/relationships/items', ...)` to call this endpoint.",
229
+ "content": "## POST /api/catalog-categories/{id}/relationships/items\n\nCreate a new item relationship for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/add_items_to_catalog_category.json)\n\n**Parameters:**\n- `id` (required) — The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n\nUse `klaviyo.post('catalog-categories/{id}/relationships/items', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
230
230
  "tags": [
231
231
  "klaviyo",
232
232
  "openapi",
@@ -239,7 +239,7 @@
239
239
  "platform": "klaviyo",
240
240
  "category": "method",
241
241
  "summary": "Add Profiles to List",
242
- "content": "## POST /api/lists/{id}/relationships/profiles\n\nAdd a profile to a list with the given list ID.\n\nIt is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you're trying to give a profile [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api) to receive email marketing, SMS marketing, or both.\n\nThis endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:write`\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/add_profiles_to_list.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.post('api/lists/{id}/relationships/profiles', ...)` to call this endpoint.",
242
+ "content": "## POST /api/lists/{id}/relationships/profiles\n\nAdd a profile to a list with the given list ID.\n\nIt is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you're trying to give a profile [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api) to receive email marketing, SMS marketing, or both.\n\nThis endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:write`\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/add_profiles_to_list.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.post('lists/{id}/relationships/profiles', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
243
243
  "tags": [
244
244
  "klaviyo",
245
245
  "openapi",
@@ -252,7 +252,7 @@
252
252
  "platform": "klaviyo",
253
253
  "category": "method",
254
254
  "summary": "Assign Template to Campaign Message",
255
- "content": "## POST /api/campaign-message-assign-template\n\nCreates a non-reusable version of the template and assigns it to the message.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/assign_template_to_campaign_message.json)\n\n**Parameters:**\n- `fields[campaign-message]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/campaign-message-assign-template', ...)` to call this endpoint.",
255
+ "content": "## POST /api/campaign-message-assign-template\n\nCreates a non-reusable version of the template and assigns it to the message.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/assign_template_to_campaign_message.json)\n\n**Parameters:**\n- `fields[campaign-message]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('campaign-message-assign-template', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
256
256
  "tags": [
257
257
  "klaviyo",
258
258
  "openapi",
@@ -265,7 +265,7 @@
265
265
  "platform": "klaviyo",
266
266
  "category": "method",
267
267
  "summary": "Bulk Create Catalog Categories",
268
- "content": "## POST /api/catalog-category-bulk-create-jobs\n\nCreate a catalog category bulk create job to create a batch of catalog categories.\n\nAccepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_catalog_categories.json)\n\n**Parameters:**\n- `fields[catalog-category-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/catalog-category-bulk-create-jobs', ...)` to call this endpoint.",
268
+ "content": "## POST /api/catalog-category-bulk-create-jobs\n\nCreate a catalog category bulk create job to create a batch of catalog categories.\n\nAccepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_catalog_categories.json)\n\n**Parameters:**\n- `fields[catalog-category-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('catalog-category-bulk-create-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
269
269
  "tags": [
270
270
  "klaviyo",
271
271
  "openapi",
@@ -278,7 +278,7 @@
278
278
  "platform": "klaviyo",
279
279
  "category": "method",
280
280
  "summary": "Bulk Create Catalog Items",
281
- "content": "## POST /api/catalog-item-bulk-create-jobs\n\nCreate a catalog item bulk create job to create a batch of catalog items.\n\nAccepts up to 100 catalog items per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_catalog_items.json)\n\n**Parameters:**\n- `fields[catalog-item-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/catalog-item-bulk-create-jobs', ...)` to call this endpoint.",
281
+ "content": "## POST /api/catalog-item-bulk-create-jobs\n\nCreate a catalog item bulk create job to create a batch of catalog items.\n\nAccepts up to 100 catalog items per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_catalog_items.json)\n\n**Parameters:**\n- `fields[catalog-item-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('catalog-item-bulk-create-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
282
282
  "tags": [
283
283
  "klaviyo",
284
284
  "openapi",
@@ -291,7 +291,7 @@
291
291
  "platform": "klaviyo",
292
292
  "category": "method",
293
293
  "summary": "Bulk Create Catalog Variants",
294
- "content": "## POST /api/catalog-variant-bulk-create-jobs\n\nCreate a catalog variant bulk create job to create a batch of catalog variants.\n\nAccepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_catalog_variants.json)\n\n**Parameters:**\n- `fields[catalog-variant-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/catalog-variant-bulk-create-jobs', ...)` to call this endpoint.",
294
+ "content": "## POST /api/catalog-variant-bulk-create-jobs\n\nCreate a catalog variant bulk create job to create a batch of catalog variants.\n\nAccepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_catalog_variants.json)\n\n**Parameters:**\n- `fields[catalog-variant-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('catalog-variant-bulk-create-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
295
295
  "tags": [
296
296
  "klaviyo",
297
297
  "openapi",
@@ -304,7 +304,7 @@
304
304
  "platform": "klaviyo",
305
305
  "category": "method",
306
306
  "summary": "Bulk Create Client Events",
307
- "content": "## POST /client/event-bulk-create\n\nCreate new events to track a profile's activity.\n\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\n\nDo not use this endpoint from server-side applications.\nTo create events from server-side applications, instead use [POST /api/event-bulk-create-jobs](https://developers.klaviyo.com/en/reference/bulk_create_events).\n\nAccepts a maximum of `1000` events per request.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`events:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_client_events.json)\n\n**Parameters:**\n- `company_id` (required) — Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.\n\nUse `klaviyo.post('client/event-bulk-create', ...)` to call this endpoint.",
307
+ "content": "## POST /client/event-bulk-create\n\nCreate new events to track a profile's activity.\n\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\n\nDo not use this endpoint from server-side applications.\nTo create events from server-side applications, instead use [POST /api/event-bulk-create-jobs](https://developers.klaviyo.com/en/reference/bulk_create_events).\n\nAccepts a maximum of `1000` events per request.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`events:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_client_events.json)\n\n**Parameters:**\n- `company_id` (required) — Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.\n\nUse `klaviyo.post('client/event-bulk-create', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
308
308
  "tags": [
309
309
  "klaviyo",
310
310
  "openapi",
@@ -317,7 +317,7 @@
317
317
  "platform": "klaviyo",
318
318
  "category": "method",
319
319
  "summary": "Bulk Create Coupon Codes",
320
- "content": "## POST /api/coupon-code-bulk-create-jobs\n\nCreate a coupon-code-bulk-create-job to bulk create a list of coupon codes.\n\nMax number of coupon codes per job we allow for is 1000.\nMax number of jobs queued at once we allow for is 100.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`coupon-codes:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_coupon_codes.json)\n\n**Parameters:**\n- `fields[coupon-code-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/coupon-code-bulk-create-jobs', ...)` to call this endpoint.",
320
+ "content": "## POST /api/coupon-code-bulk-create-jobs\n\nCreate a coupon-code-bulk-create-job to bulk create a list of coupon codes.\n\nMax number of coupon codes per job we allow for is 1000.\nMax number of jobs queued at once we allow for is 100.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`coupon-codes:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_coupon_codes.json)\n\n**Parameters:**\n- `fields[coupon-code-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('coupon-code-bulk-create-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
321
321
  "tags": [
322
322
  "klaviyo",
323
323
  "openapi",
@@ -330,7 +330,7 @@
330
330
  "platform": "klaviyo",
331
331
  "category": "method",
332
332
  "summary": "Bulk Create Data Source Records",
333
- "content": "## POST /api/data-source-record-bulk-create-jobs\n\nCreate a bulk data source record import job to create a batch of records.\n\nAccepts up to 500 records per request. The maximum allowed payload size is 4MB. The maximum allowed payload size per-record is 512KB.\n\nTo learn more, see our [Custom Objects API overview](https://developers.klaviyo.com/en/reference/custom_objects_api_overview).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `15/m`\n\n**Scopes:**\n`custom-objects:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_data_source_records.json)\n\n\n\nUse `klaviyo.post('api/data-source-record-bulk-create-jobs', ...)` to call this endpoint.",
333
+ "content": "## POST /api/data-source-record-bulk-create-jobs\n\nCreate a bulk data source record import job to create a batch of records.\n\nAccepts up to 500 records per request. The maximum allowed payload size is 4MB. The maximum allowed payload size per-record is 512KB.\n\nTo learn more, see our [Custom Objects API overview](https://developers.klaviyo.com/en/reference/custom_objects_api_overview).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `15/m`\n\n**Scopes:**\n`custom-objects:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_data_source_records.json)\n\n\n\nUse `klaviyo.post('data-source-record-bulk-create-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
334
334
  "tags": [
335
335
  "klaviyo",
336
336
  "openapi",
@@ -343,7 +343,7 @@
343
343
  "platform": "klaviyo",
344
344
  "category": "method",
345
345
  "summary": "Bulk Create Events",
346
- "content": "## POST /api/event-bulk-create-jobs\n\nCreate a batch of events for one or more profiles.\n\nNote that this endpoint allows you to create new profiles or update existing profile properties.\n\nAt a minimum, profile and metric objects should include at least one profile identifier (e.g., `id`, `email`, or `phone_number`) and the metric `name`, respectively.\n\nAccepts up to 1,000 events per request. The maximum allowed payload size is 5MB. A single string cannot exceed 100KB.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`events:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_events.json)\n\n\n\nUse `klaviyo.post('api/event-bulk-create-jobs', ...)` to call this endpoint.",
346
+ "content": "## POST /api/event-bulk-create-jobs\n\nCreate a batch of events for one or more profiles.\n\nNote that this endpoint allows you to create new profiles or update existing profile properties.\n\nAt a minimum, profile and metric objects should include at least one profile identifier (e.g., `id`, `email`, or `phone_number`) and the metric `name`, respectively.\n\nAccepts up to 1,000 events per request. The maximum allowed payload size is 5MB. A single string cannot exceed 100KB.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`events:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_events.json)\n\n\n\nUse `klaviyo.post('event-bulk-create-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
347
347
  "tags": [
348
348
  "klaviyo",
349
349
  "openapi",
@@ -356,7 +356,7 @@
356
356
  "platform": "klaviyo",
357
357
  "category": "method",
358
358
  "summary": "Bulk Delete Catalog Categories",
359
- "content": "## POST /api/catalog-category-bulk-delete-jobs\n\nCreate a catalog category bulk delete job to delete a batch of catalog categories.\n\nAccepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_delete_catalog_categories.json)\n\n**Parameters:**\n- `fields[catalog-category-bulk-delete-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/catalog-category-bulk-delete-jobs', ...)` to call this endpoint.",
359
+ "content": "## POST /api/catalog-category-bulk-delete-jobs\n\nCreate a catalog category bulk delete job to delete a batch of catalog categories.\n\nAccepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_delete_catalog_categories.json)\n\n**Parameters:**\n- `fields[catalog-category-bulk-delete-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('catalog-category-bulk-delete-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
360
360
  "tags": [
361
361
  "klaviyo",
362
362
  "openapi",
@@ -369,7 +369,7 @@
369
369
  "platform": "klaviyo",
370
370
  "category": "method",
371
371
  "summary": "Bulk Delete Catalog Items",
372
- "content": "## POST /api/catalog-item-bulk-delete-jobs\n\nCreate a catalog item bulk delete job to delete a batch of catalog items.\n\nAccepts up to 100 catalog items per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_delete_catalog_items.json)\n\n**Parameters:**\n- `fields[catalog-item-bulk-delete-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/catalog-item-bulk-delete-jobs', ...)` to call this endpoint.",
372
+ "content": "## POST /api/catalog-item-bulk-delete-jobs\n\nCreate a catalog item bulk delete job to delete a batch of catalog items.\n\nAccepts up to 100 catalog items per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_delete_catalog_items.json)\n\n**Parameters:**\n- `fields[catalog-item-bulk-delete-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('catalog-item-bulk-delete-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
373
373
  "tags": [
374
374
  "klaviyo",
375
375
  "openapi",
@@ -382,7 +382,7 @@
382
382
  "platform": "klaviyo",
383
383
  "category": "method",
384
384
  "summary": "Bulk Delete Catalog Variants",
385
- "content": "## POST /api/catalog-variant-bulk-delete-jobs\n\nCreate a catalog variant bulk delete job to delete a batch of catalog variants.\n\nAccepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_delete_catalog_variants.json)\n\n**Parameters:**\n- `fields[catalog-variant-bulk-delete-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/catalog-variant-bulk-delete-jobs', ...)` to call this endpoint.",
385
+ "content": "## POST /api/catalog-variant-bulk-delete-jobs\n\nCreate a catalog variant bulk delete job to delete a batch of catalog variants.\n\nAccepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_delete_catalog_variants.json)\n\n**Parameters:**\n- `fields[catalog-variant-bulk-delete-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('catalog-variant-bulk-delete-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
386
386
  "tags": [
387
387
  "klaviyo",
388
388
  "openapi",
@@ -395,7 +395,7 @@
395
395
  "platform": "klaviyo",
396
396
  "category": "method",
397
397
  "summary": "Bulk Import Profiles",
398
- "content": "## POST /api/profile-bulk-import-jobs\n\nCreate a bulk profile import job to create or update a batch of profiles.\n\nAccepts up to 10,000 profiles per request. The maximum allowed payload size is 5MB. The maximum allowed payload size per-profile is 100KB.\n\nTo learn more, see our [Bulk Profile Import API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_bulk_profile_import_api).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:write`\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_import_profiles.json)\n\n**Parameters:**\n- `fields[profile-bulk-import-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/profile-bulk-import-jobs', ...)` to call this endpoint.",
398
+ "content": "## POST /api/profile-bulk-import-jobs\n\nCreate a bulk profile import job to create or update a batch of profiles.\n\nAccepts up to 10,000 profiles per request. The maximum allowed payload size is 5MB. The maximum allowed payload size per-profile is 100KB.\n\nTo learn more, see our [Bulk Profile Import API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_bulk_profile_import_api).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:write`\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_import_profiles.json)\n\n**Parameters:**\n- `fields[profile-bulk-import-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('profile-bulk-import-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
399
399
  "tags": [
400
400
  "klaviyo",
401
401
  "openapi",
@@ -408,7 +408,7 @@
408
408
  "platform": "klaviyo",
409
409
  "category": "method",
410
410
  "summary": "Bulk Subscribe Profiles",
411
- "content": "## POST /api/profile-subscription-bulk-create-jobs\n\nSubscribe one or more profiles to email marketing, SMS marketing, WhatsApp, or push. If the provided list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message.\nLearn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).\n\nIf a list is not provided, the opt-in process used will be determined by the [account-level default opt-in setting](https://www.klaviyo.com/settings/account/api-keys).\n\nTo add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships).\n\nThis API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about [suppressed profiles](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1).\n\nMaximum number of profiles can be submitted for subscription: 1000\n\nThis endpoint now supports a `historical_import` flag. If this flag is set `true`, profiles being subscribed will bypass double opt-in emails and be subscribed immediately. They will also bypass any associated \"Added to list\" flows. This is useful for importing historical data where you have already collected consent. If `historical_import` is set to true, the `consented_at` field is required and must be in the past.\n\nPush tokens provided in `push_tokens` will be registered for each profile as long as push subscriptions are consented to.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`lists:write`\n`profiles:write`\n`subscriptions:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_subscribe_profiles.json)\n\n\n\nUse `klaviyo.post('api/profile-subscription-bulk-create-jobs', ...)` to call this endpoint.",
411
+ "content": "## POST /api/profile-subscription-bulk-create-jobs\n\nSubscribe one or more profiles to email marketing, SMS marketing, WhatsApp, or push. If the provided list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message.\nLearn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).\n\nIf a list is not provided, the opt-in process used will be determined by the [account-level default opt-in setting](https://www.klaviyo.com/settings/account/api-keys).\n\nTo add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships).\n\nThis API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about [suppressed profiles](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1).\n\nMaximum number of profiles can be submitted for subscription: 1000\n\nThis endpoint now supports a `historical_import` flag. If this flag is set `true`, profiles being subscribed will bypass double opt-in emails and be subscribed immediately. They will also bypass any associated \"Added to list\" flows. This is useful for importing historical data where you have already collected consent. If `historical_import` is set to true, the `consented_at` field is required and must be in the past.\n\nPush tokens provided in `push_tokens` will be registered for each profile as long as push subscriptions are consented to.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`lists:write`\n`profiles:write`\n`subscriptions:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_subscribe_profiles.json)\n\n\n\nUse `klaviyo.post('profile-subscription-bulk-create-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
412
412
  "tags": [
413
413
  "klaviyo",
414
414
  "openapi",
@@ -421,7 +421,7 @@
421
421
  "platform": "klaviyo",
422
422
  "category": "method",
423
423
  "summary": "Bulk Suppress Profiles",
424
- "content": "## POST /api/profile-suppression-bulk-create-jobs\n\nManually suppress profiles by email address or specify a segment/list ID to suppress all current members of a segment/list.\n\nSuppressed profiles cannot receive email marketing, independent of their consent status. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).\n\nEmail address per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`profiles:write`\n`subscriptions:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_suppress_profiles.json)\n\n**Parameters:**\n- `fields[profile-suppression-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/profile-suppression-bulk-create-jobs', ...)` to call this endpoint.",
424
+ "content": "## POST /api/profile-suppression-bulk-create-jobs\n\nManually suppress profiles by email address or specify a segment/list ID to suppress all current members of a segment/list.\n\nSuppressed profiles cannot receive email marketing, independent of their consent status. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).\n\nEmail address per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`profiles:write`\n`subscriptions:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_suppress_profiles.json)\n\n**Parameters:**\n- `fields[profile-suppression-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('profile-suppression-bulk-create-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
425
425
  "tags": [
426
426
  "klaviyo",
427
427
  "openapi",
@@ -434,7 +434,7 @@
434
434
  "platform": "klaviyo",
435
435
  "category": "method",
436
436
  "summary": "Bulk Unsubscribe Profiles",
437
- "content": "## POST /api/profile-subscription-bulk-delete-jobs\n\n> 🚧\n>\n> Profiles not in the specified list will be globally unsubscribed. Always verify profile list membership before calling this endpoint to avoid unintended global unsubscribes.\n\nUnsubscribe one or more profiles from email marketing, SMS marketing, push marketing, or a combination. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).\n\nPush tokens provided in `subscriptions.push.tokens` will be removed for the specified profiles.\n\nTo remove someone from a list without changing their subscription status, use [Remove Profiles from List](https://developers.klaviyo.com/en/reference/remove_profiles_from_list).\n\nMaximum number of profiles per call: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`lists:write`\n`profiles:write`\n`subscriptions:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_unsubscribe_profiles.json)\n\n\n\nUse `klaviyo.post('api/profile-subscription-bulk-delete-jobs', ...)` to call this endpoint.",
437
+ "content": "## POST /api/profile-subscription-bulk-delete-jobs\n\n> 🚧\n>\n> Profiles not in the specified list will be globally unsubscribed. Always verify profile list membership before calling this endpoint to avoid unintended global unsubscribes.\n\nUnsubscribe one or more profiles from email marketing, SMS marketing, push marketing, or a combination. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).\n\nPush tokens provided in `subscriptions.push.tokens` will be removed for the specified profiles.\n\nTo remove someone from a list without changing their subscription status, use [Remove Profiles from List](https://developers.klaviyo.com/en/reference/remove_profiles_from_list).\n\nMaximum number of profiles per call: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`lists:write`\n`profiles:write`\n`subscriptions:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_unsubscribe_profiles.json)\n\n\n\nUse `klaviyo.post('profile-subscription-bulk-delete-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
438
438
  "tags": [
439
439
  "klaviyo",
440
440
  "openapi",
@@ -447,7 +447,7 @@
447
447
  "platform": "klaviyo",
448
448
  "category": "method",
449
449
  "summary": "Bulk Unsuppress Profiles",
450
- "content": "## POST /api/profile-suppression-bulk-delete-jobs\n\nManually unsuppress profiles by email address or specify a segment/list ID to unsuppress all current members of a segment/list.\n\nThis only removes suppressions with reason USER_SUPPRESSED ; unsubscribed profiles and suppressed profiles with reason INVALID_EMAIL or HARD_BOUNCE remain unchanged. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).\n\nEmail address per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`subscriptions:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_unsuppress_profiles.json)\n\n**Parameters:**\n- `fields[profile-suppression-bulk-delete-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/profile-suppression-bulk-delete-jobs', ...)` to call this endpoint.",
450
+ "content": "## POST /api/profile-suppression-bulk-delete-jobs\n\nManually unsuppress profiles by email address or specify a segment/list ID to unsuppress all current members of a segment/list.\n\nThis only removes suppressions with reason USER_SUPPRESSED ; unsubscribed profiles and suppressed profiles with reason INVALID_EMAIL or HARD_BOUNCE remain unchanged. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).\n\nEmail address per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`subscriptions:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_unsuppress_profiles.json)\n\n**Parameters:**\n- `fields[profile-suppression-bulk-delete-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('profile-suppression-bulk-delete-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
451
451
  "tags": [
452
452
  "klaviyo",
453
453
  "openapi",
@@ -460,7 +460,7 @@
460
460
  "platform": "klaviyo",
461
461
  "category": "method",
462
462
  "summary": "Bulk Update Catalog Categories",
463
- "content": "## POST /api/catalog-category-bulk-update-jobs\n\nCreate a catalog category bulk update job to update a batch of catalog categories.\n\nAccepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_update_catalog_categories.json)\n\n**Parameters:**\n- `fields[catalog-category-bulk-update-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/catalog-category-bulk-update-jobs', ...)` to call this endpoint.",
463
+ "content": "## POST /api/catalog-category-bulk-update-jobs\n\nCreate a catalog category bulk update job to update a batch of catalog categories.\n\nAccepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_update_catalog_categories.json)\n\n**Parameters:**\n- `fields[catalog-category-bulk-update-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('catalog-category-bulk-update-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
464
464
  "tags": [
465
465
  "klaviyo",
466
466
  "openapi",
@@ -473,7 +473,7 @@
473
473
  "platform": "klaviyo",
474
474
  "category": "method",
475
475
  "summary": "Bulk Update Catalog Items",
476
- "content": "## POST /api/catalog-item-bulk-update-jobs\n\nCreate a catalog item bulk update job to update a batch of catalog items.\n\nAccepts up to 100 catalog items per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_update_catalog_items.json)\n\n**Parameters:**\n- `fields[catalog-item-bulk-update-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/catalog-item-bulk-update-jobs', ...)` to call this endpoint.",
476
+ "content": "## POST /api/catalog-item-bulk-update-jobs\n\nCreate a catalog item bulk update job to update a batch of catalog items.\n\nAccepts up to 100 catalog items per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_update_catalog_items.json)\n\n**Parameters:**\n- `fields[catalog-item-bulk-update-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('catalog-item-bulk-update-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
477
477
  "tags": [
478
478
  "klaviyo",
479
479
  "openapi",
@@ -486,7 +486,7 @@
486
486
  "platform": "klaviyo",
487
487
  "category": "method",
488
488
  "summary": "Bulk Update Catalog Variants",
489
- "content": "## POST /api/catalog-variant-bulk-update-jobs\n\nCreate a catalog variant bulk update job to update a batch of catalog variants.\n\nAccepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_update_catalog_variants.json)\n\n**Parameters:**\n- `fields[catalog-variant-bulk-update-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/catalog-variant-bulk-update-jobs', ...)` to call this endpoint.",
489
+ "content": "## POST /api/catalog-variant-bulk-update-jobs\n\nCreate a catalog variant bulk update job to update a batch of catalog variants.\n\nAccepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_update_catalog_variants.json)\n\n**Parameters:**\n- `fields[catalog-variant-bulk-update-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('catalog-variant-bulk-update-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
490
490
  "tags": [
491
491
  "klaviyo",
492
492
  "openapi",
@@ -499,7 +499,7 @@
499
499
  "platform": "klaviyo",
500
500
  "category": "method",
501
501
  "summary": "Cancel Campaign Send",
502
- "content": "## PATCH /api/campaign-send-jobs/{id}\n\nPermanently cancel the campaign, setting the status to CANCELED or\nrevert the campaign, setting the status back to DRAFT<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/cancel_campaign_send.json)\n\n**Parameters:**\n- `id` (required) — The ID of the currently sending campaign to cancel or revert\n\nUse `klaviyo.post('api/campaign-send-jobs/{id}', ...)` to call this endpoint.",
502
+ "content": "## PATCH /api/campaign-send-jobs/{id}\n\nPermanently cancel the campaign, setting the status to CANCELED or\nrevert the campaign, setting the status back to DRAFT<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/cancel_campaign_send.json)\n\n**Parameters:**\n- `id` (required) — The ID of the currently sending campaign to cancel or revert\n\nUse `klaviyo.post('campaign-send-jobs/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
503
503
  "tags": [
504
504
  "klaviyo",
505
505
  "openapi",
@@ -512,7 +512,7 @@
512
512
  "platform": "klaviyo",
513
513
  "category": "method",
514
514
  "summary": "Clone Template",
515
- "content": "## POST /api/template-clone\n\nCreate a clone of a template with the given template ID.\n\nIf there are 1,000 or more templates in an account, cloning will fail as there is a limit of 1,000 templates\nthat can be created via the API.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`templates:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/clone_template.json)\n\n**Parameters:**\n- `fields[template]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/template-clone', ...)` to call this endpoint.",
515
+ "content": "## POST /api/template-clone\n\nCreate a clone of a template with the given template ID.\n\nIf there are 1,000 or more templates in an account, cloning will fail as there is a limit of 1,000 templates\nthat can be created via the API.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`templates:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/clone_template.json)\n\n**Parameters:**\n- `fields[template]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('template-clone', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
516
516
  "tags": [
517
517
  "klaviyo",
518
518
  "openapi",
@@ -525,7 +525,7 @@
525
525
  "platform": "klaviyo",
526
526
  "category": "method",
527
527
  "summary": "Create Back In Stock Subscription",
528
- "content": "## POST /api/back-in-stock-subscriptions\n\nSubscribe a profile to receive back in stock notifications. Check out [our Back in Stock API guide](https://developers.klaviyo.com/en/docs/how_to_set_up_custom_back_in_stock) for more details.\n\nThis endpoint is specifically designed to be called from server-side applications. To create subscriptions from client-side contexts, use [POST /client/back-in-stock-subscriptions](https://developers.klaviyo.com/en/reference/create_client_back_in_stock_subscription).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:write`\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_back_in_stock_subscription.json)\n\n\n\nUse `klaviyo.post('api/back-in-stock-subscriptions', ...)` to call this endpoint.",
528
+ "content": "## POST /api/back-in-stock-subscriptions\n\nSubscribe a profile to receive back in stock notifications. Check out [our Back in Stock API guide](https://developers.klaviyo.com/en/docs/how_to_set_up_custom_back_in_stock) for more details.\n\nThis endpoint is specifically designed to be called from server-side applications. To create subscriptions from client-side contexts, use [POST /client/back-in-stock-subscriptions](https://developers.klaviyo.com/en/reference/create_client_back_in_stock_subscription).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:write`\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_back_in_stock_subscription.json)\n\n\n\nUse `klaviyo.post('back-in-stock-subscriptions', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
529
529
  "tags": [
530
530
  "klaviyo",
531
531
  "openapi",
@@ -538,7 +538,7 @@
538
538
  "platform": "klaviyo",
539
539
  "category": "method",
540
540
  "summary": "Create Campaign",
541
- "content": "## POST /api/campaigns\n\nCreates a campaign given a set of parameters, then returns it.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_campaign.json)\n\n**Parameters:**\n- `fields[campaign]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/campaigns', ...)` to call this endpoint.",
541
+ "content": "## POST /api/campaigns\n\nCreates a campaign given a set of parameters, then returns it.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_campaign.json)\n\n**Parameters:**\n- `fields[campaign]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('campaigns', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
542
542
  "tags": [
543
543
  "klaviyo",
544
544
  "openapi",
@@ -551,7 +551,7 @@
551
551
  "platform": "klaviyo",
552
552
  "category": "method",
553
553
  "summary": "Create Campaign Clone",
554
- "content": "## POST /api/campaign-clone\n\nClones an existing campaign, returning a new campaign based on the original with a new ID and name.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_campaign_clone.json)\n\n**Parameters:**\n- `fields[campaign]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/campaign-clone', ...)` to call this endpoint.",
554
+ "content": "## POST /api/campaign-clone\n\nClones an existing campaign, returning a new campaign based on the original with a new ID and name.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_campaign_clone.json)\n\n**Parameters:**\n- `fields[campaign]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('campaign-clone', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
555
555
  "tags": [
556
556
  "klaviyo",
557
557
  "openapi",
@@ -564,7 +564,7 @@
564
564
  "platform": "klaviyo",
565
565
  "category": "method",
566
566
  "summary": "Create Catalog Category",
567
- "content": "## POST /api/catalog-categories\n\nCreate a new catalog category.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_catalog_category.json)\n\n**Parameters:**\n- `fields[catalog-category]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/catalog-categories', ...)` to call this endpoint.",
567
+ "content": "## POST /api/catalog-categories\n\nCreate a new catalog category.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_catalog_category.json)\n\n**Parameters:**\n- `fields[catalog-category]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('catalog-categories', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
568
568
  "tags": [
569
569
  "klaviyo",
570
570
  "openapi",
@@ -577,7 +577,7 @@
577
577
  "platform": "klaviyo",
578
578
  "category": "method",
579
579
  "summary": "Create Catalog Item",
580
- "content": "## POST /api/catalog-items\n\nCreate a new catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_catalog_item.json)\n\n**Parameters:**\n- `fields[catalog-item]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/catalog-items', ...)` to call this endpoint.",
580
+ "content": "## POST /api/catalog-items\n\nCreate a new catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_catalog_item.json)\n\n**Parameters:**\n- `fields[catalog-item]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('catalog-items', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
581
581
  "tags": [
582
582
  "klaviyo",
583
583
  "openapi",
@@ -590,7 +590,7 @@
590
590
  "platform": "klaviyo",
591
591
  "category": "method",
592
592
  "summary": "Create Catalog Variant",
593
- "content": "## POST /api/catalog-variants\n\nCreate a new variant for a related catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_catalog_variant.json)\n\n**Parameters:**\n- `fields[catalog-variant]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/catalog-variants', ...)` to call this endpoint.",
593
+ "content": "## POST /api/catalog-variants\n\nCreate a new variant for a related catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_catalog_variant.json)\n\n**Parameters:**\n- `fields[catalog-variant]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('catalog-variants', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
594
594
  "tags": [
595
595
  "klaviyo",
596
596
  "openapi",
@@ -603,7 +603,7 @@
603
603
  "platform": "klaviyo",
604
604
  "category": "method",
605
605
  "summary": "Create Client Back In Stock Subscription",
606
- "content": "## POST /client/back-in-stock-subscriptions\n\nSubscribe a profile to receive back in stock notifications. Check out [our Back in Stock API guide](https://developers.klaviyo.com/en/docs/how_to_set_up_custom_back_in_stock) for more details.\n\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\n\nDo not use this endpoint from server-side applications.\nTo create back in stock subscriptions from server-side applications, instead use [POST /api/back-in-stock-subscriptions](https://developers.klaviyo.com/en/reference/create_back_in_stock_subscription).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:write`\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_client_back_in_stock_subscription.json)\n\n**Parameters:**\n- `company_id` (required) — Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.\n\nUse `klaviyo.post('client/back-in-stock-subscriptions', ...)` to call this endpoint.",
606
+ "content": "## POST /client/back-in-stock-subscriptions\n\nSubscribe a profile to receive back in stock notifications. Check out [our Back in Stock API guide](https://developers.klaviyo.com/en/docs/how_to_set_up_custom_back_in_stock) for more details.\n\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\n\nDo not use this endpoint from server-side applications.\nTo create back in stock subscriptions from server-side applications, instead use [POST /api/back-in-stock-subscriptions](https://developers.klaviyo.com/en/reference/create_back_in_stock_subscription).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:write`\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_client_back_in_stock_subscription.json)\n\n**Parameters:**\n- `company_id` (required) — Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.\n\nUse `klaviyo.post('client/back-in-stock-subscriptions', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
607
607
  "tags": [
608
608
  "klaviyo",
609
609
  "openapi",
@@ -616,7 +616,7 @@
616
616
  "platform": "klaviyo",
617
617
  "category": "method",
618
618
  "summary": "Create Client Event",
619
- "content": "## POST /client/events\n\nCreate a new event to track a profile's activity.\n\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\n\nDo not use this endpoint from server-side applications.\nTo create events from server-side applications, instead use [POST /api/events](https://developers.klaviyo.com/en/reference/create_event).\n\nNote that to update a profile's existing identifiers (e.g., email), you must use a server-side endpoint authenticated by a private API key. Attempts to do so via client-side endpoints will return a 202, however the identifier field(s) will not be updated.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`events:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_client_event.json)\n\n**Parameters:**\n- `company_id` (required) — Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.\n\nUse `klaviyo.post('client/events', ...)` to call this endpoint.",
619
+ "content": "## POST /client/events\n\nCreate a new event to track a profile's activity.\n\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\n\nDo not use this endpoint from server-side applications.\nTo create events from server-side applications, instead use [POST /api/events](https://developers.klaviyo.com/en/reference/create_event).\n\nNote that to update a profile's existing identifiers (e.g., email), you must use a server-side endpoint authenticated by a private API key. Attempts to do so via client-side endpoints will return a 202, however the identifier field(s) will not be updated.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`events:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_client_event.json)\n\n**Parameters:**\n- `company_id` (required) — Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.\n\nUse `klaviyo.post('client/events', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
620
620
  "tags": [
621
621
  "klaviyo",
622
622
  "openapi",
@@ -629,7 +629,7 @@
629
629
  "platform": "klaviyo",
630
630
  "category": "method",
631
631
  "summary": "Create or Update Client Profile",
632
- "content": "## POST /client/profiles\n\nCreate or update properties about a profile without tracking an associated event.\n\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\n\nDo not use this endpoint from server-side applications.\nTo create or update profiles from server-side applications, instead use [POST /api/profile-import](https://developers.klaviyo.com/en/reference/create_or_update_profile).\n\nNote that to update a profile's existing identifiers (e.g., email), you must use a server-side endpoint authenticated by a private API key. Attempts to do so via client-side endpoints will return a 202, however the identifier field(s) will not be updated.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_client_profile.json)\n\n**Parameters:**\n- `company_id` (required) — Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.\n\nUse `klaviyo.post('client/profiles', ...)` to call this endpoint.",
632
+ "content": "## POST /client/profiles\n\nCreate or update properties about a profile without tracking an associated event.\n\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\n\nDo not use this endpoint from server-side applications.\nTo create or update profiles from server-side applications, instead use [POST /api/profile-import](https://developers.klaviyo.com/en/reference/create_or_update_profile).\n\nNote that to update a profile's existing identifiers (e.g., email), you must use a server-side endpoint authenticated by a private API key. Attempts to do so via client-side endpoints will return a 202, however the identifier field(s) will not be updated.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_client_profile.json)\n\n**Parameters:**\n- `company_id` (required) — Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.\n\nUse `klaviyo.post('client/profiles', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
633
633
  "tags": [
634
634
  "klaviyo",
635
635
  "openapi",
@@ -642,7 +642,7 @@
642
642
  "platform": "klaviyo",
643
643
  "category": "method",
644
644
  "summary": "Create or Update Client Push Token",
645
- "content": "## POST /client/push-tokens\n\nCreate or update a push token.\n\nThis endpoint is specifically designed to be called from our mobile SDKs ([iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk)) and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\nYou must have push notifications enabled to use this endpoint.\n\nTo migrate push tokens from another platform to Klaviyo, please use our server-side [POST /api/push-tokens](https://developers.klaviyo.com/en/reference/create_push_token) endpoint instead.<br><br>*Rate limits*:<br>Burst: `150/s`<br>Steady: `1400/m`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_client_push_token.json)\n\n**Parameters:**\n- `company_id` (required) — Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.\n\nUse `klaviyo.post('client/push-tokens', ...)` to call this endpoint.",
645
+ "content": "## POST /client/push-tokens\n\nCreate or update a push token.\n\nThis endpoint is specifically designed to be called from our mobile SDKs ([iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk)) and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\nYou must have push notifications enabled to use this endpoint.\n\nTo migrate push tokens from another platform to Klaviyo, please use our server-side [POST /api/push-tokens](https://developers.klaviyo.com/en/reference/create_push_token) endpoint instead.<br><br>*Rate limits*:<br>Burst: `150/s`<br>Steady: `1400/m`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_client_push_token.json)\n\n**Parameters:**\n- `company_id` (required) — Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.\n\nUse `klaviyo.post('client/push-tokens', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
646
646
  "tags": [
647
647
  "klaviyo",
648
648
  "openapi",
@@ -655,7 +655,7 @@
655
655
  "platform": "klaviyo",
656
656
  "category": "method",
657
657
  "summary": "Create Client Review",
658
- "content": "## POST /client/reviews\n\nCreate a review with the given ID. This endpoint is for client-side environments only.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_client_review.json)\n\n**Parameters:**\n- `company_id` (required) — Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.\n\nUse `klaviyo.post('client/reviews', ...)` to call this endpoint.",
658
+ "content": "## POST /client/reviews\n\nCreate a review with the given ID. This endpoint is for client-side environments only.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_client_review.json)\n\n**Parameters:**\n- `company_id` (required) — Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.\n\nUse `klaviyo.post('client/reviews', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
659
659
  "tags": [
660
660
  "klaviyo",
661
661
  "openapi",
@@ -668,7 +668,7 @@
668
668
  "platform": "klaviyo",
669
669
  "category": "method",
670
670
  "summary": "Create Client Subscription",
671
- "content": "## POST /client/subscriptions\n\nCreates a subscription and consent record for email and/or SMS channels based on the provided `email` and `phone_number` attributes, respectively. One of either `email` or `phone_number` must be provided.\n\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\n\nDo not use this endpoint from server-side applications.\nTo subscribe profiles from server-side applications, instead use [POST /api/profile-subscription-bulk-create-jobs](https://developers.klaviyo.com/en/reference/subscribe_profiles).\n\nProfiles can be opted into multiple channels: email marketing, SMS marketing, and SMS transactional. You can specify the channel(s) to subscribe the profile to by providing a subscriptions object in the profile attributes.\n\nIf you include a subscriptions object, only channels in that object will be subscribed. You can use this to update `email` or `phone` on the profile without subscribing them, for example, by setting the profile property but omitting that channel in the subscriptions object. If a subscriptions object is not provided, subscriptions are defaulted to `MARKETING`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `750/m`\n\n**Scopes:**\n`subscriptions:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_client_subscription.json)\n\n**Parameters:**\n- `company_id` (required) — Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.\n\nUse `klaviyo.post('client/subscriptions', ...)` to call this endpoint.",
671
+ "content": "## POST /client/subscriptions\n\nCreates a subscription and consent record for email and/or SMS channels based on the provided `email` and `phone_number` attributes, respectively. One of either `email` or `phone_number` must be provided.\n\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\n\nDo not use this endpoint from server-side applications.\nTo subscribe profiles from server-side applications, instead use [POST /api/profile-subscription-bulk-create-jobs](https://developers.klaviyo.com/en/reference/subscribe_profiles).\n\nProfiles can be opted into multiple channels: email marketing, SMS marketing, and SMS transactional. You can specify the channel(s) to subscribe the profile to by providing a subscriptions object in the profile attributes.\n\nIf you include a subscriptions object, only channels in that object will be subscribed. You can use this to update `email` or `phone` on the profile without subscribing them, for example, by setting the profile property but omitting that channel in the subscriptions object. If a subscriptions object is not provided, subscriptions are defaulted to `MARKETING`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `750/m`\n\n**Scopes:**\n`subscriptions:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_client_subscription.json)\n\n**Parameters:**\n- `company_id` (required) — Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.\n\nUse `klaviyo.post('client/subscriptions', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
672
672
  "tags": [
673
673
  "klaviyo",
674
674
  "openapi",
@@ -681,7 +681,7 @@
681
681
  "platform": "klaviyo",
682
682
  "category": "method",
683
683
  "summary": "Create Conversation Message",
684
- "content": "## POST /api/conversation-messages\n\nSend an outbound message to a conversation.\n\nRequires OAuth authentication and account-level enablement. To request access, reach out in the [developer community](https://community.klaviyo.com/groups/developer-group-64).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`conversations:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_conversation_message.json)\n\n\n\nUse `klaviyo.post('api/conversation-messages', ...)` to call this endpoint.",
684
+ "content": "## POST /api/conversation-messages\n\nSend an outbound message to a conversation.\n\nRequires OAuth authentication and account-level enablement. To request access, reach out in the [developer community](https://community.klaviyo.com/groups/developer-group-64).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`conversations:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_conversation_message.json)\n\n\n\nUse `klaviyo.post('conversation-messages', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
685
685
  "tags": [
686
686
  "klaviyo",
687
687
  "openapi",
@@ -694,7 +694,7 @@
694
694
  "platform": "klaviyo",
695
695
  "category": "method",
696
696
  "summary": "Create Coupon",
697
- "content": "## POST /api/coupons\n\nCreates a new coupon.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`coupons:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_coupon.json)\n\n**Parameters:**\n- `fields[coupon]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/coupons', ...)` to call this endpoint.",
697
+ "content": "## POST /api/coupons\n\nCreates a new coupon.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`coupons:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_coupon.json)\n\n**Parameters:**\n- `fields[coupon]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('coupons', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
698
698
  "tags": [
699
699
  "klaviyo",
700
700
  "openapi",
@@ -707,7 +707,7 @@
707
707
  "platform": "klaviyo",
708
708
  "category": "method",
709
709
  "summary": "Create Coupon Code",
710
- "content": "## POST /api/coupon-codes\n\nSynchronously creates a coupon code for the given coupon.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`coupon-codes:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_coupon_code.json)\n\n**Parameters:**\n- `fields[coupon-code]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/coupon-codes', ...)` to call this endpoint.",
710
+ "content": "## POST /api/coupon-codes\n\nSynchronously creates a coupon code for the given coupon.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`coupon-codes:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_coupon_code.json)\n\n**Parameters:**\n- `fields[coupon-code]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('coupon-codes', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
711
711
  "tags": [
712
712
  "klaviyo",
713
713
  "openapi",
@@ -720,7 +720,7 @@
720
720
  "platform": "klaviyo",
721
721
  "category": "method",
722
722
  "summary": "Create Custom Metric",
723
- "content": "## POST /api/custom-metrics\n\nCreate a new custom metric.\n\nCustom metric objects must include a `name` and `definition`.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `15/d`\n\n**Scopes:**\n`metrics:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_custom_metric.json)\n\n**Parameters:**\n- `fields[custom-metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/custom-metrics', ...)` to call this endpoint.",
723
+ "content": "## POST /api/custom-metrics\n\nCreate a new custom metric.\n\nCustom metric objects must include a `name` and `definition`.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `15/d`\n\n**Scopes:**\n`metrics:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_custom_metric.json)\n\n**Parameters:**\n- `fields[custom-metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('custom-metrics', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
724
724
  "tags": [
725
725
  "klaviyo",
726
726
  "openapi",
@@ -733,7 +733,7 @@
733
733
  "platform": "klaviyo",
734
734
  "category": "method",
735
735
  "summary": "Create Data Source",
736
- "content": "## POST /api/data-sources\n\nCreate a new data source in an account<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`custom-objects:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_data_source.json)\n\n**Parameters:**\n- `fields[data-source]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/data-sources', ...)` to call this endpoint.",
736
+ "content": "## POST /api/data-sources\n\nCreate a new data source in an account<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`custom-objects:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_data_source.json)\n\n**Parameters:**\n- `fields[data-source]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('data-sources', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
737
737
  "tags": [
738
738
  "klaviyo",
739
739
  "openapi",
@@ -746,7 +746,7 @@
746
746
  "platform": "klaviyo",
747
747
  "category": "method",
748
748
  "summary": "Create Data Source Record",
749
- "content": "## POST /api/data-source-record-create-jobs\n\nCreate a data source record import job to create a single record.\n\nThe maximum allowed payload size per-record is 512KB.\n\nTo learn more, see our [Custom Objects API overview](https://developers.klaviyo.com/en/reference/custom_objects_api_overview).<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`custom-objects:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_data_source_record.json)\n\n\n\nUse `klaviyo.post('api/data-source-record-create-jobs', ...)` to call this endpoint.",
749
+ "content": "## POST /api/data-source-record-create-jobs\n\nCreate a data source record import job to create a single record.\n\nThe maximum allowed payload size per-record is 512KB.\n\nTo learn more, see our [Custom Objects API overview](https://developers.klaviyo.com/en/reference/custom_objects_api_overview).<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`custom-objects:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_data_source_record.json)\n\n\n\nUse `klaviyo.post('data-source-record-create-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
750
750
  "tags": [
751
751
  "klaviyo",
752
752
  "openapi",
@@ -759,7 +759,7 @@
759
759
  "platform": "klaviyo",
760
760
  "category": "method",
761
761
  "summary": "Create Event",
762
- "content": "## POST /api/events\n\nCreate a new event to track a profile's activity.\n\nNote that this endpoint allows you to create a new profile or update an existing profile's properties.\n\nAt a minimum, profile and metric objects should include at least one profile identifier (e.g., `id`, `email`, or `phone_number`) and the metric `name`, respectively.\n\nSuccessful response indicates that the event was validated and submitted for processing, but does not guarantee that processing is complete.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`events:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_event.json)\n\n\n\nUse `klaviyo.post('api/events', ...)` to call this endpoint.",
762
+ "content": "## POST /api/events\n\nCreate a new event to track a profile's activity.\n\nNote that this endpoint allows you to create a new profile or update an existing profile's properties.\n\nAt a minimum, profile and metric objects should include at least one profile identifier (e.g., `id`, `email`, or `phone_number`) and the metric `name`, respectively.\n\nSuccessful response indicates that the event was validated and submitted for processing, but does not guarantee that processing is complete.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`events:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_event.json)\n\n\n\nUse `klaviyo.post('events', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
763
763
  "tags": [
764
764
  "klaviyo",
765
765
  "openapi",
@@ -772,7 +772,7 @@
772
772
  "platform": "klaviyo",
773
773
  "category": "method",
774
774
  "summary": "Create Flow",
775
- "content": "## POST /api/flows\n\nCreate a new flow using an encoded flow definition.\n\nNew objects within the flow definition, such as actions, will need to use a\n`temporary_id` field for identification. These will be replaced with traditional `id` fields\nafter successful creation.\n\nA successful request will return the new definition to you.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d`\n\n**Scopes:**\n`flows:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_flow.json)\n\n**Parameters:**\n- `additional-fields[flow]` — Request additional fields not included by default in the response. Supported values: 'definition'\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/flows', ...)` to call this endpoint.",
775
+ "content": "## POST /api/flows\n\nCreate a new flow using an encoded flow definition.\n\nNew objects within the flow definition, such as actions, will need to use a\n`temporary_id` field for identification. These will be replaced with traditional `id` fields\nafter successful creation.\n\nA successful request will return the new definition to you.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d`\n\n**Scopes:**\n`flows:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_flow.json)\n\n**Parameters:**\n- `additional-fields[flow]` — Request additional fields not included by default in the response. Supported values: 'definition'\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('flows', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
776
776
  "tags": [
777
777
  "klaviyo",
778
778
  "openapi",
@@ -785,7 +785,7 @@
785
785
  "platform": "klaviyo",
786
786
  "category": "method",
787
787
  "summary": "Create Form",
788
- "content": "## POST /api/forms\n\nCreate a new form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`forms:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_form.json)\n\n**Parameters:**\n- `fields[form]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/forms', ...)` to call this endpoint.",
788
+ "content": "## POST /api/forms\n\nCreate a new form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`forms:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_form.json)\n\n**Parameters:**\n- `fields[form]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('forms', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
789
789
  "tags": [
790
790
  "klaviyo",
791
791
  "openapi",
@@ -798,7 +798,7 @@
798
798
  "platform": "klaviyo",
799
799
  "category": "method",
800
800
  "summary": "Create List",
801
- "content": "## POST /api/lists\n\nCreate a new list.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`<br>Daily: `150/d`\n\n**Scopes:**\n`lists:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_list.json)\n\n**Parameters:**\n- `fields[list]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/lists', ...)` to call this endpoint.",
801
+ "content": "## POST /api/lists\n\nCreate a new list.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`<br>Daily: `150/d`\n\n**Scopes:**\n`lists:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_list.json)\n\n**Parameters:**\n- `fields[list]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('lists', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
802
802
  "tags": [
803
803
  "klaviyo",
804
804
  "openapi",
@@ -811,7 +811,7 @@
811
811
  "platform": "klaviyo",
812
812
  "category": "method",
813
813
  "summary": "Create or Update Profile",
814
- "content": "## POST /api/profile-import\n\nGiven a set of profile attributes and optionally an ID, create or update a profile.\n\nReturns 201 if a new profile was created, 200 if an existing profile was updated.\n\nUse the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.\n\nNote that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged.\n\nThe maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_or_update_profile.json)\n\n**Parameters:**\n- `additional-fields[profile]` — Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/profile-import', ...)` to call this endpoint.",
814
+ "content": "## POST /api/profile-import\n\nGiven a set of profile attributes and optionally an ID, create or update a profile.\n\nReturns 201 if a new profile was created, 200 if an existing profile was updated.\n\nUse the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.\n\nNote that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged.\n\nThe maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_or_update_profile.json)\n\n**Parameters:**\n- `additional-fields[profile]` — Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('profile-import', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
815
815
  "tags": [
816
816
  "klaviyo",
817
817
  "openapi",
@@ -824,7 +824,7 @@
824
824
  "platform": "klaviyo",
825
825
  "category": "method",
826
826
  "summary": "Create Profile",
827
- "content": "## POST /api/profiles\n\nCreate a new profile.\n\nUse the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.\n\nThe maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_profile.json)\n\n**Parameters:**\n- `additional-fields[profile]` — Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/profiles', ...)` to call this endpoint.",
827
+ "content": "## POST /api/profiles\n\nCreate a new profile.\n\nUse the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.\n\nThe maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_profile.json)\n\n**Parameters:**\n- `additional-fields[profile]` — Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('profiles', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
828
828
  "tags": [
829
829
  "klaviyo",
830
830
  "openapi",
@@ -837,7 +837,7 @@
837
837
  "platform": "klaviyo",
838
838
  "category": "method",
839
839
  "summary": "Create or Update Push Token",
840
- "content": "## POST /api/push-tokens\n\nCreate or update a push token.\n\nThis endpoint can be used to migrate push tokens from another platform to Klaviyo. Please use our mobile SDKs ([iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk)) to create push tokens from users' devices.\n\nThe maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`profiles:write`\n`push-tokens:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_push_token.json)\n\n\n\nUse `klaviyo.post('api/push-tokens', ...)` to call this endpoint.",
840
+ "content": "## POST /api/push-tokens\n\nCreate or update a push token.\n\nThis endpoint can be used to migrate push tokens from another platform to Klaviyo. Please use our mobile SDKs ([iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk)) to create push tokens from users' devices.\n\nThe maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`profiles:write`\n`push-tokens:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_push_token.json)\n\n\n\nUse `klaviyo.post('push-tokens', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
841
841
  "tags": [
842
842
  "klaviyo",
843
843
  "openapi",
@@ -850,7 +850,7 @@
850
850
  "platform": "klaviyo",
851
851
  "category": "method",
852
852
  "summary": "Create Segment",
853
- "content": "## POST /api/segments\n\nCreate a segment.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d`\n\n**Scopes:**\n`segments:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_segment.json)\n\n**Parameters:**\n- `fields[segment]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/segments', ...)` to call this endpoint.",
853
+ "content": "## POST /api/segments\n\nCreate a segment.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d`\n\n**Scopes:**\n`segments:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_segment.json)\n\n**Parameters:**\n- `fields[segment]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('segments', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
854
854
  "tags": [
855
855
  "klaviyo",
856
856
  "openapi",
@@ -863,7 +863,7 @@
863
863
  "platform": "klaviyo",
864
864
  "category": "method",
865
865
  "summary": "Create Tag",
866
- "content": "## POST /api/tags\n\nCreate a tag. An account cannot have more than **500** unique tags.\n\nA tag belongs to a single tag group. If `relationships.tag-group.data.id` is not specified,\nthe tag is added to the account's default tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_tag.json)\n\n**Parameters:**\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/tags', ...)` to call this endpoint.",
866
+ "content": "## POST /api/tags\n\nCreate a tag. An account cannot have more than **500** unique tags.\n\nA tag belongs to a single tag group. If `relationships.tag-group.data.id` is not specified,\nthe tag is added to the account's default tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_tag.json)\n\n**Parameters:**\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('tags', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
867
867
  "tags": [
868
868
  "klaviyo",
869
869
  "openapi",
@@ -876,7 +876,7 @@
876
876
  "platform": "klaviyo",
877
877
  "category": "method",
878
878
  "summary": "Create Tag Group",
879
- "content": "## POST /api/tag-groups\n\nCreate a tag group. An account cannot have more than **50** unique tag groups.\n\nIf `exclusive` is not specified `true` or `false`, the tag group defaults to non-exclusive.\n\nIf a tag group is non-exclusive, any given related resource (campaign, flow, etc.)\ncan be linked to multiple tags from that tag group.\nIf a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_tag_group.json)\n\n**Parameters:**\n- `fields[tag-group]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/tag-groups', ...)` to call this endpoint.",
879
+ "content": "## POST /api/tag-groups\n\nCreate a tag group. An account cannot have more than **50** unique tag groups.\n\nIf `exclusive` is not specified `true` or `false`, the tag group defaults to non-exclusive.\n\nIf a tag group is non-exclusive, any given related resource (campaign, flow, etc.)\ncan be linked to multiple tags from that tag group.\nIf a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_tag_group.json)\n\n**Parameters:**\n- `fields[tag-group]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('tag-groups', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
880
880
  "tags": [
881
881
  "klaviyo",
882
882
  "openapi",
@@ -889,7 +889,7 @@
889
889
  "platform": "klaviyo",
890
890
  "category": "method",
891
891
  "summary": "Create Template",
892
- "content": "## POST /api/templates\n\nCreate a new HTML or drag-and-drop template.\n\nIf there are 1,000 or more templates in an account, creation will fail as there is a limit of 1,000 templates\nthat can be created via the API.\n\nRequest specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/reference/api_overview#sparse-fieldsets).<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`templates:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_template.json)\n\n**Parameters:**\n- `additional-fields[template]` — Request additional fields not included by default in the response. Supported values: 'definition'\n- `fields[template]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/templates', ...)` to call this endpoint.",
892
+ "content": "## POST /api/templates\n\nCreate a new HTML or drag-and-drop template.\n\nIf there are 1,000 or more templates in an account, creation will fail as there is a limit of 1,000 templates\nthat can be created via the API.\n\nRequest specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/reference/api_overview#sparse-fieldsets).<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`templates:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_template.json)\n\n**Parameters:**\n- `additional-fields[template]` — Request additional fields not included by default in the response. Supported values: 'definition'\n- `fields[template]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('templates', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
893
893
  "tags": [
894
894
  "klaviyo",
895
895
  "openapi",
@@ -902,7 +902,7 @@
902
902
  "platform": "klaviyo",
903
903
  "category": "method",
904
904
  "summary": "Create Universal Content",
905
- "content": "## POST /api/template-universal-content\n\nCreate universal content. Currently supported block types are: `button`, `drop_shadow`, `horizontal_rule`, `html`, `image`, `spacer`, and `text`.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`templates:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_universal_content.json)\n\n**Parameters:**\n- `fields[template-universal-content]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/template-universal-content', ...)` to call this endpoint.",
905
+ "content": "## POST /api/template-universal-content\n\nCreate universal content. Currently supported block types are: `button`, `drop_shadow`, `horizontal_rule`, `html`, `image`, `spacer`, and `text`.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`templates:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_universal_content.json)\n\n**Parameters:**\n- `fields[template-universal-content]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('template-universal-content', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
906
906
  "tags": [
907
907
  "klaviyo",
908
908
  "openapi",
@@ -915,7 +915,7 @@
915
915
  "platform": "klaviyo",
916
916
  "category": "method",
917
917
  "summary": "Create Web Feed",
918
- "content": "## POST /api/web-feeds\n\nCreate a web feed.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`web-feeds:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_web_feed.json)\n\n**Parameters:**\n- `fields[web-feed]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/web-feeds', ...)` to call this endpoint.",
918
+ "content": "## POST /api/web-feeds\n\nCreate a web feed.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`web-feeds:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_web_feed.json)\n\n**Parameters:**\n- `fields[web-feed]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('web-feeds', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
919
919
  "tags": [
920
920
  "klaviyo",
921
921
  "openapi",
@@ -928,7 +928,7 @@
928
928
  "platform": "klaviyo",
929
929
  "category": "method",
930
930
  "summary": "Create Webhook",
931
- "content": "## POST /api/webhooks\n\nCreate a new Webhook<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`webhooks:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_webhook.json)\n\n**Parameters:**\n- `fields[webhook]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/webhooks', ...)` to call this endpoint.",
931
+ "content": "## POST /api/webhooks\n\nCreate a new Webhook<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`webhooks:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_webhook.json)\n\n**Parameters:**\n- `fields[webhook]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('webhooks', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
932
932
  "tags": [
933
933
  "klaviyo",
934
934
  "openapi",
@@ -941,7 +941,7 @@
941
941
  "platform": "klaviyo",
942
942
  "category": "method",
943
943
  "summary": "Delete Campaign",
944
- "content": "## DELETE /api/campaigns/{id}\n\nDelete a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_campaign.json)\n\n**Parameters:**\n- `id` (required) — The campaign ID to be deleted\n\nUse `klaviyo.post('api/campaigns/{id}', ...)` to call this endpoint.",
944
+ "content": "## DELETE /api/campaigns/{id}\n\nDelete a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_campaign.json)\n\n**Parameters:**\n- `id` (required) — The campaign ID to be deleted\n\nUse `klaviyo.post('campaigns/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
945
945
  "tags": [
946
946
  "klaviyo",
947
947
  "openapi",
@@ -954,7 +954,7 @@
954
954
  "platform": "klaviyo",
955
955
  "category": "method",
956
956
  "summary": "Delete Catalog Category",
957
- "content": "## DELETE /api/catalog-categories/{id}\n\nDelete a catalog category using the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_catalog_category.json)\n\n**Parameters:**\n- `id` (required) — The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n\nUse `klaviyo.post('api/catalog-categories/{id}', ...)` to call this endpoint.",
957
+ "content": "## DELETE /api/catalog-categories/{id}\n\nDelete a catalog category using the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_catalog_category.json)\n\n**Parameters:**\n- `id` (required) — The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n\nUse `klaviyo.post('catalog-categories/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
958
958
  "tags": [
959
959
  "klaviyo",
960
960
  "openapi",
@@ -967,7 +967,7 @@
967
967
  "platform": "klaviyo",
968
968
  "category": "method",
969
969
  "summary": "Delete Catalog Item",
970
- "content": "## DELETE /api/catalog-items/{id}\n\nDelete a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_catalog_item.json)\n\n**Parameters:**\n- `id` (required) — The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n\nUse `klaviyo.post('api/catalog-items/{id}', ...)` to call this endpoint.",
970
+ "content": "## DELETE /api/catalog-items/{id}\n\nDelete a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_catalog_item.json)\n\n**Parameters:**\n- `id` (required) — The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n\nUse `klaviyo.post('catalog-items/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
971
971
  "tags": [
972
972
  "klaviyo",
973
973
  "openapi",
@@ -980,7 +980,7 @@
980
980
  "platform": "klaviyo",
981
981
  "category": "method",
982
982
  "summary": "Delete Catalog Variant",
983
- "content": "## DELETE /api/catalog-variants/{id}\n\nDelete a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_catalog_variant.json)\n\n**Parameters:**\n- `id` (required) — The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n\nUse `klaviyo.post('api/catalog-variants/{id}', ...)` to call this endpoint.",
983
+ "content": "## DELETE /api/catalog-variants/{id}\n\nDelete a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_catalog_variant.json)\n\n**Parameters:**\n- `id` (required) — The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n\nUse `klaviyo.post('catalog-variants/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
984
984
  "tags": [
985
985
  "klaviyo",
986
986
  "openapi",
@@ -993,7 +993,7 @@
993
993
  "platform": "klaviyo",
994
994
  "category": "method",
995
995
  "summary": "Delete Coupon",
996
- "content": "## DELETE /api/coupons/{id}\n\nDelete the coupon with the given coupon ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`coupons:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_coupon.json)\n\n**Parameters:**\n- `id` (required) — The internal id of a Coupon is equivalent to its external id stored within an integration.\n\nUse `klaviyo.post('api/coupons/{id}', ...)` to call this endpoint.",
996
+ "content": "## DELETE /api/coupons/{id}\n\nDelete the coupon with the given coupon ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`coupons:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_coupon.json)\n\n**Parameters:**\n- `id` (required) — The internal id of a Coupon is equivalent to its external id stored within an integration.\n\nUse `klaviyo.post('coupons/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
997
997
  "tags": [
998
998
  "klaviyo",
999
999
  "openapi",
@@ -1006,7 +1006,7 @@
1006
1006
  "platform": "klaviyo",
1007
1007
  "category": "method",
1008
1008
  "summary": "Delete Coupon Code",
1009
- "content": "## DELETE /api/coupon-codes/{id}\n\nDeletes a coupon code specified by the given identifier synchronously. If a profile has been assigned to the\ncoupon code, an exception will be raised<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`coupon-codes:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_coupon_code.json)\n\n**Parameters:**\n- `id` (required) — The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.\n\nUse `klaviyo.post('api/coupon-codes/{id}', ...)` to call this endpoint.",
1009
+ "content": "## DELETE /api/coupon-codes/{id}\n\nDeletes a coupon code specified by the given identifier synchronously. If a profile has been assigned to the\ncoupon code, an exception will be raised<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`coupon-codes:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_coupon_code.json)\n\n**Parameters:**\n- `id` (required) — The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.\n\nUse `klaviyo.post('coupon-codes/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1010
1010
  "tags": [
1011
1011
  "klaviyo",
1012
1012
  "openapi",
@@ -1019,7 +1019,7 @@
1019
1019
  "platform": "klaviyo",
1020
1020
  "category": "method",
1021
1021
  "summary": "Delete Custom Metric",
1022
- "content": "## DELETE /api/custom-metrics/{id}\n\nDelete a custom metric with the given custom metric ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`metrics:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_custom_metric.json)\n\n**Parameters:**\n- `id` (required) — The ID of the custom metric\n\nUse `klaviyo.post('api/custom-metrics/{id}', ...)` to call this endpoint.",
1022
+ "content": "## DELETE /api/custom-metrics/{id}\n\nDelete a custom metric with the given custom metric ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`metrics:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_custom_metric.json)\n\n**Parameters:**\n- `id` (required) — The ID of the custom metric\n\nUse `klaviyo.post('custom-metrics/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1023
1023
  "tags": [
1024
1024
  "klaviyo",
1025
1025
  "openapi",
@@ -1032,7 +1032,7 @@
1032
1032
  "platform": "klaviyo",
1033
1033
  "category": "method",
1034
1034
  "summary": "Delete Data Source",
1035
- "content": "## DELETE /api/data-sources/{id}\n\nDelete a data source in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`custom-objects:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_data_source.json)\n\n**Parameters:**\n- `id` (required) — The ID of the data source to delete\n\nUse `klaviyo.post('api/data-sources/{id}', ...)` to call this endpoint.",
1035
+ "content": "## DELETE /api/data-sources/{id}\n\nDelete a data source in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`custom-objects:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_data_source.json)\n\n**Parameters:**\n- `id` (required) — The ID of the data source to delete\n\nUse `klaviyo.post('data-sources/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1036
1036
  "tags": [
1037
1037
  "klaviyo",
1038
1038
  "openapi",
@@ -1045,7 +1045,7 @@
1045
1045
  "platform": "klaviyo",
1046
1046
  "category": "method",
1047
1047
  "summary": "Delete Flow",
1048
- "content": "## DELETE /api/flows/{id}\n\nDelete a flow with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_flow.json)\n\n**Parameters:**\n- `id` (required) — ID of the Flow to delete. Ex: XVTP5Q\n\nUse `klaviyo.post('api/flows/{id}', ...)` to call this endpoint.",
1048
+ "content": "## DELETE /api/flows/{id}\n\nDelete a flow with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_flow.json)\n\n**Parameters:**\n- `id` (required) — ID of the Flow to delete. Ex: XVTP5Q\n\nUse `klaviyo.post('flows/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1049
1049
  "tags": [
1050
1050
  "klaviyo",
1051
1051
  "openapi",
@@ -1058,7 +1058,7 @@
1058
1058
  "platform": "klaviyo",
1059
1059
  "category": "method",
1060
1060
  "summary": "Delete Form",
1061
- "content": "## DELETE /api/forms/{id}\n\nDelete a given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`forms:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_form.json)\n\n**Parameters:**\n- `id` (required) — The ID of the form\n\nUse `klaviyo.post('api/forms/{id}', ...)` to call this endpoint.",
1061
+ "content": "## DELETE /api/forms/{id}\n\nDelete a given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`forms:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_form.json)\n\n**Parameters:**\n- `id` (required) — The ID of the form\n\nUse `klaviyo.post('forms/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1062
1062
  "tags": [
1063
1063
  "klaviyo",
1064
1064
  "openapi",
@@ -1071,7 +1071,7 @@
1071
1071
  "platform": "klaviyo",
1072
1072
  "category": "method",
1073
1073
  "summary": "Delete List",
1074
- "content": "## DELETE /api/lists/{id}\n\nDelete a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_list.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this list. Generated by Klaviyo.\n\nUse `klaviyo.post('api/lists/{id}', ...)` to call this endpoint.",
1074
+ "content": "## DELETE /api/lists/{id}\n\nDelete a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_list.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this list. Generated by Klaviyo.\n\nUse `klaviyo.post('lists/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1075
1075
  "tags": [
1076
1076
  "klaviyo",
1077
1077
  "openapi",
@@ -1084,7 +1084,7 @@
1084
1084
  "platform": "klaviyo",
1085
1085
  "category": "method",
1086
1086
  "summary": "Delete Push Token",
1087
- "content": "## DELETE /api/push-tokens/{id}\n\nDelete a specific push token based on its ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`push-tokens:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_push_token.json)\n\n**Parameters:**\n- `id` (required) — The value of the push token to delete\n\nUse `klaviyo.post('api/push-tokens/{id}', ...)` to call this endpoint.",
1087
+ "content": "## DELETE /api/push-tokens/{id}\n\nDelete a specific push token based on its ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`push-tokens:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_push_token.json)\n\n**Parameters:**\n- `id` (required) — The value of the push token to delete\n\nUse `klaviyo.post('push-tokens/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1088
1088
  "tags": [
1089
1089
  "klaviyo",
1090
1090
  "openapi",
@@ -1097,7 +1097,7 @@
1097
1097
  "platform": "klaviyo",
1098
1098
  "category": "method",
1099
1099
  "summary": "Delete Segment",
1100
- "content": "## DELETE /api/segments/{id}\n\nDelete a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`segments:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_segment.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.post('api/segments/{id}', ...)` to call this endpoint.",
1100
+ "content": "## DELETE /api/segments/{id}\n\nDelete a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`segments:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_segment.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.post('segments/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1101
1101
  "tags": [
1102
1102
  "klaviyo",
1103
1103
  "openapi",
@@ -1110,7 +1110,7 @@
1110
1110
  "platform": "klaviyo",
1111
1111
  "category": "method",
1112
1112
  "summary": "Delete Tag",
1113
- "content": "## DELETE /api/tags/{id}\n\nDelete the tag with the given tag ID. Any associations between the tag and other resources will also be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_tag.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.post('api/tags/{id}', ...)` to call this endpoint.",
1113
+ "content": "## DELETE /api/tags/{id}\n\nDelete the tag with the given tag ID. Any associations between the tag and other resources will also be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_tag.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.post('tags/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1114
1114
  "tags": [
1115
1115
  "klaviyo",
1116
1116
  "openapi",
@@ -1123,7 +1123,7 @@
1123
1123
  "platform": "klaviyo",
1124
1124
  "category": "method",
1125
1125
  "summary": "Delete Tag Group",
1126
- "content": "## DELETE /api/tag-groups/{id}\n\nDelete the tag group with the given tag group ID.\n\nAny tags inside that tag group, and any associations between those tags and other resources, will also be removed. The default tag group cannot be deleted.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_tag_group.json)\n\n**Parameters:**\n- `id` (required) — The Tag Group ID\n\nUse `klaviyo.post('api/tag-groups/{id}', ...)` to call this endpoint.",
1126
+ "content": "## DELETE /api/tag-groups/{id}\n\nDelete the tag group with the given tag group ID.\n\nAny tags inside that tag group, and any associations between those tags and other resources, will also be removed. The default tag group cannot be deleted.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_tag_group.json)\n\n**Parameters:**\n- `id` (required) — The Tag Group ID\n\nUse `klaviyo.post('tag-groups/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1127
1127
  "tags": [
1128
1128
  "klaviyo",
1129
1129
  "openapi",
@@ -1136,7 +1136,7 @@
1136
1136
  "platform": "klaviyo",
1137
1137
  "category": "method",
1138
1138
  "summary": "Delete Template",
1139
- "content": "## DELETE /api/templates/{id}\n\nDelete a template with the given template ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`templates:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_template.json)\n\n**Parameters:**\n- `id` (required) — The ID of template\n\nUse `klaviyo.post('api/templates/{id}', ...)` to call this endpoint.",
1139
+ "content": "## DELETE /api/templates/{id}\n\nDelete a template with the given template ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`templates:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_template.json)\n\n**Parameters:**\n- `id` (required) — The ID of template\n\nUse `klaviyo.post('templates/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1140
1140
  "tags": [
1141
1141
  "klaviyo",
1142
1142
  "openapi",
@@ -1149,7 +1149,7 @@
1149
1149
  "platform": "klaviyo",
1150
1150
  "category": "method",
1151
1151
  "summary": "Delete Universal Content",
1152
- "content": "## DELETE /api/template-universal-content/{id}\n\nDelete the universal content with the given ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`templates:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_universal_content.json)\n\n**Parameters:**\n- `id` (required) — The ID of the template universal content\n\nUse `klaviyo.post('api/template-universal-content/{id}', ...)` to call this endpoint.",
1152
+ "content": "## DELETE /api/template-universal-content/{id}\n\nDelete the universal content with the given ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`templates:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_universal_content.json)\n\n**Parameters:**\n- `id` (required) — The ID of the template universal content\n\nUse `klaviyo.post('template-universal-content/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1153
1153
  "tags": [
1154
1154
  "klaviyo",
1155
1155
  "openapi",
@@ -1162,7 +1162,7 @@
1162
1162
  "platform": "klaviyo",
1163
1163
  "category": "method",
1164
1164
  "summary": "Delete Web Feed",
1165
- "content": "## DELETE /api/web-feeds/{id}\n\nDelete the web feed with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`web-feeds:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_web_feed.json)\n\n**Parameters:**\n- `id` (required) — The ID of the web feed\n\nUse `klaviyo.post('api/web-feeds/{id}', ...)` to call this endpoint.",
1165
+ "content": "## DELETE /api/web-feeds/{id}\n\nDelete the web feed with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`web-feeds:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_web_feed.json)\n\n**Parameters:**\n- `id` (required) — The ID of the web feed\n\nUse `klaviyo.post('web-feeds/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1166
1166
  "tags": [
1167
1167
  "klaviyo",
1168
1168
  "openapi",
@@ -1175,7 +1175,7 @@
1175
1175
  "platform": "klaviyo",
1176
1176
  "category": "method",
1177
1177
  "summary": "Delete Webhook",
1178
- "content": "## DELETE /api/webhooks/{id}\n\nDelete a webhook with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`webhooks:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_webhook.json)\n\n**Parameters:**\n- `id` (required) — The ID of the webhook.\n\nUse `klaviyo.post('api/webhooks/{id}', ...)` to call this endpoint.",
1178
+ "content": "## DELETE /api/webhooks/{id}\n\nDelete a webhook with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`webhooks:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_webhook.json)\n\n**Parameters:**\n- `id` (required) — The ID of the webhook.\n\nUse `klaviyo.post('webhooks/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1179
1179
  "tags": [
1180
1180
  "klaviyo",
1181
1181
  "openapi",
@@ -1188,7 +1188,7 @@
1188
1188
  "platform": "klaviyo",
1189
1189
  "category": "method",
1190
1190
  "summary": "Get Account",
1191
- "content": "## GET /api/accounts/{id}\n\nRetrieve a single account object by its account ID. You can only request the account by which the private API key was generated.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`accounts:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_account.json)\n\n**Parameters:**\n- `id` (required) — The ID of the account\n- `fields[account]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/accounts/{id}', ...)` to call this endpoint.",
1191
+ "content": "## GET /api/accounts/{id}\n\nRetrieve a single account object by its account ID. You can only request the account by which the private API key was generated.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`accounts:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_account.json)\n\n**Parameters:**\n- `id` (required) — The ID of the account\n- `fields[account]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('accounts/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1192
1192
  "tags": [
1193
1193
  "klaviyo",
1194
1194
  "openapi",
@@ -1201,7 +1201,7 @@
1201
1201
  "platform": "klaviyo",
1202
1202
  "category": "method",
1203
1203
  "summary": "Get Accounts",
1204
- "content": "## GET /api/accounts\n\nRetrieve the account(s) associated with a given private API key. This will return 1 account object within the array.\n\nYou can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`accounts:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_accounts.json)\n\n**Parameters:**\n- `fields[account]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/accounts', ...)` to call this endpoint.",
1204
+ "content": "## GET /api/accounts\n\nRetrieve the account(s) associated with a given private API key. This will return 1 account object within the array.\n\nYou can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`accounts:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_accounts.json)\n\n**Parameters:**\n- `fields[account]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('accounts', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1205
1205
  "tags": [
1206
1206
  "klaviyo",
1207
1207
  "openapi",
@@ -1214,7 +1214,7 @@
1214
1214
  "platform": "klaviyo",
1215
1215
  "category": "method",
1216
1216
  "summary": "Get Action for Flow Message",
1217
- "content": "## GET /api/flow-messages/{id}/flow-action\n\nGet the flow action for a flow message with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_action_for_flow_message.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[flow-action]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/flow-messages/{id}/flow-action', ...)` to call this endpoint.",
1217
+ "content": "## GET /api/flow-messages/{id}/flow-action\n\nGet the flow action for a flow message with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_action_for_flow_message.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[flow-action]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('flow-messages/{id}/flow-action', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1218
1218
  "tags": [
1219
1219
  "klaviyo",
1220
1220
  "openapi",
@@ -1227,7 +1227,7 @@
1227
1227
  "platform": "klaviyo",
1228
1228
  "category": "method",
1229
1229
  "summary": "Get Action ID for Flow Message",
1230
- "content": "## GET /api/flow-messages/{id}/relationships/flow-action\n\nGet the [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a flow message's flow action, given the flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_action_id_for_flow_message.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('api/flow-messages/{id}/relationships/flow-action', ...)` to call this endpoint.",
1230
+ "content": "## GET /api/flow-messages/{id}/relationships/flow-action\n\nGet the [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a flow message's flow action, given the flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_action_id_for_flow_message.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('flow-messages/{id}/relationships/flow-action', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1231
1231
  "tags": [
1232
1232
  "klaviyo",
1233
1233
  "openapi",
@@ -1240,7 +1240,7 @@
1240
1240
  "platform": "klaviyo",
1241
1241
  "category": "method",
1242
1242
  "summary": "Get Action IDs for Flow",
1243
- "content": "## GET /api/flows/{id}/relationships/flow-actions\n\nGet all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow actions associated with the given flow ID.\n\nReturns a maximum of 100 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_action_ids_for_flow.json)\n\n**Parameters:**\n- `id` (required)\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 50. Min: 1. Max: 50.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/flows/{id}/relationships/flow-actions', ...)` to call this endpoint.",
1243
+ "content": "## GET /api/flows/{id}/relationships/flow-actions\n\nGet all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow actions associated with the given flow ID.\n\nReturns a maximum of 100 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_action_ids_for_flow.json)\n\n**Parameters:**\n- `id` (required)\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 50. Min: 1. Max: 50.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('flows/{id}/relationships/flow-actions', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1244
1244
  "tags": [
1245
1245
  "klaviyo",
1246
1246
  "openapi",
@@ -1253,7 +1253,7 @@
1253
1253
  "platform": "klaviyo",
1254
1254
  "category": "method",
1255
1255
  "summary": "Get Actions for Flow",
1256
- "content": "## GET /api/flows/{id}/flow-actions\n\nGet all flow actions associated with the given flow ID.\n\nReturns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_actions_for_flow.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[flow-action]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 50. Min: 1. Max: 50.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/flows/{id}/flow-actions', ...)` to call this endpoint.",
1256
+ "content": "## GET /api/flows/{id}/flow-actions\n\nGet all flow actions associated with the given flow ID.\n\nReturns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_actions_for_flow.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[flow-action]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 50. Min: 1. Max: 50.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('flows/{id}/flow-actions', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1257
1257
  "tags": [
1258
1258
  "klaviyo",
1259
1259
  "openapi",
@@ -1266,7 +1266,7 @@
1266
1266
  "platform": "klaviyo",
1267
1267
  "category": "method",
1268
1268
  "summary": "Get All Universal Content",
1269
- "content": "## GET /api/template-universal-content\n\nGet all universal content in an account.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_all_universal_content.json)\n\n**Parameters:**\n- `fields[template-universal-content]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `equals`<br>`created`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`definition.content_type`: `equals`<br>`definition.type`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/template-universal-content', ...)` to call this endpoint.",
1269
+ "content": "## GET /api/template-universal-content\n\nGet all universal content in an account.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_all_universal_content.json)\n\n**Parameters:**\n- `fields[template-universal-content]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `equals`<br>`created`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`definition.content_type`: `equals`<br>`definition.type`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('template-universal-content', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1270
1270
  "tags": [
1271
1271
  "klaviyo",
1272
1272
  "openapi",
@@ -1279,7 +1279,7 @@
1279
1279
  "platform": "klaviyo",
1280
1280
  "category": "method",
1281
1281
  "summary": "Get Bulk Create Catalog Items Job",
1282
- "content": "## GET /api/catalog-item-bulk-create-jobs/{job_id}\n\nGet a catalog item bulk create job with the given job ID.\n\nAn `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_catalog_items_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[catalog-item-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[catalog-item]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/catalog-item-bulk-create-jobs/{job_id}', ...)` to call this endpoint.",
1282
+ "content": "## GET /api/catalog-item-bulk-create-jobs/{job_id}\n\nGet a catalog item bulk create job with the given job ID.\n\nAn `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_catalog_items_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[catalog-item-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[catalog-item]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('catalog-item-bulk-create-jobs/{job_id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1283
1283
  "tags": [
1284
1284
  "klaviyo",
1285
1285
  "openapi",
@@ -1292,7 +1292,7 @@
1292
1292
  "platform": "klaviyo",
1293
1293
  "category": "method",
1294
1294
  "summary": "Get Bulk Create Catalog Items Jobs",
1295
- "content": "## GET /api/catalog-item-bulk-create-jobs\n\nGet all catalog item bulk create jobs.\n\nReturns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_catalog_items_jobs.json)\n\n**Parameters:**\n- `fields[catalog-item-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.get('api/catalog-item-bulk-create-jobs', ...)` to call this endpoint.",
1295
+ "content": "## GET /api/catalog-item-bulk-create-jobs\n\nGet all catalog item bulk create jobs.\n\nReturns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_catalog_items_jobs.json)\n\n**Parameters:**\n- `fields[catalog-item-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.get('catalog-item-bulk-create-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1296
1296
  "tags": [
1297
1297
  "klaviyo",
1298
1298
  "openapi",
@@ -1305,7 +1305,7 @@
1305
1305
  "platform": "klaviyo",
1306
1306
  "category": "method",
1307
1307
  "summary": "Get Bulk Create Categories Job",
1308
- "content": "## GET /api/catalog-category-bulk-create-jobs/{job_id}\n\nGet a catalog category bulk create job with the given job ID.\n\nAn `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_categories_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[catalog-category-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[catalog-category]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/catalog-category-bulk-create-jobs/{job_id}', ...)` to call this endpoint.",
1308
+ "content": "## GET /api/catalog-category-bulk-create-jobs/{job_id}\n\nGet a catalog category bulk create job with the given job ID.\n\nAn `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_categories_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[catalog-category-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[catalog-category]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('catalog-category-bulk-create-jobs/{job_id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1309
1309
  "tags": [
1310
1310
  "klaviyo",
1311
1311
  "openapi",
@@ -1318,7 +1318,7 @@
1318
1318
  "platform": "klaviyo",
1319
1319
  "category": "method",
1320
1320
  "summary": "Get Bulk Create Categories Jobs",
1321
- "content": "## GET /api/catalog-category-bulk-create-jobs\n\nGet all catalog category bulk create jobs.\n\nReturns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_categories_jobs.json)\n\n**Parameters:**\n- `fields[catalog-category-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.get('api/catalog-category-bulk-create-jobs', ...)` to call this endpoint.",
1321
+ "content": "## GET /api/catalog-category-bulk-create-jobs\n\nGet all catalog category bulk create jobs.\n\nReturns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_categories_jobs.json)\n\n**Parameters:**\n- `fields[catalog-category-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.get('catalog-category-bulk-create-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1322
1322
  "tags": [
1323
1323
  "klaviyo",
1324
1324
  "openapi",
@@ -1331,7 +1331,7 @@
1331
1331
  "platform": "klaviyo",
1332
1332
  "category": "method",
1333
1333
  "summary": "Get Bulk Create Coupon Code Jobs",
1334
- "content": "## GET /api/coupon-code-bulk-create-jobs\n\nGet all coupon code bulk create jobs.\n\nReturns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`coupon-codes:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_coupon_code_jobs.json)\n\n**Parameters:**\n- `fields[coupon-code-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.get('api/coupon-code-bulk-create-jobs', ...)` to call this endpoint.",
1334
+ "content": "## GET /api/coupon-code-bulk-create-jobs\n\nGet all coupon code bulk create jobs.\n\nReturns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`coupon-codes:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_coupon_code_jobs.json)\n\n**Parameters:**\n- `fields[coupon-code-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.get('coupon-code-bulk-create-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1335
1335
  "tags": [
1336
1336
  "klaviyo",
1337
1337
  "openapi",
@@ -1344,7 +1344,7 @@
1344
1344
  "platform": "klaviyo",
1345
1345
  "category": "method",
1346
1346
  "summary": "Get Bulk Create Coupon Codes Job",
1347
- "content": "## GET /api/coupon-code-bulk-create-jobs/{job_id}\n\nGet a coupon code bulk create job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`coupon-codes:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_coupon_codes_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[coupon-code-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[coupon-code]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/coupon-code-bulk-create-jobs/{job_id}', ...)` to call this endpoint.",
1347
+ "content": "## GET /api/coupon-code-bulk-create-jobs/{job_id}\n\nGet a coupon code bulk create job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`coupon-codes:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_coupon_codes_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[coupon-code-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[coupon-code]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('coupon-code-bulk-create-jobs/{job_id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1348
1348
  "tags": [
1349
1349
  "klaviyo",
1350
1350
  "openapi",
@@ -1357,7 +1357,7 @@
1357
1357
  "platform": "klaviyo",
1358
1358
  "category": "method",
1359
1359
  "summary": "Get Bulk Create Variants Job",
1360
- "content": "## GET /api/catalog-variant-bulk-create-jobs/{job_id}\n\nGet a catalog variant bulk create job with the given job ID.\n\nAn `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_variants_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[catalog-variant-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[catalog-variant]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/catalog-variant-bulk-create-jobs/{job_id}', ...)` to call this endpoint.",
1360
+ "content": "## GET /api/catalog-variant-bulk-create-jobs/{job_id}\n\nGet a catalog variant bulk create job with the given job ID.\n\nAn `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_variants_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[catalog-variant-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[catalog-variant]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('catalog-variant-bulk-create-jobs/{job_id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1361
1361
  "tags": [
1362
1362
  "klaviyo",
1363
1363
  "openapi",
@@ -1370,7 +1370,7 @@
1370
1370
  "platform": "klaviyo",
1371
1371
  "category": "method",
1372
1372
  "summary": "Get Bulk Create Variants Jobs",
1373
- "content": "## GET /api/catalog-variant-bulk-create-jobs\n\nGet all catalog variant bulk create jobs.\n\nReturns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_variants_jobs.json)\n\n**Parameters:**\n- `fields[catalog-variant-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.get('api/catalog-variant-bulk-create-jobs', ...)` to call this endpoint.",
1373
+ "content": "## GET /api/catalog-variant-bulk-create-jobs\n\nGet all catalog variant bulk create jobs.\n\nReturns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_variants_jobs.json)\n\n**Parameters:**\n- `fields[catalog-variant-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.get('catalog-variant-bulk-create-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1374
1374
  "tags": [
1375
1375
  "klaviyo",
1376
1376
  "openapi",
@@ -1383,7 +1383,7 @@
1383
1383
  "platform": "klaviyo",
1384
1384
  "category": "method",
1385
1385
  "summary": "Get Bulk Delete Catalog Items Job",
1386
- "content": "## GET /api/catalog-item-bulk-delete-jobs/{job_id}\n\nGet a catalog item bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_catalog_items_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[catalog-item-bulk-delete-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/catalog-item-bulk-delete-jobs/{job_id}', ...)` to call this endpoint.",
1386
+ "content": "## GET /api/catalog-item-bulk-delete-jobs/{job_id}\n\nGet a catalog item bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_catalog_items_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[catalog-item-bulk-delete-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('catalog-item-bulk-delete-jobs/{job_id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1387
1387
  "tags": [
1388
1388
  "klaviyo",
1389
1389
  "openapi",
@@ -1396,7 +1396,7 @@
1396
1396
  "platform": "klaviyo",
1397
1397
  "category": "method",
1398
1398
  "summary": "Get Bulk Delete Catalog Items Jobs",
1399
- "content": "## GET /api/catalog-item-bulk-delete-jobs\n\nGet all catalog item bulk delete jobs.\n\nReturns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_catalog_items_jobs.json)\n\n**Parameters:**\n- `fields[catalog-item-bulk-delete-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.get('api/catalog-item-bulk-delete-jobs', ...)` to call this endpoint.",
1399
+ "content": "## GET /api/catalog-item-bulk-delete-jobs\n\nGet all catalog item bulk delete jobs.\n\nReturns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_catalog_items_jobs.json)\n\n**Parameters:**\n- `fields[catalog-item-bulk-delete-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.get('catalog-item-bulk-delete-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1400
1400
  "tags": [
1401
1401
  "klaviyo",
1402
1402
  "openapi",
@@ -1409,7 +1409,7 @@
1409
1409
  "platform": "klaviyo",
1410
1410
  "category": "method",
1411
1411
  "summary": "Get Bulk Delete Categories Job",
1412
- "content": "## GET /api/catalog-category-bulk-delete-jobs/{job_id}\n\nGet a catalog category bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_categories_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[catalog-category-bulk-delete-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/catalog-category-bulk-delete-jobs/{job_id}', ...)` to call this endpoint.",
1412
+ "content": "## GET /api/catalog-category-bulk-delete-jobs/{job_id}\n\nGet a catalog category bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_categories_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[catalog-category-bulk-delete-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('catalog-category-bulk-delete-jobs/{job_id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1413
1413
  "tags": [
1414
1414
  "klaviyo",
1415
1415
  "openapi",
@@ -1422,7 +1422,7 @@
1422
1422
  "platform": "klaviyo",
1423
1423
  "category": "method",
1424
1424
  "summary": "Get Bulk Delete Categories Jobs",
1425
- "content": "## GET /api/catalog-category-bulk-delete-jobs\n\nGet all catalog category bulk delete jobs.\n\nReturns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_categories_jobs.json)\n\n**Parameters:**\n- `fields[catalog-category-bulk-delete-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.get('api/catalog-category-bulk-delete-jobs', ...)` to call this endpoint.",
1425
+ "content": "## GET /api/catalog-category-bulk-delete-jobs\n\nGet all catalog category bulk delete jobs.\n\nReturns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_categories_jobs.json)\n\n**Parameters:**\n- `fields[catalog-category-bulk-delete-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.get('catalog-category-bulk-delete-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1426
1426
  "tags": [
1427
1427
  "klaviyo",
1428
1428
  "openapi",
@@ -1435,7 +1435,7 @@
1435
1435
  "platform": "klaviyo",
1436
1436
  "category": "method",
1437
1437
  "summary": "Get Bulk Delete Variants Job",
1438
- "content": "## GET /api/catalog-variant-bulk-delete-jobs/{job_id}\n\nGet a catalog variant bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_variants_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[catalog-variant-bulk-delete-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/catalog-variant-bulk-delete-jobs/{job_id}', ...)` to call this endpoint.",
1438
+ "content": "## GET /api/catalog-variant-bulk-delete-jobs/{job_id}\n\nGet a catalog variant bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_variants_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[catalog-variant-bulk-delete-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('catalog-variant-bulk-delete-jobs/{job_id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1439
1439
  "tags": [
1440
1440
  "klaviyo",
1441
1441
  "openapi",
@@ -1448,7 +1448,7 @@
1448
1448
  "platform": "klaviyo",
1449
1449
  "category": "method",
1450
1450
  "summary": "Get Bulk Delete Variants Jobs",
1451
- "content": "## GET /api/catalog-variant-bulk-delete-jobs\n\nGet all catalog variant bulk delete jobs.\n\nReturns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_variants_jobs.json)\n\n**Parameters:**\n- `fields[catalog-variant-bulk-delete-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.get('api/catalog-variant-bulk-delete-jobs', ...)` to call this endpoint.",
1451
+ "content": "## GET /api/catalog-variant-bulk-delete-jobs\n\nGet all catalog variant bulk delete jobs.\n\nReturns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_variants_jobs.json)\n\n**Parameters:**\n- `fields[catalog-variant-bulk-delete-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.get('catalog-variant-bulk-delete-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1452
1452
  "tags": [
1453
1453
  "klaviyo",
1454
1454
  "openapi",
@@ -1461,7 +1461,7 @@
1461
1461
  "platform": "klaviyo",
1462
1462
  "category": "method",
1463
1463
  "summary": "Get Bulk Import Profiles Job",
1464
- "content": "## GET /api/profile-bulk-import-jobs/{job_id}\n\nGet a bulk profile import job with the given job ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_import_profiles_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[list]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[profile-bulk-import-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/profile-bulk-import-jobs/{job_id}', ...)` to call this endpoint.",
1464
+ "content": "## GET /api/profile-bulk-import-jobs/{job_id}\n\nGet a bulk profile import job with the given job ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_import_profiles_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[list]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[profile-bulk-import-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('profile-bulk-import-jobs/{job_id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1465
1465
  "tags": [
1466
1466
  "klaviyo",
1467
1467
  "openapi",
@@ -1474,7 +1474,7 @@
1474
1474
  "platform": "klaviyo",
1475
1475
  "category": "method",
1476
1476
  "summary": "Get Bulk Import Profiles Jobs",
1477
- "content": "## GET /api/profile-bulk-import-jobs\n\nGet all bulk profile import jobs.\n\nReturns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_import_profiles_jobs.json)\n\n**Parameters:**\n- `fields[profile-bulk-import-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/profile-bulk-import-jobs', ...)` to call this endpoint.",
1477
+ "content": "## GET /api/profile-bulk-import-jobs\n\nGet all bulk profile import jobs.\n\nReturns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_import_profiles_jobs.json)\n\n**Parameters:**\n- `fields[profile-bulk-import-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('profile-bulk-import-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1478
1478
  "tags": [
1479
1479
  "klaviyo",
1480
1480
  "openapi",
@@ -1487,7 +1487,7 @@
1487
1487
  "platform": "klaviyo",
1488
1488
  "category": "method",
1489
1489
  "summary": "Get Bulk Suppress Profiles Job",
1490
- "content": "## GET /api/profile-suppression-bulk-create-jobs/{job_id}\n\nGet the bulk suppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`subscriptions:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_suppress_profiles_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[profile-suppression-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/profile-suppression-bulk-create-jobs/{job_id}', ...)` to call this endpoint.",
1490
+ "content": "## GET /api/profile-suppression-bulk-create-jobs/{job_id}\n\nGet the bulk suppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`subscriptions:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_suppress_profiles_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[profile-suppression-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('profile-suppression-bulk-create-jobs/{job_id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1491
1491
  "tags": [
1492
1492
  "klaviyo",
1493
1493
  "openapi",
@@ -1500,7 +1500,7 @@
1500
1500
  "platform": "klaviyo",
1501
1501
  "category": "method",
1502
1502
  "summary": "Get Bulk Suppress Profiles Jobs",
1503
- "content": "## GET /api/profile-suppression-bulk-create-jobs\n\nGet the status of all bulk profile suppression jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`subscriptions:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_suppress_profiles_jobs.json)\n\n**Parameters:**\n- `fields[profile-suppression-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`list_id`: `equals`<br>`segment_id`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/profile-suppression-bulk-create-jobs', ...)` to call this endpoint.",
1503
+ "content": "## GET /api/profile-suppression-bulk-create-jobs\n\nGet the status of all bulk profile suppression jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`subscriptions:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_suppress_profiles_jobs.json)\n\n**Parameters:**\n- `fields[profile-suppression-bulk-create-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`list_id`: `equals`<br>`segment_id`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('profile-suppression-bulk-create-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1504
1504
  "tags": [
1505
1505
  "klaviyo",
1506
1506
  "openapi",
@@ -1513,7 +1513,7 @@
1513
1513
  "platform": "klaviyo",
1514
1514
  "category": "method",
1515
1515
  "summary": "Get Bulk Unsuppress Profiles Job",
1516
- "content": "## GET /api/profile-suppression-bulk-delete-jobs/{job_id}\n\nGet the bulk unsuppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`subscriptions:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_unsuppress_profiles_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[profile-suppression-bulk-delete-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/profile-suppression-bulk-delete-jobs/{job_id}', ...)` to call this endpoint.",
1516
+ "content": "## GET /api/profile-suppression-bulk-delete-jobs/{job_id}\n\nGet the bulk unsuppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`subscriptions:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_unsuppress_profiles_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[profile-suppression-bulk-delete-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('profile-suppression-bulk-delete-jobs/{job_id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1517
1517
  "tags": [
1518
1518
  "klaviyo",
1519
1519
  "openapi",
@@ -1526,7 +1526,7 @@
1526
1526
  "platform": "klaviyo",
1527
1527
  "category": "method",
1528
1528
  "summary": "Get Bulk Unsuppress Profiles Jobs",
1529
- "content": "## GET /api/profile-suppression-bulk-delete-jobs\n\nGet all bulk unsuppress profiles jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`subscriptions:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_unsuppress_profiles_jobs.json)\n\n**Parameters:**\n- `fields[profile-suppression-bulk-delete-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`list_id`: `equals`<br>`segment_id`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/profile-suppression-bulk-delete-jobs', ...)` to call this endpoint.",
1529
+ "content": "## GET /api/profile-suppression-bulk-delete-jobs\n\nGet all bulk unsuppress profiles jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`subscriptions:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_unsuppress_profiles_jobs.json)\n\n**Parameters:**\n- `fields[profile-suppression-bulk-delete-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`list_id`: `equals`<br>`segment_id`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('profile-suppression-bulk-delete-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1530
1530
  "tags": [
1531
1531
  "klaviyo",
1532
1532
  "openapi",
@@ -1539,7 +1539,7 @@
1539
1539
  "platform": "klaviyo",
1540
1540
  "category": "method",
1541
1541
  "summary": "Get Bulk Update Catalog Items Job",
1542
- "content": "## GET /api/catalog-item-bulk-update-jobs/{job_id}\n\nGet a catalog item bulk update job with the given job ID.\n\nAn `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_catalog_items_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[catalog-item-bulk-update-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[catalog-item]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/catalog-item-bulk-update-jobs/{job_id}', ...)` to call this endpoint.",
1542
+ "content": "## GET /api/catalog-item-bulk-update-jobs/{job_id}\n\nGet a catalog item bulk update job with the given job ID.\n\nAn `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_catalog_items_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[catalog-item-bulk-update-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[catalog-item]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('catalog-item-bulk-update-jobs/{job_id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1543
1543
  "tags": [
1544
1544
  "klaviyo",
1545
1545
  "openapi",
@@ -1552,7 +1552,7 @@
1552
1552
  "platform": "klaviyo",
1553
1553
  "category": "method",
1554
1554
  "summary": "Get Bulk Update Catalog Items Jobs",
1555
- "content": "## GET /api/catalog-item-bulk-update-jobs\n\nGet all catalog item bulk update jobs.\n\nReturns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_catalog_items_jobs.json)\n\n**Parameters:**\n- `fields[catalog-item-bulk-update-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.get('api/catalog-item-bulk-update-jobs', ...)` to call this endpoint.",
1555
+ "content": "## GET /api/catalog-item-bulk-update-jobs\n\nGet all catalog item bulk update jobs.\n\nReturns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_catalog_items_jobs.json)\n\n**Parameters:**\n- `fields[catalog-item-bulk-update-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.get('catalog-item-bulk-update-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1556
1556
  "tags": [
1557
1557
  "klaviyo",
1558
1558
  "openapi",
@@ -1565,7 +1565,7 @@
1565
1565
  "platform": "klaviyo",
1566
1566
  "category": "method",
1567
1567
  "summary": "Get Bulk Update Categories Job",
1568
- "content": "## GET /api/catalog-category-bulk-update-jobs/{job_id}\n\nGet a catalog category bulk update job with the given job ID.\n\nAn `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_categories_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[catalog-category-bulk-update-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[catalog-category]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/catalog-category-bulk-update-jobs/{job_id}', ...)` to call this endpoint.",
1568
+ "content": "## GET /api/catalog-category-bulk-update-jobs/{job_id}\n\nGet a catalog category bulk update job with the given job ID.\n\nAn `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_categories_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[catalog-category-bulk-update-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[catalog-category]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('catalog-category-bulk-update-jobs/{job_id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1569
1569
  "tags": [
1570
1570
  "klaviyo",
1571
1571
  "openapi",
@@ -1578,7 +1578,7 @@
1578
1578
  "platform": "klaviyo",
1579
1579
  "category": "method",
1580
1580
  "summary": "Get Bulk Update Categories Jobs",
1581
- "content": "## GET /api/catalog-category-bulk-update-jobs\n\nGet all catalog category bulk update jobs.\n\nReturns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_categories_jobs.json)\n\n**Parameters:**\n- `fields[catalog-category-bulk-update-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.get('api/catalog-category-bulk-update-jobs', ...)` to call this endpoint.",
1581
+ "content": "## GET /api/catalog-category-bulk-update-jobs\n\nGet all catalog category bulk update jobs.\n\nReturns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_categories_jobs.json)\n\n**Parameters:**\n- `fields[catalog-category-bulk-update-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.get('catalog-category-bulk-update-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1582
1582
  "tags": [
1583
1583
  "klaviyo",
1584
1584
  "openapi",
@@ -1591,7 +1591,7 @@
1591
1591
  "platform": "klaviyo",
1592
1592
  "category": "method",
1593
1593
  "summary": "Get Bulk Update Variants Job",
1594
- "content": "## GET /api/catalog-variant-bulk-update-jobs/{job_id}\n\nGet a catalog variate bulk update job with the given job ID.\n\nAn `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_variants_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[catalog-variant-bulk-update-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[catalog-variant]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/catalog-variant-bulk-update-jobs/{job_id}', ...)` to call this endpoint.",
1594
+ "content": "## GET /api/catalog-variant-bulk-update-jobs/{job_id}\n\nGet a catalog variate bulk update job with the given job ID.\n\nAn `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_variants_job.json)\n\n**Parameters:**\n- `job_id` (required) — ID of the job to retrieve.\n- `fields[catalog-variant-bulk-update-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[catalog-variant]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('catalog-variant-bulk-update-jobs/{job_id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1595
1595
  "tags": [
1596
1596
  "klaviyo",
1597
1597
  "openapi",
@@ -1604,7 +1604,7 @@
1604
1604
  "platform": "klaviyo",
1605
1605
  "category": "method",
1606
1606
  "summary": "Get Bulk Update Variants Jobs",
1607
- "content": "## GET /api/catalog-variant-bulk-update-jobs\n\nGet all catalog variant bulk update jobs.\n\nReturns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_variants_jobs.json)\n\n**Parameters:**\n- `fields[catalog-variant-bulk-update-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.get('api/catalog-variant-bulk-update-jobs', ...)` to call this endpoint.",
1607
+ "content": "## GET /api/catalog-variant-bulk-update-jobs\n\nGet all catalog variant bulk update jobs.\n\nReturns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_variants_jobs.json)\n\n**Parameters:**\n- `fields[catalog-variant-bulk-update-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.get('catalog-variant-bulk-update-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1608
1608
  "tags": [
1609
1609
  "klaviyo",
1610
1610
  "openapi",
@@ -1617,7 +1617,7 @@
1617
1617
  "platform": "klaviyo",
1618
1618
  "category": "method",
1619
1619
  "summary": "Get Campaign",
1620
- "content": "## GET /api/campaigns/{id}\n\nReturns a specific campaign based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign.json)\n\n**Parameters:**\n- `id` (required) — The campaign ID to be retrieved\n- `fields[campaign-message]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[campaign]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/campaigns/{id}', ...)` to call this endpoint.",
1620
+ "content": "## GET /api/campaigns/{id}\n\nReturns a specific campaign based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign.json)\n\n**Parameters:**\n- `id` (required) — The campaign ID to be retrieved\n- `fields[campaign-message]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[campaign]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('campaigns/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1621
1621
  "tags": [
1622
1622
  "klaviyo",
1623
1623
  "openapi",
@@ -1630,7 +1630,7 @@
1630
1630
  "platform": "klaviyo",
1631
1631
  "category": "method",
1632
1632
  "summary": "Get Campaign for Campaign Message",
1633
- "content": "## GET /api/campaign-messages/{id}/campaign\n\nReturn the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_for_campaign_message.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[campaign]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/campaign-messages/{id}/campaign', ...)` to call this endpoint.",
1633
+ "content": "## GET /api/campaign-messages/{id}/campaign\n\nReturn the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_for_campaign_message.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[campaign]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('campaign-messages/{id}/campaign', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1634
1634
  "tags": [
1635
1635
  "klaviyo",
1636
1636
  "openapi",
@@ -1643,7 +1643,7 @@
1643
1643
  "platform": "klaviyo",
1644
1644
  "category": "method",
1645
1645
  "summary": "Get Campaign ID for Campaign Message",
1646
- "content": "## GET /api/campaign-messages/{id}/relationships/campaign\n\nReturns the ID of the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_id_for_campaign_message.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('api/campaign-messages/{id}/relationships/campaign', ...)` to call this endpoint.",
1646
+ "content": "## GET /api/campaign-messages/{id}/relationships/campaign\n\nReturns the ID of the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_id_for_campaign_message.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('campaign-messages/{id}/relationships/campaign', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1647
1647
  "tags": [
1648
1648
  "klaviyo",
1649
1649
  "openapi",
@@ -1656,7 +1656,7 @@
1656
1656
  "platform": "klaviyo",
1657
1657
  "category": "method",
1658
1658
  "summary": "Get Campaign IDs for Tag",
1659
- "content": "## GET /api/tags/{id}/relationships/campaigns\n\nReturns the IDs of all campaigns associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`campaigns:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_ids_for_tag.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.get('api/tags/{id}/relationships/campaigns', ...)` to call this endpoint.",
1659
+ "content": "## GET /api/tags/{id}/relationships/campaigns\n\nReturns the IDs of all campaigns associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`campaigns:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_ids_for_tag.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.get('tags/{id}/relationships/campaigns', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1660
1660
  "tags": [
1661
1661
  "klaviyo",
1662
1662
  "openapi",
@@ -1669,7 +1669,7 @@
1669
1669
  "platform": "klaviyo",
1670
1670
  "category": "method",
1671
1671
  "summary": "Get Campaign Message",
1672
- "content": "## GET /api/campaign-messages/{id}\n\nReturns a specific message based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_message.json)\n\n**Parameters:**\n- `id` (required) — The message ID to be retrieved\n- `fields[campaign-message]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[campaign]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[image]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[template]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/campaign-messages/{id}', ...)` to call this endpoint.",
1672
+ "content": "## GET /api/campaign-messages/{id}\n\nReturns a specific message based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_message.json)\n\n**Parameters:**\n- `id` (required) — The message ID to be retrieved\n- `fields[campaign-message]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[campaign]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[image]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[template]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('campaign-messages/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1673
1673
  "tags": [
1674
1674
  "klaviyo",
1675
1675
  "openapi",
@@ -1682,7 +1682,7 @@
1682
1682
  "platform": "klaviyo",
1683
1683
  "category": "method",
1684
1684
  "summary": "Get Campaign Recipient Estimation",
1685
- "content": "## GET /api/campaign-recipient-estimations/{id}\n\nGet the estimated recipient count for a campaign with the provided campaign ID.\nYou can refresh this count by using the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_recipient_estimation.json)\n\n**Parameters:**\n- `id` (required) — The ID of the campaign for which to get the estimated number of recipients\n- `fields[campaign-recipient-estimation]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/campaign-recipient-estimations/{id}', ...)` to call this endpoint.",
1685
+ "content": "## GET /api/campaign-recipient-estimations/{id}\n\nGet the estimated recipient count for a campaign with the provided campaign ID.\nYou can refresh this count by using the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_recipient_estimation.json)\n\n**Parameters:**\n- `id` (required) — The ID of the campaign for which to get the estimated number of recipients\n- `fields[campaign-recipient-estimation]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('campaign-recipient-estimations/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1686
1686
  "tags": [
1687
1687
  "klaviyo",
1688
1688
  "openapi",
@@ -1695,7 +1695,7 @@
1695
1695
  "platform": "klaviyo",
1696
1696
  "category": "method",
1697
1697
  "summary": "Get Campaign Recipient Estimation Job",
1698
- "content": "## GET /api/campaign-recipient-estimation-jobs/{id}\n\nRetrieve the status of a recipient estimation job triggered\nwith the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_recipient_estimation_job.json)\n\n**Parameters:**\n- `id` (required) — The ID of the campaign to get recipient estimation status\n- `fields[campaign-recipient-estimation-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/campaign-recipient-estimation-jobs/{id}', ...)` to call this endpoint.",
1698
+ "content": "## GET /api/campaign-recipient-estimation-jobs/{id}\n\nRetrieve the status of a recipient estimation job triggered\nwith the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_recipient_estimation_job.json)\n\n**Parameters:**\n- `id` (required) — The ID of the campaign to get recipient estimation status\n- `fields[campaign-recipient-estimation-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('campaign-recipient-estimation-jobs/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1699
1699
  "tags": [
1700
1700
  "klaviyo",
1701
1701
  "openapi",
@@ -1708,7 +1708,7 @@
1708
1708
  "platform": "klaviyo",
1709
1709
  "category": "method",
1710
1710
  "summary": "Get Campaign Send Job",
1711
- "content": "## GET /api/campaign-send-jobs/{id}\n\nGet a campaign send job<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_send_job.json)\n\n**Parameters:**\n- `id` (required) — The ID of the campaign to send\n- `fields[campaign-send-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/campaign-send-jobs/{id}', ...)` to call this endpoint.",
1711
+ "content": "## GET /api/campaign-send-jobs/{id}\n\nGet a campaign send job<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_send_job.json)\n\n**Parameters:**\n- `id` (required) — The ID of the campaign to send\n- `fields[campaign-send-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('campaign-send-jobs/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1712
1712
  "tags": [
1713
1713
  "klaviyo",
1714
1714
  "openapi",
@@ -1721,7 +1721,7 @@
1721
1721
  "platform": "klaviyo",
1722
1722
  "category": "method",
1723
1723
  "summary": "Get Campaigns",
1724
- "content": "## GET /api/campaigns\n\nReturns some or all campaigns based on filters.\n\nA channel filter is required to list campaigns. Please provide either:\n`?filter=equals(messages.channel,'email')` to list email campaigns, or\n`?filter=equals(messages.channel,'sms')` to list SMS campaigns.\n`?filter=equals(messages.channel,'mobile_push')` to list mobile push campaigns.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaigns.json)\n\n**Parameters:**\n- `fields[campaign-message]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[campaign]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` (required) — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`messages.channel`: `equals`<br>`name`: `contains`<br>`status`: `any`, `equals`<br>`archived`: `equals`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/campaigns', ...)` to call this endpoint.",
1724
+ "content": "## GET /api/campaigns\n\nReturns some or all campaigns based on filters.\n\nA channel filter is required to list campaigns. Please provide either:\n`?filter=equals(messages.channel,'email')` to list email campaigns, or\n`?filter=equals(messages.channel,'sms')` to list SMS campaigns.\n`?filter=equals(messages.channel,'mobile_push')` to list mobile push campaigns.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaigns.json)\n\n**Parameters:**\n- `fields[campaign-message]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[campaign]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` (required) — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`messages.channel`: `equals`<br>`name`: `contains`<br>`status`: `any`, `equals`<br>`archived`: `equals`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('campaigns', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1725
1725
  "tags": [
1726
1726
  "klaviyo",
1727
1727
  "openapi",
@@ -1734,7 +1734,7 @@
1734
1734
  "platform": "klaviyo",
1735
1735
  "category": "method",
1736
1736
  "summary": "Get Catalog Categories",
1737
- "content": "## GET /api/catalog-categories\n\nGet all catalog categories in an account.\n\nCatalog categories can be sorted by the following fields, in ascending and descending order:\n`created`\n\nCurrently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`.\n\nReturns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_categories.json)\n\n**Parameters:**\n- `fields[catalog-category]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/catalog-categories', ...)` to call this endpoint.",
1737
+ "content": "## GET /api/catalog-categories\n\nGet all catalog categories in an account.\n\nCatalog categories can be sorted by the following fields, in ascending and descending order:\n`created`\n\nCurrently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`.\n\nReturns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_categories.json)\n\n**Parameters:**\n- `fields[catalog-category]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('catalog-categories', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1738
1738
  "tags": [
1739
1739
  "klaviyo",
1740
1740
  "openapi",
@@ -1747,7 +1747,7 @@
1747
1747
  "platform": "klaviyo",
1748
1748
  "category": "method",
1749
1749
  "summary": "Get Catalog Category",
1750
- "content": "## GET /api/catalog-categories/{id}\n\nGet a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_category.json)\n\n**Parameters:**\n- `id` (required) — The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n- `fields[catalog-category]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/catalog-categories/{id}', ...)` to call this endpoint.",
1750
+ "content": "## GET /api/catalog-categories/{id}\n\nGet a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_category.json)\n\n**Parameters:**\n- `id` (required) — The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n- `fields[catalog-category]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('catalog-categories/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1751
1751
  "tags": [
1752
1752
  "klaviyo",
1753
1753
  "openapi",
@@ -1760,7 +1760,7 @@
1760
1760
  "platform": "klaviyo",
1761
1761
  "category": "method",
1762
1762
  "summary": "Get Catalog Item",
1763
- "content": "## GET /api/catalog-items/{id}\n\nGet a specific catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_item.json)\n\n**Parameters:**\n- `id` (required) — The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n- `fields[catalog-item]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[catalog-variant]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/catalog-items/{id}', ...)` to call this endpoint.",
1763
+ "content": "## GET /api/catalog-items/{id}\n\nGet a specific catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_item.json)\n\n**Parameters:**\n- `id` (required) — The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n- `fields[catalog-item]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[catalog-variant]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('catalog-items/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1764
1764
  "tags": [
1765
1765
  "klaviyo",
1766
1766
  "openapi",
@@ -1773,7 +1773,7 @@
1773
1773
  "platform": "klaviyo",
1774
1774
  "category": "method",
1775
1775
  "summary": "Get Catalog Items",
1776
- "content": "## GET /api/catalog-items\n\nGet all catalog items in an account.\n\nCatalog items can be sorted by the following fields, in ascending and descending order:\n`created`\n\nCurrently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`.\n\nReturns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_items.json)\n\n**Parameters:**\n- `fields[catalog-item]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[catalog-variant]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/catalog-items', ...)` to call this endpoint.",
1776
+ "content": "## GET /api/catalog-items\n\nGet all catalog items in an account.\n\nCatalog items can be sorted by the following fields, in ascending and descending order:\n`created`\n\nCurrently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`.\n\nReturns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_items.json)\n\n**Parameters:**\n- `fields[catalog-item]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[catalog-variant]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('catalog-items', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1777
1777
  "tags": [
1778
1778
  "klaviyo",
1779
1779
  "openapi",
@@ -1786,7 +1786,7 @@
1786
1786
  "platform": "klaviyo",
1787
1787
  "category": "method",
1788
1788
  "summary": "Get Catalog Variant",
1789
- "content": "## GET /api/catalog-variants/{id}\n\nGet a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_variant.json)\n\n**Parameters:**\n- `id` (required) — The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n- `fields[catalog-variant]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/catalog-variants/{id}', ...)` to call this endpoint.",
1789
+ "content": "## GET /api/catalog-variants/{id}\n\nGet a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_variant.json)\n\n**Parameters:**\n- `id` (required) — The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n- `fields[catalog-variant]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('catalog-variants/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1790
1790
  "tags": [
1791
1791
  "klaviyo",
1792
1792
  "openapi",
@@ -1799,7 +1799,7 @@
1799
1799
  "platform": "klaviyo",
1800
1800
  "category": "method",
1801
1801
  "summary": "Get Catalog Variants",
1802
- "content": "## GET /api/catalog-variants\n\nGet all variants in an account.\n\nVariants can be sorted by the following fields, in ascending and descending order:\n`created`\n\nCurrently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`.\n\nReturns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_variants.json)\n\n**Parameters:**\n- `fields[catalog-variant]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/catalog-variants', ...)` to call this endpoint.",
1802
+ "content": "## GET /api/catalog-variants\n\nGet all variants in an account.\n\nVariants can be sorted by the following fields, in ascending and descending order:\n`created`\n\nCurrently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`.\n\nReturns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_variants.json)\n\n**Parameters:**\n- `fields[catalog-variant]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('catalog-variants', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1803
1803
  "tags": [
1804
1804
  "klaviyo",
1805
1805
  "openapi",
@@ -1812,7 +1812,7 @@
1812
1812
  "platform": "klaviyo",
1813
1813
  "category": "method",
1814
1814
  "summary": "Get Categories for Catalog Item",
1815
- "content": "## GET /api/catalog-items/{id}/categories\n\nGet all catalog categories that an item with the given item ID is in.\n\nCatalog categories can be sorted by the following fields, in ascending and descending order:\n`created`\n\nReturns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_categories_for_catalog_item.json)\n\n**Parameters:**\n- `id` (required) — The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n- `fields[catalog-category]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/catalog-items/{id}/categories', ...)` to call this endpoint.",
1815
+ "content": "## GET /api/catalog-items/{id}/categories\n\nGet all catalog categories that an item with the given item ID is in.\n\nCatalog categories can be sorted by the following fields, in ascending and descending order:\n`created`\n\nReturns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_categories_for_catalog_item.json)\n\n**Parameters:**\n- `id` (required) — The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n- `fields[catalog-category]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('catalog-items/{id}/categories', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1816
1816
  "tags": [
1817
1817
  "klaviyo",
1818
1818
  "openapi",
@@ -1825,7 +1825,7 @@
1825
1825
  "platform": "klaviyo",
1826
1826
  "category": "method",
1827
1827
  "summary": "Get Category IDs for Catalog Item",
1828
- "content": "## GET /api/catalog-items/{id}/relationships/categories\n\nGet all catalog categories that a particular item is in. Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_category_ids_for_catalog_item.json)\n\n**Parameters:**\n- `id` (required) — The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/catalog-items/{id}/relationships/categories', ...)` to call this endpoint.",
1828
+ "content": "## GET /api/catalog-items/{id}/relationships/categories\n\nGet all catalog categories that a particular item is in. Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_category_ids_for_catalog_item.json)\n\n**Parameters:**\n- `id` (required) — The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('catalog-items/{id}/relationships/categories', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1829
1829
  "tags": [
1830
1830
  "klaviyo",
1831
1831
  "openapi",
@@ -1838,7 +1838,7 @@
1838
1838
  "platform": "klaviyo",
1839
1839
  "category": "method",
1840
1840
  "summary": "Get Client Geofences",
1841
- "content": "## GET /client/geofences\n\nGet all geofences in an account.\n\nReturns a paginated list of all geofences for the specified company.\nThis is the GA API endpoint designed for mobile SDK consumption.\nNo authentication required.\n\nReturns a maximum of 100 results per page (default 20).\n\nThis API supports filtering via header instead of query param. Provide\n`X-Klaviyo-API-Filters` header to filter geofences. We don't use regular\nquery param filters here because lat and long are sensitive information.\n\nSupported filters:\n- `lat` (equals) - Latitude coordinate for distance-based sorting\n- `lng` (equals) - Longitude coordinate for distance-based sorting\n\nWhen both lat and lng are provided, geofences are returned sorted by\ndistance from the specified coordinates (closest first).\n\nExample filter header:\n`X-Klaviyo-API-Filters: and(equals(lat,40.7128),equals(lng,-74.0060))`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_client_geofences.json)\n\n**Parameters:**\n- `company_id` (required) — Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.\n- `fields[geofence]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n\nUse `klaviyo.get('client/geofences', ...)` to call this endpoint.",
1841
+ "content": "## GET /client/geofences\n\nGet all geofences in an account.\n\nReturns a paginated list of all geofences for the specified company.\nThis is the GA API endpoint designed for mobile SDK consumption.\nNo authentication required.\n\nReturns a maximum of 100 results per page (default 20).\n\nThis API supports filtering via header instead of query param. Provide\n`X-Klaviyo-API-Filters` header to filter geofences. We don't use regular\nquery param filters here because lat and long are sensitive information.\n\nSupported filters:\n- `lat` (equals) - Latitude coordinate for distance-based sorting\n- `lng` (equals) - Longitude coordinate for distance-based sorting\n\nWhen both lat and lng are provided, geofences are returned sorted by\ndistance from the specified coordinates (closest first).\n\nExample filter header:\n`X-Klaviyo-API-Filters: and(equals(lat,40.7128),equals(lng,-74.0060))`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_client_geofences.json)\n\n**Parameters:**\n- `company_id` (required) — Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.\n- `fields[geofence]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n\nUse `klaviyo.get('client/geofences', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1842
1842
  "tags": [
1843
1843
  "klaviyo",
1844
1844
  "openapi",
@@ -1851,7 +1851,7 @@
1851
1851
  "platform": "klaviyo",
1852
1852
  "category": "method",
1853
1853
  "summary": "Get Client Review Values Reports",
1854
- "content": "## GET /client/review-values-reports\n\nGet all reviews values reports in an account.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_client_review_values_reports.json)\n\n**Parameters:**\n- `company_id` (required) — Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.\n- `fields[review-values-report]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`product_external_ids`: `any`, `equals`\n- `group_by` (required) — group by value for this report\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `statistics` (required) — list of statistics to calculate for this report\n- `timeframe` (required) — timeframe window for value report\n\nUse `klaviyo.get('client/review-values-reports', ...)` to call this endpoint.",
1854
+ "content": "## GET /client/review-values-reports\n\nGet all reviews values reports in an account.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_client_review_values_reports.json)\n\n**Parameters:**\n- `company_id` (required) — Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.\n- `fields[review-values-report]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`product_external_ids`: `any`, `equals`\n- `group_by` (required) — group by value for this report\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `statistics` (required) — list of statistics to calculate for this report\n- `timeframe` (required) — timeframe window for value report\n\nUse `klaviyo.get('client/review-values-reports', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1855
1855
  "tags": [
1856
1856
  "klaviyo",
1857
1857
  "openapi",
@@ -1864,7 +1864,7 @@
1864
1864
  "platform": "klaviyo",
1865
1865
  "category": "method",
1866
1866
  "summary": "Get Client Reviews",
1867
- "content": "## GET /client/reviews\n\nGet all reviews. This endpoint is for client-side environments only, for server-side use, refer to https://developers.klaviyo.com/en/reference/get_reviews<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_client_reviews.json)\n\n**Parameters:**\n- `company_id` (required) — Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.\n- `fields[review]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`review_type`: `equals`<br>`rating`: `any`, `equals`, `greater-or-equal`, `less-or-equal`<br>`id`: `any`, `equals`<br>`content`: `contains`<br>`smart_quote`: `has`<br>`public_reply`: `has`<br>`verified`: `equals`<br>`incentivized`: `equals`<br>`edited`: `equals`<br>`media`: `has`<br>`created`: `greater-or-equal`, `less-or-equal`<br>`updated`: `greater-or-equal`, `less-or-equal`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('client/reviews', ...)` to call this endpoint.",
1867
+ "content": "## GET /client/reviews\n\nGet all reviews. This endpoint is for client-side environments only, for server-side use, refer to https://developers.klaviyo.com/en/reference/get_reviews<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_client_reviews.json)\n\n**Parameters:**\n- `company_id` (required) — Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.\n- `fields[review]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`review_type`: `equals`<br>`rating`: `any`, `equals`, `greater-or-equal`, `less-or-equal`<br>`id`: `any`, `equals`<br>`content`: `contains`<br>`smart_quote`: `has`<br>`public_reply`: `has`<br>`verified`: `equals`<br>`incentivized`: `equals`<br>`edited`: `equals`<br>`media`: `has`<br>`created`: `greater-or-equal`, `less-or-equal`<br>`updated`: `greater-or-equal`, `less-or-equal`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('client/reviews', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1868
1868
  "tags": [
1869
1869
  "klaviyo",
1870
1870
  "openapi",
@@ -1877,7 +1877,7 @@
1877
1877
  "platform": "klaviyo",
1878
1878
  "category": "method",
1879
1879
  "summary": "Get Conversation for Profile",
1880
- "content": "## GET /api/profiles/{id}/conversation\n\nGet the conversation for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`conversations:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_conversation_for_profile.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[conversation]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/profiles/{id}/conversation', ...)` to call this endpoint.",
1880
+ "content": "## GET /api/profiles/{id}/conversation\n\nGet the conversation for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`conversations:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_conversation_for_profile.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[conversation]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('profiles/{id}/conversation', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1881
1881
  "tags": [
1882
1882
  "klaviyo",
1883
1883
  "openapi",
@@ -1890,7 +1890,7 @@
1890
1890
  "platform": "klaviyo",
1891
1891
  "category": "method",
1892
1892
  "summary": "Get Conversation ID for Profile",
1893
- "content": "## GET /api/profiles/{id}/relationships/conversation\n\nGet the conversation relationship for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`conversations:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_conversation_id_for_profile.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('api/profiles/{id}/relationships/conversation', ...)` to call this endpoint.",
1893
+ "content": "## GET /api/profiles/{id}/relationships/conversation\n\nGet the conversation relationship for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`conversations:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_conversation_id_for_profile.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('profiles/{id}/relationships/conversation', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1894
1894
  "tags": [
1895
1895
  "klaviyo",
1896
1896
  "openapi",
@@ -1903,7 +1903,7 @@
1903
1903
  "platform": "klaviyo",
1904
1904
  "category": "method",
1905
1905
  "summary": "Get Coupon",
1906
- "content": "## GET /api/coupons/{id}\n\nGet a specific coupon with the given coupon ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`coupons:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon.json)\n\n**Parameters:**\n- `id` (required) — The internal id of a Coupon is equivalent to its external id stored within an integration.\n- `fields[coupon]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/coupons/{id}', ...)` to call this endpoint.",
1906
+ "content": "## GET /api/coupons/{id}\n\nGet a specific coupon with the given coupon ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`coupons:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon.json)\n\n**Parameters:**\n- `id` (required) — The internal id of a Coupon is equivalent to its external id stored within an integration.\n- `fields[coupon]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('coupons/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1907
1907
  "tags": [
1908
1908
  "klaviyo",
1909
1909
  "openapi",
@@ -1916,7 +1916,7 @@
1916
1916
  "platform": "klaviyo",
1917
1917
  "category": "method",
1918
1918
  "summary": "Get Coupon Code",
1919
- "content": "## GET /api/coupon-codes/{id}\n\nReturns a Coupon Code specified by the given identifier.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`coupon-codes:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_code.json)\n\n**Parameters:**\n- `id` (required) — The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.\n- `fields[coupon-code]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[coupon]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/coupon-codes/{id}', ...)` to call this endpoint.",
1919
+ "content": "## GET /api/coupon-codes/{id}\n\nReturns a Coupon Code specified by the given identifier.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`coupon-codes:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_code.json)\n\n**Parameters:**\n- `id` (required) — The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.\n- `fields[coupon-code]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[coupon]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('coupon-codes/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1920
1920
  "tags": [
1921
1921
  "klaviyo",
1922
1922
  "openapi",
@@ -1929,7 +1929,7 @@
1929
1929
  "platform": "klaviyo",
1930
1930
  "category": "method",
1931
1931
  "summary": "Get Coupon Code IDs for Coupon",
1932
- "content": "## GET /api/coupons/{id}/relationships/coupon-codes\n\nGets a list of coupon code relationships associated with the given coupon id<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`coupon-codes:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_code_ids_for_coupon.json)\n\n**Parameters:**\n- `id` (required) — The ID of the coupon to look up the relationship of.\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`<br>`coupon.id`: `any`, `equals`<br>`profile.id`: `any`, `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n\nUse `klaviyo.get('api/coupons/{id}/relationships/coupon-codes', ...)` to call this endpoint.",
1932
+ "content": "## GET /api/coupons/{id}/relationships/coupon-codes\n\nGets a list of coupon code relationships associated with the given coupon id<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`coupon-codes:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_code_ids_for_coupon.json)\n\n**Parameters:**\n- `id` (required) — The ID of the coupon to look up the relationship of.\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`<br>`coupon.id`: `any`, `equals`<br>`profile.id`: `any`, `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n\nUse `klaviyo.get('coupons/{id}/relationships/coupon-codes', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1933
1933
  "tags": [
1934
1934
  "klaviyo",
1935
1935
  "openapi",
@@ -1942,7 +1942,7 @@
1942
1942
  "platform": "klaviyo",
1943
1943
  "category": "method",
1944
1944
  "summary": "Get Coupon Codes",
1945
- "content": "## GET /api/coupon-codes\n\nGets a list of coupon codes associated with a coupon/coupons or a profile/profiles.\n\nA coupon/coupons or a profile/profiles must be provided as required filter params.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`coupon-codes:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_codes.json)\n\n**Parameters:**\n- `fields[coupon-code]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[coupon]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` (required) — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`<br>`coupon.id`: `any`, `equals`<br>`profile.id`: `any`, `equals`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n\nUse `klaviyo.get('api/coupon-codes', ...)` to call this endpoint.",
1945
+ "content": "## GET /api/coupon-codes\n\nGets a list of coupon codes associated with a coupon/coupons or a profile/profiles.\n\nA coupon/coupons or a profile/profiles must be provided as required filter params.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`coupon-codes:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_codes.json)\n\n**Parameters:**\n- `fields[coupon-code]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[coupon]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` (required) — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`<br>`coupon.id`: `any`, `equals`<br>`profile.id`: `any`, `equals`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n\nUse `klaviyo.get('coupon-codes', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1946
1946
  "tags": [
1947
1947
  "klaviyo",
1948
1948
  "openapi",
@@ -1955,7 +1955,7 @@
1955
1955
  "platform": "klaviyo",
1956
1956
  "category": "method",
1957
1957
  "summary": "Get Coupon Codes for Coupon",
1958
- "content": "## GET /api/coupons/{id}/coupon-codes\n\nGets a list of coupon codes associated with the given coupon id<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`coupon-codes:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_codes_for_coupon.json)\n\n**Parameters:**\n- `id` (required) — The ID of the coupon to look up the relationship of.\n- `fields[coupon-code]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`<br>`coupon.id`: `any`, `equals`<br>`profile.id`: `any`, `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n\nUse `klaviyo.get('api/coupons/{id}/coupon-codes', ...)` to call this endpoint.",
1958
+ "content": "## GET /api/coupons/{id}/coupon-codes\n\nGets a list of coupon codes associated with the given coupon id<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`coupon-codes:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_codes_for_coupon.json)\n\n**Parameters:**\n- `id` (required) — The ID of the coupon to look up the relationship of.\n- `fields[coupon-code]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`<br>`coupon.id`: `any`, `equals`<br>`profile.id`: `any`, `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n\nUse `klaviyo.get('coupons/{id}/coupon-codes', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1959
1959
  "tags": [
1960
1960
  "klaviyo",
1961
1961
  "openapi",
@@ -1968,7 +1968,7 @@
1968
1968
  "platform": "klaviyo",
1969
1969
  "category": "method",
1970
1970
  "summary": "Get Coupon For Coupon Code",
1971
- "content": "## GET /api/coupon-codes/{id}/coupon\n\nGet the coupon associated with a given coupon code ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`coupons:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_for_coupon_code.json)\n\n**Parameters:**\n- `id` (required) — The ID of the coupon to look up the relationship of.\n- `fields[coupon]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/coupon-codes/{id}/coupon', ...)` to call this endpoint.",
1971
+ "content": "## GET /api/coupon-codes/{id}/coupon\n\nGet the coupon associated with a given coupon code ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`coupons:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_for_coupon_code.json)\n\n**Parameters:**\n- `id` (required) — The ID of the coupon to look up the relationship of.\n- `fields[coupon]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('coupon-codes/{id}/coupon', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1972
1972
  "tags": [
1973
1973
  "klaviyo",
1974
1974
  "openapi",
@@ -1981,7 +1981,7 @@
1981
1981
  "platform": "klaviyo",
1982
1982
  "category": "method",
1983
1983
  "summary": "Get Coupon ID for Coupon Code",
1984
- "content": "## GET /api/coupon-codes/{id}/relationships/coupon\n\nGets the coupon relationship associated with the given coupon code id<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`coupons:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_id_for_coupon_code.json)\n\n**Parameters:**\n- `id` (required) — The ID of the coupon to look up the relationship of.\n\nUse `klaviyo.get('api/coupon-codes/{id}/relationships/coupon', ...)` to call this endpoint.",
1984
+ "content": "## GET /api/coupon-codes/{id}/relationships/coupon\n\nGets the coupon relationship associated with the given coupon code id<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`coupons:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_id_for_coupon_code.json)\n\n**Parameters:**\n- `id` (required) — The ID of the coupon to look up the relationship of.\n\nUse `klaviyo.get('coupon-codes/{id}/relationships/coupon', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1985
1985
  "tags": [
1986
1986
  "klaviyo",
1987
1987
  "openapi",
@@ -1994,7 +1994,7 @@
1994
1994
  "platform": "klaviyo",
1995
1995
  "category": "method",
1996
1996
  "summary": "Get Coupons",
1997
- "content": "## GET /api/coupons\n\nGet all coupons in an account.\n\nTo learn more, see our [Coupons API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_coupons_api).<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`coupons:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupons.json)\n\n**Parameters:**\n- `fields[coupon]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n\nUse `klaviyo.get('api/coupons', ...)` to call this endpoint.",
1997
+ "content": "## GET /api/coupons\n\nGet all coupons in an account.\n\nTo learn more, see our [Coupons API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_coupons_api).<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`coupons:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupons.json)\n\n**Parameters:**\n- `fields[coupon]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n\nUse `klaviyo.get('coupons', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
1998
1998
  "tags": [
1999
1999
  "klaviyo",
2000
2000
  "openapi",
@@ -2007,7 +2007,7 @@
2007
2007
  "platform": "klaviyo",
2008
2008
  "category": "method",
2009
2009
  "summary": "Get Custom Metric",
2010
- "content": "## GET /api/custom-metrics/{id}\n\nGet a custom metric with the given custom metric ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_custom_metric.json)\n\n**Parameters:**\n- `id` (required) — The ID of the custom metric\n- `fields[custom-metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/custom-metrics/{id}', ...)` to call this endpoint.",
2010
+ "content": "## GET /api/custom-metrics/{id}\n\nGet a custom metric with the given custom metric ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_custom_metric.json)\n\n**Parameters:**\n- `id` (required) — The ID of the custom metric\n- `fields[custom-metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('custom-metrics/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2011
2011
  "tags": [
2012
2012
  "klaviyo",
2013
2013
  "openapi",
@@ -2020,7 +2020,7 @@
2020
2020
  "platform": "klaviyo",
2021
2021
  "category": "method",
2022
2022
  "summary": "Get Custom Metric for Mapped Metric",
2023
- "content": "## GET /api/mapped-metrics/{id}/custom-metric\n\nGet the custom metric for the given mapped metric ID (if applicable).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_custom_metric_for_mapped_metric.json)\n\n**Parameters:**\n- `id` (required) — The type of mapping.\n- `fields[custom-metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/mapped-metrics/{id}/custom-metric', ...)` to call this endpoint.",
2023
+ "content": "## GET /api/mapped-metrics/{id}/custom-metric\n\nGet the custom metric for the given mapped metric ID (if applicable).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_custom_metric_for_mapped_metric.json)\n\n**Parameters:**\n- `id` (required) — The type of mapping.\n- `fields[custom-metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('mapped-metrics/{id}/custom-metric', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2024
2024
  "tags": [
2025
2025
  "klaviyo",
2026
2026
  "openapi",
@@ -2033,7 +2033,7 @@
2033
2033
  "platform": "klaviyo",
2034
2034
  "category": "method",
2035
2035
  "summary": "Get Custom Metric ID for Mapped Metric",
2036
- "content": "## GET /api/mapped-metrics/{id}/relationships/custom-metric\n\nGet the ID of the custom metric for the given mapped metric.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_custom_metric_id_for_mapped_metric.json)\n\n**Parameters:**\n- `id` (required) — The type of mapping.\n\nUse `klaviyo.get('api/mapped-metrics/{id}/relationships/custom-metric', ...)` to call this endpoint.",
2036
+ "content": "## GET /api/mapped-metrics/{id}/relationships/custom-metric\n\nGet the ID of the custom metric for the given mapped metric.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_custom_metric_id_for_mapped_metric.json)\n\n**Parameters:**\n- `id` (required) — The type of mapping.\n\nUse `klaviyo.get('mapped-metrics/{id}/relationships/custom-metric', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2037
2037
  "tags": [
2038
2038
  "klaviyo",
2039
2039
  "openapi",
@@ -2046,7 +2046,7 @@
2046
2046
  "platform": "klaviyo",
2047
2047
  "category": "method",
2048
2048
  "summary": "Get Custom Metrics",
2049
- "content": "## GET /api/custom-metrics\n\nGet all custom metrics in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_custom_metrics.json)\n\n**Parameters:**\n- `fields[custom-metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/custom-metrics', ...)` to call this endpoint.",
2049
+ "content": "## GET /api/custom-metrics\n\nGet all custom metrics in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_custom_metrics.json)\n\n**Parameters:**\n- `fields[custom-metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('custom-metrics', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2050
2050
  "tags": [
2051
2051
  "klaviyo",
2052
2052
  "openapi",
@@ -2059,7 +2059,7 @@
2059
2059
  "platform": "klaviyo",
2060
2060
  "category": "method",
2061
2061
  "summary": "Get Data Source",
2062
- "content": "## GET /api/data-sources/{id}\n\nRetrieve a data source in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`custom-objects:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_data_source.json)\n\n**Parameters:**\n- `id` (required) — The ID of the data source\n- `fields[data-source]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/data-sources/{id}', ...)` to call this endpoint.",
2062
+ "content": "## GET /api/data-sources/{id}\n\nRetrieve a data source in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`custom-objects:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_data_source.json)\n\n**Parameters:**\n- `id` (required) — The ID of the data source\n- `fields[data-source]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('data-sources/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2063
2063
  "tags": [
2064
2064
  "klaviyo",
2065
2065
  "openapi",
@@ -2072,7 +2072,7 @@
2072
2072
  "platform": "klaviyo",
2073
2073
  "category": "method",
2074
2074
  "summary": "Get Data Sources",
2075
- "content": "## GET /api/data-sources\n\nGet all data sources in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`custom-objects:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_data_sources.json)\n\n**Parameters:**\n- `fields[data-source]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n\nUse `klaviyo.get('api/data-sources', ...)` to call this endpoint.",
2075
+ "content": "## GET /api/data-sources\n\nGet all data sources in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`custom-objects:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_data_sources.json)\n\n**Parameters:**\n- `fields[data-source]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n\nUse `klaviyo.get('data-sources', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2076
2076
  "tags": [
2077
2077
  "klaviyo",
2078
2078
  "openapi",
@@ -2085,7 +2085,7 @@
2085
2085
  "platform": "klaviyo",
2086
2086
  "category": "method",
2087
2087
  "summary": "Get Errors for Bulk Import Profiles Job",
2088
- "content": "## GET /api/profile-bulk-import-jobs/{id}/import-errors\n\nGet import errors for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_errors_for_bulk_import_profiles_job.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[import-error]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n\nUse `klaviyo.get('api/profile-bulk-import-jobs/{id}/import-errors', ...)` to call this endpoint.",
2088
+ "content": "## GET /api/profile-bulk-import-jobs/{id}/import-errors\n\nGet import errors for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_errors_for_bulk_import_profiles_job.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[import-error]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n\nUse `klaviyo.get('profile-bulk-import-jobs/{id}/import-errors', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2089
2089
  "tags": [
2090
2090
  "klaviyo",
2091
2091
  "openapi",
@@ -2098,7 +2098,7 @@
2098
2098
  "platform": "klaviyo",
2099
2099
  "category": "method",
2100
2100
  "summary": "Get Event",
2101
- "content": "## GET /api/events/{id}\n\nGet an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`events:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_event.json)\n\n**Parameters:**\n- `id` (required) — ID of the event\n- `fields[attribution]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[event]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/events/{id}', ...)` to call this endpoint.",
2101
+ "content": "## GET /api/events/{id}\n\nGet an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`events:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_event.json)\n\n**Parameters:**\n- `id` (required) — ID of the event\n- `fields[attribution]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[event]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('events/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2102
2102
  "tags": [
2103
2103
  "klaviyo",
2104
2104
  "openapi",
@@ -2111,7 +2111,7 @@
2111
2111
  "platform": "klaviyo",
2112
2112
  "category": "method",
2113
2113
  "summary": "Get Events",
2114
- "content": "## GET /api/events\n\nGet all events in an account\n\nRequests can be sorted by the following fields:\n`datetime`, `timestamp`\n\n[Custom metrics](https://developers.klaviyo.com/en/reference/custom_metrics_api_overview) are not supported in the `metric_id` filter.\n\nReturns a maximum of 200 events per page.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`events:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_events.json)\n\n**Parameters:**\n- `fields[attribution]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[event]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`metric_id`: `equals`<br>`profile_id`: `equals`<br>`profile`: `has`<br>`datetime`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 200. Min: 1. Max: 1000.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/events', ...)` to call this endpoint.",
2114
+ "content": "## GET /api/events\n\nGet all events in an account\n\nRequests can be sorted by the following fields:\n`datetime`, `timestamp`\n\n[Custom metrics](https://developers.klaviyo.com/en/reference/custom_metrics_api_overview) are not supported in the `metric_id` filter.\n\nReturns a maximum of 200 events per page.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`events:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_events.json)\n\n**Parameters:**\n- `fields[attribution]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[event]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`metric_id`: `equals`<br>`profile_id`: `equals`<br>`profile`: `has`<br>`datetime`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 200. Min: 1. Max: 1000.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('events', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2115
2115
  "tags": [
2116
2116
  "klaviyo",
2117
2117
  "openapi",
@@ -2124,7 +2124,7 @@
2124
2124
  "platform": "klaviyo",
2125
2125
  "category": "method",
2126
2126
  "summary": "Get Flow",
2127
- "content": "## GET /api/flows/{id}\n\nGet a flow with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow.json)\n\n**Parameters:**\n- `id` (required)\n- `additional-fields[flow]` — Request additional fields not included by default in the response. Supported values: 'definition'\n- `fields[flow-action]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/flows/{id}', ...)` to call this endpoint.",
2127
+ "content": "## GET /api/flows/{id}\n\nGet a flow with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow.json)\n\n**Parameters:**\n- `id` (required)\n- `additional-fields[flow]` — Request additional fields not included by default in the response. Supported values: 'definition'\n- `fields[flow-action]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('flows/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2128
2128
  "tags": [
2129
2129
  "klaviyo",
2130
2130
  "openapi",
@@ -2137,7 +2137,7 @@
2137
2137
  "platform": "klaviyo",
2138
2138
  "category": "method",
2139
2139
  "summary": "Get Flow Action",
2140
- "content": "## GET /api/flow-actions/{id}\n\nGet a flow action from a flow with the given flow action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_action.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[flow-action]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[flow-message]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/flow-actions/{id}', ...)` to call this endpoint.",
2140
+ "content": "## GET /api/flow-actions/{id}\n\nGet a flow action from a flow with the given flow action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_action.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[flow-action]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[flow-message]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('flow-actions/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2141
2141
  "tags": [
2142
2142
  "klaviyo",
2143
2143
  "openapi",
@@ -2150,7 +2150,7 @@
2150
2150
  "platform": "klaviyo",
2151
2151
  "category": "method",
2152
2152
  "summary": "Get Messages For Flow Action",
2153
- "content": "## GET /api/flow-actions/{id}/flow-messages\n\nGet all flow messages associated with the given flow action ID.\n\nReturns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_action_messages.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[flow-message]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 50. Min: 1. Max: 50.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/flow-actions/{id}/flow-messages', ...)` to call this endpoint.",
2153
+ "content": "## GET /api/flow-actions/{id}/flow-messages\n\nGet all flow messages associated with the given flow action ID.\n\nReturns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_action_messages.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[flow-message]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 50. Min: 1. Max: 50.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('flow-actions/{id}/flow-messages', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2154
2154
  "tags": [
2155
2155
  "klaviyo",
2156
2156
  "openapi",
@@ -2163,7 +2163,7 @@
2163
2163
  "platform": "klaviyo",
2164
2164
  "category": "method",
2165
2165
  "summary": "Get Flow for Flow Action",
2166
- "content": "## GET /api/flow-actions/{id}/flow\n\nGet the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_for_flow_action.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/flow-actions/{id}/flow', ...)` to call this endpoint.",
2166
+ "content": "## GET /api/flow-actions/{id}/flow\n\nGet the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_for_flow_action.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('flow-actions/{id}/flow', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2167
2167
  "tags": [
2168
2168
  "klaviyo",
2169
2169
  "openapi",
@@ -2176,7 +2176,7 @@
2176
2176
  "platform": "klaviyo",
2177
2177
  "category": "method",
2178
2178
  "summary": "Get Flow ID for Flow Action",
2179
- "content": "## GET /api/flow-actions/{id}/relationships/flow\n\nGet the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_id_for_flow_action.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('api/flow-actions/{id}/relationships/flow', ...)` to call this endpoint.",
2179
+ "content": "## GET /api/flow-actions/{id}/relationships/flow\n\nGet the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_id_for_flow_action.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('flow-actions/{id}/relationships/flow', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2180
2180
  "tags": [
2181
2181
  "klaviyo",
2182
2182
  "openapi",
@@ -2189,7 +2189,7 @@
2189
2189
  "platform": "klaviyo",
2190
2190
  "category": "method",
2191
2191
  "summary": "Get Flow IDs for Tag",
2192
- "content": "## GET /api/tags/{id}/relationships/flows\n\nReturns the IDs of all flows associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_ids_for_tag.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.get('api/tags/{id}/relationships/flows', ...)` to call this endpoint.",
2192
+ "content": "## GET /api/tags/{id}/relationships/flows\n\nReturns the IDs of all flows associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_ids_for_tag.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.get('tags/{id}/relationships/flows', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2193
2193
  "tags": [
2194
2194
  "klaviyo",
2195
2195
  "openapi",
@@ -2202,7 +2202,7 @@
2202
2202
  "platform": "klaviyo",
2203
2203
  "category": "method",
2204
2204
  "summary": "Get Flow Message",
2205
- "content": "## GET /api/flow-messages/{id}\n\nGet a flow message from a flow with the given flow message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_message.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[flow-action]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[flow-message]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[template]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/flow-messages/{id}', ...)` to call this endpoint.",
2205
+ "content": "## GET /api/flow-messages/{id}\n\nGet a flow message from a flow with the given flow message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_message.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[flow-action]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[flow-message]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[template]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('flow-messages/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2206
2206
  "tags": [
2207
2207
  "klaviyo",
2208
2208
  "openapi",
@@ -2215,7 +2215,7 @@
2215
2215
  "platform": "klaviyo",
2216
2216
  "category": "method",
2217
2217
  "summary": "Get Flows",
2218
- "content": "## GET /api/flows\n\nGet all flows in an account.\n\nReturns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flows.json)\n\n**Parameters:**\n- `fields[flow-action]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`status`: `equals`<br>`archived`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`trigger_type`: `equals`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 50. Min: 1. Max: 50.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/flows', ...)` to call this endpoint.",
2218
+ "content": "## GET /api/flows\n\nGet all flows in an account.\n\nReturns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flows.json)\n\n**Parameters:**\n- `fields[flow-action]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`status`: `equals`<br>`archived`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`trigger_type`: `equals`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 50. Min: 1. Max: 50.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('flows', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2219
2219
  "tags": [
2220
2220
  "klaviyo",
2221
2221
  "openapi",
@@ -2228,7 +2228,7 @@
2228
2228
  "platform": "klaviyo",
2229
2229
  "category": "method",
2230
2230
  "summary": "Get Flows Triggered by List",
2231
- "content": "## GET /api/lists/{id}/flow-triggers\n\nGet all flows where the given list ID is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n`lists:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flows_triggered_by_list.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this list. Generated by Klaviyo.\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/lists/{id}/flow-triggers', ...)` to call this endpoint.",
2231
+ "content": "## GET /api/lists/{id}/flow-triggers\n\nGet all flows where the given list ID is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n`lists:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flows_triggered_by_list.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this list. Generated by Klaviyo.\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('lists/{id}/flow-triggers', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2232
2232
  "tags": [
2233
2233
  "klaviyo",
2234
2234
  "openapi",
@@ -2241,7 +2241,7 @@
2241
2241
  "platform": "klaviyo",
2242
2242
  "category": "method",
2243
2243
  "summary": "Get Flows Triggered by Metric",
2244
- "content": "## GET /api/metrics/{id}/flow-triggers\n\nGet all flows where the given metric is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`flows:read`\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flows_triggered_by_metric.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/metrics/{id}/flow-triggers', ...)` to call this endpoint.",
2244
+ "content": "## GET /api/metrics/{id}/flow-triggers\n\nGet all flows where the given metric is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`flows:read`\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flows_triggered_by_metric.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('metrics/{id}/flow-triggers', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2245
2245
  "tags": [
2246
2246
  "klaviyo",
2247
2247
  "openapi",
@@ -2254,7 +2254,7 @@
2254
2254
  "platform": "klaviyo",
2255
2255
  "category": "method",
2256
2256
  "summary": "Get Flows Triggered by Segment",
2257
- "content": "## GET /api/segments/{id}/flow-triggers\n\nGet all flows where the given segment ID is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flows_triggered_by_segment.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this segment. Generated by Klaviyo.\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/segments/{id}/flow-triggers', ...)` to call this endpoint.",
2257
+ "content": "## GET /api/segments/{id}/flow-triggers\n\nGet all flows where the given segment ID is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flows_triggered_by_segment.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this segment. Generated by Klaviyo.\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('segments/{id}/flow-triggers', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2258
2258
  "tags": [
2259
2259
  "klaviyo",
2260
2260
  "openapi",
@@ -2267,7 +2267,7 @@
2267
2267
  "platform": "klaviyo",
2268
2268
  "category": "method",
2269
2269
  "summary": "Get Form",
2270
- "content": "## GET /api/forms/{id}\n\nGet the form with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form.json)\n\n**Parameters:**\n- `id` (required) — The ID of the form\n- `fields[form]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/forms/{id}', ...)` to call this endpoint.",
2270
+ "content": "## GET /api/forms/{id}\n\nGet the form with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form.json)\n\n**Parameters:**\n- `id` (required) — The ID of the form\n- `fields[form]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('forms/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2271
2271
  "tags": [
2272
2272
  "klaviyo",
2273
2273
  "openapi",
@@ -2280,7 +2280,7 @@
2280
2280
  "platform": "klaviyo",
2281
2281
  "category": "method",
2282
2282
  "summary": "Get Form for Form Version",
2283
- "content": "## GET /api/form-versions/{id}/form\n\nGet the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form_for_form_version.json)\n\n**Parameters:**\n- `id` (required) — The ID of the form version\n- `fields[form]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/form-versions/{id}/form', ...)` to call this endpoint.",
2283
+ "content": "## GET /api/form-versions/{id}/form\n\nGet the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form_for_form_version.json)\n\n**Parameters:**\n- `id` (required) — The ID of the form version\n- `fields[form]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('form-versions/{id}/form', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2284
2284
  "tags": [
2285
2285
  "klaviyo",
2286
2286
  "openapi",
@@ -2293,7 +2293,7 @@
2293
2293
  "platform": "klaviyo",
2294
2294
  "category": "method",
2295
2295
  "summary": "Get Form ID for Form Version",
2296
- "content": "## GET /api/form-versions/{id}/relationships/form\n\nGet the ID of the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form_id_for_form_version.json)\n\n**Parameters:**\n- `id` (required) — The ID of the form version\n\nUse `klaviyo.get('api/form-versions/{id}/relationships/form', ...)` to call this endpoint.",
2296
+ "content": "## GET /api/form-versions/{id}/relationships/form\n\nGet the ID of the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form_id_for_form_version.json)\n\n**Parameters:**\n- `id` (required) — The ID of the form version\n\nUse `klaviyo.get('form-versions/{id}/relationships/form', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2297
2297
  "tags": [
2298
2298
  "klaviyo",
2299
2299
  "openapi",
@@ -2306,7 +2306,7 @@
2306
2306
  "platform": "klaviyo",
2307
2307
  "category": "method",
2308
2308
  "summary": "Get Form Version",
2309
- "content": "## GET /api/form-versions/{id}\n\nGet the form version with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form_version.json)\n\n**Parameters:**\n- `id` (required) — The ID of the form version\n- `fields[form-version]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/form-versions/{id}', ...)` to call this endpoint.",
2309
+ "content": "## GET /api/form-versions/{id}\n\nGet the form version with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form_version.json)\n\n**Parameters:**\n- `id` (required) — The ID of the form version\n- `fields[form-version]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('form-versions/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2310
2310
  "tags": [
2311
2311
  "klaviyo",
2312
2312
  "openapi",
@@ -2319,7 +2319,7 @@
2319
2319
  "platform": "klaviyo",
2320
2320
  "category": "method",
2321
2321
  "summary": "Get Forms",
2322
- "content": "## GET /api/forms\n\nGet all forms in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_forms.json)\n\n**Parameters:**\n- `fields[form]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `contains`, `equals`<br>`ab_test`: `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/forms', ...)` to call this endpoint.",
2322
+ "content": "## GET /api/forms\n\nGet all forms in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_forms.json)\n\n**Parameters:**\n- `fields[form]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `contains`, `equals`<br>`ab_test`: `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('forms', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2323
2323
  "tags": [
2324
2324
  "klaviyo",
2325
2325
  "openapi",
@@ -2332,7 +2332,7 @@
2332
2332
  "platform": "klaviyo",
2333
2333
  "category": "method",
2334
2334
  "summary": "Get IDs for Flows Triggered by List",
2335
- "content": "## GET /api/lists/{id}/relationships/flow-triggers\n\nGet the IDs of all flows where the given list is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n`lists:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_ids_for_flows_triggered_by_list.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this list. Generated by Klaviyo.\n\nUse `klaviyo.get('api/lists/{id}/relationships/flow-triggers', ...)` to call this endpoint.",
2335
+ "content": "## GET /api/lists/{id}/relationships/flow-triggers\n\nGet the IDs of all flows where the given list is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n`lists:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_ids_for_flows_triggered_by_list.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this list. Generated by Klaviyo.\n\nUse `klaviyo.get('lists/{id}/relationships/flow-triggers', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2336
2336
  "tags": [
2337
2337
  "klaviyo",
2338
2338
  "openapi",
@@ -2345,7 +2345,7 @@
2345
2345
  "platform": "klaviyo",
2346
2346
  "category": "method",
2347
2347
  "summary": "Get IDs for Flows Triggered by Metric",
2348
- "content": "## GET /api/metrics/{id}/relationships/flow-triggers\n\nGet the IDs of all flows where the given metric is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`flows:read`\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_ids_for_flows_triggered_by_metric.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('api/metrics/{id}/relationships/flow-triggers', ...)` to call this endpoint.",
2348
+ "content": "## GET /api/metrics/{id}/relationships/flow-triggers\n\nGet the IDs of all flows where the given metric is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`flows:read`\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_ids_for_flows_triggered_by_metric.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('metrics/{id}/relationships/flow-triggers', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2349
2349
  "tags": [
2350
2350
  "klaviyo",
2351
2351
  "openapi",
@@ -2358,7 +2358,7 @@
2358
2358
  "platform": "klaviyo",
2359
2359
  "category": "method",
2360
2360
  "summary": "Get IDs for Flows Triggered by Segment",
2361
- "content": "## GET /api/segments/{id}/relationships/flow-triggers\n\nGet the IDs of all flows where the given segment is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_ids_for_flows_triggered_by_segment.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this segment. Generated by Klaviyo.\n\nUse `klaviyo.get('api/segments/{id}/relationships/flow-triggers', ...)` to call this endpoint.",
2361
+ "content": "## GET /api/segments/{id}/relationships/flow-triggers\n\nGet the IDs of all flows where the given segment is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_ids_for_flows_triggered_by_segment.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this segment. Generated by Klaviyo.\n\nUse `klaviyo.get('segments/{id}/relationships/flow-triggers', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2362
2362
  "tags": [
2363
2363
  "klaviyo",
2364
2364
  "openapi",
@@ -2371,7 +2371,7 @@
2371
2371
  "platform": "klaviyo",
2372
2372
  "category": "method",
2373
2373
  "summary": "Get Image",
2374
- "content": "## GET /api/images/{id}\n\nGet the image with the given image ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`images:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_image.json)\n\n**Parameters:**\n- `id` (required) — The ID of the image\n- `fields[image]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/images/{id}', ...)` to call this endpoint.",
2374
+ "content": "## GET /api/images/{id}\n\nGet the image with the given image ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`images:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_image.json)\n\n**Parameters:**\n- `id` (required) — The ID of the image\n- `fields[image]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('images/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2375
2375
  "tags": [
2376
2376
  "klaviyo",
2377
2377
  "openapi",
@@ -2384,7 +2384,7 @@
2384
2384
  "platform": "klaviyo",
2385
2385
  "category": "method",
2386
2386
  "summary": "Get Image for Campaign Message",
2387
- "content": "## GET /api/campaign-messages/{id}/image\n\nReturn the related image for a given campaign message<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n`images:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_image_for_campaign_message.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[image]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/campaign-messages/{id}/image', ...)` to call this endpoint.",
2387
+ "content": "## GET /api/campaign-messages/{id}/image\n\nReturn the related image for a given campaign message<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n`images:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_image_for_campaign_message.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[image]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('campaign-messages/{id}/image', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2388
2388
  "tags": [
2389
2389
  "klaviyo",
2390
2390
  "openapi",
@@ -2397,7 +2397,7 @@
2397
2397
  "platform": "klaviyo",
2398
2398
  "category": "method",
2399
2399
  "summary": "Get Image ID for Campaign Message",
2400
- "content": "## GET /api/campaign-messages/{id}/relationships/image\n\nReturns the ID of the related image<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n`images:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_image_id_for_campaign_message.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('api/campaign-messages/{id}/relationships/image', ...)` to call this endpoint.",
2400
+ "content": "## GET /api/campaign-messages/{id}/relationships/image\n\nReturns the ID of the related image<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n`images:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_image_id_for_campaign_message.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('campaign-messages/{id}/relationships/image', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2401
2401
  "tags": [
2402
2402
  "klaviyo",
2403
2403
  "openapi",
@@ -2410,7 +2410,7 @@
2410
2410
  "platform": "klaviyo",
2411
2411
  "category": "method",
2412
2412
  "summary": "Get Images",
2413
- "content": "## GET /api/images\n\nGet all images in an account.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`images:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_images.json)\n\n**Parameters:**\n- `fields[image]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`format`: `any`, `equals`<br>`name`: `any`, `contains`, `ends-with`, `equals`, `starts-with`<br>`size`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`hidden`: `any`, `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/images', ...)` to call this endpoint.",
2413
+ "content": "## GET /api/images\n\nGet all images in an account.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`images:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_images.json)\n\n**Parameters:**\n- `fields[image]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`format`: `any`, `equals`<br>`name`: `any`, `contains`, `ends-with`, `equals`, `starts-with`<br>`size`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`hidden`: `any`, `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('images', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2414
2414
  "tags": [
2415
2415
  "klaviyo",
2416
2416
  "openapi",
@@ -2423,7 +2423,7 @@
2423
2423
  "platform": "klaviyo",
2424
2424
  "category": "method",
2425
2425
  "summary": "Get Item IDs for Catalog Category",
2426
- "content": "## GET /api/catalog-categories/{id}/relationships/items\n\nGet all items in the given category ID. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_item_ids_for_catalog_category.json)\n\n**Parameters:**\n- `id` (required) — The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/catalog-categories/{id}/relationships/items', ...)` to call this endpoint.",
2426
+ "content": "## GET /api/catalog-categories/{id}/relationships/items\n\nGet all items in the given category ID. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_item_ids_for_catalog_category.json)\n\n**Parameters:**\n- `id` (required) — The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('catalog-categories/{id}/relationships/items', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2427
2427
  "tags": [
2428
2428
  "klaviyo",
2429
2429
  "openapi",
@@ -2436,7 +2436,7 @@
2436
2436
  "platform": "klaviyo",
2437
2437
  "category": "method",
2438
2438
  "summary": "Get Items for Catalog Category",
2439
- "content": "## GET /api/catalog-categories/{id}/items\n\nGet all items in a category with the given category ID.\n\nItems can be sorted by the following fields, in ascending and descending order:\n`created`\n\nReturns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_items_for_catalog_category.json)\n\n**Parameters:**\n- `id` (required) — The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n- `fields[catalog-item]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[catalog-variant]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/catalog-categories/{id}/items', ...)` to call this endpoint.",
2439
+ "content": "## GET /api/catalog-categories/{id}/items\n\nGet all items in a category with the given category ID.\n\nItems can be sorted by the following fields, in ascending and descending order:\n`created`\n\nReturns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_items_for_catalog_category.json)\n\n**Parameters:**\n- `id` (required) — The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n- `fields[catalog-item]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[catalog-variant]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('catalog-categories/{id}/items', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2440
2440
  "tags": [
2441
2441
  "klaviyo",
2442
2442
  "openapi",
@@ -2449,7 +2449,7 @@
2449
2449
  "platform": "klaviyo",
2450
2450
  "category": "method",
2451
2451
  "summary": "Get List",
2452
- "content": "## GET /api/lists/{id}\n\nGet a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `additional-fields[list]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-04-15/docs/rate_limits_and_error_handling) guide.\n\n**Scopes:**\n`lists:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this list. Generated by Klaviyo.\n- `additional-fields[list]` — Request additional fields not included by default in the response. Supported values: 'profile_count'\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[list]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/lists/{id}', ...)` to call this endpoint.",
2452
+ "content": "## GET /api/lists/{id}\n\nGet a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `additional-fields[list]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-04-15/docs/rate_limits_and_error_handling) guide.\n\n**Scopes:**\n`lists:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this list. Generated by Klaviyo.\n- `additional-fields[list]` — Request additional fields not included by default in the response. Supported values: 'profile_count'\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[list]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('lists/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2453
2453
  "tags": [
2454
2454
  "klaviyo",
2455
2455
  "openapi",
@@ -2462,7 +2462,7 @@
2462
2462
  "platform": "klaviyo",
2463
2463
  "category": "method",
2464
2464
  "summary": "Get List for Bulk Import Profiles Job",
2465
- "content": "## GET /api/profile-bulk-import-jobs/{id}/lists\n\nGet list for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_for_bulk_import_profiles_job.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[list]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/profile-bulk-import-jobs/{id}/lists', ...)` to call this endpoint.",
2465
+ "content": "## GET /api/profile-bulk-import-jobs/{id}/lists\n\nGet list for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_for_bulk_import_profiles_job.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[list]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('profile-bulk-import-jobs/{id}/lists', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2466
2466
  "tags": [
2467
2467
  "klaviyo",
2468
2468
  "openapi",
@@ -2475,7 +2475,7 @@
2475
2475
  "platform": "klaviyo",
2476
2476
  "category": "method",
2477
2477
  "summary": "Get List IDs for Bulk Import Profiles Job",
2478
- "content": "## GET /api/profile-bulk-import-jobs/{id}/relationships/lists\n\nGet list relationship for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_ids_for_bulk_import_profiles_job.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('api/profile-bulk-import-jobs/{id}/relationships/lists', ...)` to call this endpoint.",
2478
+ "content": "## GET /api/profile-bulk-import-jobs/{id}/relationships/lists\n\nGet list relationship for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_ids_for_bulk_import_profiles_job.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('profile-bulk-import-jobs/{id}/relationships/lists', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2479
2479
  "tags": [
2480
2480
  "klaviyo",
2481
2481
  "openapi",
@@ -2488,7 +2488,7 @@
2488
2488
  "platform": "klaviyo",
2489
2489
  "category": "method",
2490
2490
  "summary": "Get List IDs for Profile",
2491
- "content": "## GET /api/profiles/{id}/relationships/lists\n\nGet list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`lists:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_ids_for_profile.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('api/profiles/{id}/relationships/lists', ...)` to call this endpoint.",
2491
+ "content": "## GET /api/profiles/{id}/relationships/lists\n\nGet list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`lists:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_ids_for_profile.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('profiles/{id}/relationships/lists', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2492
2492
  "tags": [
2493
2493
  "klaviyo",
2494
2494
  "openapi",
@@ -2501,7 +2501,7 @@
2501
2501
  "platform": "klaviyo",
2502
2502
  "category": "method",
2503
2503
  "summary": "Get List IDs for Tag",
2504
- "content": "## GET /api/tags/{id}/relationships/lists\n\nReturns the IDs of all lists associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`lists:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_ids_for_tag.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.get('api/tags/{id}/relationships/lists', ...)` to call this endpoint.",
2504
+ "content": "## GET /api/tags/{id}/relationships/lists\n\nReturns the IDs of all lists associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`lists:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_ids_for_tag.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.get('tags/{id}/relationships/lists', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2505
2505
  "tags": [
2506
2506
  "klaviyo",
2507
2507
  "openapi",
@@ -2514,7 +2514,7 @@
2514
2514
  "platform": "klaviyo",
2515
2515
  "category": "method",
2516
2516
  "summary": "Get Lists",
2517
- "content": "## GET /api/lists\n\nGet all lists in an account.\n\nFilter to request a subset of all lists. Lists can be filtered by `id`, `name`, `created`, and `updated` fields.\n\nReturns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`lists:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_lists.json)\n\n**Parameters:**\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[list]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 10. Min: 1. Max: 10.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/lists', ...)` to call this endpoint.",
2517
+ "content": "## GET /api/lists\n\nGet all lists in an account.\n\nFilter to request a subset of all lists. Lists can be filtered by `id`, `name`, `created`, and `updated` fields.\n\nReturns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`lists:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_lists.json)\n\n**Parameters:**\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[list]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 10. Min: 1. Max: 10.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('lists', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2518
2518
  "tags": [
2519
2519
  "klaviyo",
2520
2520
  "openapi",
@@ -2527,7 +2527,7 @@
2527
2527
  "platform": "klaviyo",
2528
2528
  "category": "method",
2529
2529
  "summary": "Get Lists for Profile",
2530
- "content": "## GET /api/profiles/{id}/lists\n\nGet list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`lists:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_lists_for_profile.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[list]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/profiles/{id}/lists', ...)` to call this endpoint.",
2530
+ "content": "## GET /api/profiles/{id}/lists\n\nGet list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`lists:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_lists_for_profile.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[list]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('profiles/{id}/lists', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2531
2531
  "tags": [
2532
2532
  "klaviyo",
2533
2533
  "openapi",
@@ -2540,7 +2540,7 @@
2540
2540
  "platform": "klaviyo",
2541
2541
  "category": "method",
2542
2542
  "summary": "Get Mapped Metric",
2543
- "content": "## GET /api/mapped-metrics/{id}\n\nGet the mapped metric with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_mapped_metric.json)\n\n**Parameters:**\n- `id` (required) — The type of mapping.\n- `fields[custom-metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[mapped-metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/mapped-metrics/{id}', ...)` to call this endpoint.",
2543
+ "content": "## GET /api/mapped-metrics/{id}\n\nGet the mapped metric with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_mapped_metric.json)\n\n**Parameters:**\n- `id` (required) — The type of mapping.\n- `fields[custom-metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[mapped-metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('mapped-metrics/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2544
2544
  "tags": [
2545
2545
  "klaviyo",
2546
2546
  "openapi",
@@ -2553,7 +2553,7 @@
2553
2553
  "platform": "klaviyo",
2554
2554
  "category": "method",
2555
2555
  "summary": "Get Mapped Metrics",
2556
- "content": "## GET /api/mapped-metrics\n\nGet all mapped metrics in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_mapped_metrics.json)\n\n**Parameters:**\n- `fields[custom-metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[mapped-metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/mapped-metrics', ...)` to call this endpoint.",
2556
+ "content": "## GET /api/mapped-metrics\n\nGet all mapped metrics in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_mapped_metrics.json)\n\n**Parameters:**\n- `fields[custom-metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[mapped-metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('mapped-metrics', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2557
2557
  "tags": [
2558
2558
  "klaviyo",
2559
2559
  "openapi",
@@ -2566,7 +2566,7 @@
2566
2566
  "platform": "klaviyo",
2567
2567
  "category": "method",
2568
2568
  "summary": "Get Message IDs for Campaign",
2569
- "content": "## GET /api/campaigns/{id}/relationships/campaign-messages\n\nReturns the IDs of all messages associated with the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_message_ids_for_campaign.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('api/campaigns/{id}/relationships/campaign-messages', ...)` to call this endpoint.",
2569
+ "content": "## GET /api/campaigns/{id}/relationships/campaign-messages\n\nReturns the IDs of all messages associated with the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_message_ids_for_campaign.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('campaigns/{id}/relationships/campaign-messages', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2570
2570
  "tags": [
2571
2571
  "klaviyo",
2572
2572
  "openapi",
@@ -2579,7 +2579,7 @@
2579
2579
  "platform": "klaviyo",
2580
2580
  "category": "method",
2581
2581
  "summary": "Get Message IDs for Flow Action",
2582
- "content": "## GET /api/flow-actions/{id}/relationships/flow-messages\n\nGet all relationships for flow messages associated with the given flow action ID.\n\nReturns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_message_ids_for_flow_action.json)\n\n**Parameters:**\n- `id` (required)\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 50. Min: 1. Max: 50.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/flow-actions/{id}/relationships/flow-messages', ...)` to call this endpoint.",
2582
+ "content": "## GET /api/flow-actions/{id}/relationships/flow-messages\n\nGet all relationships for flow messages associated with the given flow action ID.\n\nReturns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_message_ids_for_flow_action.json)\n\n**Parameters:**\n- `id` (required)\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 50. Min: 1. Max: 50.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('flow-actions/{id}/relationships/flow-messages', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2583
2583
  "tags": [
2584
2584
  "klaviyo",
2585
2585
  "openapi",
@@ -2592,7 +2592,7 @@
2592
2592
  "platform": "klaviyo",
2593
2593
  "category": "method",
2594
2594
  "summary": "Get Messages for Campaign",
2595
- "content": "## GET /api/campaigns/{id}/campaign-messages\n\nReturn all messages that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_messages_for_campaign.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[campaign-message]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[campaign]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[image]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[template]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/campaigns/{id}/campaign-messages', ...)` to call this endpoint.",
2595
+ "content": "## GET /api/campaigns/{id}/campaign-messages\n\nReturn all messages that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_messages_for_campaign.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[campaign-message]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[campaign]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[image]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[template]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('campaigns/{id}/campaign-messages', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2596
2596
  "tags": [
2597
2597
  "klaviyo",
2598
2598
  "openapi",
@@ -2605,7 +2605,7 @@
2605
2605
  "platform": "klaviyo",
2606
2606
  "category": "method",
2607
2607
  "summary": "Get Metric",
2608
- "content": "## GET /api/metrics/{id}\n\nGet a metric with the given metric ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric.json)\n\n**Parameters:**\n- `id` (required) — Metric ID\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/metrics/{id}', ...)` to call this endpoint.",
2608
+ "content": "## GET /api/metrics/{id}\n\nGet a metric with the given metric ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric.json)\n\n**Parameters:**\n- `id` (required) — Metric ID\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('metrics/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2609
2609
  "tags": [
2610
2610
  "klaviyo",
2611
2611
  "openapi",
@@ -2618,7 +2618,7 @@
2618
2618
  "platform": "klaviyo",
2619
2619
  "category": "method",
2620
2620
  "summary": "Get Metric for Event",
2621
- "content": "## GET /api/events/{id}/metric\n\nGet the metric for an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`events:read`\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_for_event.json)\n\n**Parameters:**\n- `id` (required) — ID of the event\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/events/{id}/metric', ...)` to call this endpoint.",
2621
+ "content": "## GET /api/events/{id}/metric\n\nGet the metric for an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`events:read`\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_for_event.json)\n\n**Parameters:**\n- `id` (required) — ID of the event\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('events/{id}/metric', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2622
2622
  "tags": [
2623
2623
  "klaviyo",
2624
2624
  "openapi",
@@ -2631,7 +2631,7 @@
2631
2631
  "platform": "klaviyo",
2632
2632
  "category": "method",
2633
2633
  "summary": "Get Metric for Mapped Metric",
2634
- "content": "## GET /api/mapped-metrics/{id}/metric\n\nGet the metric for the given mapped metric ID (if applicable).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_for_mapped_metric.json)\n\n**Parameters:**\n- `id` (required) — The type of mapping.\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/mapped-metrics/{id}/metric', ...)` to call this endpoint.",
2634
+ "content": "## GET /api/mapped-metrics/{id}/metric\n\nGet the metric for the given mapped metric ID (if applicable).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_for_mapped_metric.json)\n\n**Parameters:**\n- `id` (required) — The type of mapping.\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('mapped-metrics/{id}/metric', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2635
2635
  "tags": [
2636
2636
  "klaviyo",
2637
2637
  "openapi",
@@ -2644,7 +2644,7 @@
2644
2644
  "platform": "klaviyo",
2645
2645
  "category": "method",
2646
2646
  "summary": "Get Metric for Metric Property",
2647
- "content": "## GET /api/metric-properties/{id}/metric\n\nGet the metric for the given metric property ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_for_metric_property.json)\n\n**Parameters:**\n- `id` (required) — The ID of the metric property\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/metric-properties/{id}/metric', ...)` to call this endpoint.",
2647
+ "content": "## GET /api/metric-properties/{id}/metric\n\nGet the metric for the given metric property ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_for_metric_property.json)\n\n**Parameters:**\n- `id` (required) — The ID of the metric property\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('metric-properties/{id}/metric', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2648
2648
  "tags": [
2649
2649
  "klaviyo",
2650
2650
  "openapi",
@@ -2657,7 +2657,7 @@
2657
2657
  "platform": "klaviyo",
2658
2658
  "category": "method",
2659
2659
  "summary": "Get Metric ID for Event",
2660
- "content": "## GET /api/events/{id}/relationships/metric\n\nGet a list of related Metrics for an Event<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`events:read`\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_id_for_event.json)\n\n**Parameters:**\n- `id` (required) — ID of the event\n\nUse `klaviyo.get('api/events/{id}/relationships/metric', ...)` to call this endpoint.",
2660
+ "content": "## GET /api/events/{id}/relationships/metric\n\nGet a list of related Metrics for an Event<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`events:read`\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_id_for_event.json)\n\n**Parameters:**\n- `id` (required) — ID of the event\n\nUse `klaviyo.get('events/{id}/relationships/metric', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2661
2661
  "tags": [
2662
2662
  "klaviyo",
2663
2663
  "openapi",
@@ -2670,7 +2670,7 @@
2670
2670
  "platform": "klaviyo",
2671
2671
  "category": "method",
2672
2672
  "summary": "Get Metric ID for Mapped Metric",
2673
- "content": "## GET /api/mapped-metrics/{id}/relationships/metric\n\nGet the ID of the metric for the given mapped metric.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_id_for_mapped_metric.json)\n\n**Parameters:**\n- `id` (required) — The type of mapping.\n\nUse `klaviyo.get('api/mapped-metrics/{id}/relationships/metric', ...)` to call this endpoint.",
2673
+ "content": "## GET /api/mapped-metrics/{id}/relationships/metric\n\nGet the ID of the metric for the given mapped metric.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_id_for_mapped_metric.json)\n\n**Parameters:**\n- `id` (required) — The type of mapping.\n\nUse `klaviyo.get('mapped-metrics/{id}/relationships/metric', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2674
2674
  "tags": [
2675
2675
  "klaviyo",
2676
2676
  "openapi",
@@ -2683,7 +2683,7 @@
2683
2683
  "platform": "klaviyo",
2684
2684
  "category": "method",
2685
2685
  "summary": "Get Metric ID for Metric Property",
2686
- "content": "## GET /api/metric-properties/{id}/relationships/metric\n\nGet the ID of the metric for the given metric property.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_id_for_metric_property.json)\n\n**Parameters:**\n- `id` (required) — The ID of the metric property\n\nUse `klaviyo.get('api/metric-properties/{id}/relationships/metric', ...)` to call this endpoint.",
2686
+ "content": "## GET /api/metric-properties/{id}/relationships/metric\n\nGet the ID of the metric for the given metric property.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_id_for_metric_property.json)\n\n**Parameters:**\n- `id` (required) — The ID of the metric property\n\nUse `klaviyo.get('metric-properties/{id}/relationships/metric', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2687
2687
  "tags": [
2688
2688
  "klaviyo",
2689
2689
  "openapi",
@@ -2696,7 +2696,7 @@
2696
2696
  "platform": "klaviyo",
2697
2697
  "category": "method",
2698
2698
  "summary": "Get Metric IDs for Custom Metric",
2699
- "content": "## GET /api/custom-metrics/{id}/relationships/metrics\n\nGet all metrics for the given custom metric ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_ids_for_custom_metric.json)\n\n**Parameters:**\n- `id` (required) — The ID of the custom metric\n\nUse `klaviyo.get('api/custom-metrics/{id}/relationships/metrics', ...)` to call this endpoint.",
2699
+ "content": "## GET /api/custom-metrics/{id}/relationships/metrics\n\nGet all metrics for the given custom metric ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_ids_for_custom_metric.json)\n\n**Parameters:**\n- `id` (required) — The ID of the custom metric\n\nUse `klaviyo.get('custom-metrics/{id}/relationships/metrics', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2700
2700
  "tags": [
2701
2701
  "klaviyo",
2702
2702
  "openapi",
@@ -2709,7 +2709,7 @@
2709
2709
  "platform": "klaviyo",
2710
2710
  "category": "method",
2711
2711
  "summary": "Get Metric Property",
2712
- "content": "## GET /api/metric-properties/{id}\n\nGet a metric property with the given metric property ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_property.json)\n\n**Parameters:**\n- `id` (required) — The ID of the metric property\n- `additional-fields[metric-property]` — Request additional fields not included by default in the response. Supported values: 'sample_values'\n- `fields[metric-property]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/metric-properties/{id}', ...)` to call this endpoint.",
2712
+ "content": "## GET /api/metric-properties/{id}\n\nGet a metric property with the given metric property ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_property.json)\n\n**Parameters:**\n- `id` (required) — The ID of the metric property\n- `additional-fields[metric-property]` — Request additional fields not included by default in the response. Supported values: 'sample_values'\n- `fields[metric-property]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('metric-properties/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2713
2713
  "tags": [
2714
2714
  "klaviyo",
2715
2715
  "openapi",
@@ -2722,7 +2722,7 @@
2722
2722
  "platform": "klaviyo",
2723
2723
  "category": "method",
2724
2724
  "summary": "Get Metrics",
2725
- "content": "## GET /api/metrics\n\nGet all metrics in an account.\n\nRequests can be filtered by the following fields:\nintegration `name`, integration `category`\n\nReturns a maximum of 200 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metrics.json)\n\n**Parameters:**\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`integration.name`: `equals`<br>`integration.category`: `equals`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.get('api/metrics', ...)` to call this endpoint.",
2725
+ "content": "## GET /api/metrics\n\nGet all metrics in an account.\n\nRequests can be filtered by the following fields:\nintegration `name`, integration `category`\n\nReturns a maximum of 200 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metrics.json)\n\n**Parameters:**\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`integration.name`: `equals`<br>`integration.category`: `equals`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.get('metrics', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2726
2726
  "tags": [
2727
2727
  "klaviyo",
2728
2728
  "openapi",
@@ -2735,7 +2735,7 @@
2735
2735
  "platform": "klaviyo",
2736
2736
  "category": "method",
2737
2737
  "summary": "Get Metrics for Custom Metric",
2738
- "content": "## GET /api/custom-metrics/{id}/metrics\n\nGet all metrics for the given custom metric ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metrics_for_custom_metric.json)\n\n**Parameters:**\n- `id` (required) — The ID of the custom metric\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/custom-metrics/{id}/metrics', ...)` to call this endpoint.",
2738
+ "content": "## GET /api/custom-metrics/{id}/metrics\n\nGet all metrics for the given custom metric ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metrics_for_custom_metric.json)\n\n**Parameters:**\n- `id` (required) — The ID of the custom metric\n- `fields[metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('custom-metrics/{id}/metrics', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2739
2739
  "tags": [
2740
2740
  "klaviyo",
2741
2741
  "openapi",
@@ -2748,7 +2748,7 @@
2748
2748
  "platform": "klaviyo",
2749
2749
  "category": "method",
2750
2750
  "summary": "Get Profile",
2751
- "content": "## GET /api/profiles/{id}\n\nGet the profile with the given profile ID.\n\nUse the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `include=list` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>Rate limits when using the `include=segment` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `include` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-04-15/docs/rate_limits_and_error_handling) guide.\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile.json)\n\n**Parameters:**\n- `id` (required)\n- `additional-fields[profile]` — Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'\n- `fields[conversation]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[list]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[push-token]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[segment]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/profiles/{id}', ...)` to call this endpoint.",
2751
+ "content": "## GET /api/profiles/{id}\n\nGet the profile with the given profile ID.\n\nUse the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `include=list` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>Rate limits when using the `include=segment` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `include` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-04-15/docs/rate_limits_and_error_handling) guide.\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile.json)\n\n**Parameters:**\n- `id` (required)\n- `additional-fields[profile]` — Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'\n- `fields[conversation]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[list]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[push-token]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[segment]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('profiles/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2752
2752
  "tags": [
2753
2753
  "klaviyo",
2754
2754
  "openapi",
@@ -2761,7 +2761,7 @@
2761
2761
  "platform": "klaviyo",
2762
2762
  "category": "method",
2763
2763
  "summary": "Get Profile for Event",
2764
- "content": "## GET /api/events/{id}/profile\n\nGet the profile associated with an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`events:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_for_event.json)\n\n**Parameters:**\n- `id` (required) — ID of the event\n- `additional-fields[profile]` — Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/events/{id}/profile', ...)` to call this endpoint.",
2764
+ "content": "## GET /api/events/{id}/profile\n\nGet the profile associated with an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`events:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_for_event.json)\n\n**Parameters:**\n- `id` (required) — ID of the event\n- `additional-fields[profile]` — Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('events/{id}/profile', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2765
2765
  "tags": [
2766
2766
  "klaviyo",
2767
2767
  "openapi",
@@ -2774,7 +2774,7 @@
2774
2774
  "platform": "klaviyo",
2775
2775
  "category": "method",
2776
2776
  "summary": "Get Profile for Push Token",
2777
- "content": "## GET /api/push-tokens/{id}/profile\n\nReturn the profile associated with the given push token.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n`push-tokens:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_for_push_token.json)\n\n**Parameters:**\n- `id` (required) — The value of the push token\n- `additional-fields[profile]` — Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/push-tokens/{id}/profile', ...)` to call this endpoint.",
2777
+ "content": "## GET /api/push-tokens/{id}/profile\n\nReturn the profile associated with the given push token.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n`push-tokens:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_for_push_token.json)\n\n**Parameters:**\n- `id` (required) — The value of the push token\n- `additional-fields[profile]` — Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('push-tokens/{id}/profile', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2778
2778
  "tags": [
2779
2779
  "klaviyo",
2780
2780
  "openapi",
@@ -2787,7 +2787,7 @@
2787
2787
  "platform": "klaviyo",
2788
2788
  "category": "method",
2789
2789
  "summary": "Get Profile ID for Event",
2790
- "content": "## GET /api/events/{id}/relationships/profile\n\nGet profile [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`events:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_id_for_event.json)\n\n**Parameters:**\n- `id` (required) — ID of the event\n\nUse `klaviyo.get('api/events/{id}/relationships/profile', ...)` to call this endpoint.",
2790
+ "content": "## GET /api/events/{id}/relationships/profile\n\nGet profile [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`events:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_id_for_event.json)\n\n**Parameters:**\n- `id` (required) — ID of the event\n\nUse `klaviyo.get('events/{id}/relationships/profile', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2791
2791
  "tags": [
2792
2792
  "klaviyo",
2793
2793
  "openapi",
@@ -2800,7 +2800,7 @@
2800
2800
  "platform": "klaviyo",
2801
2801
  "category": "method",
2802
2802
  "summary": "Get Profile ID for Push Token",
2803
- "content": "## GET /api/push-tokens/{id}/relationships/profile\n\nReturn the ID of the profile associated with the given push token.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n`push-tokens:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_id_for_push_token.json)\n\n**Parameters:**\n- `id` (required) — The value of the push token\n\nUse `klaviyo.get('api/push-tokens/{id}/relationships/profile', ...)` to call this endpoint.",
2803
+ "content": "## GET /api/push-tokens/{id}/relationships/profile\n\nReturn the ID of the profile associated with the given push token.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n`push-tokens:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_id_for_push_token.json)\n\n**Parameters:**\n- `id` (required) — The value of the push token\n\nUse `klaviyo.get('push-tokens/{id}/relationships/profile', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2804
2804
  "tags": [
2805
2805
  "klaviyo",
2806
2806
  "openapi",
@@ -2813,7 +2813,7 @@
2813
2813
  "platform": "klaviyo",
2814
2814
  "category": "method",
2815
2815
  "summary": "Get Profile IDs for Bulk Import Profiles Job",
2816
- "content": "## GET /api/profile-bulk-import-jobs/{id}/relationships/profiles\n\nGet profile relationships for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_ids_for_bulk_import_profiles_job.json)\n\n**Parameters:**\n- `id` (required)\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n\nUse `klaviyo.get('api/profile-bulk-import-jobs/{id}/relationships/profiles', ...)` to call this endpoint.",
2816
+ "content": "## GET /api/profile-bulk-import-jobs/{id}/relationships/profiles\n\nGet profile relationships for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_ids_for_bulk_import_profiles_job.json)\n\n**Parameters:**\n- `id` (required)\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n\nUse `klaviyo.get('profile-bulk-import-jobs/{id}/relationships/profiles', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2817
2817
  "tags": [
2818
2818
  "klaviyo",
2819
2819
  "openapi",
@@ -2826,7 +2826,7 @@
2826
2826
  "platform": "klaviyo",
2827
2827
  "category": "method",
2828
2828
  "summary": "Get Profile IDs for List",
2829
- "content": "## GET /api/lists/{id}/relationships/profiles\n\nGet profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-04-15/docs/rate_limits_and_error_handling) guide.\n\n**Scopes:**\n`lists:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_ids_for_list.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this list. Generated by Klaviyo.\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/lists/{id}/relationships/profiles', ...)` to call this endpoint.",
2829
+ "content": "## GET /api/lists/{id}/relationships/profiles\n\nGet profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-04-15/docs/rate_limits_and_error_handling) guide.\n\n**Scopes:**\n`lists:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_ids_for_list.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this list. Generated by Klaviyo.\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('lists/{id}/relationships/profiles', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2830
2830
  "tags": [
2831
2831
  "klaviyo",
2832
2832
  "openapi",
@@ -2839,7 +2839,7 @@
2839
2839
  "platform": "klaviyo",
2840
2840
  "category": "method",
2841
2841
  "summary": "Get Profile IDs for Segment",
2842
- "content": "## GET /api/segments/{id}/relationships/profiles\n\nGet all profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`profiles:read`\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_ids_for_segment.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this segment. Generated by Klaviyo.\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`profile_id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/segments/{id}/relationships/profiles', ...)` to call this endpoint.",
2842
+ "content": "## GET /api/segments/{id}/relationships/profiles\n\nGet all profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`profiles:read`\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_ids_for_segment.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this segment. Generated by Klaviyo.\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`profile_id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('segments/{id}/relationships/profiles', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2843
2843
  "tags": [
2844
2844
  "klaviyo",
2845
2845
  "openapi",
@@ -2852,7 +2852,7 @@
2852
2852
  "platform": "klaviyo",
2853
2853
  "category": "method",
2854
2854
  "summary": "Get Profiles",
2855
- "content": "## GET /api/profiles\n\nGet all profiles in an account.\n\nProfiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp`\n\nUse the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-04-15/docs/rate_limits_and_error_handling) guide.\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles.json)\n\n**Parameters:**\n- `additional-fields[profile]` — Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'\n- `fields[conversation]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[push-token]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`external_id`: `any`, `equals`<br>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`<br>`updated`: `greater-than`, `less-than`<br>`subscriptions.email.marketing.list_suppressions.reason`: `equals`<br>`subscriptions.email.marketing.list_suppressions.timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`subscriptions.email.marketing.list_suppressions.list_id`: `equals`<br>`subscriptions.email.marketing.suppression.reason`: `equals`<br>`subscriptions.email.marketing.suppression.timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/profiles', ...)` to call this endpoint.",
2855
+ "content": "## GET /api/profiles\n\nGet all profiles in an account.\n\nProfiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp`\n\nUse the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-04-15/docs/rate_limits_and_error_handling) guide.\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles.json)\n\n**Parameters:**\n- `additional-fields[profile]` — Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'\n- `fields[conversation]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[push-token]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`external_id`: `any`, `equals`<br>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`<br>`updated`: `greater-than`, `less-than`<br>`subscriptions.email.marketing.list_suppressions.reason`: `equals`<br>`subscriptions.email.marketing.list_suppressions.timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`subscriptions.email.marketing.list_suppressions.list_id`: `equals`<br>`subscriptions.email.marketing.suppression.reason`: `equals`<br>`subscriptions.email.marketing.suppression.timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('profiles', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2856
2856
  "tags": [
2857
2857
  "klaviyo",
2858
2858
  "openapi",
@@ -2865,7 +2865,7 @@
2865
2865
  "platform": "klaviyo",
2866
2866
  "category": "method",
2867
2867
  "summary": "Get Profiles for Bulk Import Profiles Job",
2868
- "content": "## GET /api/profile-bulk-import-jobs/{id}/profiles\n\nGet profiles for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles_for_bulk_import_profiles_job.json)\n\n**Parameters:**\n- `id` (required)\n- `additional-fields[profile]` — Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n\nUse `klaviyo.get('api/profile-bulk-import-jobs/{id}/profiles', ...)` to call this endpoint.",
2868
+ "content": "## GET /api/profile-bulk-import-jobs/{id}/profiles\n\nGet profiles for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles_for_bulk_import_profiles_job.json)\n\n**Parameters:**\n- `id` (required)\n- `additional-fields[profile]` — Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n\nUse `klaviyo.get('profile-bulk-import-jobs/{id}/profiles', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2869
2869
  "tags": [
2870
2870
  "klaviyo",
2871
2871
  "openapi",
@@ -2878,7 +2878,7 @@
2878
2878
  "platform": "klaviyo",
2879
2879
  "category": "method",
2880
2880
  "summary": "Get Profiles for List",
2881
- "content": "## GET /api/lists/{id}/profiles\n\nGet all profiles within a list with the given list ID.\n\nFilter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-04-15/docs/rate_limits_and_error_handling) guide.\n\n**Scopes:**\n`lists:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles_for_list.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this list. Generated by Klaviyo.\n- `additional-fields[profile]` — Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/lists/{id}/profiles', ...)` to call this endpoint.",
2881
+ "content": "## GET /api/lists/{id}/profiles\n\nGet all profiles within a list with the given list ID.\n\nFilter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-04-15/docs/rate_limits_and_error_handling) guide.\n\n**Scopes:**\n`lists:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles_for_list.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this list. Generated by Klaviyo.\n- `additional-fields[profile]` — Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('lists/{id}/profiles', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2882
2882
  "tags": [
2883
2883
  "klaviyo",
2884
2884
  "openapi",
@@ -2891,7 +2891,7 @@
2891
2891
  "platform": "klaviyo",
2892
2892
  "category": "method",
2893
2893
  "summary": "Get Profiles for Segment",
2894
- "content": "## GET /api/segments/{id}/profiles\n\nGet all profiles within a segment with the given segment ID.\n\nFilter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`profiles:read`\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles_for_segment.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this segment. Generated by Klaviyo.\n- `additional-fields[profile]` — Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`profile_id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/segments/{id}/profiles', ...)` to call this endpoint.",
2894
+ "content": "## GET /api/segments/{id}/profiles\n\nGet all profiles within a segment with the given segment ID.\n\nFilter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`profiles:read`\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles_for_segment.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this segment. Generated by Klaviyo.\n- `additional-fields[profile]` — Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`profile_id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('segments/{id}/profiles', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2895
2895
  "tags": [
2896
2896
  "klaviyo",
2897
2897
  "openapi",
@@ -2904,7 +2904,7 @@
2904
2904
  "platform": "klaviyo",
2905
2905
  "category": "method",
2906
2906
  "summary": "Get Properties for Metric",
2907
- "content": "## GET /api/metrics/{id}/metric-properties\n\nGet the metric properties for the given metric ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_properties_for_metric.json)\n\n**Parameters:**\n- `id` (required) — The ID of the metric\n- `additional-fields[metric-property]` — Request additional fields not included by default in the response. Supported values: 'sample_values'\n- `fields[metric-property]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/metrics/{id}/metric-properties', ...)` to call this endpoint.",
2907
+ "content": "## GET /api/metrics/{id}/metric-properties\n\nGet the metric properties for the given metric ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_properties_for_metric.json)\n\n**Parameters:**\n- `id` (required) — The ID of the metric\n- `additional-fields[metric-property]` — Request additional fields not included by default in the response. Supported values: 'sample_values'\n- `fields[metric-property]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('metrics/{id}/metric-properties', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2908
2908
  "tags": [
2909
2909
  "klaviyo",
2910
2910
  "openapi",
@@ -2917,7 +2917,7 @@
2917
2917
  "platform": "klaviyo",
2918
2918
  "category": "method",
2919
2919
  "summary": "Get Property IDs for Metric",
2920
- "content": "## GET /api/metrics/{id}/relationships/metric-properties\n\nGet the IDs of metric properties for the given metric.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_property_ids_for_metric.json)\n\n**Parameters:**\n- `id` (required) — The ID of the metric\n\nUse `klaviyo.get('api/metrics/{id}/relationships/metric-properties', ...)` to call this endpoint.",
2920
+ "content": "## GET /api/metrics/{id}/relationships/metric-properties\n\nGet the IDs of metric properties for the given metric.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_property_ids_for_metric.json)\n\n**Parameters:**\n- `id` (required) — The ID of the metric\n\nUse `klaviyo.get('metrics/{id}/relationships/metric-properties', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2921
2921
  "tags": [
2922
2922
  "klaviyo",
2923
2923
  "openapi",
@@ -2930,7 +2930,7 @@
2930
2930
  "platform": "klaviyo",
2931
2931
  "category": "method",
2932
2932
  "summary": "Get Push Token",
2933
- "content": "## GET /api/push-tokens/{id}\n\nReturn a specific push token based on its ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n`push-tokens:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_token.json)\n\n**Parameters:**\n- `id` (required) — The value of the push token\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[push-token]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/push-tokens/{id}', ...)` to call this endpoint.",
2933
+ "content": "## GET /api/push-tokens/{id}\n\nReturn a specific push token based on its ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n`push-tokens:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_token.json)\n\n**Parameters:**\n- `id` (required) — The value of the push token\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[push-token]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('push-tokens/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2934
2934
  "tags": [
2935
2935
  "klaviyo",
2936
2936
  "openapi",
@@ -2943,7 +2943,7 @@
2943
2943
  "platform": "klaviyo",
2944
2944
  "category": "method",
2945
2945
  "summary": "Get Push Token IDs for Profile",
2946
- "content": "## GET /api/profiles/{id}/relationships/push-tokens\n\nReturn the IDs of all push tokens associated with the given profile.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_token_ids_for_profile.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('api/profiles/{id}/relationships/push-tokens', ...)` to call this endpoint.",
2946
+ "content": "## GET /api/profiles/{id}/relationships/push-tokens\n\nReturn the IDs of all push tokens associated with the given profile.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_token_ids_for_profile.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('profiles/{id}/relationships/push-tokens', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2947
2947
  "tags": [
2948
2948
  "klaviyo",
2949
2949
  "openapi",
@@ -2956,7 +2956,7 @@
2956
2956
  "platform": "klaviyo",
2957
2957
  "category": "method",
2958
2958
  "summary": "Get Push Tokens",
2959
- "content": "## GET /api/push-tokens\n\nReturn push tokens associated with company.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n`push-tokens:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_tokens.json)\n\n**Parameters:**\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[push-token]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `equals`<br>`profile.id`: `equals`<br>`enablement_status`: `equals`<br>`platform`: `equals`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n\nUse `klaviyo.get('api/push-tokens', ...)` to call this endpoint.",
2959
+ "content": "## GET /api/push-tokens\n\nReturn push tokens associated with company.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n`push-tokens:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_tokens.json)\n\n**Parameters:**\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[push-token]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `equals`<br>`profile.id`: `equals`<br>`enablement_status`: `equals`<br>`platform`: `equals`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n\nUse `klaviyo.get('push-tokens', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2960
2960
  "tags": [
2961
2961
  "klaviyo",
2962
2962
  "openapi",
@@ -2969,7 +2969,7 @@
2969
2969
  "platform": "klaviyo",
2970
2970
  "category": "method",
2971
2971
  "summary": "Get Push Tokens for Profile",
2972
- "content": "## GET /api/profiles/{id}/push-tokens\n\nReturn all push tokens that belong to the given profile.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_tokens_for_profile.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[push-token]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/profiles/{id}/push-tokens', ...)` to call this endpoint.",
2972
+ "content": "## GET /api/profiles/{id}/push-tokens\n\nReturn all push tokens that belong to the given profile.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_tokens_for_profile.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[push-token]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('profiles/{id}/push-tokens', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2973
2973
  "tags": [
2974
2974
  "klaviyo",
2975
2975
  "openapi",
@@ -2982,7 +2982,7 @@
2982
2982
  "platform": "klaviyo",
2983
2983
  "category": "method",
2984
2984
  "summary": "Get Review",
2985
- "content": "## GET /api/reviews/{id}\n\nGet the review with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`reviews:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_review.json)\n\n**Parameters:**\n- `id` (required) — The ID of the review\n- `fields[event]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[review]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/reviews/{id}', ...)` to call this endpoint.",
2985
+ "content": "## GET /api/reviews/{id}\n\nGet the review with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`reviews:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_review.json)\n\n**Parameters:**\n- `id` (required) — The ID of the review\n- `fields[event]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[review]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('reviews/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2986
2986
  "tags": [
2987
2987
  "klaviyo",
2988
2988
  "openapi",
@@ -2995,7 +2995,7 @@
2995
2995
  "platform": "klaviyo",
2996
2996
  "category": "method",
2997
2997
  "summary": "Get Reviews",
2998
- "content": "## GET /api/reviews\n\nGet all reviews.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`reviews:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_reviews.json)\n\n**Parameters:**\n- `fields[event]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[review]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`created`: `greater-or-equal`, `less-or-equal`<br>`rating`: `any`, `equals`, `greater-or-equal`, `less-or-equal`<br>`id`: `any`, `equals`<br>`item.id`: `any`, `equals`<br>`content`: `contains`<br>`status`: `equals`<br>`review_type`: `equals`<br>`verified`: `equals`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/reviews', ...)` to call this endpoint.",
2998
+ "content": "## GET /api/reviews\n\nGet all reviews.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`reviews:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_reviews.json)\n\n**Parameters:**\n- `fields[event]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[review]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`created`: `greater-or-equal`, `less-or-equal`<br>`rating`: `any`, `equals`, `greater-or-equal`, `less-or-equal`<br>`id`: `any`, `equals`<br>`item.id`: `any`, `equals`<br>`content`: `contains`<br>`status`: `equals`<br>`review_type`: `equals`<br>`verified`: `equals`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('reviews', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
2999
2999
  "tags": [
3000
3000
  "klaviyo",
3001
3001
  "openapi",
@@ -3008,7 +3008,7 @@
3008
3008
  "platform": "klaviyo",
3009
3009
  "category": "method",
3010
3010
  "summary": "Get Segment",
3011
- "content": "## GET /api/segments/{id}\n\nGet a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-04-15/docs/rate_limits_and_error_handling) guide.\n\n**Scopes:**\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segment.json)\n\n**Parameters:**\n- `id` (required)\n- `additional-fields[segment]` — Request additional fields not included by default in the response. Supported values: 'profile_count'\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[segment]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/segments/{id}', ...)` to call this endpoint.",
3011
+ "content": "## GET /api/segments/{id}\n\nGet a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-04-15/docs/rate_limits_and_error_handling) guide.\n\n**Scopes:**\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segment.json)\n\n**Parameters:**\n- `id` (required)\n- `additional-fields[segment]` — Request additional fields not included by default in the response. Supported values: 'profile_count'\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[segment]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('segments/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3012
3012
  "tags": [
3013
3013
  "klaviyo",
3014
3014
  "openapi",
@@ -3021,7 +3021,7 @@
3021
3021
  "platform": "klaviyo",
3022
3022
  "category": "method",
3023
3023
  "summary": "Get Segment IDs for Profile",
3024
- "content": "## GET /api/profiles/{id}/relationships/segments\n\nGet segment membership relationships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`profiles:read`\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segment_ids_for_profile.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('api/profiles/{id}/relationships/segments', ...)` to call this endpoint.",
3024
+ "content": "## GET /api/profiles/{id}/relationships/segments\n\nGet segment membership relationships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`profiles:read`\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segment_ids_for_profile.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('profiles/{id}/relationships/segments', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3025
3025
  "tags": [
3026
3026
  "klaviyo",
3027
3027
  "openapi",
@@ -3034,7 +3034,7 @@
3034
3034
  "platform": "klaviyo",
3035
3035
  "category": "method",
3036
3036
  "summary": "Get Segment IDs for Tag",
3037
- "content": "## GET /api/tags/{id}/relationships/segments\n\nReturns the IDs of all segments associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`segments:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segment_ids_for_tag.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.get('api/tags/{id}/relationships/segments', ...)` to call this endpoint.",
3037
+ "content": "## GET /api/tags/{id}/relationships/segments\n\nReturns the IDs of all segments associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`segments:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segment_ids_for_tag.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.get('tags/{id}/relationships/segments', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3038
3038
  "tags": [
3039
3039
  "klaviyo",
3040
3040
  "openapi",
@@ -3047,7 +3047,7 @@
3047
3047
  "platform": "klaviyo",
3048
3048
  "category": "method",
3049
3049
  "summary": "Get Segments",
3050
- "content": "## GET /api/segments\n\nGet all segments in an account.\n\nFilter to request a subset of all segments. Segments can be filtered by `name`, `created`, and `updated` fields.\n\nReturns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segments.json)\n\n**Parameters:**\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[segment]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`<br>`is_active`: `any`, `equals`<br>`is_starred`: `equals`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 10. Min: 1. Max: 10.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/segments', ...)` to call this endpoint.",
3050
+ "content": "## GET /api/segments\n\nGet all segments in an account.\n\nFilter to request a subset of all segments. Segments can be filtered by `name`, `created`, and `updated` fields.\n\nReturns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segments.json)\n\n**Parameters:**\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[segment]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`<br>`is_active`: `any`, `equals`<br>`is_starred`: `equals`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 10. Min: 1. Max: 10.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('segments', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3051
3051
  "tags": [
3052
3052
  "klaviyo",
3053
3053
  "openapi",
@@ -3060,7 +3060,7 @@
3060
3060
  "platform": "klaviyo",
3061
3061
  "category": "method",
3062
3062
  "summary": "Get Segments for Profile",
3063
- "content": "## GET /api/profiles/{id}/segments\n\nGet segment memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`profiles:read`\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segments_for_profile.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[segment]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/profiles/{id}/segments', ...)` to call this endpoint.",
3063
+ "content": "## GET /api/profiles/{id}/segments\n\nGet segment memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`profiles:read`\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segments_for_profile.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[segment]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('profiles/{id}/segments', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3064
3064
  "tags": [
3065
3065
  "klaviyo",
3066
3066
  "openapi",
@@ -3073,7 +3073,7 @@
3073
3073
  "platform": "klaviyo",
3074
3074
  "category": "method",
3075
3075
  "summary": "Get Tag",
3076
- "content": "## GET /api/tags/{id}\n\nRetrieve the tag with the given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n- `fields[tag-group]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/tags/{id}', ...)` to call this endpoint.",
3076
+ "content": "## GET /api/tags/{id}\n\nRetrieve the tag with the given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n- `fields[tag-group]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('tags/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3077
3077
  "tags": [
3078
3078
  "klaviyo",
3079
3079
  "openapi",
@@ -3086,7 +3086,7 @@
3086
3086
  "platform": "klaviyo",
3087
3087
  "category": "method",
3088
3088
  "summary": "Get Tag Group",
3089
- "content": "## GET /api/tag-groups/{id}\n\nRetrieve the tag group with the given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_group.json)\n\n**Parameters:**\n- `id` (required) — The Tag Group ID\n- `fields[tag-group]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/tag-groups/{id}', ...)` to call this endpoint.",
3089
+ "content": "## GET /api/tag-groups/{id}\n\nRetrieve the tag group with the given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_group.json)\n\n**Parameters:**\n- `id` (required) — The Tag Group ID\n- `fields[tag-group]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('tag-groups/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3090
3090
  "tags": [
3091
3091
  "klaviyo",
3092
3092
  "openapi",
@@ -3099,7 +3099,7 @@
3099
3099
  "platform": "klaviyo",
3100
3100
  "category": "method",
3101
3101
  "summary": "Get Tag Group for Tag",
3102
- "content": "## GET /api/tags/{id}/tag-group\n\nReturns the tag group resource for a given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_group_for_tag.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n- `fields[tag-group]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/tags/{id}/tag-group', ...)` to call this endpoint.",
3102
+ "content": "## GET /api/tags/{id}/tag-group\n\nReturns the tag group resource for a given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_group_for_tag.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n- `fields[tag-group]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('tags/{id}/tag-group', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3103
3103
  "tags": [
3104
3104
  "klaviyo",
3105
3105
  "openapi",
@@ -3112,7 +3112,7 @@
3112
3112
  "platform": "klaviyo",
3113
3113
  "category": "method",
3114
3114
  "summary": "Get Tag Group ID for Tag",
3115
- "content": "## GET /api/tags/{id}/relationships/tag-group\n\nReturns the id of the tag group related to the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_group_id_for_tag.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.get('api/tags/{id}/relationships/tag-group', ...)` to call this endpoint.",
3115
+ "content": "## GET /api/tags/{id}/relationships/tag-group\n\nReturns the id of the tag group related to the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_group_id_for_tag.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.get('tags/{id}/relationships/tag-group', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3116
3116
  "tags": [
3117
3117
  "klaviyo",
3118
3118
  "openapi",
@@ -3125,7 +3125,7 @@
3125
3125
  "platform": "klaviyo",
3126
3126
  "category": "method",
3127
3127
  "summary": "Get Tag Groups",
3128
- "content": "## GET /api/tag-groups\n\nList all tag groups in an account. Every account has one default tag group.\n\nTag groups can be filtered by `name`, `exclusive`, and `default`, and sorted by `name` or `id` in ascending or descending order.\n\nReturns a maximum of 25 tag groups per request, which can be paginated with\n[cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_groups.json)\n\n**Parameters:**\n- `fields[tag-group]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 25. Min: 1. Max: 25.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/tag-groups', ...)` to call this endpoint.",
3128
+ "content": "## GET /api/tag-groups\n\nList all tag groups in an account. Every account has one default tag group.\n\nTag groups can be filtered by `name`, `exclusive`, and `default`, and sorted by `name` or `id` in ascending or descending order.\n\nReturns a maximum of 25 tag groups per request, which can be paginated with\n[cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_groups.json)\n\n**Parameters:**\n- `fields[tag-group]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 25. Min: 1. Max: 25.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('tag-groups', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3129
3129
  "tags": [
3130
3130
  "klaviyo",
3131
3131
  "openapi",
@@ -3138,7 +3138,7 @@
3138
3138
  "platform": "klaviyo",
3139
3139
  "category": "method",
3140
3140
  "summary": "Get Tag IDs for Campaign",
3141
- "content": "## GET /api/campaigns/{id}/relationships/tags\n\nReturns the IDs of all tags associated with the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`campaigns:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_campaign.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('api/campaigns/{id}/relationships/tags', ...)` to call this endpoint.",
3141
+ "content": "## GET /api/campaigns/{id}/relationships/tags\n\nReturns the IDs of all tags associated with the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`campaigns:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_campaign.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('campaigns/{id}/relationships/tags', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3142
3142
  "tags": [
3143
3143
  "klaviyo",
3144
3144
  "openapi",
@@ -3151,7 +3151,7 @@
3151
3151
  "platform": "klaviyo",
3152
3152
  "category": "method",
3153
3153
  "summary": "Get Tag IDs for Flow",
3154
- "content": "## GET /api/flows/{id}/relationships/tags\n\nReturn the tag IDs of all tags associated with the given flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_flow.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('api/flows/{id}/relationships/tags', ...)` to call this endpoint.",
3154
+ "content": "## GET /api/flows/{id}/relationships/tags\n\nReturn the tag IDs of all tags associated with the given flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_flow.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('flows/{id}/relationships/tags', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3155
3155
  "tags": [
3156
3156
  "klaviyo",
3157
3157
  "openapi",
@@ -3164,7 +3164,7 @@
3164
3164
  "platform": "klaviyo",
3165
3165
  "category": "method",
3166
3166
  "summary": "Get Tag IDs for List",
3167
- "content": "## GET /api/lists/{id}/relationships/tags\n\nReturn all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`lists:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_list.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this list. Generated by Klaviyo.\n\nUse `klaviyo.get('api/lists/{id}/relationships/tags', ...)` to call this endpoint.",
3167
+ "content": "## GET /api/lists/{id}/relationships/tags\n\nReturn all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`lists:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_list.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this list. Generated by Klaviyo.\n\nUse `klaviyo.get('lists/{id}/relationships/tags', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3168
3168
  "tags": [
3169
3169
  "klaviyo",
3170
3170
  "openapi",
@@ -3177,7 +3177,7 @@
3177
3177
  "platform": "klaviyo",
3178
3178
  "category": "method",
3179
3179
  "summary": "Get Tag IDs for Segment",
3180
- "content": "## GET /api/segments/{id}/relationships/tags\n\nIf `related_resource` is `tags`, returns the tag IDs of all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`segments:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_segment.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('api/segments/{id}/relationships/tags', ...)` to call this endpoint.",
3180
+ "content": "## GET /api/segments/{id}/relationships/tags\n\nIf `related_resource` is `tags`, returns the tag IDs of all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`segments:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_segment.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('segments/{id}/relationships/tags', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3181
3181
  "tags": [
3182
3182
  "klaviyo",
3183
3183
  "openapi",
@@ -3190,7 +3190,7 @@
3190
3190
  "platform": "klaviyo",
3191
3191
  "category": "method",
3192
3192
  "summary": "Get Tag IDs for Tag Group",
3193
- "content": "## GET /api/tag-groups/{id}/relationships/tags\n\nReturns the tag IDs of all tags inside the given tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_tag_group.json)\n\n**Parameters:**\n- `id` (required) — The Tag Group ID\n\nUse `klaviyo.get('api/tag-groups/{id}/relationships/tags', ...)` to call this endpoint.",
3193
+ "content": "## GET /api/tag-groups/{id}/relationships/tags\n\nReturns the tag IDs of all tags inside the given tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_tag_group.json)\n\n**Parameters:**\n- `id` (required) — The Tag Group ID\n\nUse `klaviyo.get('tag-groups/{id}/relationships/tags', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3194
3194
  "tags": [
3195
3195
  "klaviyo",
3196
3196
  "openapi",
@@ -3203,7 +3203,7 @@
3203
3203
  "platform": "klaviyo",
3204
3204
  "category": "method",
3205
3205
  "summary": "Get Tags",
3206
- "content": "## GET /api/tags\n\nList all tags in an account.\n\nTags can be filtered by `name`, and sorted by `name` or `id` in ascending or descending order.\n\nReturns a maximum of 50 tags per request, which can be paginated with\n[cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags.json)\n\n**Parameters:**\n- `fields[tag-group]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 50. Min: 1. Max: 50.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/tags', ...)` to call this endpoint.",
3206
+ "content": "## GET /api/tags\n\nList all tags in an account.\n\nTags can be filtered by `name`, and sorted by `name` or `id` in ascending or descending order.\n\nReturns a maximum of 50 tags per request, which can be paginated with\n[cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags.json)\n\n**Parameters:**\n- `fields[tag-group]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 50. Min: 1. Max: 50.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('tags', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3207
3207
  "tags": [
3208
3208
  "klaviyo",
3209
3209
  "openapi",
@@ -3216,7 +3216,7 @@
3216
3216
  "platform": "klaviyo",
3217
3217
  "category": "method",
3218
3218
  "summary": "Get Tags for Campaign",
3219
- "content": "## GET /api/campaigns/{id}/tags\n\nReturn all tags that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`campaigns:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_campaign.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/campaigns/{id}/tags', ...)` to call this endpoint.",
3219
+ "content": "## GET /api/campaigns/{id}/tags\n\nReturn all tags that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`campaigns:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_campaign.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('campaigns/{id}/tags', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3220
3220
  "tags": [
3221
3221
  "klaviyo",
3222
3222
  "openapi",
@@ -3229,7 +3229,7 @@
3229
3229
  "platform": "klaviyo",
3230
3230
  "category": "method",
3231
3231
  "summary": "Get Tags for Flow",
3232
- "content": "## GET /api/flows/{id}/tags\n\nReturn all tags associated with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_flow.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/flows/{id}/tags', ...)` to call this endpoint.",
3232
+ "content": "## GET /api/flows/{id}/tags\n\nReturn all tags associated with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_flow.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('flows/{id}/tags', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3233
3233
  "tags": [
3234
3234
  "klaviyo",
3235
3235
  "openapi",
@@ -3242,7 +3242,7 @@
3242
3242
  "platform": "klaviyo",
3243
3243
  "category": "method",
3244
3244
  "summary": "Get Tags for List",
3245
- "content": "## GET /api/lists/{id}/tags\n\nReturn all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`lists:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_list.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this list. Generated by Klaviyo.\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/lists/{id}/tags', ...)` to call this endpoint.",
3245
+ "content": "## GET /api/lists/{id}/tags\n\nReturn all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`lists:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_list.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this list. Generated by Klaviyo.\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('lists/{id}/tags', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3246
3246
  "tags": [
3247
3247
  "klaviyo",
3248
3248
  "openapi",
@@ -3255,7 +3255,7 @@
3255
3255
  "platform": "klaviyo",
3256
3256
  "category": "method",
3257
3257
  "summary": "Get Tags for Segment",
3258
- "content": "## GET /api/segments/{id}/tags\n\nReturn all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`segments:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_segment.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/segments/{id}/tags', ...)` to call this endpoint.",
3258
+ "content": "## GET /api/segments/{id}/tags\n\nReturn all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`segments:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_segment.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('segments/{id}/tags', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3259
3259
  "tags": [
3260
3260
  "klaviyo",
3261
3261
  "openapi",
@@ -3268,7 +3268,7 @@
3268
3268
  "platform": "klaviyo",
3269
3269
  "category": "method",
3270
3270
  "summary": "Get Tags for Tag Group",
3271
- "content": "## GET /api/tag-groups/{id}/tags\n\nReturn the tags for a given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_tag_group.json)\n\n**Parameters:**\n- `id` (required) — The Tag Group ID\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/tag-groups/{id}/tags', ...)` to call this endpoint.",
3271
+ "content": "## GET /api/tag-groups/{id}/tags\n\nReturn the tags for a given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_tag_group.json)\n\n**Parameters:**\n- `id` (required) — The Tag Group ID\n- `fields[tag]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('tag-groups/{id}/tags', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3272
3272
  "tags": [
3273
3273
  "klaviyo",
3274
3274
  "openapi",
@@ -3281,7 +3281,7 @@
3281
3281
  "platform": "klaviyo",
3282
3282
  "category": "method",
3283
3283
  "summary": "Get Template",
3284
- "content": "## GET /api/templates/{id}\n\nGet a template with the given template ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template.json)\n\n**Parameters:**\n- `id` (required) — The ID of template\n- `additional-fields[template]` — Request additional fields not included by default in the response. Supported values: 'definition'\n- `fields[template]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/templates/{id}', ...)` to call this endpoint.",
3284
+ "content": "## GET /api/templates/{id}\n\nGet a template with the given template ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template.json)\n\n**Parameters:**\n- `id` (required) — The ID of template\n- `additional-fields[template]` — Request additional fields not included by default in the response. Supported values: 'definition'\n- `fields[template]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('templates/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3285
3285
  "tags": [
3286
3286
  "klaviyo",
3287
3287
  "openapi",
@@ -3294,7 +3294,7 @@
3294
3294
  "platform": "klaviyo",
3295
3295
  "category": "method",
3296
3296
  "summary": "Get Template for Campaign Message",
3297
- "content": "## GET /api/campaign-messages/{id}/template\n\nReturn the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_for_campaign_message.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[template]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/campaign-messages/{id}/template', ...)` to call this endpoint.",
3297
+ "content": "## GET /api/campaign-messages/{id}/template\n\nReturn the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_for_campaign_message.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[template]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('campaign-messages/{id}/template', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3298
3298
  "tags": [
3299
3299
  "klaviyo",
3300
3300
  "openapi",
@@ -3307,7 +3307,7 @@
3307
3307
  "platform": "klaviyo",
3308
3308
  "category": "method",
3309
3309
  "summary": "Get Template for Flow Message",
3310
- "content": "## GET /api/flow-messages/{id}/template\n\nReturn the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_for_flow_message.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[template]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/flow-messages/{id}/template', ...)` to call this endpoint.",
3310
+ "content": "## GET /api/flow-messages/{id}/template\n\nReturn the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_for_flow_message.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[template]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('flow-messages/{id}/template', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3311
3311
  "tags": [
3312
3312
  "klaviyo",
3313
3313
  "openapi",
@@ -3320,7 +3320,7 @@
3320
3320
  "platform": "klaviyo",
3321
3321
  "category": "method",
3322
3322
  "summary": "Get Template ID for Campaign Message",
3323
- "content": "## GET /api/campaign-messages/{id}/relationships/template\n\nReturns the ID of the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_id_for_campaign_message.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('api/campaign-messages/{id}/relationships/template', ...)` to call this endpoint.",
3323
+ "content": "## GET /api/campaign-messages/{id}/relationships/template\n\nReturns the ID of the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_id_for_campaign_message.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('campaign-messages/{id}/relationships/template', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3324
3324
  "tags": [
3325
3325
  "klaviyo",
3326
3326
  "openapi",
@@ -3333,7 +3333,7 @@
3333
3333
  "platform": "klaviyo",
3334
3334
  "category": "method",
3335
3335
  "summary": "Get Template ID for Flow Message",
3336
- "content": "## GET /api/flow-messages/{id}/relationships/template\n\nReturns the ID of the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_id_for_flow_message.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('api/flow-messages/{id}/relationships/template', ...)` to call this endpoint.",
3336
+ "content": "## GET /api/flow-messages/{id}/relationships/template\n\nReturns the ID of the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_id_for_flow_message.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.get('flow-messages/{id}/relationships/template', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3337
3337
  "tags": [
3338
3338
  "klaviyo",
3339
3339
  "openapi",
@@ -3346,7 +3346,7 @@
3346
3346
  "platform": "klaviyo",
3347
3347
  "category": "method",
3348
3348
  "summary": "Get Templates",
3349
- "content": "## GET /api/templates\n\nGet all templates in an account.\n\nUse `additional-fields[template]=definition` to include the full template\ndefinition for SYSTEM_DRAGGABLE templates.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_templates.json)\n\n**Parameters:**\n- `additional-fields[template]` — Request additional fields not included by default in the response. Supported values: 'definition'\n- `fields[template]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `contains`, `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 10. Min: 1. Max: 10.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/templates', ...)` to call this endpoint.",
3349
+ "content": "## GET /api/templates\n\nGet all templates in an account.\n\nUse `additional-fields[template]=definition` to include the full template\ndefinition for SYSTEM_DRAGGABLE templates.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_templates.json)\n\n**Parameters:**\n- `additional-fields[template]` — Request additional fields not included by default in the response. Supported values: 'definition'\n- `fields[template]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `contains`, `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 10. Min: 1. Max: 10.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('templates', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3350
3350
  "tags": [
3351
3351
  "klaviyo",
3352
3352
  "openapi",
@@ -3359,7 +3359,7 @@
3359
3359
  "platform": "klaviyo",
3360
3360
  "category": "method",
3361
3361
  "summary": "Get Tracking Setting",
3362
- "content": "## GET /api/tracking-settings/{id}\n\nGet the UTM tracking setting with the given account ID.\n\nMore information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`tracking-settings:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tracking_setting.json)\n\n**Parameters:**\n- `id` (required) — The id of the tracking setting (account ID).\n- `fields[tracking-setting]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/tracking-settings/{id}', ...)` to call this endpoint.",
3362
+ "content": "## GET /api/tracking-settings/{id}\n\nGet the UTM tracking setting with the given account ID.\n\nMore information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`tracking-settings:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tracking_setting.json)\n\n**Parameters:**\n- `id` (required) — The id of the tracking setting (account ID).\n- `fields[tracking-setting]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('tracking-settings/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3363
3363
  "tags": [
3364
3364
  "klaviyo",
3365
3365
  "openapi",
@@ -3372,7 +3372,7 @@
3372
3372
  "platform": "klaviyo",
3373
3373
  "category": "method",
3374
3374
  "summary": "Get Tracking Settings",
3375
- "content": "## GET /api/tracking-settings\n\nGet all UTM tracking settings in an account. Returns an array with a single tracking setting.\n\nMore information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`tracking-settings:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tracking_settings.json)\n\n**Parameters:**\n- `fields[tracking-setting]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 1. Min: 1. Max: 1.\n\nUse `klaviyo.get('api/tracking-settings', ...)` to call this endpoint.",
3375
+ "content": "## GET /api/tracking-settings\n\nGet all UTM tracking settings in an account. Returns an array with a single tracking setting.\n\nMore information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`tracking-settings:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tracking_settings.json)\n\n**Parameters:**\n- `fields[tracking-setting]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 1. Min: 1. Max: 1.\n\nUse `klaviyo.get('tracking-settings', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3376
3376
  "tags": [
3377
3377
  "klaviyo",
3378
3378
  "openapi",
@@ -3385,7 +3385,7 @@
3385
3385
  "platform": "klaviyo",
3386
3386
  "category": "method",
3387
3387
  "summary": "Get Universal Content",
3388
- "content": "## GET /api/template-universal-content/{id}\n\nGet the universal content with the given ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_universal_content.json)\n\n**Parameters:**\n- `id` (required) — The ID of the universal content\n- `fields[template-universal-content]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/template-universal-content/{id}', ...)` to call this endpoint.",
3388
+ "content": "## GET /api/template-universal-content/{id}\n\nGet the universal content with the given ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_universal_content.json)\n\n**Parameters:**\n- `id` (required) — The ID of the universal content\n- `fields[template-universal-content]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('template-universal-content/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3389
3389
  "tags": [
3390
3390
  "klaviyo",
3391
3391
  "openapi",
@@ -3398,7 +3398,7 @@
3398
3398
  "platform": "klaviyo",
3399
3399
  "category": "method",
3400
3400
  "summary": "Get Variant IDs for Catalog Item",
3401
- "content": "## GET /api/catalog-items/{id}/relationships/variants\n\nGet all variants related to the given item ID.\n\nVariants can be sorted by the following fields, in ascending and descending order:\n`created`\n\nReturns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_variant_ids_for_catalog_item.json)\n\n**Parameters:**\n- `id` (required) — The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/catalog-items/{id}/relationships/variants', ...)` to call this endpoint.",
3401
+ "content": "## GET /api/catalog-items/{id}/relationships/variants\n\nGet all variants related to the given item ID.\n\nVariants can be sorted by the following fields, in ascending and descending order:\n`created`\n\nReturns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_variant_ids_for_catalog_item.json)\n\n**Parameters:**\n- `id` (required) — The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('catalog-items/{id}/relationships/variants', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3402
3402
  "tags": [
3403
3403
  "klaviyo",
3404
3404
  "openapi",
@@ -3411,7 +3411,7 @@
3411
3411
  "platform": "klaviyo",
3412
3412
  "category": "method",
3413
3413
  "summary": "Get Variants for Catalog Item",
3414
- "content": "## GET /api/catalog-items/{id}/variants\n\nGet all variants related to the given item ID.\n\nVariants can be sorted by the following fields, in ascending and descending order:\n`created`\n\nReturns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_variants_for_catalog_item.json)\n\n**Parameters:**\n- `id` (required) — The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n- `fields[catalog-variant]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/catalog-items/{id}/variants', ...)` to call this endpoint.",
3414
+ "content": "## GET /api/catalog-items/{id}/variants\n\nGet all variants related to the given item ID.\n\nVariants can be sorted by the following fields, in ascending and descending order:\n`created`\n\nReturns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_variants_for_catalog_item.json)\n\n**Parameters:**\n- `id` (required) — The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n- `fields[catalog-variant]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 100. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('catalog-items/{id}/variants', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3415
3415
  "tags": [
3416
3416
  "klaviyo",
3417
3417
  "openapi",
@@ -3424,7 +3424,7 @@
3424
3424
  "platform": "klaviyo",
3425
3425
  "category": "method",
3426
3426
  "summary": "Get Version IDs for Form",
3427
- "content": "## GET /api/forms/{id}/relationships/form-versions\n\nGet the IDs of the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_version_ids_for_form.json)\n\n**Parameters:**\n- `id` (required) — The ID of the form\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`form_type`: `any`, `equals`<br>`status`: `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/forms/{id}/relationships/form-versions', ...)` to call this endpoint.",
3427
+ "content": "## GET /api/forms/{id}/relationships/form-versions\n\nGet the IDs of the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_version_ids_for_form.json)\n\n**Parameters:**\n- `id` (required) — The ID of the form\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`form_type`: `any`, `equals`<br>`status`: `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('forms/{id}/relationships/form-versions', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3428
3428
  "tags": [
3429
3429
  "klaviyo",
3430
3430
  "openapi",
@@ -3437,7 +3437,7 @@
3437
3437
  "platform": "klaviyo",
3438
3438
  "category": "method",
3439
3439
  "summary": "Get Versions for Form",
3440
- "content": "## GET /api/forms/{id}/form-versions\n\nGet the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_versions_for_form.json)\n\n**Parameters:**\n- `id` (required) — The ID of the form\n- `fields[form-version]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`form_type`: `any`, `equals`<br>`status`: `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/forms/{id}/form-versions', ...)` to call this endpoint.",
3440
+ "content": "## GET /api/forms/{id}/form-versions\n\nGet the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_versions_for_form.json)\n\n**Parameters:**\n- `id` (required) — The ID of the form\n- `fields[form-version]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`form_type`: `any`, `equals`<br>`status`: `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 20. Min: 1. Max: 100.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('forms/{id}/form-versions', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3441
3441
  "tags": [
3442
3442
  "klaviyo",
3443
3443
  "openapi",
@@ -3450,7 +3450,7 @@
3450
3450
  "platform": "klaviyo",
3451
3451
  "category": "method",
3452
3452
  "summary": "Get Web Feed",
3453
- "content": "## GET /api/web-feeds/{id}\n\nGet the web feed with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`web-feeds:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_web_feed.json)\n\n**Parameters:**\n- `id` (required) — The ID of the web feed\n- `fields[web-feed]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/web-feeds/{id}', ...)` to call this endpoint.",
3453
+ "content": "## GET /api/web-feeds/{id}\n\nGet the web feed with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`web-feeds:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_web_feed.json)\n\n**Parameters:**\n- `id` (required) — The ID of the web feed\n- `fields[web-feed]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('web-feeds/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3454
3454
  "tags": [
3455
3455
  "klaviyo",
3456
3456
  "openapi",
@@ -3463,7 +3463,7 @@
3463
3463
  "platform": "klaviyo",
3464
3464
  "category": "method",
3465
3465
  "summary": "Get Web Feeds",
3466
- "content": "## GET /api/web-feeds\n\nGet all web feeds for an account.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`web-feeds:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_web_feeds.json)\n\n**Parameters:**\n- `fields[web-feed]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `contains`, `equals`<br>`created`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 5. Min: 1. Max: 20.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('api/web-feeds', ...)` to call this endpoint.",
3466
+ "content": "## GET /api/web-feeds\n\nGet all web feeds for an account.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`web-feeds:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_web_feeds.json)\n\n**Parameters:**\n- `fields[web-feed]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `filter` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `contains`, `equals`<br>`created`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\n- `page[cursor]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n- `page[size]` — Default: 5. Min: 1. Max: 20.\n- `sort` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting\n\nUse `klaviyo.get('web-feeds', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3467
3467
  "tags": [
3468
3468
  "klaviyo",
3469
3469
  "openapi",
@@ -3476,7 +3476,7 @@
3476
3476
  "platform": "klaviyo",
3477
3477
  "category": "method",
3478
3478
  "summary": "Get Webhook",
3479
- "content": "## GET /api/webhooks/{id}\n\nGet the webhook with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`webhooks:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_webhook.json)\n\n**Parameters:**\n- `id` (required) — The ID of the webhook.\n- `fields[webhook-topic]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[webhook]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/webhooks/{id}', ...)` to call this endpoint.",
3479
+ "content": "## GET /api/webhooks/{id}\n\nGet the webhook with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`webhooks:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_webhook.json)\n\n**Parameters:**\n- `id` (required) — The ID of the webhook.\n- `fields[webhook-topic]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[webhook]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('webhooks/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3480
3480
  "tags": [
3481
3481
  "klaviyo",
3482
3482
  "openapi",
@@ -3489,7 +3489,7 @@
3489
3489
  "platform": "klaviyo",
3490
3490
  "category": "method",
3491
3491
  "summary": "Get Webhook Topic",
3492
- "content": "## GET /api/webhook-topics/{id}\n\nGet the webhook topic with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`webhooks:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_webhook_topic.json)\n\n**Parameters:**\n- `id` (required) — The ID of the webhook topic.\n- `fields[webhook-topic]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/webhook-topics/{id}', ...)` to call this endpoint.",
3492
+ "content": "## GET /api/webhook-topics/{id}\n\nGet the webhook topic with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`webhooks:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_webhook_topic.json)\n\n**Parameters:**\n- `id` (required) — The ID of the webhook topic.\n- `fields[webhook-topic]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('webhook-topics/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3493
3493
  "tags": [
3494
3494
  "klaviyo",
3495
3495
  "openapi",
@@ -3502,7 +3502,7 @@
3502
3502
  "platform": "klaviyo",
3503
3503
  "category": "method",
3504
3504
  "summary": "Get Webhook Topics",
3505
- "content": "## GET /api/webhook-topics\n\nGet all webhook topics in a Klaviyo account.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`webhooks:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_webhook_topics.json)\n\n**Parameters:**\n- `fields[webhook-topic]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('api/webhook-topics', ...)` to call this endpoint.",
3505
+ "content": "## GET /api/webhook-topics\n\nGet all webhook topics in a Klaviyo account.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`webhooks:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_webhook_topics.json)\n\n**Parameters:**\n- `fields[webhook-topic]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.get('webhook-topics', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3506
3506
  "tags": [
3507
3507
  "klaviyo",
3508
3508
  "openapi",
@@ -3515,7 +3515,7 @@
3515
3515
  "platform": "klaviyo",
3516
3516
  "category": "method",
3517
3517
  "summary": "Get Webhooks",
3518
- "content": "## GET /api/webhooks\n\nGet all webhooks in an account.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`webhooks:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_webhooks.json)\n\n**Parameters:**\n- `fields[webhook-topic]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[webhook]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('api/webhooks', ...)` to call this endpoint.",
3518
+ "content": "## GET /api/webhooks\n\nGet all webhooks in an account.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`webhooks:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_webhooks.json)\n\n**Parameters:**\n- `fields[webhook-topic]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `fields[webhook]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `include` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships\n\nUse `klaviyo.get('webhooks', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3519
3519
  "tags": [
3520
3520
  "klaviyo",
3521
3521
  "openapi",
@@ -3528,7 +3528,7 @@
3528
3528
  "platform": "klaviyo",
3529
3529
  "category": "method",
3530
3530
  "summary": "Merge Profiles",
3531
- "content": "## POST /api/profile-merge\n\nMerge a given related profile into a profile with the given profile ID.\n\nThe profile provided under `relationships` (the \"source\" profile) will be merged into the profile provided by the ID in the base data object (the \"destination\" profile).\nThis endpoint queues an asynchronous task which will merge data from the source profile into the destination profile, deleting the source profile in the process. This endpoint accepts only one source profile.\n\nTo learn more about how profile data is preserved or overwritten during a merge, please [visit our Help Center](https://help.klaviyo.com/hc/en-us/articles/115005073847#merge-2-profiles3).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/merge_profiles.json)\n\n**Parameters:**\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/profile-merge', ...)` to call this endpoint.",
3531
+ "content": "## POST /api/profile-merge\n\nMerge a given related profile into a profile with the given profile ID.\n\nThe profile provided under `relationships` (the \"source\" profile) will be merged into the profile provided by the ID in the base data object (the \"destination\" profile).\nThis endpoint queues an asynchronous task which will merge data from the source profile into the destination profile, deleting the source profile in the process. This endpoint accepts only one source profile.\n\nTo learn more about how profile data is preserved or overwritten during a merge, please [visit our Help Center](https://help.klaviyo.com/hc/en-us/articles/115005073847#merge-2-profiles3).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/merge_profiles.json)\n\n**Parameters:**\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('profile-merge', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3532
3532
  "tags": [
3533
3533
  "klaviyo",
3534
3534
  "openapi",
@@ -3541,7 +3541,7 @@
3541
3541
  "platform": "klaviyo",
3542
3542
  "category": "method",
3543
3543
  "summary": "Query Campaign Values",
3544
- "content": "## POST /api/campaign-values-reports\n\nReturns the requested campaign analytics values data<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_campaign_values.json)\n\n**Parameters:**\n- `fields[campaign-values-report]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `page_cursor` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.post('api/campaign-values-reports', ...)` to call this endpoint.",
3544
+ "content": "## POST /api/campaign-values-reports\n\nReturns the requested campaign analytics values data<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_campaign_values.json)\n\n**Parameters:**\n- `fields[campaign-values-report]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `page_cursor` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.post('campaign-values-reports', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3545
3545
  "tags": [
3546
3546
  "klaviyo",
3547
3547
  "openapi",
@@ -3554,7 +3554,7 @@
3554
3554
  "platform": "klaviyo",
3555
3555
  "category": "method",
3556
3556
  "summary": "Query Flow Series",
3557
- "content": "## POST /api/flow-series-reports\n\nReturns the requested flow analytics series data<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_flow_series.json)\n\n**Parameters:**\n- `fields[flow-series-report]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `page_cursor` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.post('api/flow-series-reports', ...)` to call this endpoint.",
3557
+ "content": "## POST /api/flow-series-reports\n\nReturns the requested flow analytics series data<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_flow_series.json)\n\n**Parameters:**\n- `fields[flow-series-report]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `page_cursor` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.post('flow-series-reports', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3558
3558
  "tags": [
3559
3559
  "klaviyo",
3560
3560
  "openapi",
@@ -3567,7 +3567,7 @@
3567
3567
  "platform": "klaviyo",
3568
3568
  "category": "method",
3569
3569
  "summary": "Query Flow Values",
3570
- "content": "## POST /api/flow-values-reports\n\nReturns the requested flow analytics values data<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_flow_values.json)\n\n**Parameters:**\n- `fields[flow-values-report]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `page_cursor` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.post('api/flow-values-reports', ...)` to call this endpoint.",
3570
+ "content": "## POST /api/flow-values-reports\n\nReturns the requested flow analytics values data<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_flow_values.json)\n\n**Parameters:**\n- `fields[flow-values-report]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n- `page_cursor` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination\n\nUse `klaviyo.post('flow-values-reports', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3571
3571
  "tags": [
3572
3572
  "klaviyo",
3573
3573
  "openapi",
@@ -3580,7 +3580,7 @@
3580
3580
  "platform": "klaviyo",
3581
3581
  "category": "method",
3582
3582
  "summary": "Query Form Series",
3583
- "content": "## POST /api/form-series-reports\n\nReturns the requested form analytics series data.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_form_series.json)\n\n**Parameters:**\n- `fields[form-series-report]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/form-series-reports', ...)` to call this endpoint.",
3583
+ "content": "## POST /api/form-series-reports\n\nReturns the requested form analytics series data.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_form_series.json)\n\n**Parameters:**\n- `fields[form-series-report]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('form-series-reports', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3584
3584
  "tags": [
3585
3585
  "klaviyo",
3586
3586
  "openapi",
@@ -3593,7 +3593,7 @@
3593
3593
  "platform": "klaviyo",
3594
3594
  "category": "method",
3595
3595
  "summary": "Query Form Values",
3596
- "content": "## POST /api/form-values-reports\n\nReturns the requested form analytics values data.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_form_values.json)\n\n**Parameters:**\n- `fields[form-values-report]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/form-values-reports', ...)` to call this endpoint.",
3596
+ "content": "## POST /api/form-values-reports\n\nReturns the requested form analytics values data.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_form_values.json)\n\n**Parameters:**\n- `fields[form-values-report]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('form-values-reports', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3597
3597
  "tags": [
3598
3598
  "klaviyo",
3599
3599
  "openapi",
@@ -3606,7 +3606,7 @@
3606
3606
  "platform": "klaviyo",
3607
3607
  "category": "method",
3608
3608
  "summary": "Query Metric Aggregates",
3609
- "content": "## POST /api/metric-aggregates\n\nQuery and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events (not to be confused with [custom metrics](https://developers.klaviyo.com/en/reference/custom_metrics_api_overview), which are not supported at this time). Queries must be passed in the JSON body of your `POST` request.\n\nTo request campaign and flow performance data that matches the data shown in Klaviyo's UI, we recommend the [Reporting API](https://developers.klaviyo.com/en/reference/reporting_api_overview).\n\nResults can be filtered and grouped by time, event, or profile dimensions.\n\nTo learn more about how to use this endpoint, check out our new [Using the Query Metric Aggregates Endpoint guide](https://developers.klaviyo.com/en/docs/using-the-query-metric-aggregates-endpoint).\n\nFor a comprehensive list of request body parameters, native Klaviyo metrics, and their associated attributes for grouping and filtering, please refer to the [metrics attributes guide](https://developers.klaviyo.com/en/docs/supported_metrics_and_attributes).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_metric_aggregates.json)\n\n**Parameters:**\n- `fields[metric-aggregate]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/metric-aggregates', ...)` to call this endpoint.",
3609
+ "content": "## POST /api/metric-aggregates\n\nQuery and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events (not to be confused with [custom metrics](https://developers.klaviyo.com/en/reference/custom_metrics_api_overview), which are not supported at this time). Queries must be passed in the JSON body of your `POST` request.\n\nTo request campaign and flow performance data that matches the data shown in Klaviyo's UI, we recommend the [Reporting API](https://developers.klaviyo.com/en/reference/reporting_api_overview).\n\nResults can be filtered and grouped by time, event, or profile dimensions.\n\nTo learn more about how to use this endpoint, check out our new [Using the Query Metric Aggregates Endpoint guide](https://developers.klaviyo.com/en/docs/using-the-query-metric-aggregates-endpoint).\n\nFor a comprehensive list of request body parameters, native Klaviyo metrics, and their associated attributes for grouping and filtering, please refer to the [metrics attributes guide](https://developers.klaviyo.com/en/docs/supported_metrics_and_attributes).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_metric_aggregates.json)\n\n**Parameters:**\n- `fields[metric-aggregate]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('metric-aggregates', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3610
3610
  "tags": [
3611
3611
  "klaviyo",
3612
3612
  "openapi",
@@ -3619,7 +3619,7 @@
3619
3619
  "platform": "klaviyo",
3620
3620
  "category": "method",
3621
3621
  "summary": "Query Segment Series",
3622
- "content": "## POST /api/segment-series-reports\n\nReturns the requested segment analytics series data.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d`\n\n**Scopes:**\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_segment_series.json)\n\n**Parameters:**\n- `fields[segment-series-report]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/segment-series-reports', ...)` to call this endpoint.",
3622
+ "content": "## POST /api/segment-series-reports\n\nReturns the requested segment analytics series data.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d`\n\n**Scopes:**\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_segment_series.json)\n\n**Parameters:**\n- `fields[segment-series-report]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('segment-series-reports', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3623
3623
  "tags": [
3624
3624
  "klaviyo",
3625
3625
  "openapi",
@@ -3632,7 +3632,7 @@
3632
3632
  "platform": "klaviyo",
3633
3633
  "category": "method",
3634
3634
  "summary": "Query Segment Values",
3635
- "content": "## POST /api/segment-values-reports\n\nReturns the requested segment analytics values data.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d`\n\n**Scopes:**\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_segment_values.json)\n\n**Parameters:**\n- `fields[segment-values-report]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/segment-values-reports', ...)` to call this endpoint.",
3635
+ "content": "## POST /api/segment-values-reports\n\nReturns the requested segment analytics values data.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d`\n\n**Scopes:**\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_segment_values.json)\n\n**Parameters:**\n- `fields[segment-values-report]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('segment-values-reports', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3636
3636
  "tags": [
3637
3637
  "klaviyo",
3638
3638
  "openapi",
@@ -3645,7 +3645,7 @@
3645
3645
  "platform": "klaviyo",
3646
3646
  "category": "method",
3647
3647
  "summary": "Refresh Campaign Recipient Estimation",
3648
- "content": "## POST /api/campaign-recipient-estimation-jobs\n\nTrigger an asynchronous job to update the estimated number of recipients\nfor the given campaign ID. Use the `Get Campaign Recipient Estimation\nJob` endpoint to retrieve the status of this estimation job. Use the\n`Get Campaign Recipient Estimation` endpoint to retrieve the estimated\nrecipient count for a given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/refresh_campaign_recipient_estimation.json)\n\n**Parameters:**\n- `fields[campaign-recipient-estimation-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/campaign-recipient-estimation-jobs', ...)` to call this endpoint.",
3648
+ "content": "## POST /api/campaign-recipient-estimation-jobs\n\nTrigger an asynchronous job to update the estimated number of recipients\nfor the given campaign ID. Use the `Get Campaign Recipient Estimation\nJob` endpoint to retrieve the status of this estimation job. Use the\n`Get Campaign Recipient Estimation` endpoint to retrieve the estimated\nrecipient count for a given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/refresh_campaign_recipient_estimation.json)\n\n**Parameters:**\n- `fields[campaign-recipient-estimation-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('campaign-recipient-estimation-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3649
3649
  "tags": [
3650
3650
  "klaviyo",
3651
3651
  "openapi",
@@ -3658,7 +3658,7 @@
3658
3658
  "platform": "klaviyo",
3659
3659
  "category": "method",
3660
3660
  "summary": "Remove Categories from Catalog Item",
3661
- "content": "## DELETE /api/catalog-items/{id}/relationships/categories\n\nDelete catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_categories_from_catalog_item.json)\n\n**Parameters:**\n- `id` (required) — The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n\nUse `klaviyo.post('api/catalog-items/{id}/relationships/categories', ...)` to call this endpoint.",
3661
+ "content": "## DELETE /api/catalog-items/{id}/relationships/categories\n\nDelete catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_categories_from_catalog_item.json)\n\n**Parameters:**\n- `id` (required) — The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n\nUse `klaviyo.post('catalog-items/{id}/relationships/categories', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3662
3662
  "tags": [
3663
3663
  "klaviyo",
3664
3664
  "openapi",
@@ -3671,7 +3671,7 @@
3671
3671
  "platform": "klaviyo",
3672
3672
  "category": "method",
3673
3673
  "summary": "Remove Items from Catalog Category",
3674
- "content": "## DELETE /api/catalog-categories/{id}/relationships/items\n\nDelete item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_items_from_catalog_category.json)\n\n**Parameters:**\n- `id` (required) — The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n\nUse `klaviyo.post('api/catalog-categories/{id}/relationships/items', ...)` to call this endpoint.",
3674
+ "content": "## DELETE /api/catalog-categories/{id}/relationships/items\n\nDelete item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_items_from_catalog_category.json)\n\n**Parameters:**\n- `id` (required) — The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n\nUse `klaviyo.post('catalog-categories/{id}/relationships/items', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3675
3675
  "tags": [
3676
3676
  "klaviyo",
3677
3677
  "openapi",
@@ -3684,7 +3684,7 @@
3684
3684
  "platform": "klaviyo",
3685
3685
  "category": "method",
3686
3686
  "summary": "Remove Profiles from List",
3687
- "content": "## DELETE /api/lists/{id}/relationships/profiles\n\nRemove a profile from a list with the given list ID.\n\nThe provided profile will no longer receive marketing from this particular list once removed.\n\nRemoving a profile from a list will not impact the profile's [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api) status or subscription status in general.\nTo update a profile's subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles).\n\nThis endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:write`\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_profiles_from_list.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.post('api/lists/{id}/relationships/profiles', ...)` to call this endpoint.",
3687
+ "content": "## DELETE /api/lists/{id}/relationships/profiles\n\nRemove a profile from a list with the given list ID.\n\nThe provided profile will no longer receive marketing from this particular list once removed.\n\nRemoving a profile from a list will not impact the profile's [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api) status or subscription status in general.\nTo update a profile's subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles).\n\nThis endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:write`\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_profiles_from_list.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.post('lists/{id}/relationships/profiles', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3688
3688
  "tags": [
3689
3689
  "klaviyo",
3690
3690
  "openapi",
@@ -3697,7 +3697,7 @@
3697
3697
  "platform": "klaviyo",
3698
3698
  "category": "method",
3699
3699
  "summary": "Remove Tag from Campaigns",
3700
- "content": "## DELETE /api/tags/{id}/relationships/campaigns\n\nRemove a tag's association with one or more campaigns.\n\n\nUse the request body to pass in the ID(s) of the campaign(s) whose association with the tag\nwill be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`campaigns:write`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_tag_from_campaigns.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.post('api/tags/{id}/relationships/campaigns', ...)` to call this endpoint.",
3700
+ "content": "## DELETE /api/tags/{id}/relationships/campaigns\n\nRemove a tag's association with one or more campaigns.\n\n\nUse the request body to pass in the ID(s) of the campaign(s) whose association with the tag\nwill be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`campaigns:write`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_tag_from_campaigns.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.post('tags/{id}/relationships/campaigns', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3701
3701
  "tags": [
3702
3702
  "klaviyo",
3703
3703
  "openapi",
@@ -3710,7 +3710,7 @@
3710
3710
  "platform": "klaviyo",
3711
3711
  "category": "method",
3712
3712
  "summary": "Remove Tag from Flows",
3713
- "content": "## DELETE /api/tags/{id}/relationships/flows\n\nRemove a tag's association with one or more flows.\n\n\nUse the request body to pass in the ID(s) of the flows(s) whose association with the tag\nwill be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:write`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_tag_from_flows.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.post('api/tags/{id}/relationships/flows', ...)` to call this endpoint.",
3713
+ "content": "## DELETE /api/tags/{id}/relationships/flows\n\nRemove a tag's association with one or more flows.\n\n\nUse the request body to pass in the ID(s) of the flows(s) whose association with the tag\nwill be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:write`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_tag_from_flows.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.post('tags/{id}/relationships/flows', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3714
3714
  "tags": [
3715
3715
  "klaviyo",
3716
3716
  "openapi",
@@ -3723,7 +3723,7 @@
3723
3723
  "platform": "klaviyo",
3724
3724
  "category": "method",
3725
3725
  "summary": "Remove Tag from Lists",
3726
- "content": "## DELETE /api/tags/{id}/relationships/lists\n\nRemove a tag's association with one or more lists.\n\n\nUse the request body to pass in the ID(s) of the list(s) whose association with the tag\nwill be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`lists:write`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_tag_from_lists.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.post('api/tags/{id}/relationships/lists', ...)` to call this endpoint.",
3726
+ "content": "## DELETE /api/tags/{id}/relationships/lists\n\nRemove a tag's association with one or more lists.\n\n\nUse the request body to pass in the ID(s) of the list(s) whose association with the tag\nwill be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`lists:write`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_tag_from_lists.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.post('tags/{id}/relationships/lists', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3727
3727
  "tags": [
3728
3728
  "klaviyo",
3729
3729
  "openapi",
@@ -3736,7 +3736,7 @@
3736
3736
  "platform": "klaviyo",
3737
3737
  "category": "method",
3738
3738
  "summary": "Remove Tag from Segments",
3739
- "content": "## DELETE /api/tags/{id}/relationships/segments\n\nRemove a tag's association with one or more segments.\n\n\nUse the request body to pass in the ID(s) of the segments(s) whose association with the tag\nwill be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`segments:write`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_tag_from_segments.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.post('api/tags/{id}/relationships/segments', ...)` to call this endpoint.",
3739
+ "content": "## DELETE /api/tags/{id}/relationships/segments\n\nRemove a tag's association with one or more segments.\n\n\nUse the request body to pass in the ID(s) of the segments(s) whose association with the tag\nwill be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`segments:write`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_tag_from_segments.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.post('tags/{id}/relationships/segments', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3740
3740
  "tags": [
3741
3741
  "klaviyo",
3742
3742
  "openapi",
@@ -3749,7 +3749,7 @@
3749
3749
  "platform": "klaviyo",
3750
3750
  "category": "method",
3751
3751
  "summary": "Render Template",
3752
- "content": "## POST /api/template-render\n\nRender a template with the given template ID and context attribute. Returns the AMP, HTML, and plain text versions of the email template.\n\n**Request body parameters** (nested under `attributes`):\n\n* `return_fields`: Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/reference/api_overview#sparse-fieldsets).\n\n* `context`: This is the context your email template will be rendered with. You must pass in a `context` object as a JSON object.\n\nEmail templates are rendered with contexts in a similar manner to Django templates. Nested template variables can be referenced via dot notation. Template variables without corresponding `context` values are treated as `FALSE` and output nothing.\n\nEx. `{ \"name\" : \"George Washington\", \"state\" : \"VA\" }`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/render_template.json)\n\n**Parameters:**\n- `fields[template]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/template-render', ...)` to call this endpoint.",
3752
+ "content": "## POST /api/template-render\n\nRender a template with the given template ID and context attribute. Returns the AMP, HTML, and plain text versions of the email template.\n\n**Request body parameters** (nested under `attributes`):\n\n* `return_fields`: Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/reference/api_overview#sparse-fieldsets).\n\n* `context`: This is the context your email template will be rendered with. You must pass in a `context` object as a JSON object.\n\nEmail templates are rendered with contexts in a similar manner to Django templates. Nested template variables can be referenced via dot notation. Template variables without corresponding `context` values are treated as `FALSE` and output nothing.\n\nEx. `{ \"name\" : \"George Washington\", \"state\" : \"VA\" }`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/render_template.json)\n\n**Parameters:**\n- `fields[template]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('template-render', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3753
3753
  "tags": [
3754
3754
  "klaviyo",
3755
3755
  "openapi",
@@ -3762,7 +3762,7 @@
3762
3762
  "platform": "klaviyo",
3763
3763
  "category": "method",
3764
3764
  "summary": "Request Profile Deletion",
3765
- "content": "## POST /api/data-privacy-deletion-jobs\n\nRequest a deletion for the profiles corresponding to one of the following identifiers: `email`, `phone_number`, or `id`. If multiple identifiers are provided, we will return an error.\n\nAll profiles that match the provided identifier will be deleted.\n\nThe deletion occurs asynchronously; however, once it has completed, the deleted profile will appear on the [Deleted Profiles page](https://www.klaviyo.com/account/deleted).\n\nFor more information on the deletion process, please refer to our [Help Center docs on how to handle GDPR and CCPA deletion requests](https://help.klaviyo.com/hc/en-us/articles/360004217631-How-to-Handle-GDPR-Requests#record-gdpr-and-ccpa%20%20-deletion-requests2).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`data-privacy:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/request_profile_deletion.json)\n\n\n\nUse `klaviyo.post('api/data-privacy-deletion-jobs', ...)` to call this endpoint.",
3765
+ "content": "## POST /api/data-privacy-deletion-jobs\n\nRequest a deletion for the profiles corresponding to one of the following identifiers: `email`, `phone_number`, or `id`. If multiple identifiers are provided, we will return an error.\n\nAll profiles that match the provided identifier will be deleted.\n\nThe deletion occurs asynchronously; however, once it has completed, the deleted profile will appear on the [Deleted Profiles page](https://www.klaviyo.com/account/deleted).\n\nFor more information on the deletion process, please refer to our [Help Center docs on how to handle GDPR and CCPA deletion requests](https://help.klaviyo.com/hc/en-us/articles/360004217631-How-to-Handle-GDPR-Requests#record-gdpr-and-ccpa%20%20-deletion-requests2).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`data-privacy:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/request_profile_deletion.json)\n\n\n\nUse `klaviyo.post('data-privacy-deletion-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3766
3766
  "tags": [
3767
3767
  "klaviyo",
3768
3768
  "openapi",
@@ -3775,7 +3775,7 @@
3775
3775
  "platform": "klaviyo",
3776
3776
  "category": "method",
3777
3777
  "summary": "Send Campaign",
3778
- "content": "## POST /api/campaign-send-jobs\n\nTrigger a campaign to send asynchronously<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/send_campaign.json)\n\n**Parameters:**\n- `fields[campaign-send-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/campaign-send-jobs', ...)` to call this endpoint.",
3778
+ "content": "## POST /api/campaign-send-jobs\n\nTrigger a campaign to send asynchronously<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/send_campaign.json)\n\n**Parameters:**\n- `fields[campaign-send-job]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('campaign-send-jobs', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3779
3779
  "tags": [
3780
3780
  "klaviyo",
3781
3781
  "openapi",
@@ -3788,7 +3788,7 @@
3788
3788
  "platform": "klaviyo",
3789
3789
  "category": "method",
3790
3790
  "summary": "Tag Campaigns",
3791
- "content": "## POST /api/tags/{id}/relationships/campaigns\n\nAssociate a tag with one or more campaigns. Any campaign cannot be associated with more than **100** tags.\n\n\nUse the request body to pass in the ID(s) of the campaign(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`campaigns:write`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/tag_campaigns.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.post('api/tags/{id}/relationships/campaigns', ...)` to call this endpoint.",
3791
+ "content": "## POST /api/tags/{id}/relationships/campaigns\n\nAssociate a tag with one or more campaigns. Any campaign cannot be associated with more than **100** tags.\n\n\nUse the request body to pass in the ID(s) of the campaign(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`campaigns:write`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/tag_campaigns.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.post('tags/{id}/relationships/campaigns', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3792
3792
  "tags": [
3793
3793
  "klaviyo",
3794
3794
  "openapi",
@@ -3801,7 +3801,7 @@
3801
3801
  "platform": "klaviyo",
3802
3802
  "category": "method",
3803
3803
  "summary": "Tag Flows",
3804
- "content": "## POST /api/tags/{id}/relationships/flows\n\nAssociate a tag with one or more flows. Any flow cannot be associated with more than **100** tags.\n\n\nUse the request body to pass in the ID(s) of the flow(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:write`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/tag_flows.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.post('api/tags/{id}/relationships/flows', ...)` to call this endpoint.",
3804
+ "content": "## POST /api/tags/{id}/relationships/flows\n\nAssociate a tag with one or more flows. Any flow cannot be associated with more than **100** tags.\n\n\nUse the request body to pass in the ID(s) of the flow(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:write`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/tag_flows.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.post('tags/{id}/relationships/flows', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3805
3805
  "tags": [
3806
3806
  "klaviyo",
3807
3807
  "openapi",
@@ -3814,7 +3814,7 @@
3814
3814
  "platform": "klaviyo",
3815
3815
  "category": "method",
3816
3816
  "summary": "Tag Lists",
3817
- "content": "## POST /api/tags/{id}/relationships/lists\n\nAssociate a tag with one or more lists. Any list cannot be associated with more than **100** tags.\n\n\nUse the request body to pass in the ID(s) of the lists(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`lists:write`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/tag_lists.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.post('api/tags/{id}/relationships/lists', ...)` to call this endpoint.",
3817
+ "content": "## POST /api/tags/{id}/relationships/lists\n\nAssociate a tag with one or more lists. Any list cannot be associated with more than **100** tags.\n\n\nUse the request body to pass in the ID(s) of the lists(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`lists:write`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/tag_lists.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.post('tags/{id}/relationships/lists', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3818
3818
  "tags": [
3819
3819
  "klaviyo",
3820
3820
  "openapi",
@@ -3827,7 +3827,7 @@
3827
3827
  "platform": "klaviyo",
3828
3828
  "category": "method",
3829
3829
  "summary": "Tag Segments",
3830
- "content": "## POST /api/tags/{id}/relationships/segments\n\nAssociate a tag with one or more segments. Any segment cannot be associated with more than **100** tags.\n\n\nUse the request body to pass in the ID(s) of the segments(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`segments:write`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/tag_segments.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.post('api/tags/{id}/relationships/segments', ...)` to call this endpoint.",
3830
+ "content": "## POST /api/tags/{id}/relationships/segments\n\nAssociate a tag with one or more segments. Any segment cannot be associated with more than **100** tags.\n\n\nUse the request body to pass in the ID(s) of the segments(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`segments:write`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/tag_segments.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.post('tags/{id}/relationships/segments', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3831
3831
  "tags": [
3832
3832
  "klaviyo",
3833
3833
  "openapi",
@@ -3840,7 +3840,7 @@
3840
3840
  "platform": "klaviyo",
3841
3841
  "category": "method",
3842
3842
  "summary": "Unregister Client Push Token",
3843
- "content": "## POST /client/push-token-unregister\n\nUnregister a push token.\n\nThis endpoint is specifically designed to be called from our mobile SDKs ([iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk)) and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\nYou must have push notifications enabled to use this endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/unregister_client_push_token.json)\n\n**Parameters:**\n- `company_id` (required) — Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.\n\nUse `klaviyo.post('client/push-token-unregister', ...)` to call this endpoint.",
3843
+ "content": "## POST /client/push-token-unregister\n\nUnregister a push token.\n\nThis endpoint is specifically designed to be called from our mobile SDKs ([iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk)) and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\nYou must have push notifications enabled to use this endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/unregister_client_push_token.json)\n\n**Parameters:**\n- `company_id` (required) — Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.\n\nUse `klaviyo.post('client/push-token-unregister', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3844
3844
  "tags": [
3845
3845
  "klaviyo",
3846
3846
  "openapi",
@@ -3853,7 +3853,7 @@
3853
3853
  "platform": "klaviyo",
3854
3854
  "category": "method",
3855
3855
  "summary": "Update Campaign",
3856
- "content": "## PATCH /api/campaigns/{id}\n\nUpdate a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_campaign.json)\n\n**Parameters:**\n- `id` (required) — The campaign ID to be retrieved\n- `fields[campaign]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/campaigns/{id}', ...)` to call this endpoint.",
3856
+ "content": "## PATCH /api/campaigns/{id}\n\nUpdate a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_campaign.json)\n\n**Parameters:**\n- `id` (required) — The campaign ID to be retrieved\n- `fields[campaign]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('campaigns/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3857
3857
  "tags": [
3858
3858
  "klaviyo",
3859
3859
  "openapi",
@@ -3866,7 +3866,7 @@
3866
3866
  "platform": "klaviyo",
3867
3867
  "category": "method",
3868
3868
  "summary": "Update Campaign Message",
3869
- "content": "## PATCH /api/campaign-messages/{id}\n\nUpdate a campaign message<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_campaign_message.json)\n\n**Parameters:**\n- `id` (required) — The message ID to be retrieved\n- `fields[campaign-message]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/campaign-messages/{id}', ...)` to call this endpoint.",
3869
+ "content": "## PATCH /api/campaign-messages/{id}\n\nUpdate a campaign message<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_campaign_message.json)\n\n**Parameters:**\n- `id` (required) — The message ID to be retrieved\n- `fields[campaign-message]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('campaign-messages/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3870
3870
  "tags": [
3871
3871
  "klaviyo",
3872
3872
  "openapi",
@@ -3879,7 +3879,7 @@
3879
3879
  "platform": "klaviyo",
3880
3880
  "category": "method",
3881
3881
  "summary": "Update Catalog Category",
3882
- "content": "## PATCH /api/catalog-categories/{id}\n\nUpdate a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_catalog_category.json)\n\n**Parameters:**\n- `id` (required) — The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n- `fields[catalog-category]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/catalog-categories/{id}', ...)` to call this endpoint.",
3882
+ "content": "## PATCH /api/catalog-categories/{id}\n\nUpdate a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_catalog_category.json)\n\n**Parameters:**\n- `id` (required) — The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n- `fields[catalog-category]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('catalog-categories/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3883
3883
  "tags": [
3884
3884
  "klaviyo",
3885
3885
  "openapi",
@@ -3892,7 +3892,7 @@
3892
3892
  "platform": "klaviyo",
3893
3893
  "category": "method",
3894
3894
  "summary": "Update Catalog Item",
3895
- "content": "## PATCH /api/catalog-items/{id}\n\nUpdate a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_catalog_item.json)\n\n**Parameters:**\n- `id` (required) — The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n- `fields[catalog-item]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/catalog-items/{id}', ...)` to call this endpoint.",
3895
+ "content": "## PATCH /api/catalog-items/{id}\n\nUpdate a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_catalog_item.json)\n\n**Parameters:**\n- `id` (required) — The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n- `fields[catalog-item]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('catalog-items/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3896
3896
  "tags": [
3897
3897
  "klaviyo",
3898
3898
  "openapi",
@@ -3905,7 +3905,7 @@
3905
3905
  "platform": "klaviyo",
3906
3906
  "category": "method",
3907
3907
  "summary": "Update Catalog Variant",
3908
- "content": "## PATCH /api/catalog-variants/{id}\n\nUpdate a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_catalog_variant.json)\n\n**Parameters:**\n- `id` (required) — The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n- `fields[catalog-variant]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/catalog-variants/{id}', ...)` to call this endpoint.",
3908
+ "content": "## PATCH /api/catalog-variants/{id}\n\nUpdate a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_catalog_variant.json)\n\n**Parameters:**\n- `id` (required) — The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n- `fields[catalog-variant]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('catalog-variants/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3909
3909
  "tags": [
3910
3910
  "klaviyo",
3911
3911
  "openapi",
@@ -3918,7 +3918,7 @@
3918
3918
  "platform": "klaviyo",
3919
3919
  "category": "method",
3920
3920
  "summary": "Update Categories for Catalog Item",
3921
- "content": "## PATCH /api/catalog-items/{id}/relationships/categories\n\nUpdate catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_categories_for_catalog_item.json)\n\n**Parameters:**\n- `id` (required) — The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n\nUse `klaviyo.post('api/catalog-items/{id}/relationships/categories', ...)` to call this endpoint.",
3921
+ "content": "## PATCH /api/catalog-items/{id}/relationships/categories\n\nUpdate catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_categories_for_catalog_item.json)\n\n**Parameters:**\n- `id` (required) — The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n\nUse `klaviyo.post('catalog-items/{id}/relationships/categories', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3922
3922
  "tags": [
3923
3923
  "klaviyo",
3924
3924
  "openapi",
@@ -3931,7 +3931,7 @@
3931
3931
  "platform": "klaviyo",
3932
3932
  "category": "method",
3933
3933
  "summary": "Update Coupon",
3934
- "content": "## PATCH /api/coupons/{id}\n\n*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`coupons:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_coupon.json)\n\n**Parameters:**\n- `id` (required) — The internal id of a Coupon is equivalent to its external id stored within an integration.\n- `fields[coupon]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/coupons/{id}', ...)` to call this endpoint.",
3934
+ "content": "## PATCH /api/coupons/{id}\n\n*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`coupons:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_coupon.json)\n\n**Parameters:**\n- `id` (required) — The internal id of a Coupon is equivalent to its external id stored within an integration.\n- `fields[coupon]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('coupons/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3935
3935
  "tags": [
3936
3936
  "klaviyo",
3937
3937
  "openapi",
@@ -3944,7 +3944,7 @@
3944
3944
  "platform": "klaviyo",
3945
3945
  "category": "method",
3946
3946
  "summary": "Update Coupon Code",
3947
- "content": "## PATCH /api/coupon-codes/{id}\n\nUpdates a coupon code specified by the given identifier synchronously. We allow updating the 'status' and\n'expires_at' of coupon codes.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`coupon-codes:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_coupon_code.json)\n\n**Parameters:**\n- `id` (required) — The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.\n- `fields[coupon-code]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/coupon-codes/{id}', ...)` to call this endpoint.",
3947
+ "content": "## PATCH /api/coupon-codes/{id}\n\nUpdates a coupon code specified by the given identifier synchronously. We allow updating the 'status' and\n'expires_at' of coupon codes.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`\n\n**Scopes:**\n`coupon-codes:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_coupon_code.json)\n\n**Parameters:**\n- `id` (required) — The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.\n- `fields[coupon-code]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('coupon-codes/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3948
3948
  "tags": [
3949
3949
  "klaviyo",
3950
3950
  "openapi",
@@ -3957,7 +3957,7 @@
3957
3957
  "platform": "klaviyo",
3958
3958
  "category": "method",
3959
3959
  "summary": "Update Custom Metric",
3960
- "content": "## PATCH /api/custom-metrics/{id}\n\nUpdate a custom metric with the given custom metric ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `15/d`\n\n**Scopes:**\n`metrics:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_custom_metric.json)\n\n**Parameters:**\n- `id` (required) — The ID of the custom metric\n- `fields[custom-metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/custom-metrics/{id}', ...)` to call this endpoint.",
3960
+ "content": "## PATCH /api/custom-metrics/{id}\n\nUpdate a custom metric with the given custom metric ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `15/d`\n\n**Scopes:**\n`metrics:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_custom_metric.json)\n\n**Parameters:**\n- `id` (required) — The ID of the custom metric\n- `fields[custom-metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('custom-metrics/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3961
3961
  "tags": [
3962
3962
  "klaviyo",
3963
3963
  "openapi",
@@ -3970,7 +3970,7 @@
3970
3970
  "platform": "klaviyo",
3971
3971
  "category": "method",
3972
3972
  "summary": "Update Flow Status",
3973
- "content": "## PATCH /api/flows/{id}\n\nUpdate the status of a flow with the given flow ID, and all actions in that flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_flow.json)\n\n**Parameters:**\n- `id` (required) — ID of the Flow to update. Ex: XVTP5Q\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/flows/{id}', ...)` to call this endpoint.",
3973
+ "content": "## PATCH /api/flows/{id}\n\nUpdate the status of a flow with the given flow ID, and all actions in that flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_flow.json)\n\n**Parameters:**\n- `id` (required) — ID of the Flow to update. Ex: XVTP5Q\n- `fields[flow]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('flows/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3974
3974
  "tags": [
3975
3975
  "klaviyo",
3976
3976
  "openapi",
@@ -3983,7 +3983,7 @@
3983
3983
  "platform": "klaviyo",
3984
3984
  "category": "method",
3985
3985
  "summary": "Update Flow Action",
3986
- "content": "## PATCH /api/flow-actions/{id}\n\nUpdate a flow action.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_flow_action.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[flow-action]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/flow-actions/{id}', ...)` to call this endpoint.",
3986
+ "content": "## PATCH /api/flow-actions/{id}\n\nUpdate a flow action.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_flow_action.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[flow-action]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('flow-actions/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
3987
3987
  "tags": [
3988
3988
  "klaviyo",
3989
3989
  "openapi",
@@ -3996,7 +3996,7 @@
3996
3996
  "platform": "klaviyo",
3997
3997
  "category": "method",
3998
3998
  "summary": "Update Image",
3999
- "content": "## PATCH /api/images/{id}\n\nUpdate the image with the given image ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`images:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_image.json)\n\n**Parameters:**\n- `id` (required) — The ID of the image\n- `fields[image]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/images/{id}', ...)` to call this endpoint.",
3999
+ "content": "## PATCH /api/images/{id}\n\nUpdate the image with the given image ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`images:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_image.json)\n\n**Parameters:**\n- `id` (required) — The ID of the image\n- `fields[image]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('images/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
4000
4000
  "tags": [
4001
4001
  "klaviyo",
4002
4002
  "openapi",
@@ -4009,7 +4009,7 @@
4009
4009
  "platform": "klaviyo",
4010
4010
  "category": "method",
4011
4011
  "summary": "Update Image for Campaign Message",
4012
- "content": "## PATCH /api/campaign-messages/{id}/relationships/image\n\nUpdate a campaign message image<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n`images:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_image_for_campaign_message.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.post('api/campaign-messages/{id}/relationships/image', ...)` to call this endpoint.",
4012
+ "content": "## PATCH /api/campaign-messages/{id}/relationships/image\n\nUpdate a campaign message image<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n`images:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_image_for_campaign_message.json)\n\n**Parameters:**\n- `id` (required)\n\nUse `klaviyo.post('campaign-messages/{id}/relationships/image', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
4013
4013
  "tags": [
4014
4014
  "klaviyo",
4015
4015
  "openapi",
@@ -4022,7 +4022,7 @@
4022
4022
  "platform": "klaviyo",
4023
4023
  "category": "method",
4024
4024
  "summary": "Update Items for Catalog Category",
4025
- "content": "## PATCH /api/catalog-categories/{id}/relationships/items\n\nUpdate item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_items_for_catalog_category.json)\n\n**Parameters:**\n- `id` (required) — The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n\nUse `klaviyo.post('api/catalog-categories/{id}/relationships/items', ...)` to call this endpoint.",
4025
+ "content": "## PATCH /api/catalog-categories/{id}/relationships/items\n\nUpdate item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_items_for_catalog_category.json)\n\n**Parameters:**\n- `id` (required) — The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.\n\nUse `klaviyo.post('catalog-categories/{id}/relationships/items', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
4026
4026
  "tags": [
4027
4027
  "klaviyo",
4028
4028
  "openapi",
@@ -4035,7 +4035,7 @@
4035
4035
  "platform": "klaviyo",
4036
4036
  "category": "method",
4037
4037
  "summary": "Update List",
4038
- "content": "## PATCH /api/lists/{id}\n\nUpdate the name of a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_list.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this list. Generated by Klaviyo.\n- `fields[list]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/lists/{id}', ...)` to call this endpoint.",
4038
+ "content": "## PATCH /api/lists/{id}\n\nUpdate the name of a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_list.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this list. Generated by Klaviyo.\n- `fields[list]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('lists/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
4039
4039
  "tags": [
4040
4040
  "klaviyo",
4041
4041
  "openapi",
@@ -4048,7 +4048,7 @@
4048
4048
  "platform": "klaviyo",
4049
4049
  "category": "method",
4050
4050
  "summary": "Update Mapped Metric",
4051
- "content": "## PATCH /api/mapped-metrics/{id}\n\nUpdate the mapped metric with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `30/d`\n\n**Scopes:**\n`metrics:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_mapped_metric.json)\n\n**Parameters:**\n- `id` (required) — The type of mapping.\n- `fields[mapped-metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/mapped-metrics/{id}', ...)` to call this endpoint.",
4051
+ "content": "## PATCH /api/mapped-metrics/{id}\n\nUpdate the mapped metric with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `30/d`\n\n**Scopes:**\n`metrics:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_mapped_metric.json)\n\n**Parameters:**\n- `id` (required) — The type of mapping.\n- `fields[mapped-metric]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('mapped-metrics/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
4052
4052
  "tags": [
4053
4053
  "klaviyo",
4054
4054
  "openapi",
@@ -4061,7 +4061,7 @@
4061
4061
  "platform": "klaviyo",
4062
4062
  "category": "method",
4063
4063
  "summary": "Update Profile",
4064
- "content": "## PATCH /api/profiles/{id}\n\nUpdate the profile with the given profile ID.\n\nUse the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.\n\nNote that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged.\n\nThe maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_profile.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this profile. Generated by Klaviyo.\n- `additional-fields[profile]` — Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/profiles/{id}', ...)` to call this endpoint.",
4064
+ "content": "## PATCH /api/profiles/{id}\n\nUpdate the profile with the given profile ID.\n\nUse the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.\n\nNote that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged.\n\nThe maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_profile.json)\n\n**Parameters:**\n- `id` (required) — Primary key that uniquely identifies this profile. Generated by Klaviyo.\n- `additional-fields[profile]` — Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'\n- `fields[profile]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('profiles/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
4065
4065
  "tags": [
4066
4066
  "klaviyo",
4067
4067
  "openapi",
@@ -4074,7 +4074,7 @@
4074
4074
  "platform": "klaviyo",
4075
4075
  "category": "method",
4076
4076
  "summary": "Update Review",
4077
- "content": "## PATCH /api/reviews/{id}\n\nUpdate a review.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`reviews:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_review.json)\n\n**Parameters:**\n- `id` (required) — The id of the review (review ID).\n- `fields[review]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/reviews/{id}', ...)` to call this endpoint.",
4077
+ "content": "## PATCH /api/reviews/{id}\n\nUpdate a review.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`reviews:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_review.json)\n\n**Parameters:**\n- `id` (required) — The id of the review (review ID).\n- `fields[review]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('reviews/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
4078
4078
  "tags": [
4079
4079
  "klaviyo",
4080
4080
  "openapi",
@@ -4087,7 +4087,7 @@
4087
4087
  "platform": "klaviyo",
4088
4088
  "category": "method",
4089
4089
  "summary": "Update Segment",
4090
- "content": "## PATCH /api/segments/{id}\n\nUpdate a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d`\n\n**Scopes:**\n`segments:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_segment.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[segment]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/segments/{id}', ...)` to call this endpoint.",
4090
+ "content": "## PATCH /api/segments/{id}\n\nUpdate a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d`\n\n**Scopes:**\n`segments:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_segment.json)\n\n**Parameters:**\n- `id` (required)\n- `fields[segment]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('segments/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
4091
4091
  "tags": [
4092
4092
  "klaviyo",
4093
4093
  "openapi",
@@ -4100,7 +4100,7 @@
4100
4100
  "platform": "klaviyo",
4101
4101
  "category": "method",
4102
4102
  "summary": "Update Tag",
4103
- "content": "## PATCH /api/tags/{id}\n\nUpdate the tag with the given tag ID.\n\nOnly a tag's `name` can be changed. A tag cannot be moved from one tag group to another.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_tag.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.post('api/tags/{id}', ...)` to call this endpoint.",
4103
+ "content": "## PATCH /api/tags/{id}\n\nUpdate the tag with the given tag ID.\n\nOnly a tag's `name` can be changed. A tag cannot be moved from one tag group to another.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_tag.json)\n\n**Parameters:**\n- `id` (required) — The Tag ID\n\nUse `klaviyo.post('tags/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
4104
4104
  "tags": [
4105
4105
  "klaviyo",
4106
4106
  "openapi",
@@ -4113,7 +4113,7 @@
4113
4113
  "platform": "klaviyo",
4114
4114
  "category": "method",
4115
4115
  "summary": "Update Tag Group",
4116
- "content": "## PATCH /api/tag-groups/{id}\n\nUpdate the tag group with the given tag group ID.\n\nOnly a tag group's `name` can be changed. A tag group's `exclusive` or `default` value cannot be changed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_tag_group.json)\n\n**Parameters:**\n- `id` (required) — The Tag Group ID\n\nUse `klaviyo.post('api/tag-groups/{id}', ...)` to call this endpoint.",
4116
+ "content": "## PATCH /api/tag-groups/{id}\n\nUpdate the tag group with the given tag group ID.\n\nOnly a tag group's `name` can be changed. A tag group's `exclusive` or `default` value cannot be changed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_tag_group.json)\n\n**Parameters:**\n- `id` (required) — The Tag Group ID\n\nUse `klaviyo.post('tag-groups/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
4117
4117
  "tags": [
4118
4118
  "klaviyo",
4119
4119
  "openapi",
@@ -4126,7 +4126,7 @@
4126
4126
  "platform": "klaviyo",
4127
4127
  "category": "method",
4128
4128
  "summary": "Update Template",
4129
- "content": "## PATCH /api/templates/{id}\n\nUpdate a template with the given template ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`templates:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_template.json)\n\n**Parameters:**\n- `id` (required) — The ID of template\n- `additional-fields[template]` — Request additional fields not included by default in the response. Supported values: 'definition'\n- `fields[template]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/templates/{id}', ...)` to call this endpoint.",
4129
+ "content": "## PATCH /api/templates/{id}\n\nUpdate a template with the given template ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`templates:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_template.json)\n\n**Parameters:**\n- `id` (required) — The ID of template\n- `additional-fields[template]` — Request additional fields not included by default in the response. Supported values: 'definition'\n- `fields[template]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('templates/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
4130
4130
  "tags": [
4131
4131
  "klaviyo",
4132
4132
  "openapi",
@@ -4139,7 +4139,7 @@
4139
4139
  "platform": "klaviyo",
4140
4140
  "category": "method",
4141
4141
  "summary": "Update Tracking Setting",
4142
- "content": "## PATCH /api/tracking-settings/{id}\n\nUpdate the UTM tracking setting with the given account ID.\n\nMore information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`tracking-settings:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_tracking_setting.json)\n\n**Parameters:**\n- `id` (required) — The id of the tracking setting (account ID).\n- `fields[tracking-setting]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/tracking-settings/{id}', ...)` to call this endpoint.",
4142
+ "content": "## PATCH /api/tracking-settings/{id}\n\nUpdate the UTM tracking setting with the given account ID.\n\nMore information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`tracking-settings:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_tracking_setting.json)\n\n**Parameters:**\n- `id` (required) — The id of the tracking setting (account ID).\n- `fields[tracking-setting]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('tracking-settings/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
4143
4143
  "tags": [
4144
4144
  "klaviyo",
4145
4145
  "openapi",
@@ -4152,7 +4152,7 @@
4152
4152
  "platform": "klaviyo",
4153
4153
  "category": "method",
4154
4154
  "summary": "Update Universal Content",
4155
- "content": "## PATCH /api/template-universal-content/{id}\n\nUpdate universal content. The `definition` field can only be updated on the following block types at this time: `button`, `drop_shadow`, `horizontal_rule`, `html`, `image`, `spacer`, and `text`.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`templates:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_universal_content.json)\n\n**Parameters:**\n- `id` (required) — The ID of the template universal content\n- `fields[template-universal-content]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/template-universal-content/{id}', ...)` to call this endpoint.",
4155
+ "content": "## PATCH /api/template-universal-content/{id}\n\nUpdate universal content. The `definition` field can only be updated on the following block types at this time: `button`, `drop_shadow`, `horizontal_rule`, `html`, `image`, `spacer`, and `text`.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`templates:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_universal_content.json)\n\n**Parameters:**\n- `id` (required) — The ID of the template universal content\n- `fields[template-universal-content]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('template-universal-content/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
4156
4156
  "tags": [
4157
4157
  "klaviyo",
4158
4158
  "openapi",
@@ -4165,7 +4165,7 @@
4165
4165
  "platform": "klaviyo",
4166
4166
  "category": "method",
4167
4167
  "summary": "Update Web Feed",
4168
- "content": "## PATCH /api/web-feeds/{id}\n\nUpdate the web feed with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`web-feeds:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_web_feed.json)\n\n**Parameters:**\n- `id` (required) — The ID of the web feed\n- `fields[web-feed]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/web-feeds/{id}', ...)` to call this endpoint.",
4168
+ "content": "## PATCH /api/web-feeds/{id}\n\nUpdate the web feed with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`web-feeds:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_web_feed.json)\n\n**Parameters:**\n- `id` (required) — The ID of the web feed\n- `fields[web-feed]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('web-feeds/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
4169
4169
  "tags": [
4170
4170
  "klaviyo",
4171
4171
  "openapi",
@@ -4178,7 +4178,7 @@
4178
4178
  "platform": "klaviyo",
4179
4179
  "category": "method",
4180
4180
  "summary": "Update Webhook",
4181
- "content": "## PATCH /api/webhooks/{id}\n\nUpdate the webhook with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`webhooks:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_webhook.json)\n\n**Parameters:**\n- `id` (required) — The ID of the webhook.\n- `fields[webhook]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/webhooks/{id}', ...)` to call this endpoint.",
4181
+ "content": "## PATCH /api/webhooks/{id}\n\nUpdate the webhook with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`webhooks:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_webhook.json)\n\n**Parameters:**\n- `id` (required) — The ID of the webhook.\n- `fields[webhook]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('webhooks/{id}', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
4182
4182
  "tags": [
4183
4183
  "klaviyo",
4184
4184
  "openapi",
@@ -4191,7 +4191,7 @@
4191
4191
  "platform": "klaviyo",
4192
4192
  "category": "method",
4193
4193
  "summary": "Upload Image From File",
4194
- "content": "## POST /api/image-upload\n\nUpload an image from a file.\n\nIf you want to import an image from an existing url or a data uri, use the Upload Image From URL endpoint instead.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `100/m`<br>Daily: `100/d`\n\n**Scopes:**\n`images:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/upload_image_from_url.json)\n\n**Parameters:**\n- `fields[image]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/image-upload', ...)` to call this endpoint.",
4194
+ "content": "## POST /api/image-upload\n\nUpload an image from a file.\n\nIf you want to import an image from an existing url or a data uri, use the Upload Image From URL endpoint instead.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `100/m`<br>Daily: `100/d`\n\n**Scopes:**\n`images:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/upload_image_from_url.json)\n\n**Parameters:**\n- `fields[image]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('image-upload', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
4195
4195
  "tags": [
4196
4196
  "klaviyo",
4197
4197
  "openapi",
@@ -4204,7 +4204,7 @@
4204
4204
  "platform": "klaviyo",
4205
4205
  "category": "method",
4206
4206
  "summary": "Upload Image From URL",
4207
- "content": "## POST /api/images\n\nImport an image from a url or data uri.\n\nIf you want to upload an image from a file, use the Upload Image From File endpoint instead.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `100/m`<br>Daily: `100/d`\n\n**Scopes:**\n`images:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/upload_image_from_url.json)\n\n**Parameters:**\n- `fields[image]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('api/images', ...)` to call this endpoint.",
4207
+ "content": "## POST /api/images\n\nImport an image from a url or data uri.\n\nIf you want to upload an image from a file, use the Upload Image From File endpoint instead.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `100/m`<br>Daily: `100/d`\n\n**Scopes:**\n`images:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/upload_image_from_url.json)\n\n**Parameters:**\n- `fields[image]` — For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets\n\nUse `klaviyo.post('images', ...)` to call this endpoint. (Note: the SDK auto-prepends `/api/`, so do NOT include it in the path argument.)",
4208
4208
  "tags": [
4209
4209
  "klaviyo",
4210
4210
  "openapi",