{"id":15145699,"url":"https://github.com/klaviyo/klaviyo-api-python","last_synced_at":"2025-04-05T17:03:40.732Z","repository":{"id":62057380,"uuid":"554442106","full_name":"klaviyo/klaviyo-api-python","owner":"klaviyo","description":"Python SDK for Klaviyo API","archived":false,"fork":false,"pushed_at":"2025-02-21T16:38:17.000Z","size":2487,"stargazers_count":40,"open_issues_count":2,"forks_count":7,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-03-29T16:04:53.793Z","etag":null,"topics":["bigcommerce","ecommerce","email","klaviyo","magento","notifications","prestashop","push","sfcc","shopify","sms","wix","woocommerce"],"latest_commit_sha":null,"homepage":"https://developers.klaviyo.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/klaviyo.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-19T20:27:36.000Z","updated_at":"2025-03-24T11:44:32.000Z","dependencies_parsed_at":"2024-08-06T00:31:38.358Z","dependency_job_id":"5a74ff28-f06d-4356-929a-ebc179cdfeaf","html_url":"https://github.com/klaviyo/klaviyo-api-python","commit_stats":{"total_commits":56,"total_committers":3,"mean_commits":"18.666666666666668","dds":0.5178571428571428,"last_synced_commit":"3fd7b7a332208db5c47873cc9dc85a0708ca1193"},"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaviyo%2Fklaviyo-api-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaviyo%2Fklaviyo-api-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaviyo%2Fklaviyo-api-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaviyo%2Fklaviyo-api-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/klaviyo","download_url":"https://codeload.github.com/klaviyo/klaviyo-api-python/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247369953,"owners_count":20927928,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bigcommerce","ecommerce","email","klaviyo","magento","notifications","prestashop","push","sfcc","shopify","sms","wix","woocommerce"],"created_at":"2024-09-26T11:41:52.431Z","updated_at":"2025-04-05T17:03:40.684Z","avatar_url":"https://github.com/klaviyo.png","language":"Python","readme":"# Klaviyo Python SDK\n\n- SDK version: 18.0.0\n- API revision: 2025-01-15\n\n## Table of Contents\n\u003c!-- TOC --\u003e\n  * [Helpful Resources](#helpful-resources)\n  * [Design \u0026 Approach](#design--approach)\n  * [Organization](#organization)\n  * [Installation](#installation)\n  * [Usage Example](#usage-example)\n    * [To instantiate the client](#to-instantiate-the-client)\n    * [Example request](#example-request)\n    * [Use Case Examples](#use-case-examples)\n      * [How to use filtering, sorting, and spare fieldset JSON API features](#how-to-use-filtering-sorting-and-spare-fieldset-json-api-features)\n      * [How to filter based on datetime](#how-to-filter-based-on-datetime)\n      * [How to use pagination and the page[size] param](#how-to-use-pagination-and-the-pagesize-param)\n      * [How to add additional information to your API response via additional-fields and the `includes` parameter](#how-to-add-additional-information-to-your-api-response-via-additional-fields-and-the-includes-parameter)\n      * [How to use our relationship endpoints to see related resources](#how-to-use-our-relationship-endpoints-to-see-related-resources)\n      * [How to see what Klaviyo objects are associated with a specific tag](#how-to-see-what-klaviyo-objects-are-associated-with-a-specific-tag)\n      * [Uploading Image From File](#uploading-image-from-file)\n  * [Error Handling](#error-handling)\n  * [Important Notes](#important-notes)\n* [Comprehensive List of Operations \u0026 Parameters](#comprehensive-list-of-operations--parameters)\n  * [Accounts](#accounts)\n  * [Campaigns](#campaigns)\n  * [Catalogs](#catalogs)\n  * [Coupons](#coupons)\n  * [Data_Privacy](#dataprivacy)\n  * [Events](#events)\n  * [Flows](#flows)\n  * [Images](#images)\n  * [Lists](#lists)\n  * [Metrics](#metrics)\n  * [Profiles](#profiles)\n  * [Reporting](#reporting)\n  * [Segments](#segments)\n  * [Tags](#tags)\n  * [Templates](#templates)\n* [Appendix](#appendix)\n  * [Global Keyword Args](#global-keyword-args)\n  * [Refresher on catching exceptions:](#refresher-on-catching-exceptions)\n  * [Parameters \u0026 Arguments](#parameters--arguments)\n  * [Namespace](#namespace)\n  * [Renamed Fields](#renamed-fields)\n  * [Filter Builder](#filter-builder)\n  * [Typed Responses](#typed-responses)\n    * [Backwards Compatibility](#backwards-compatibility)\n  * [Untyped Response Data for Specific APIs](#untyped-response-data-for-specific-apis)\n  * [Lazy Imports](#lazy-imports)\n\u003c!-- TOC --\u003e\n\n## Helpful Resources\n\n- [API Reference](https://developers.klaviyo.com/en/v2025-01-15/reference)\n- [API Guides](https://developers.klaviyo.com/en/v2025-01-15/docs)\n- [Postman Workspace](https://www.postman.com/klaviyo/workspace/klaviyo-developers)\n- [Interactive Guide (Jupyter Notebook)](https://github.com/klaviyo-labs/klaviyo-api-guides)\n\n## Design \u0026 Approach\n\nThis SDK is a thin wrapper around our API. See our API Reference for full documentation on behavior.\n\nThis SDK exactly mirrors the organization and naming convention of the above language-agnostic resources, with a few namespace changes to make it Pythonic (details in Appendix).\n\n## Organization\n\nThis SDK is organized into the following resources:\n\n\n\n- Accounts\n\n\n\n- Campaigns\n\n\n\n- Catalogs\n\n\n\n- Coupons\n\n\n\n- Data_Privacy\n\n\n\n- Events\n\n\n\n- Flows\n\n\n\n- Forms\n\n\n\n- Images\n\n\n\n- Lists\n\n\n\n- Metrics\n\n\n\n- Profiles\n\n\n\n- Reporting\n\n\n\n- Reviews\n\n\n\n- Segments\n\n\n\n- Tags\n\n\n\n- Templates\n\n\n\n- Tracking_Settings\n\n\n\n- Webhooks\n\n\n\n## Installation\n\nYou can install this library using [our pip package here](https://pypi.org/project/klaviyo-api/).\n\nDepending on your system configuration, you will need to run *one* of the following shell commands:\n\n```bash\npip install klaviyo-api\n```\n\nOR \n\n```bash\npip3 install klaviyo-api\n```\n\n## Usage Example\n\n### To instantiate the client\n\nNOTE: \n* The SDK retries on resolvable errors, namely: rate limits (common) and server errors (rare).\n* The keyword arguments define some advanced settings; the example is populated with the default values.\n* `max_delay` denotes delay (in seconds) for a single retry attempt.\n\n```python\nfrom klaviyo_api import KlaviyoAPI\n\nklaviyo = KlaviyoAPI(\"YOUR_API_KEY_HERE\", max_delay=60, max_retries=3, test_host=None)\n```\n\n### Example request\n\n```python\nklaviyo.Metrics.get_metrics() \n```\n\n### Use Case Examples\n\n#### How to use filtering, sorting, and spare fieldset JSON API features\n\n**Use Case**: Get events associated with a specific metric, then return just the event properties sorted by oldest to newest datetime.\n\n```python\nklaviyo.Events.get_events(\n    fields_event=['event_properties'], \n    filter=\"equals(metric_id,\\\"aBc123\\\")\", \n    sort='-datetime'\n    )\n```\n\n#### How to filter based on datetime\n\n**Use Case**: Get profiles that have been updated between two datetimes.\n\n```python\nklaviyo.Profiles.get_profiles(\n    filter='less-than(updated,2023-04-26T00:00:00Z),greater-than(updated,2023-04-19T00:00:00Z)'\n    )\n```\n\n#### How to use pagination and the page[size] param\n\n**Use Case**: Use cursor-based pagination to get the next 20 profile records.\n\n```python\nklaviyo.Profiles.get_profiles(\n    page_cursor=\"https://a.klaviyo.com/api/profiles/?page%5Bcursor%5D=bmV4dDo6aWQ6OjAxRjNaWk5ITlRYMUtFVEhQMzJTUzRBN0ZY\",\n    page_size=20\n)\n```\n\nNOTE: This page cursor value is exactly what is returned in the `self`/`next`/`prev` response values\n\n#### How to add additional information to your API response via additional-fields and the `includes` parameter\n\n**Use Case**: Get a specific profile, return an additional predictive analytics field, and also return the list objects associated with the profile.\n\n```python\nklaviyo.Profiles.get_profile(\n    '01GDDKASAP8TKDDA2GRZDSVP4H', \n    additional_fields_profile=['predictive_analytics'], \n    include=['lists']\n)\n```\n\n#### How to use our relationship endpoints to see related resources\n\n**Use Case**: Get all list memberships for a profile with the given `profile_id`.\n\n```python\nklaviyo.Profiles.get_profile_relationships_lists('01GDDKASAP8TKDDA2GRZDSVP4H')\n```\n\n#### How to see what Klaviyo objects are associated with a specific tag\n\n**Use Case**: Get all campaigns associated with the given `tag_id`.\n\n```python\nklaviyo.Tags.get_tag_relationships_campaigns('9c8db7a0-5ab5-4e3c-9a37-a3224fd14382')\n```\n\n#### Uploading Image From File\n\nWhen using `Images.upload_image_from_file(file, name=name)`, `file`` can be either a file path string OR a bytearray.\n\nNOTE: when file is a bytearray, you will need to use the optional `name` parameter to specify the file name, else name will default to `unnamed_image_from_python_sdk`\n\n*as a file path*\n```python\nfilepath = '/path/to/image.png'\nklaviyo.Images.upload_image_from_file(file, name=name)\n```\n\n*as a bytearray*\n```python\nfilepath = '/path/to/image.png'\nwith open(filepath, 'rb') as f:\n    file = f.read()\nklaviyo.Images.upload_image_from_file(file, name=name)\n```\n\n## Error Handling\n\nThis SDK throws an `ApiException` error when the server returns a non-`2XX` response. \n\nAn `ApiException` consists of the following attributes:\n\n* `status` : `int`\n* `reason` : `str`\n* `body` : `bytes`\n    * this can be decoded into a native python dictionary as follows:\n        ```python\n        # to decode to a dictionary\n        import json\n        BODY_DICT = json.loads(YOUR_EXCEPTION.body)\n\n        # to decode to a string\n        BODY_STRING = YOUR_EXCEPTION.body.decode('utf-8')\n        ```\n* `headers` : [class 'urllib3._collections.HTTPHeaderDict'](https://urllib3.readthedocs.io/en/stable/user-guide.html?highlight=httpheaderdict#response-content)\n    * This can be interacted with as a normal dictionary:\n        * ex:\n            ```\n            date = YOUR_EXCEPTION.headers['Date']\n            keys = YOUR_EXCEPTION.headers.keys()\n            values = YOUR_EXCEPTION.headers.values()\n            ```\n\n## Important Notes\n\n- The main difference between this SDK and the language-agnostic API Docs that the below endpoints link to is that this SDK automatically adds the `revision` header corresponding to the SDK version.\n- Organization: Resource groups and operation_ids are listed below in alphabetical order, first by Resource name, then by **OpenAPI Summary**. Operation summaries are those listed in the right side bar of the [API Reference](https://developers.klaviyo.com/en/v2025-01-15/reference/get_events).\n- For example values / data types, as well as whether parameters are required/optional, please reference the corresponding API Reference link.\n- Some keyword args may potentially be required for the API call to succeed, the linked API docs are the source of truth regarding which keyword params are required.\n- JSON payloads should be passed in as native python dictionaries.\n- You can override the client private key by passing in an optional `_request_auth` keyword arg to any API call that takes a private key. As a reminder: do NOT do this client-side/onsite.\n\n# Comprehensive List of Operations \u0026 Parameters\n\n\n\n\n\n## Accounts\n\n#### [Get Account](https://developers.klaviyo.com/en/v2025-01-15/reference/get_account)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_account | List[str]\n\nklaviyo.Accounts.get_account(id, fields_account=fields_account)\n```\n\n\n\n\n#### [Get Accounts](https://developers.klaviyo.com/en/v2025-01-15/reference/get_accounts)\n\n```python\n\n## Keyword Arguments\n\n# fields_account | List[str]\n\nklaviyo.Accounts.get_accounts(fields_account=fields_account)\n```\n\n\n\n\n\n\n## Campaigns\n\n#### [Assign Template to Campaign Message](https://developers.klaviyo.com/en/v2025-01-15/reference/assign_template_to_campaign_message)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Campaigns.assign_template_to_campaign_message(body)\n```\n##### Method alias:\n```python\nklaviyo.Campaigns.create_campaign_message_assign_template(body)\n```\n\n\n\n\n#### [Cancel Campaign Send](https://developers.klaviyo.com/en/v2025-01-15/reference/cancel_campaign_send)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Campaigns.cancel_campaign_send(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Campaigns.update_campaign_send_job(id, body)\n```\n\n\n\n\n#### [Create Campaign](https://developers.klaviyo.com/en/v2025-01-15/reference/create_campaign)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Campaigns.create_campaign(body)\n```\n\n\n\n\n#### [Create Campaign Clone](https://developers.klaviyo.com/en/v2025-01-15/reference/create_campaign_clone)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Campaigns.create_campaign_clone(body)\n```\n##### Method alias:\n```python\nklaviyo.Campaigns.clone_campaign(body)\n```\n\n\n\n\n#### [Delete Campaign](https://developers.klaviyo.com/en/v2025-01-15/reference/delete_campaign)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Campaigns.delete_campaign(id)\n```\n\n\n\n\n#### [Get Campaign](https://developers.klaviyo.com/en/v2025-01-15/reference/get_campaign)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_campaign_message | List[str]\n# fields_campaign | List[str]\n# fields_tag | List[str]\n# include | List[str]\n\nklaviyo.Campaigns.get_campaign(id, fields_campaign_message=fields_campaign_message, fields_campaign=fields_campaign, fields_tag=fields_tag, include=include)\n```\n\n\n\n\n#### [Get Campaign for Campaign Message](https://developers.klaviyo.com/en/v2025-01-15/reference/get_campaign_for_campaign_message)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_campaign | List[str]\n\nklaviyo.Campaigns.get_campaign_for_campaign_message(id, fields_campaign=fields_campaign)\n```\n##### Method alias:\n```python\nklaviyo.Campaigns.get_campaign_message_campaign(id, fields_campaign=fields_campaign)\n```\n\n\n\n\n#### [Get Campaign ID for Campaign Message](https://developers.klaviyo.com/en/v2025-01-15/reference/get_campaign_id_for_campaign_message)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Campaigns.get_campaign_id_for_campaign_message(id)\n```\n##### Method alias:\n```python\nklaviyo.Campaigns.get_campaign_message_relationships_campaign(id)\n```\n\n\n\n\n#### [Get Campaign Message](https://developers.klaviyo.com/en/v2025-01-15/reference/get_campaign_message)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_campaign_message | List[str]\n# fields_campaign | List[str]\n# fields_image | List[str]\n# fields_template | List[str]\n# include | List[str]\n\nklaviyo.Campaigns.get_campaign_message(id, fields_campaign_message=fields_campaign_message, fields_campaign=fields_campaign, fields_image=fields_image, fields_template=fields_template, include=include)\n```\n\n\n\n\n#### [Get Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2025-01-15/reference/get_campaign_recipient_estimation)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_campaign_recipient_estimation | List[str]\n\nklaviyo.Campaigns.get_campaign_recipient_estimation(id, fields_campaign_recipient_estimation=fields_campaign_recipient_estimation)\n```\n\n\n\n\n#### [Get Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_campaign_recipient_estimation_job)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_campaign_recipient_estimation_job | List[str]\n\nklaviyo.Campaigns.get_campaign_recipient_estimation_job(id, fields_campaign_recipient_estimation_job=fields_campaign_recipient_estimation_job)\n```\n\n\n\n\n#### [Get Campaign Send Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_campaign_send_job)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_campaign_send_job | List[str]\n\nklaviyo.Campaigns.get_campaign_send_job(id, fields_campaign_send_job=fields_campaign_send_job)\n```\n\n\n\n\n#### [Get Campaigns](https://developers.klaviyo.com/en/v2025-01-15/reference/get_campaigns)\n\n```python\n## Positional Arguments\n\n# filter | str\n\n## Keyword Arguments\n\n# fields_campaign_message | List[str]\n# fields_campaign | List[str]\n# fields_tag | List[str]\n# include | List[str]\n# page_cursor | str\n# sort | str\n\nklaviyo.Campaigns.get_campaigns(filter, fields_campaign_message=fields_campaign_message, fields_campaign=fields_campaign, fields_tag=fields_tag, include=include, page_cursor=page_cursor, sort=sort)\n```\n\n\n\n\n#### [Get Image for Campaign Message](https://developers.klaviyo.com/en/v2025-01-15/reference/get_image_for_campaign_message)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_image | List[str]\n\nklaviyo.Campaigns.get_image_for_campaign_message(id, fields_image=fields_image)\n```\n##### Method alias:\n```python\nklaviyo.Campaigns.get_campaign_message_image(id, fields_image=fields_image)\n```\n\n\n\n\n#### [Get Image ID for Campaign Message](https://developers.klaviyo.com/en/v2025-01-15/reference/get_image_id_for_campaign_message)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Campaigns.get_image_id_for_campaign_message(id)\n```\n##### Method alias:\n```python\nklaviyo.Campaigns.get_campaign_message_relationships_image(id)\n```\n\n\n\n\n#### [Get Message IDs for Campaign](https://developers.klaviyo.com/en/v2025-01-15/reference/get_message_ids_for_campaign)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Campaigns.get_message_ids_for_campaign(id)\n```\n##### Method alias:\n```python\nklaviyo.Campaigns.get_campaign_relationships_campaign_messages(id)\n```\n##### Method alias:\n```python\nklaviyo.Campaigns.get_campaign_relationships_messages(id)\n```\n\n\n\n\n#### [Get Messages for Campaign](https://developers.klaviyo.com/en/v2025-01-15/reference/get_messages_for_campaign)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_campaign_message | List[str]\n# fields_campaign | List[str]\n# fields_image | List[str]\n# fields_template | List[str]\n# include | List[str]\n\nklaviyo.Campaigns.get_messages_for_campaign(id, fields_campaign_message=fields_campaign_message, fields_campaign=fields_campaign, fields_image=fields_image, fields_template=fields_template, include=include)\n```\n##### Method alias:\n```python\nklaviyo.Campaigns.get_campaign_campaign_messages(id, fields_campaign_message=fields_campaign_message, fields_campaign=fields_campaign, fields_image=fields_image, fields_template=fields_template, include=include)\n```\n##### Method alias:\n```python\nklaviyo.Campaigns.get_campaign_messages(id, fields_campaign_message=fields_campaign_message, fields_campaign=fields_campaign, fields_image=fields_image, fields_template=fields_template, include=include)\n```\n\n\n\n\n#### [Get Tag IDs for Campaign](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tag_ids_for_campaign)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Campaigns.get_tag_ids_for_campaign(id)\n```\n##### Method alias:\n```python\nklaviyo.Campaigns.get_campaign_relationships_tags(id)\n```\n\n\n\n\n#### [Get Tags for Campaign](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tags_for_campaign)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_tag | List[str]\n\nklaviyo.Campaigns.get_tags_for_campaign(id, fields_tag=fields_tag)\n```\n##### Method alias:\n```python\nklaviyo.Campaigns.get_campaign_tags(id, fields_tag=fields_tag)\n```\n\n\n\n\n#### [Get Template for Campaign Message](https://developers.klaviyo.com/en/v2025-01-15/reference/get_template_for_campaign_message)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_template | List[str]\n\nklaviyo.Campaigns.get_template_for_campaign_message(id, fields_template=fields_template)\n```\n##### Method alias:\n```python\nklaviyo.Campaigns.get_campaign_message_template(id, fields_template=fields_template)\n```\n\n\n\n\n#### [Get Template ID for Campaign Message](https://developers.klaviyo.com/en/v2025-01-15/reference/get_template_id_for_campaign_message)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Campaigns.get_template_id_for_campaign_message(id)\n```\n##### Method alias:\n```python\nklaviyo.Campaigns.get_campaign_message_relationships_template(id)\n```\n\n\n\n\n#### [Refresh Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2025-01-15/reference/refresh_campaign_recipient_estimation)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Campaigns.refresh_campaign_recipient_estimation(body)\n```\n##### Method alias:\n```python\nklaviyo.Campaigns.create_campaign_recipient_estimation_job(body)\n```\n\n\n\n\n#### [Send Campaign](https://developers.klaviyo.com/en/v2025-01-15/reference/send_campaign)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Campaigns.send_campaign(body)\n```\n##### Method alias:\n```python\nklaviyo.Campaigns.create_campaign_send_job(body)\n```\n\n\n\n\n#### [Update Campaign](https://developers.klaviyo.com/en/v2025-01-15/reference/update_campaign)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Campaigns.update_campaign(id, body)\n```\n\n\n\n\n#### [Update Campaign Message](https://developers.klaviyo.com/en/v2025-01-15/reference/update_campaign_message)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Campaigns.update_campaign_message(id, body)\n```\n\n\n\n\n#### [Update Image for Campaign Message](https://developers.klaviyo.com/en/v2025-01-15/reference/update_image_for_campaign_message)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Campaigns.update_image_for_campaign_message(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Campaigns.update_campaign_message_relationships_image(id, body)\n```\n\n\n\n\n\n\n## Catalogs\n\n#### [Add Categories to Catalog Item](https://developers.klaviyo.com/en/v2025-01-15/reference/add_categories_to_catalog_item)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Catalogs.add_categories_to_catalog_item(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.add_category_to_catalog_item(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.create_catalog_item_relationships_category(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.create_catalog_item_relationships_categories(id, body)\n```\n\n\n\n\n#### [Add Items to Catalog Category](https://developers.klaviyo.com/en/v2025-01-15/reference/add_items_to_catalog_category)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Catalogs.add_items_to_catalog_category(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.create_catalog_category_relationships_item(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.create_catalog_category_relationships_items(id, body)\n```\n\n\n\n\n#### [Bulk Create Catalog Categories](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_create_catalog_categories)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Catalogs.bulk_create_catalog_categories(body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.spawn_create_categories_job(body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.create_catalog_category_bulk_create_job(body)\n```\n\n\n\n\n#### [Bulk Create Catalog Items](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_create_catalog_items)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Catalogs.bulk_create_catalog_items(body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.spawn_create_items_job(body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.create_catalog_item_bulk_create_job(body)\n```\n\n\n\n\n#### [Bulk Create Catalog Variants](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_create_catalog_variants)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Catalogs.bulk_create_catalog_variants(body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.spawn_create_variants_job(body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.create_catalog_variant_bulk_create_job(body)\n```\n\n\n\n\n#### [Bulk Delete Catalog Categories](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_delete_catalog_categories)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Catalogs.bulk_delete_catalog_categories(body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.spawn_delete_categories_job(body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.create_catalog_category_bulk_delete_job(body)\n```\n\n\n\n\n#### [Bulk Delete Catalog Items](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_delete_catalog_items)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Catalogs.bulk_delete_catalog_items(body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.spawn_delete_items_job(body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.create_catalog_item_bulk_delete_job(body)\n```\n\n\n\n\n#### [Bulk Delete Catalog Variants](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_delete_catalog_variants)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Catalogs.bulk_delete_catalog_variants(body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.spawn_delete_variants_job(body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.create_catalog_variant_bulk_delete_job(body)\n```\n\n\n\n\n#### [Bulk Update Catalog Categories](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_update_catalog_categories)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Catalogs.bulk_update_catalog_categories(body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.spawn_update_categories_job(body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.create_catalog_category_bulk_update_job(body)\n```\n\n\n\n\n#### [Bulk Update Catalog Items](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_update_catalog_items)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Catalogs.bulk_update_catalog_items(body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.spawn_update_items_job(body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.create_catalog_item_bulk_update_job(body)\n```\n\n\n\n\n#### [Bulk Update Catalog Variants](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_update_catalog_variants)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Catalogs.bulk_update_catalog_variants(body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.spawn_update_variants_job(body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.create_catalog_variant_bulk_update_job(body)\n```\n\n\n\n\n#### [Create Back In Stock Subscription](https://developers.klaviyo.com/en/v2025-01-15/reference/create_back_in_stock_subscription)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Catalogs.create_back_in_stock_subscription(body)\n```\n\n\n\n\n#### [Create Catalog Category](https://developers.klaviyo.com/en/v2025-01-15/reference/create_catalog_category)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Catalogs.create_catalog_category(body)\n```\n\n\n\n\n#### [Create Catalog Item](https://developers.klaviyo.com/en/v2025-01-15/reference/create_catalog_item)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Catalogs.create_catalog_item(body)\n```\n\n\n\n\n#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2025-01-15/reference/create_catalog_variant)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Catalogs.create_catalog_variant(body)\n```\n\n\n\n\n#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2025-01-15/reference/delete_catalog_category)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Catalogs.delete_catalog_category(id)\n```\n\n\n\n\n#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2025-01-15/reference/delete_catalog_item)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Catalogs.delete_catalog_item(id)\n```\n\n\n\n\n#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2025-01-15/reference/delete_catalog_variant)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Catalogs.delete_catalog_variant(id)\n```\n\n\n\n\n#### [Get Bulk Create Catalog Items Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_create_catalog_items_job)\n\n```python\n## Positional Arguments\n\n# job_id | str\n\n## Keyword Arguments\n\n# fields_catalog_item_bulk_create_job | List[str]\n# fields_catalog_item | List[str]\n# include | List[str]\n\nklaviyo.Catalogs.get_bulk_create_catalog_items_job(job_id, fields_catalog_item_bulk_create_job=fields_catalog_item_bulk_create_job, fields_catalog_item=fields_catalog_item, include=include)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_create_items_job(job_id, fields_catalog_item_bulk_create_job=fields_catalog_item_bulk_create_job, fields_catalog_item=fields_catalog_item, include=include)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_catalog_item_bulk_create_job(job_id, fields_catalog_item_bulk_create_job=fields_catalog_item_bulk_create_job, fields_catalog_item=fields_catalog_item, include=include)\n```\n\n\n\n\n#### [Get Bulk Create Catalog Items Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_create_catalog_items_jobs)\n\n```python\n\n## Keyword Arguments\n\n# fields_catalog_item_bulk_create_job | List[str]\n# filter | str\n# page_cursor | str\n\nklaviyo.Catalogs.get_bulk_create_catalog_items_jobs(fields_catalog_item_bulk_create_job=fields_catalog_item_bulk_create_job, filter=filter, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_create_items_jobs(fields_catalog_item_bulk_create_job=fields_catalog_item_bulk_create_job, filter=filter, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_catalog_item_bulk_create_jobs(fields_catalog_item_bulk_create_job=fields_catalog_item_bulk_create_job, filter=filter, page_cursor=page_cursor)\n```\n\n\n\n\n#### [Get Bulk Create Categories Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_create_categories_job)\n\n```python\n## Positional Arguments\n\n# job_id | str\n\n## Keyword Arguments\n\n# fields_catalog_category_bulk_create_job | List[str]\n# fields_catalog_category | List[str]\n# include | List[str]\n\nklaviyo.Catalogs.get_bulk_create_categories_job(job_id, fields_catalog_category_bulk_create_job=fields_catalog_category_bulk_create_job, fields_catalog_category=fields_catalog_category, include=include)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_create_categories_job(job_id, fields_catalog_category_bulk_create_job=fields_catalog_category_bulk_create_job, fields_catalog_category=fields_catalog_category, include=include)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_catalog_category_bulk_create_job(job_id, fields_catalog_category_bulk_create_job=fields_catalog_category_bulk_create_job, fields_catalog_category=fields_catalog_category, include=include)\n```\n\n\n\n\n#### [Get Bulk Create Categories Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_create_categories_jobs)\n\n```python\n\n## Keyword Arguments\n\n# fields_catalog_category_bulk_create_job | List[str]\n# filter | str\n# page_cursor | str\n\nklaviyo.Catalogs.get_bulk_create_categories_jobs(fields_catalog_category_bulk_create_job=fields_catalog_category_bulk_create_job, filter=filter, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_create_categories_jobs(fields_catalog_category_bulk_create_job=fields_catalog_category_bulk_create_job, filter=filter, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_catalog_category_bulk_create_jobs(fields_catalog_category_bulk_create_job=fields_catalog_category_bulk_create_job, filter=filter, page_cursor=page_cursor)\n```\n\n\n\n\n#### [Get Bulk Create Variants Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_create_variants_job)\n\n```python\n## Positional Arguments\n\n# job_id | str\n\n## Keyword Arguments\n\n# fields_catalog_variant_bulk_create_job | List[str]\n# fields_catalog_variant | List[str]\n# include | List[str]\n\nklaviyo.Catalogs.get_bulk_create_variants_job(job_id, fields_catalog_variant_bulk_create_job=fields_catalog_variant_bulk_create_job, fields_catalog_variant=fields_catalog_variant, include=include)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_create_variants_job(job_id, fields_catalog_variant_bulk_create_job=fields_catalog_variant_bulk_create_job, fields_catalog_variant=fields_catalog_variant, include=include)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_catalog_variant_bulk_create_job(job_id, fields_catalog_variant_bulk_create_job=fields_catalog_variant_bulk_create_job, fields_catalog_variant=fields_catalog_variant, include=include)\n```\n\n\n\n\n#### [Get Bulk Create Variants Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_create_variants_jobs)\n\n```python\n\n## Keyword Arguments\n\n# fields_catalog_variant_bulk_create_job | List[str]\n# filter | str\n# page_cursor | str\n\nklaviyo.Catalogs.get_bulk_create_variants_jobs(fields_catalog_variant_bulk_create_job=fields_catalog_variant_bulk_create_job, filter=filter, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_create_variants_jobs(fields_catalog_variant_bulk_create_job=fields_catalog_variant_bulk_create_job, filter=filter, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_catalog_variant_bulk_create_jobs(fields_catalog_variant_bulk_create_job=fields_catalog_variant_bulk_create_job, filter=filter, page_cursor=page_cursor)\n```\n\n\n\n\n#### [Get Bulk Delete Catalog Items Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_delete_catalog_items_job)\n\n```python\n## Positional Arguments\n\n# job_id | str\n\n## Keyword Arguments\n\n# fields_catalog_item_bulk_delete_job | List[str]\n\nklaviyo.Catalogs.get_bulk_delete_catalog_items_job(job_id, fields_catalog_item_bulk_delete_job=fields_catalog_item_bulk_delete_job)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_delete_items_job(job_id, fields_catalog_item_bulk_delete_job=fields_catalog_item_bulk_delete_job)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_catalog_item_bulk_delete_job(job_id, fields_catalog_item_bulk_delete_job=fields_catalog_item_bulk_delete_job)\n```\n\n\n\n\n#### [Get Bulk Delete Catalog Items Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_delete_catalog_items_jobs)\n\n```python\n\n## Keyword Arguments\n\n# fields_catalog_item_bulk_delete_job | List[str]\n# filter | str\n# page_cursor | str\n\nklaviyo.Catalogs.get_bulk_delete_catalog_items_jobs(fields_catalog_item_bulk_delete_job=fields_catalog_item_bulk_delete_job, filter=filter, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_delete_items_jobs(fields_catalog_item_bulk_delete_job=fields_catalog_item_bulk_delete_job, filter=filter, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_catalog_item_bulk_delete_jobs(fields_catalog_item_bulk_delete_job=fields_catalog_item_bulk_delete_job, filter=filter, page_cursor=page_cursor)\n```\n\n\n\n\n#### [Get Bulk Delete Categories Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_delete_categories_job)\n\n```python\n## Positional Arguments\n\n# job_id | str\n\n## Keyword Arguments\n\n# fields_catalog_category_bulk_delete_job | List[str]\n\nklaviyo.Catalogs.get_bulk_delete_categories_job(job_id, fields_catalog_category_bulk_delete_job=fields_catalog_category_bulk_delete_job)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_delete_categories_job(job_id, fields_catalog_category_bulk_delete_job=fields_catalog_category_bulk_delete_job)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_catalog_category_bulk_delete_job(job_id, fields_catalog_category_bulk_delete_job=fields_catalog_category_bulk_delete_job)\n```\n\n\n\n\n#### [Get Bulk Delete Categories Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_delete_categories_jobs)\n\n```python\n\n## Keyword Arguments\n\n# fields_catalog_category_bulk_delete_job | List[str]\n# filter | str\n# page_cursor | str\n\nklaviyo.Catalogs.get_bulk_delete_categories_jobs(fields_catalog_category_bulk_delete_job=fields_catalog_category_bulk_delete_job, filter=filter, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_delete_categories_jobs(fields_catalog_category_bulk_delete_job=fields_catalog_category_bulk_delete_job, filter=filter, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_catalog_category_bulk_delete_jobs(fields_catalog_category_bulk_delete_job=fields_catalog_category_bulk_delete_job, filter=filter, page_cursor=page_cursor)\n```\n\n\n\n\n#### [Get Bulk Delete Variants Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_delete_variants_job)\n\n```python\n## Positional Arguments\n\n# job_id | str\n\n## Keyword Arguments\n\n# fields_catalog_variant_bulk_delete_job | List[str]\n\nklaviyo.Catalogs.get_bulk_delete_variants_job(job_id, fields_catalog_variant_bulk_delete_job=fields_catalog_variant_bulk_delete_job)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_delete_variants_job(job_id, fields_catalog_variant_bulk_delete_job=fields_catalog_variant_bulk_delete_job)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_catalog_variant_bulk_delete_job(job_id, fields_catalog_variant_bulk_delete_job=fields_catalog_variant_bulk_delete_job)\n```\n\n\n\n\n#### [Get Bulk Delete Variants Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_delete_variants_jobs)\n\n```python\n\n## Keyword Arguments\n\n# fields_catalog_variant_bulk_delete_job | List[str]\n# filter | str\n# page_cursor | str\n\nklaviyo.Catalogs.get_bulk_delete_variants_jobs(fields_catalog_variant_bulk_delete_job=fields_catalog_variant_bulk_delete_job, filter=filter, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_delete_variants_jobs(fields_catalog_variant_bulk_delete_job=fields_catalog_variant_bulk_delete_job, filter=filter, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_catalog_variant_bulk_delete_jobs(fields_catalog_variant_bulk_delete_job=fields_catalog_variant_bulk_delete_job, filter=filter, page_cursor=page_cursor)\n```\n\n\n\n\n#### [Get Bulk Update Catalog Items Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_update_catalog_items_job)\n\n```python\n## Positional Arguments\n\n# job_id | str\n\n## Keyword Arguments\n\n# fields_catalog_item_bulk_update_job | List[str]\n# fields_catalog_item | List[str]\n# include | List[str]\n\nklaviyo.Catalogs.get_bulk_update_catalog_items_job(job_id, fields_catalog_item_bulk_update_job=fields_catalog_item_bulk_update_job, fields_catalog_item=fields_catalog_item, include=include)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_update_items_job(job_id, fields_catalog_item_bulk_update_job=fields_catalog_item_bulk_update_job, fields_catalog_item=fields_catalog_item, include=include)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_catalog_item_bulk_update_job(job_id, fields_catalog_item_bulk_update_job=fields_catalog_item_bulk_update_job, fields_catalog_item=fields_catalog_item, include=include)\n```\n\n\n\n\n#### [Get Bulk Update Catalog Items Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_update_catalog_items_jobs)\n\n```python\n\n## Keyword Arguments\n\n# fields_catalog_item_bulk_update_job | List[str]\n# filter | str\n# page_cursor | str\n\nklaviyo.Catalogs.get_bulk_update_catalog_items_jobs(fields_catalog_item_bulk_update_job=fields_catalog_item_bulk_update_job, filter=filter, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_update_items_jobs(fields_catalog_item_bulk_update_job=fields_catalog_item_bulk_update_job, filter=filter, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_catalog_item_bulk_update_jobs(fields_catalog_item_bulk_update_job=fields_catalog_item_bulk_update_job, filter=filter, page_cursor=page_cursor)\n```\n\n\n\n\n#### [Get Bulk Update Categories Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_update_categories_job)\n\n```python\n## Positional Arguments\n\n# job_id | str\n\n## Keyword Arguments\n\n# fields_catalog_category_bulk_update_job | List[str]\n# fields_catalog_category | List[str]\n# include | List[str]\n\nklaviyo.Catalogs.get_bulk_update_categories_job(job_id, fields_catalog_category_bulk_update_job=fields_catalog_category_bulk_update_job, fields_catalog_category=fields_catalog_category, include=include)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_update_categories_job(job_id, fields_catalog_category_bulk_update_job=fields_catalog_category_bulk_update_job, fields_catalog_category=fields_catalog_category, include=include)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_catalog_category_bulk_update_job(job_id, fields_catalog_category_bulk_update_job=fields_catalog_category_bulk_update_job, fields_catalog_category=fields_catalog_category, include=include)\n```\n\n\n\n\n#### [Get Bulk Update Categories Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_update_categories_jobs)\n\n```python\n\n## Keyword Arguments\n\n# fields_catalog_category_bulk_update_job | List[str]\n# filter | str\n# page_cursor | str\n\nklaviyo.Catalogs.get_bulk_update_categories_jobs(fields_catalog_category_bulk_update_job=fields_catalog_category_bulk_update_job, filter=filter, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_update_categories_jobs(fields_catalog_category_bulk_update_job=fields_catalog_category_bulk_update_job, filter=filter, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_catalog_category_bulk_update_jobs(fields_catalog_category_bulk_update_job=fields_catalog_category_bulk_update_job, filter=filter, page_cursor=page_cursor)\n```\n\n\n\n\n#### [Get Bulk Update Variants Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_update_variants_job)\n\n```python\n## Positional Arguments\n\n# job_id | str\n\n## Keyword Arguments\n\n# fields_catalog_variant_bulk_update_job | List[str]\n# fields_catalog_variant | List[str]\n# include | List[str]\n\nklaviyo.Catalogs.get_bulk_update_variants_job(job_id, fields_catalog_variant_bulk_update_job=fields_catalog_variant_bulk_update_job, fields_catalog_variant=fields_catalog_variant, include=include)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_update_variants_job(job_id, fields_catalog_variant_bulk_update_job=fields_catalog_variant_bulk_update_job, fields_catalog_variant=fields_catalog_variant, include=include)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_catalog_variant_bulk_update_job(job_id, fields_catalog_variant_bulk_update_job=fields_catalog_variant_bulk_update_job, fields_catalog_variant=fields_catalog_variant, include=include)\n```\n\n\n\n\n#### [Get Bulk Update Variants Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_update_variants_jobs)\n\n```python\n\n## Keyword Arguments\n\n# fields_catalog_variant_bulk_update_job | List[str]\n# filter | str\n# page_cursor | str\n\nklaviyo.Catalogs.get_bulk_update_variants_jobs(fields_catalog_variant_bulk_update_job=fields_catalog_variant_bulk_update_job, filter=filter, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_update_variants_jobs(fields_catalog_variant_bulk_update_job=fields_catalog_variant_bulk_update_job, filter=filter, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_catalog_variant_bulk_update_jobs(fields_catalog_variant_bulk_update_job=fields_catalog_variant_bulk_update_job, filter=filter, page_cursor=page_cursor)\n```\n\n\n\n\n#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2025-01-15/reference/get_catalog_categories)\n\n```python\n\n## Keyword Arguments\n\n# fields_catalog_category | List[str]\n# filter | str\n# page_cursor | str\n# sort | str\n\nklaviyo.Catalogs.get_catalog_categories(fields_catalog_category=fields_catalog_category, filter=filter, page_cursor=page_cursor, sort=sort)\n```\n\n\n\n\n#### [Get Catalog Category](https://developers.klaviyo.com/en/v2025-01-15/reference/get_catalog_category)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_catalog_category | List[str]\n\nklaviyo.Catalogs.get_catalog_category(id, fields_catalog_category=fields_catalog_category)\n```\n\n\n\n\n#### [Get Catalog Item](https://developers.klaviyo.com/en/v2025-01-15/reference/get_catalog_item)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_catalog_item | List[str]\n# fields_catalog_variant | List[str]\n# include | List[str]\n\nklaviyo.Catalogs.get_catalog_item(id, fields_catalog_item=fields_catalog_item, fields_catalog_variant=fields_catalog_variant, include=include)\n```\n\n\n\n\n#### [Get Catalog Items](https://developers.klaviyo.com/en/v2025-01-15/reference/get_catalog_items)\n\n```python\n\n## Keyword Arguments\n\n# fields_catalog_item | List[str]\n# fields_catalog_variant | List[str]\n# filter | str\n# include | List[str]\n# page_cursor | str\n# sort | str\n\nklaviyo.Catalogs.get_catalog_items(fields_catalog_item=fields_catalog_item, fields_catalog_variant=fields_catalog_variant, filter=filter, include=include, page_cursor=page_cursor, sort=sort)\n```\n\n\n\n\n#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2025-01-15/reference/get_catalog_variant)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_catalog_variant | List[str]\n\nklaviyo.Catalogs.get_catalog_variant(id, fields_catalog_variant=fields_catalog_variant)\n```\n\n\n\n\n#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2025-01-15/reference/get_catalog_variants)\n\n```python\n\n## Keyword Arguments\n\n# fields_catalog_variant | List[str]\n# filter | str\n# page_cursor | str\n# sort | str\n\nklaviyo.Catalogs.get_catalog_variants(fields_catalog_variant=fields_catalog_variant, filter=filter, page_cursor=page_cursor, sort=sort)\n```\n\n\n\n\n#### [Get Categories for Catalog Item](https://developers.klaviyo.com/en/v2025-01-15/reference/get_categories_for_catalog_item)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_catalog_category | List[str]\n# filter | str\n# page_cursor | str\n# sort | str\n\nklaviyo.Catalogs.get_categories_for_catalog_item(id, fields_catalog_category=fields_catalog_category, filter=filter, page_cursor=page_cursor, sort=sort)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_catalog_item_categories(id, fields_catalog_category=fields_catalog_category, filter=filter, page_cursor=page_cursor, sort=sort)\n```\n\n\n\n\n#### [Get Category IDs for Catalog Item](https://developers.klaviyo.com/en/v2025-01-15/reference/get_category_ids_for_catalog_item)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# filter | str\n# page_cursor | str\n# sort | str\n\nklaviyo.Catalogs.get_category_ids_for_catalog_item(id, filter=filter, page_cursor=page_cursor, sort=sort)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_catalog_item_relationships_categories(id, filter=filter, page_cursor=page_cursor, sort=sort)\n```\n\n\n\n\n#### [Get Item IDs for Catalog Category](https://developers.klaviyo.com/en/v2025-01-15/reference/get_item_ids_for_catalog_category)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# filter | str\n# page_cursor | str\n# sort | str\n\nklaviyo.Catalogs.get_item_ids_for_catalog_category(id, filter=filter, page_cursor=page_cursor, sort=sort)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_catalog_category_relationships_items(id, filter=filter, page_cursor=page_cursor, sort=sort)\n```\n\n\n\n\n#### [Get Items for Catalog Category](https://developers.klaviyo.com/en/v2025-01-15/reference/get_items_for_catalog_category)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_catalog_item | List[str]\n# fields_catalog_variant | List[str]\n# filter | str\n# include | List[str]\n# page_cursor | str\n# sort | str\n\nklaviyo.Catalogs.get_items_for_catalog_category(id, fields_catalog_item=fields_catalog_item, fields_catalog_variant=fields_catalog_variant, filter=filter, include=include, page_cursor=page_cursor, sort=sort)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_catalog_category_items(id, fields_catalog_item=fields_catalog_item, fields_catalog_variant=fields_catalog_variant, filter=filter, include=include, page_cursor=page_cursor, sort=sort)\n```\n\n\n\n\n#### [Get Variant IDs for Catalog Item](https://developers.klaviyo.com/en/v2025-01-15/reference/get_variant_ids_for_catalog_item)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# filter | str\n# page_cursor | str\n# sort | str\n\nklaviyo.Catalogs.get_variant_ids_for_catalog_item(id, filter=filter, page_cursor=page_cursor, sort=sort)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_catalog_item_relationships_variants(id, filter=filter, page_cursor=page_cursor, sort=sort)\n```\n\n\n\n\n#### [Get Variants for Catalog Item](https://developers.klaviyo.com/en/v2025-01-15/reference/get_variants_for_catalog_item)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_catalog_variant | List[str]\n# filter | str\n# page_cursor | str\n# sort | str\n\nklaviyo.Catalogs.get_variants_for_catalog_item(id, fields_catalog_variant=fields_catalog_variant, filter=filter, page_cursor=page_cursor, sort=sort)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.get_catalog_item_variants(id, fields_catalog_variant=fields_catalog_variant, filter=filter, page_cursor=page_cursor, sort=sort)\n```\n\n\n\n\n#### [Remove Categories from Catalog Item](https://developers.klaviyo.com/en/v2025-01-15/reference/remove_categories_from_catalog_item)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Catalogs.remove_categories_from_catalog_item(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.delete_catalog_item_relationships_categories(id, body)\n```\n\n\n\n\n#### [Remove Items from Catalog Category](https://developers.klaviyo.com/en/v2025-01-15/reference/remove_items_from_catalog_category)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Catalogs.remove_items_from_catalog_category(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.delete_catalog_category_relationships_items(id, body)\n```\n\n\n\n\n#### [Update Catalog Category](https://developers.klaviyo.com/en/v2025-01-15/reference/update_catalog_category)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Catalogs.update_catalog_category(id, body)\n```\n\n\n\n\n#### [Update Catalog Item](https://developers.klaviyo.com/en/v2025-01-15/reference/update_catalog_item)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Catalogs.update_catalog_item(id, body)\n```\n\n\n\n\n#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2025-01-15/reference/update_catalog_variant)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Catalogs.update_catalog_variant(id, body)\n```\n\n\n\n\n#### [Update Categories for Catalog Item](https://developers.klaviyo.com/en/v2025-01-15/reference/update_categories_for_catalog_item)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Catalogs.update_categories_for_catalog_item(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.update_catalog_item_relationships_categories(id, body)\n```\n\n\n\n\n#### [Update Items for Catalog Category](https://developers.klaviyo.com/en/v2025-01-15/reference/update_items_for_catalog_category)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Catalogs.update_items_for_catalog_category(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Catalogs.update_catalog_category_relationships_items(id, body)\n```\n\n\n\n\n\n\n## Coupons\n\n#### [Bulk Create Coupon Codes](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_create_coupon_codes)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Coupons.bulk_create_coupon_codes(body)\n```\n##### Method alias:\n```python\nklaviyo.Coupons.spawn_coupon_code_bulk_create_job(body)\n```\n##### Method alias:\n```python\nklaviyo.Coupons.create_coupon_code_bulk_create_job(body)\n```\n\n\n\n\n#### [Create Coupon](https://developers.klaviyo.com/en/v2025-01-15/reference/create_coupon)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Coupons.create_coupon(body)\n```\n\n\n\n\n#### [Create Coupon Code](https://developers.klaviyo.com/en/v2025-01-15/reference/create_coupon_code)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Coupons.create_coupon_code(body)\n```\n\n\n\n\n#### [Delete Coupon](https://developers.klaviyo.com/en/v2025-01-15/reference/delete_coupon)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Coupons.delete_coupon(id)\n```\n\n\n\n\n#### [Delete Coupon Code](https://developers.klaviyo.com/en/v2025-01-15/reference/delete_coupon_code)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Coupons.delete_coupon_code(id)\n```\n\n\n\n\n#### [Get Bulk Create Coupon Code Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_create_coupon_code_jobs)\n\n```python\n\n## Keyword Arguments\n\n# fields_coupon_code_bulk_create_job | List[str]\n# filter | str\n# page_cursor | str\n\nklaviyo.Coupons.get_bulk_create_coupon_code_jobs(fields_coupon_code_bulk_create_job=fields_coupon_code_bulk_create_job, filter=filter, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Coupons.get_coupon_code_bulk_create_jobs(fields_coupon_code_bulk_create_job=fields_coupon_code_bulk_create_job, filter=filter, page_cursor=page_cursor)\n```\n\n\n\n\n#### [Get Bulk Create Coupon Codes Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_create_coupon_codes_job)\n\n```python\n## Positional Arguments\n\n# job_id | str\n\n## Keyword Arguments\n\n# fields_coupon_code_bulk_create_job | List[str]\n# fields_coupon_code | List[str]\n# include | List[str]\n\nklaviyo.Coupons.get_bulk_create_coupon_codes_job(job_id, fields_coupon_code_bulk_create_job=fields_coupon_code_bulk_create_job, fields_coupon_code=fields_coupon_code, include=include)\n```\n##### Method alias:\n```python\nklaviyo.Coupons.get_coupon_code_bulk_create_job(job_id, fields_coupon_code_bulk_create_job=fields_coupon_code_bulk_create_job, fields_coupon_code=fields_coupon_code, include=include)\n```\n\n\n\n\n#### [Get Coupon](https://developers.klaviyo.com/en/v2025-01-15/reference/get_coupon)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_coupon | List[str]\n\nklaviyo.Coupons.get_coupon(id, fields_coupon=fields_coupon)\n```\n\n\n\n\n#### [Get Coupon Code](https://developers.klaviyo.com/en/v2025-01-15/reference/get_coupon_code)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_coupon_code | List[str]\n# fields_coupon | List[str]\n# include | List[str]\n\nklaviyo.Coupons.get_coupon_code(id, fields_coupon_code=fields_coupon_code, fields_coupon=fields_coupon, include=include)\n```\n\n\n\n\n#### [Get Coupon Code IDs for Coupon](https://developers.klaviyo.com/en/v2025-01-15/reference/get_coupon_code_ids_for_coupon)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# filter | str\n# page_cursor | str\n\nklaviyo.Coupons.get_coupon_code_ids_for_coupon(id, filter=filter, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Coupons.get_coupon_code_relationships_coupon(id, filter=filter, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Coupons.get_code_ids_for_coupon(id, filter=filter, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Coupons.get_coupon_relationships_codes(id, filter=filter, page_cursor=page_cursor)\n```\n\n\n\n\n#### [Get Coupon Codes](https://developers.klaviyo.com/en/v2025-01-15/reference/get_coupon_codes)\n\n```python\n## Positional Arguments\n\n# filter | str\n\n## Keyword Arguments\n\n# fields_coupon_code | List[str]\n# fields_coupon | List[str]\n# include | List[str]\n# page_cursor | str\n\nklaviyo.Coupons.get_coupon_codes(filter, fields_coupon_code=fields_coupon_code, fields_coupon=fields_coupon, include=include, page_cursor=page_cursor)\n```\n\n\n\n\n#### [Get Coupon Codes for Coupon](https://developers.klaviyo.com/en/v2025-01-15/reference/get_coupon_codes_for_coupon)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_coupon_code | List[str]\n# filter | str\n# page_cursor | str\n\nklaviyo.Coupons.get_coupon_codes_for_coupon(id, fields_coupon_code=fields_coupon_code, filter=filter, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Coupons.get_coupon_coupon_codes(id, fields_coupon_code=fields_coupon_code, filter=filter, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Coupons.get_codes_for_coupon(id, fields_coupon_code=fields_coupon_code, filter=filter, page_cursor=page_cursor)\n```\n\n\n\n\n#### [Get Coupon For Coupon Code](https://developers.klaviyo.com/en/v2025-01-15/reference/get_coupon_for_coupon_code)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_coupon | List[str]\n\nklaviyo.Coupons.get_coupon_for_coupon_code(id, fields_coupon=fields_coupon)\n```\n##### Method alias:\n```python\nklaviyo.Coupons.get_coupon_code_coupon(id, fields_coupon=fields_coupon)\n```\n\n\n\n\n#### [Get Coupon ID for Coupon Code](https://developers.klaviyo.com/en/v2025-01-15/reference/get_coupon_id_for_coupon_code)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Coupons.get_coupon_id_for_coupon_code(id)\n```\n##### Method alias:\n```python\nklaviyo.Coupons.get_coupon_relationships_coupon_codes(id)\n```\n\n\n\n\n#### [Get Coupons](https://developers.klaviyo.com/en/v2025-01-15/reference/get_coupons)\n\n```python\n\n## Keyword Arguments\n\n# fields_coupon | List[str]\n# page_cursor | str\n\nklaviyo.Coupons.get_coupons(fields_coupon=fields_coupon, page_cursor=page_cursor)\n```\n\n\n\n\n#### [Update Coupon](https://developers.klaviyo.com/en/v2025-01-15/reference/update_coupon)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Coupons.update_coupon(id, body)\n```\n\n\n\n\n#### [Update Coupon Code](https://developers.klaviyo.com/en/v2025-01-15/reference/update_coupon_code)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Coupons.update_coupon_code(id, body)\n```\n\n\n\n\n\n\n## Data_Privacy\n\n#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2025-01-15/reference/request_profile_deletion)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Data_Privacy.request_profile_deletion(body)\n```\n##### Method alias:\n```python\nklaviyo.Data_Privacy.create_data_privacy_deletion_job(body)\n```\n\n\n\n\n\n\n## Events\n\n#### [Bulk Create Events](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_create_events)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Events.bulk_create_events(body)\n```\n##### Method alias:\n```python\nklaviyo.Events.create_event_bulk_create_job(body)\n```\n\n\n\n\n#### [Create Event](https://developers.klaviyo.com/en/v2025-01-15/reference/create_event)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Events.create_event(body)\n```\n\n\n\n\n#### [Get Event](https://developers.klaviyo.com/en/v2025-01-15/reference/get_event)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_event | List[str]\n# fields_metric | List[str]\n# fields_profile | List[str]\n# include | List[str]\n\nklaviyo.Events.get_event(id, fields_event=fields_event, fields_metric=fields_metric, fields_profile=fields_profile, include=include)\n```\n\n\n\n\n#### [Get Events](https://developers.klaviyo.com/en/v2025-01-15/reference/get_events)\n\n```python\n\n## Keyword Arguments\n\n# fields_event | List[str]\n# fields_metric | List[str]\n# fields_profile | List[str]\n# filter | str\n# include | List[str]\n# page_cursor | str\n# sort | str\n\nklaviyo.Events.get_events(fields_event=fields_event, fields_metric=fields_metric, fields_profile=fields_profile, filter=filter, include=include, page_cursor=page_cursor, sort=sort)\n```\n\n\n\n\n#### [Get Metric for Event](https://developers.klaviyo.com/en/v2025-01-15/reference/get_metric_for_event)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_metric | List[str]\n\nklaviyo.Events.get_metric_for_event(id, fields_metric=fields_metric)\n```\n##### Method alias:\n```python\nklaviyo.Events.get_event_metric(id, fields_metric=fields_metric)\n```\n\n\n\n\n#### [Get Metric ID for Event](https://developers.klaviyo.com/en/v2025-01-15/reference/get_metric_id_for_event)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Events.get_metric_id_for_event(id)\n```\n##### Method alias:\n```python\nklaviyo.Events.get_event_relationships_metric(id)\n```\n\n\n\n\n#### [Get Profile for Event](https://developers.klaviyo.com/en/v2025-01-15/reference/get_profile_for_event)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# additional_fields_profile | List[str]\n# fields_profile | List[str]\n\nklaviyo.Events.get_profile_for_event(id, additional_fields_profile=additional_fields_profile, fields_profile=fields_profile)\n```\n##### Method alias:\n```python\nklaviyo.Events.get_event_profile(id, additional_fields_profile=additional_fields_profile, fields_profile=fields_profile)\n```\n\n\n\n\n#### [Get Profile ID for Event](https://developers.klaviyo.com/en/v2025-01-15/reference/get_profile_id_for_event)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Events.get_profile_id_for_event(id)\n```\n##### Method alias:\n```python\nklaviyo.Events.get_event_relationships_profile(id)\n```\n\n\n\n\n\n\n## Flows\n\n#### [Create Flow](https://developers.klaviyo.com/en/v2025-01-15/reference/create_flow)\n\n```python\n## Positional Arguments\n\n# body | dict\n\n## Keyword Arguments\n\n# additional_fields_flow | List[str]\n\nklaviyo.Flows.create_flow(body, additional_fields_flow=additional_fields_flow)\n```\n\n\n\n\n#### [Delete Flow](https://developers.klaviyo.com/en/v2025-01-15/reference/delete_flow)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Flows.delete_flow(id)\n```\n\n\n\n\n#### [Get Action for Flow Message](https://developers.klaviyo.com/en/v2025-01-15/reference/get_action_for_flow_message)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_flow_action | List[str]\n\nklaviyo.Flows.get_action_for_flow_message(id, fields_flow_action=fields_flow_action)\n```\n##### Method alias:\n```python\nklaviyo.Flows.get_flow_message_action(id, fields_flow_action=fields_flow_action)\n```\n\n\n\n\n#### [Get Action ID for Flow Message](https://developers.klaviyo.com/en/v2025-01-15/reference/get_action_id_for_flow_message)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Flows.get_action_id_for_flow_message(id)\n```\n##### Method alias:\n```python\nklaviyo.Flows.get_flow_message_relationships_action(id)\n```\n\n\n\n\n#### [Get Action IDs for Flow](https://developers.klaviyo.com/en/v2025-01-15/reference/get_action_ids_for_flow)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# filter | str\n# page_cursor | str\n# page_size | int\n# sort | str\n\nklaviyo.Flows.get_action_ids_for_flow(id, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n##### Method alias:\n```python\nklaviyo.Flows.get_flow_relationships_flow_actions(id, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n##### Method alias:\n```python\nklaviyo.Flows.get_flow_relationships_actions(id, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n\n\n\n\n#### [Get Actions for Flow](https://developers.klaviyo.com/en/v2025-01-15/reference/get_actions_for_flow)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_flow_action | List[str]\n# filter | str\n# page_cursor | str\n# page_size | int\n# sort | str\n\nklaviyo.Flows.get_actions_for_flow(id, fields_flow_action=fields_flow_action, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n##### Method alias:\n```python\nklaviyo.Flows.get_flow_flow_actions(id, fields_flow_action=fields_flow_action, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n##### Method alias:\n```python\nklaviyo.Flows.get_flow_actions(id, fields_flow_action=fields_flow_action, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n\n\n\n\n#### [Get Flow](https://developers.klaviyo.com/en/v2025-01-15/reference/get_flow)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# additional_fields_flow | List[str]\n# fields_flow_action | List[str]\n# fields_flow | List[str]\n# fields_tag | List[str]\n# include | List[str]\n\nklaviyo.Flows.get_flow(id, additional_fields_flow=additional_fields_flow, fields_flow_action=fields_flow_action, fields_flow=fields_flow, fields_tag=fields_tag, include=include)\n```\n\n\n\n\n#### [Get Flow Action](https://developers.klaviyo.com/en/v2025-01-15/reference/get_flow_action)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_flow_action | List[str]\n# fields_flow_message | List[str]\n# fields_flow | List[str]\n# include | List[str]\n\nklaviyo.Flows.get_flow_action(id, fields_flow_action=fields_flow_action, fields_flow_message=fields_flow_message, fields_flow=fields_flow, include=include)\n```\n\n\n\n\n#### [Get Messages For Flow Action](https://developers.klaviyo.com/en/v2025-01-15/reference/get_flow_action_messages)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_flow_message | List[str]\n# filter | str\n# page_cursor | str\n# page_size | int\n# sort | str\n\nklaviyo.Flows.get_flow_action_messages(id, fields_flow_message=fields_flow_message, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n##### Method alias:\n```python\nklaviyo.Flows.get_messages_for_flow_action(id, fields_flow_message=fields_flow_message, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n\n\n\n\n#### [Get Flow for Flow Action](https://developers.klaviyo.com/en/v2025-01-15/reference/get_flow_for_flow_action)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_flow | List[str]\n\nklaviyo.Flows.get_flow_for_flow_action(id, fields_flow=fields_flow)\n```\n##### Method alias:\n```python\nklaviyo.Flows.get_flow_action_flow(id, fields_flow=fields_flow)\n```\n\n\n\n\n#### [Get Flow ID for Flow Action](https://developers.klaviyo.com/en/v2025-01-15/reference/get_flow_id_for_flow_action)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Flows.get_flow_id_for_flow_action(id)\n```\n##### Method alias:\n```python\nklaviyo.Flows.get_flow_action_relationships_flow(id)\n```\n\n\n\n\n#### [Get Flow Message](https://developers.klaviyo.com/en/v2025-01-15/reference/get_flow_message)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_flow_action | List[str]\n# fields_flow_message | List[str]\n# fields_template | List[str]\n# include | List[str]\n\nklaviyo.Flows.get_flow_message(id, fields_flow_action=fields_flow_action, fields_flow_message=fields_flow_message, fields_template=fields_template, include=include)\n```\n\n\n\n\n#### [Get Flows](https://developers.klaviyo.com/en/v2025-01-15/reference/get_flows)\n\n```python\n\n## Keyword Arguments\n\n# fields_flow_action | List[str]\n# fields_flow | List[str]\n# fields_tag | List[str]\n# filter | str\n# include | List[str]\n# page_cursor | str\n# page_size | int\n# sort | str\n\nklaviyo.Flows.get_flows(fields_flow_action=fields_flow_action, fields_flow=fields_flow, fields_tag=fields_tag, filter=filter, include=include, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n\n\n\n\n#### [Get Message IDs for Flow Action](https://developers.klaviyo.com/en/v2025-01-15/reference/get_message_ids_for_flow_action)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# filter | str\n# page_cursor | str\n# page_size | int\n# sort | str\n\nklaviyo.Flows.get_message_ids_for_flow_action(id, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n##### Method alias:\n```python\nklaviyo.Flows.get_flow_action_relationships_messages(id, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n\n\n\n\n#### [Get Tag IDs for Flow](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tag_ids_for_flow)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Flows.get_tag_ids_for_flow(id)\n```\n##### Method alias:\n```python\nklaviyo.Flows.get_flow_relationships_tags(id)\n```\n\n\n\n\n#### [Get Tags for Flow](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tags_for_flow)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_tag | List[str]\n\nklaviyo.Flows.get_tags_for_flow(id, fields_tag=fields_tag)\n```\n##### Method alias:\n```python\nklaviyo.Flows.get_flow_tags(id, fields_tag=fields_tag)\n```\n\n\n\n\n#### [Get Template for Flow Message](https://developers.klaviyo.com/en/v2025-01-15/reference/get_template_for_flow_message)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_template | List[str]\n\nklaviyo.Flows.get_template_for_flow_message(id, fields_template=fields_template)\n```\n##### Method alias:\n```python\nklaviyo.Flows.get_flow_message_template(id, fields_template=fields_template)\n```\n\n\n\n\n#### [Get Template ID for Flow Message](https://developers.klaviyo.com/en/v2025-01-15/reference/get_template_id_for_flow_message)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Flows.get_template_id_for_flow_message(id)\n```\n##### Method alias:\n```python\nklaviyo.Flows.get_flow_message_relationships_template(id)\n```\n\n\n\n\n#### [Update Flow Status](https://developers.klaviyo.com/en/v2025-01-15/reference/update_flow)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Flows.update_flow(id, body)\n```\n\n\n\n\n\n\n## Forms\n\n#### [Get Form](https://developers.klaviyo.com/en/v2025-01-15/reference/get_form)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_form_version | List[str]\n# fields_form | List[str]\n# include | List[str]\n\nklaviyo.Forms.get_form(id, fields_form_version=fields_form_version, fields_form=fields_form, include=include)\n```\n\n\n\n\n#### [Get Form for Form Version](https://developers.klaviyo.com/en/v2025-01-15/reference/get_form_for_form_version)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_form | List[str]\n\nklaviyo.Forms.get_form_for_form_version(id, fields_form=fields_form)\n```\n##### Method alias:\n```python\nklaviyo.Forms.get_form_version_form(id, fields_form=fields_form)\n```\n\n\n\n\n#### [Get Form ID for Form Version](https://developers.klaviyo.com/en/v2025-01-15/reference/get_form_id_for_form_version)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Forms.get_form_id_for_form_version(id)\n```\n##### Method alias:\n```python\nklaviyo.Forms.get_form_version_relationships_form(id)\n```\n\n\n\n\n#### [Get Form Version](https://developers.klaviyo.com/en/v2025-01-15/reference/get_form_version)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_form_version | List[str]\n\nklaviyo.Forms.get_form_version(id, fields_form_version=fields_form_version)\n```\n\n\n\n\n#### [Get Forms](https://developers.klaviyo.com/en/v2025-01-15/reference/get_forms)\n\n```python\n\n## Keyword Arguments\n\n# fields_form | List[str]\n# filter | str\n# page_cursor | str\n# page_size | int\n# sort | str\n\nklaviyo.Forms.get_forms(fields_form=fields_form, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n\n\n\n\n#### [Get Version IDs for Form](https://developers.klaviyo.com/en/v2025-01-15/reference/get_version_ids_for_form)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# filter | str\n# page_cursor | str\n# page_size | int\n# sort | str\n\nklaviyo.Forms.get_version_ids_for_form(id, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n##### Method alias:\n```python\nklaviyo.Forms.get_form_relationships_form_versions(id, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n##### Method alias:\n```python\nklaviyo.Forms.get_form_relationships_versions(id, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n\n\n\n\n#### [Get Versions for Form](https://developers.klaviyo.com/en/v2025-01-15/reference/get_versions_for_form)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_form_version | List[str]\n# filter | str\n# page_cursor | str\n# page_size | int\n# sort | str\n\nklaviyo.Forms.get_versions_for_form(id, fields_form_version=fields_form_version, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n##### Method alias:\n```python\nklaviyo.Forms.get_form_form_versions(id, fields_form_version=fields_form_version, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n##### Method alias:\n```python\nklaviyo.Forms.get_form_versions(id, fields_form_version=fields_form_version, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n\n\n\n\n\n\n## Images\n\n#### [Get Image](https://developers.klaviyo.com/en/v2025-01-15/reference/get_image)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_image | List[str]\n\nklaviyo.Images.get_image(id, fields_image=fields_image)\n```\n\n\n\n\n#### [Get Images](https://developers.klaviyo.com/en/v2025-01-15/reference/get_images)\n\n```python\n\n## Keyword Arguments\n\n# fields_image | List[str]\n# filter | str\n# page_cursor | str\n# page_size | int\n# sort | str\n\nklaviyo.Images.get_images(fields_image=fields_image, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n\n\n\n\n#### [Update Image](https://developers.klaviyo.com/en/v2025-01-15/reference/update_image)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Images.update_image(id, body)\n```\n\n\n\n\n#### [Upload Image From File](https://developers.klaviyo.com/en/v2025-01-15/reference/upload_image_from_file)\n\n```python\n## Positional Arguments\n\n# file | bytearray\n\n## Keyword Arguments\n\n# name | str\n# hidden | bool\n\nklaviyo.Images.upload_image_from_file(file, name=name, hidden=hidden)\n```\n##### Method alias:\n```python\nklaviyo.Images.create_image_upload(file, name=name, hidden=hidden)\n```\n\n\n\n\n#### [Upload Image From URL](https://developers.klaviyo.com/en/v2025-01-15/reference/upload_image_from_url)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Images.upload_image_from_url(body)\n```\n##### Method alias:\n```python\nklaviyo.Images.create_image(body)\n```\n\n\n\n\n\n\n## Lists\n\n#### [Add Profiles to List](https://developers.klaviyo.com/en/v2025-01-15/reference/add_profiles_to_list)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Lists.add_profiles_to_list(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Lists.create_list_relationships(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Lists.create_list_relationships_profile(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Lists.create_list_relationships_profiles(id, body)\n```\n\n\n\n\n#### [Create List](https://developers.klaviyo.com/en/v2025-01-15/reference/create_list)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Lists.create_list(body)\n```\n\n\n\n\n#### [Delete List](https://developers.klaviyo.com/en/v2025-01-15/reference/delete_list)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Lists.delete_list(id)\n```\n\n\n\n\n#### [Get Flows Triggered by List](https://developers.klaviyo.com/en/v2025-01-15/reference/get_flows_triggered_by_list)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_flow | List[str]\n\nklaviyo.Lists.get_flows_triggered_by_list(id, fields_flow=fields_flow)\n```\n##### Method alias:\n```python\nklaviyo.Lists.get_flow_triggers_for_list(id, fields_flow=fields_flow)\n```\n##### Method alias:\n```python\nklaviyo.Lists.get_list_flow_triggers(id, fields_flow=fields_flow)\n```\n\n\n\n\n#### [Get IDs for Flows Triggered by List](https://developers.klaviyo.com/en/v2025-01-15/reference/get_ids_for_flows_triggered_by_list)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Lists.get_ids_for_flows_triggered_by_list(id)\n```\n##### Method alias:\n```python\nklaviyo.Lists.get_flow_trigger_ids_for_list(id)\n```\n##### Method alias:\n```python\nklaviyo.Lists.get_list_relationships_flow_triggers(id)\n```\n\n\n\n\n#### [Get List](https://developers.klaviyo.com/en/v2025-01-15/reference/get_list)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# additional_fields_list | List[str]\n# fields_flow | List[str]\n# fields_list | List[str]\n# fields_tag | List[str]\n# include | List[str]\n\nklaviyo.Lists.get_list(id, additional_fields_list=additional_fields_list, fields_flow=fields_flow, fields_list=fields_list, fields_tag=fields_tag, include=include)\n```\n\n\n\n\n#### [Get Lists](https://developers.klaviyo.com/en/v2025-01-15/reference/get_lists)\n\n```python\n\n## Keyword Arguments\n\n# fields_flow | List[str]\n# fields_list | List[str]\n# fields_tag | List[str]\n# filter | str\n# include | List[str]\n# page_cursor | str\n# sort | str\n\nklaviyo.Lists.get_lists(fields_flow=fields_flow, fields_list=fields_list, fields_tag=fields_tag, filter=filter, include=include, page_cursor=page_cursor, sort=sort)\n```\n\n\n\n\n#### [Get Profile IDs for List](https://developers.klaviyo.com/en/v2025-01-15/reference/get_profile_ids_for_list)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# filter | str\n# page_cursor | str\n# page_size | int\n# sort | str\n\nklaviyo.Lists.get_profile_ids_for_list(id, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n##### Method alias:\n```python\nklaviyo.Lists.get_list_relationships_profiles(id, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n\n\n\n\n#### [Get Profiles for List](https://developers.klaviyo.com/en/v2025-01-15/reference/get_profiles_for_list)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# additional_fields_profile | List[str]\n# fields_profile | List[str]\n# filter | str\n# page_cursor | str\n# page_size | int\n# sort | str\n\nklaviyo.Lists.get_profiles_for_list(id, additional_fields_profile=additional_fields_profile, fields_profile=fields_profile, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n##### Method alias:\n```python\nklaviyo.Lists.get_list_profiles(id, additional_fields_profile=additional_fields_profile, fields_profile=fields_profile, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n\n\n\n\n#### [Get Tag IDs for List](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tag_ids_for_list)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Lists.get_tag_ids_for_list(id)\n```\n##### Method alias:\n```python\nklaviyo.Lists.get_list_relationships_tags(id)\n```\n\n\n\n\n#### [Get Tags for List](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tags_for_list)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_tag | List[str]\n\nklaviyo.Lists.get_tags_for_list(id, fields_tag=fields_tag)\n```\n##### Method alias:\n```python\nklaviyo.Lists.get_list_tags(id, fields_tag=fields_tag)\n```\n\n\n\n\n#### [Remove Profiles from List](https://developers.klaviyo.com/en/v2025-01-15/reference/remove_profiles_from_list)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Lists.remove_profiles_from_list(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Lists.delete_list_relationships(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Lists.delete_list_relationships_profiles(id, body)\n```\n\n\n\n\n#### [Update List](https://developers.klaviyo.com/en/v2025-01-15/reference/update_list)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Lists.update_list(id, body)\n```\n\n\n\n\n\n\n## Metrics\n\n#### [Get Flows Triggered by Metric](https://developers.klaviyo.com/en/v2025-01-15/reference/get_flows_triggered_by_metric)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_flow | List[str]\n\nklaviyo.Metrics.get_flows_triggered_by_metric(id, fields_flow=fields_flow)\n```\n##### Method alias:\n```python\nklaviyo.Metrics.get_flow_triggers_for_metric(id, fields_flow=fields_flow)\n```\n##### Method alias:\n```python\nklaviyo.Metrics.get_metric_flow_triggers(id, fields_flow=fields_flow)\n```\n\n\n\n\n#### [Get IDs for Flows Triggered by Metric](https://developers.klaviyo.com/en/v2025-01-15/reference/get_ids_for_flows_triggered_by_metric)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Metrics.get_ids_for_flows_triggered_by_metric(id)\n```\n##### Method alias:\n```python\nklaviyo.Metrics.get_flow_trigger_ids_for_metric(id)\n```\n##### Method alias:\n```python\nklaviyo.Metrics.get_metric_relationships_flow_triggers(id)\n```\n\n\n\n\n#### [Get Metric](https://developers.klaviyo.com/en/v2025-01-15/reference/get_metric)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_flow | List[str]\n# fields_metric | List[str]\n# include | List[str]\n\nklaviyo.Metrics.get_metric(id, fields_flow=fields_flow, fields_metric=fields_metric, include=include)\n```\n\n\n\n\n#### [Get Metric for Metric Property](https://developers.klaviyo.com/en/v2025-01-15/reference/get_metric_for_metric_property)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_metric | List[str]\n\nklaviyo.Metrics.get_metric_for_metric_property(id, fields_metric=fields_metric)\n```\n##### Method alias:\n```python\nklaviyo.Metrics.get_metric_property_metric(id, fields_metric=fields_metric)\n```\n\n\n\n\n#### [Get Metric ID for Metric Property](https://developers.klaviyo.com/en/v2025-01-15/reference/get_metric_id_for_metric_property)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Metrics.get_metric_id_for_metric_property(id)\n```\n##### Method alias:\n```python\nklaviyo.Metrics.get_metric_property_relationships_metric(id)\n```\n\n\n\n\n#### [Get Metric Property](https://developers.klaviyo.com/en/v2025-01-15/reference/get_metric_property)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# additional_fields_metric_property | List[str]\n# fields_metric_property | List[str]\n# fields_metric | List[str]\n# include | List[str]\n\nklaviyo.Metrics.get_metric_property(id, additional_fields_metric_property=additional_fields_metric_property, fields_metric_property=fields_metric_property, fields_metric=fields_metric, include=include)\n```\n\n\n\n\n#### [Get Metrics](https://developers.klaviyo.com/en/v2025-01-15/reference/get_metrics)\n\n```python\n\n## Keyword Arguments\n\n# fields_flow | List[str]\n# fields_metric | List[str]\n# filter | str\n# include | List[str]\n# page_cursor | str\n\nklaviyo.Metrics.get_metrics(fields_flow=fields_flow, fields_metric=fields_metric, filter=filter, include=include, page_cursor=page_cursor)\n```\n\n\n\n\n#### [Get Properties for Metric](https://developers.klaviyo.com/en/v2025-01-15/reference/get_properties_for_metric)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# additional_fields_metric_property | List[str]\n# fields_metric_property | List[str]\n\nklaviyo.Metrics.get_properties_for_metric(id, additional_fields_metric_property=additional_fields_metric_property, fields_metric_property=fields_metric_property)\n```\n##### Method alias:\n```python\nklaviyo.Metrics.get_metric_metric_properties(id, additional_fields_metric_property=additional_fields_metric_property, fields_metric_property=fields_metric_property)\n```\n##### Method alias:\n```python\nklaviyo.Metrics.get_metric_properties(id, additional_fields_metric_property=additional_fields_metric_property, fields_metric_property=fields_metric_property)\n```\n\n\n\n\n#### [Get Property IDs for Metric](https://developers.klaviyo.com/en/v2025-01-15/reference/get_property_ids_for_metric)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Metrics.get_property_ids_for_metric(id)\n```\n##### Method alias:\n```python\nklaviyo.Metrics.get_metric_relationships_metric_properties(id)\n```\n##### Method alias:\n```python\nklaviyo.Metrics.get_metric_relationships_properties(id)\n```\n\n\n\n\n#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2025-01-15/reference/query_metric_aggregates)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Metrics.query_metric_aggregates(body)\n```\n##### Method alias:\n```python\nklaviyo.Metrics.create_metric_aggregate(body)\n```\n\n\n\n\n\n\n## Profiles\n\n#### [Bulk Import Profiles](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_import_profiles)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Profiles.bulk_import_profiles(body)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.spawn_bulk_profile_import_job(body)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.create_profile_bulk_import_job(body)\n```\n\n\n\n\n#### [Bulk Subscribe Profiles](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_subscribe_profiles)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Profiles.bulk_subscribe_profiles(body)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.subscribe_profiles(body)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.create_profile_subscription_bulk_create_job(body)\n```\n\n\n\n\n#### [Bulk Suppress Profiles](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_suppress_profiles)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Profiles.bulk_suppress_profiles(body)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.suppress_profiles(body)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.create_profile_suppression_bulk_create_job(body)\n```\n\n\n\n\n#### [Bulk Unsubscribe Profiles](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_unsubscribe_profiles)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Profiles.bulk_unsubscribe_profiles(body)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.unsubscribe_profiles(body)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.create_profile_subscription_bulk_delete_job(body)\n```\n\n\n\n\n#### [Bulk Unsuppress Profiles](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_unsuppress_profiles)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Profiles.bulk_unsuppress_profiles(body)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.unsuppress_profiles(body)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.create_profile_suppression_bulk_delete_job(body)\n```\n\n\n\n\n#### [Create or Update Profile](https://developers.klaviyo.com/en/v2025-01-15/reference/create_or_update_profile)\n\n```python\n## Positional Arguments\n\n# body | dict\n\n## Keyword Arguments\n\n# additional_fields_profile | List[str]\n\nklaviyo.Profiles.create_or_update_profile(body, additional_fields_profile=additional_fields_profile)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.create_profile_import(body, additional_fields_profile=additional_fields_profile)\n```\n\n\n\n\n#### [Create Profile](https://developers.klaviyo.com/en/v2025-01-15/reference/create_profile)\n\n```python\n## Positional Arguments\n\n# body | dict\n\n## Keyword Arguments\n\n# additional_fields_profile | List[str]\n\nklaviyo.Profiles.create_profile(body, additional_fields_profile=additional_fields_profile)\n```\n\n\n\n\n#### [Create or Update Push Token](https://developers.klaviyo.com/en/v2025-01-15/reference/create_push_token)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Profiles.create_push_token(body)\n```\n\n\n\n\n#### [Get Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_import_profiles_job)\n\n```python\n## Positional Arguments\n\n# job_id | str\n\n## Keyword Arguments\n\n# fields_list | List[str]\n# fields_profile_bulk_import_job | List[str]\n# include | List[str]\n\nklaviyo.Profiles.get_bulk_import_profiles_job(job_id, fields_list=fields_list, fields_profile_bulk_import_job=fields_profile_bulk_import_job, include=include)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_bulk_profile_import_job(job_id, fields_list=fields_list, fields_profile_bulk_import_job=fields_profile_bulk_import_job, include=include)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_profile_bulk_import_job(job_id, fields_list=fields_list, fields_profile_bulk_import_job=fields_profile_bulk_import_job, include=include)\n```\n\n\n\n\n#### [Get Bulk Import Profiles Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_import_profiles_jobs)\n\n```python\n\n## Keyword Arguments\n\n# fields_profile_bulk_import_job | List[str]\n# filter | str\n# page_cursor | str\n# page_size | int\n# sort | str\n\nklaviyo.Profiles.get_bulk_import_profiles_jobs(fields_profile_bulk_import_job=fields_profile_bulk_import_job, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_bulk_profile_import_jobs(fields_profile_bulk_import_job=fields_profile_bulk_import_job, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_profile_bulk_import_jobs(fields_profile_bulk_import_job=fields_profile_bulk_import_job, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n\n\n\n\n#### [Get Bulk Suppress Profiles Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_suppress_profiles_job)\n\n```python\n## Positional Arguments\n\n# job_id | str\n\n## Keyword Arguments\n\n# fields_profile_suppression_bulk_create_job | List[str]\n\nklaviyo.Profiles.get_bulk_suppress_profiles_job(job_id, fields_profile_suppression_bulk_create_job=fields_profile_suppression_bulk_create_job)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_profile_suppression_bulk_create_job(job_id, fields_profile_suppression_bulk_create_job=fields_profile_suppression_bulk_create_job)\n```\n\n\n\n\n#### [Get Bulk Suppress Profiles Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_suppress_profiles_jobs)\n\n```python\n\n## Keyword Arguments\n\n# fields_profile_suppression_bulk_create_job | List[str]\n# filter | str\n# page_cursor | str\n# sort | str\n\nklaviyo.Profiles.get_bulk_suppress_profiles_jobs(fields_profile_suppression_bulk_create_job=fields_profile_suppression_bulk_create_job, filter=filter, page_cursor=page_cursor, sort=sort)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_profile_suppression_bulk_create_jobs(fields_profile_suppression_bulk_create_job=fields_profile_suppression_bulk_create_job, filter=filter, page_cursor=page_cursor, sort=sort)\n```\n\n\n\n\n#### [Get Bulk Unsuppress Profiles Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_unsuppress_profiles_job)\n\n```python\n## Positional Arguments\n\n# job_id | str\n\n## Keyword Arguments\n\n# fields_profile_suppression_bulk_delete_job | List[str]\n\nklaviyo.Profiles.get_bulk_unsuppress_profiles_job(job_id, fields_profile_suppression_bulk_delete_job=fields_profile_suppression_bulk_delete_job)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_profile_suppression_bulk_delete_job(job_id, fields_profile_suppression_bulk_delete_job=fields_profile_suppression_bulk_delete_job)\n```\n\n\n\n\n#### [Get Bulk Unsuppress Profiles Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_unsuppress_profiles_jobs)\n\n```python\n\n## Keyword Arguments\n\n# fields_profile_suppression_bulk_delete_job | List[str]\n# filter | str\n# page_cursor | str\n# sort | str\n\nklaviyo.Profiles.get_bulk_unsuppress_profiles_jobs(fields_profile_suppression_bulk_delete_job=fields_profile_suppression_bulk_delete_job, filter=filter, page_cursor=page_cursor, sort=sort)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_profile_suppression_bulk_delete_jobs(fields_profile_suppression_bulk_delete_job=fields_profile_suppression_bulk_delete_job, filter=filter, page_cursor=page_cursor, sort=sort)\n```\n\n\n\n\n#### [Get Errors for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_errors_for_bulk_import_profiles_job)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_import_error | List[str]\n# page_cursor | str\n# page_size | int\n\nklaviyo.Profiles.get_errors_for_bulk_import_profiles_job(id, fields_import_error=fields_import_error, page_cursor=page_cursor, page_size=page_size)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_bulk_profile_import_job_import_errors(id, fields_import_error=fields_import_error, page_cursor=page_cursor, page_size=page_size)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_import_errors_for_profile_bulk_import_job(id, fields_import_error=fields_import_error, page_cursor=page_cursor, page_size=page_size)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_profile_bulk_import_job_import_errors(id, fields_import_error=fields_import_error, page_cursor=page_cursor, page_size=page_size)\n```\n\n\n\n\n#### [Get List for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_list_for_bulk_import_profiles_job)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_list | List[str]\n\nklaviyo.Profiles.get_list_for_bulk_import_profiles_job(id, fields_list=fields_list)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_bulk_profile_import_job_lists(id, fields_list=fields_list)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_lists_for_profile_bulk_import_job(id, fields_list=fields_list)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_profile_bulk_import_job_lists(id, fields_list=fields_list)\n```\n\n\n\n\n#### [Get List IDs for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_list_ids_for_bulk_import_profiles_job)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Profiles.get_list_ids_for_bulk_import_profiles_job(id)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_bulk_profile_import_job_relationships_lists(id)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_list_ids_for_profile_bulk_import_job(id)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_profile_bulk_import_job_relationships_lists(id)\n```\n\n\n\n\n#### [Get List IDs for Profile](https://developers.klaviyo.com/en/v2025-01-15/reference/get_list_ids_for_profile)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Profiles.get_list_ids_for_profile(id)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_profile_relationships_lists(id)\n```\n\n\n\n\n#### [Get Lists for Profile](https://developers.klaviyo.com/en/v2025-01-15/reference/get_lists_for_profile)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_list | List[str]\n\nklaviyo.Profiles.get_lists_for_profile(id, fields_list=fields_list)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_profile_lists(id, fields_list=fields_list)\n```\n\n\n\n\n#### [Get Profile](https://developers.klaviyo.com/en/v2025-01-15/reference/get_profile)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# additional_fields_profile | List[str]\n# fields_list | List[str]\n# fields_profile | List[str]\n# fields_segment | List[str]\n# include | List[str]\n\nklaviyo.Profiles.get_profile(id, additional_fields_profile=additional_fields_profile, fields_list=fields_list, fields_profile=fields_profile, fields_segment=fields_segment, include=include)\n```\n\n\n\n\n#### [Get Profile IDs for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_profile_ids_for_bulk_import_profiles_job)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# page_cursor | str\n# page_size | int\n\nklaviyo.Profiles.get_profile_ids_for_bulk_import_profiles_job(id, page_cursor=page_cursor, page_size=page_size)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_bulk_profile_import_job_relationships_profiles(id, page_cursor=page_cursor, page_size=page_size)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_profile_bulk_import_job_relationships_profiles(id, page_cursor=page_cursor, page_size=page_size)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_profile_ids_for_profile_bulk_import_job(id, page_cursor=page_cursor, page_size=page_size)\n```\n\n\n\n\n#### [Get Profiles](https://developers.klaviyo.com/en/v2025-01-15/reference/get_profiles)\n\n```python\n\n## Keyword Arguments\n\n# additional_fields_profile | List[str]\n# fields_profile | List[str]\n# filter | str\n# page_cursor | str\n# page_size | int\n# sort | str\n\nklaviyo.Profiles.get_profiles(additional_fields_profile=additional_fields_profile, fields_profile=fields_profile, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n\n\n\n\n#### [Get Profiles for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_profiles_for_bulk_import_profiles_job)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# additional_fields_profile | List[str]\n# fields_profile | List[str]\n# page_cursor | str\n# page_size | int\n\nklaviyo.Profiles.get_profiles_for_bulk_import_profiles_job(id, additional_fields_profile=additional_fields_profile, fields_profile=fields_profile, page_cursor=page_cursor, page_size=page_size)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_bulk_profile_import_job_profiles(id, additional_fields_profile=additional_fields_profile, fields_profile=fields_profile, page_cursor=page_cursor, page_size=page_size)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_profile_bulk_import_job_profiles(id, additional_fields_profile=additional_fields_profile, fields_profile=fields_profile, page_cursor=page_cursor, page_size=page_size)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_profiles_for_profile_bulk_import_job(id, additional_fields_profile=additional_fields_profile, fields_profile=fields_profile, page_cursor=page_cursor, page_size=page_size)\n```\n\n\n\n\n#### [Get Segment IDs for Profile](https://developers.klaviyo.com/en/v2025-01-15/reference/get_segment_ids_for_profile)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Profiles.get_segment_ids_for_profile(id)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_profile_relationships_segments(id)\n```\n\n\n\n\n#### [Get Segments for Profile](https://developers.klaviyo.com/en/v2025-01-15/reference/get_segments_for_profile)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_segment | List[str]\n\nklaviyo.Profiles.get_segments_for_profile(id, fields_segment=fields_segment)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.get_profile_segments(id, fields_segment=fields_segment)\n```\n\n\n\n\n#### [Merge Profiles](https://developers.klaviyo.com/en/v2025-01-15/reference/merge_profiles)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Profiles.merge_profiles(body)\n```\n##### Method alias:\n```python\nklaviyo.Profiles.create_profile_merge(body)\n```\n\n\n\n\n#### [Update Profile](https://developers.klaviyo.com/en/v2025-01-15/reference/update_profile)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\n## Keyword Arguments\n\n# additional_fields_profile | List[str]\n\nklaviyo.Profiles.update_profile(id, body, additional_fields_profile=additional_fields_profile)\n```\n\n\n\n\n\n\n## Reporting\n\n#### [Query Campaign Values](https://developers.klaviyo.com/en/v2025-01-15/reference/query_campaign_values)\n\n```python\n## Positional Arguments\n\n# body | dict\n\n## Keyword Arguments\n\n# page_cursor | str\n\nklaviyo.Reporting.query_campaign_values(body, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Reporting.create_campaign_value_report(body, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Reporting.create_campaign_values_report(body, page_cursor=page_cursor)\n```\n\n\n\n\n#### [Query Flow Series](https://developers.klaviyo.com/en/v2025-01-15/reference/query_flow_series)\n\n```python\n## Positional Arguments\n\n# body | dict\n\n## Keyword Arguments\n\n# page_cursor | str\n\nklaviyo.Reporting.query_flow_series(body, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Reporting.create_flow_sery_report(body, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Reporting.create_flow_series_report(body, page_cursor=page_cursor)\n```\n\n\n\n\n#### [Query Flow Values](https://developers.klaviyo.com/en/v2025-01-15/reference/query_flow_values)\n\n```python\n## Positional Arguments\n\n# body | dict\n\n## Keyword Arguments\n\n# page_cursor | str\n\nklaviyo.Reporting.query_flow_values(body, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Reporting.create_flow_value_report(body, page_cursor=page_cursor)\n```\n##### Method alias:\n```python\nklaviyo.Reporting.create_flow_values_report(body, page_cursor=page_cursor)\n```\n\n\n\n\n#### [Query Form Series](https://developers.klaviyo.com/en/v2025-01-15/reference/query_form_series)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Reporting.query_form_series(body)\n```\n##### Method alias:\n```python\nklaviyo.Reporting.create_form_sery_report(body)\n```\n##### Method alias:\n```python\nklaviyo.Reporting.create_form_series_report(body)\n```\n\n\n\n\n#### [Query Form Values](https://developers.klaviyo.com/en/v2025-01-15/reference/query_form_values)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Reporting.query_form_values(body)\n```\n##### Method alias:\n```python\nklaviyo.Reporting.create_form_value_report(body)\n```\n##### Method alias:\n```python\nklaviyo.Reporting.create_form_values_report(body)\n```\n\n\n\n\n#### [Query Segment Series](https://developers.klaviyo.com/en/v2025-01-15/reference/query_segment_series)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Reporting.query_segment_series(body)\n```\n##### Method alias:\n```python\nklaviyo.Reporting.create_segment_sery_report(body)\n```\n##### Method alias:\n```python\nklaviyo.Reporting.create_segment_series_report(body)\n```\n\n\n\n\n#### [Query Segment Values](https://developers.klaviyo.com/en/v2025-01-15/reference/query_segment_values)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Reporting.query_segment_values(body)\n```\n##### Method alias:\n```python\nklaviyo.Reporting.create_segment_value_report(body)\n```\n##### Method alias:\n```python\nklaviyo.Reporting.create_segment_values_report(body)\n```\n\n\n\n\n\n\n## Reviews\n\n#### [Get Review](https://developers.klaviyo.com/en/v2025-01-15/reference/get_review)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_event | List[str]\n# fields_review | List[str]\n# include | List[str]\n\nklaviyo.Reviews.get_review(id, fields_event=fields_event, fields_review=fields_review, include=include)\n```\n\n\n\n\n#### [Get Reviews](https://developers.klaviyo.com/en/v2025-01-15/reference/get_reviews)\n\n```python\n\n## Keyword Arguments\n\n# fields_event | List[str]\n# fields_review | List[str]\n# filter | str\n# include | List[str]\n# page_cursor | str\n# page_size | int\n# sort | str\n\nklaviyo.Reviews.get_reviews(fields_event=fields_event, fields_review=fields_review, filter=filter, include=include, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n\n\n\n\n#### [Update Review](https://developers.klaviyo.com/en/v2025-01-15/reference/update_review)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Reviews.update_review(id, body)\n```\n\n\n\n\n\n\n## Segments\n\n#### [Create Segment](https://developers.klaviyo.com/en/v2025-01-15/reference/create_segment)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Segments.create_segment(body)\n```\n\n\n\n\n#### [Delete Segment](https://developers.klaviyo.com/en/v2025-01-15/reference/delete_segment)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Segments.delete_segment(id)\n```\n\n\n\n\n#### [Get Flows Triggered by Segment](https://developers.klaviyo.com/en/v2025-01-15/reference/get_flows_triggered_by_segment)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_flow | List[str]\n\nklaviyo.Segments.get_flows_triggered_by_segment(id, fields_flow=fields_flow)\n```\n##### Method alias:\n```python\nklaviyo.Segments.get_flow_triggers_for_segment(id, fields_flow=fields_flow)\n```\n##### Method alias:\n```python\nklaviyo.Segments.get_segment_flow_triggers(id, fields_flow=fields_flow)\n```\n\n\n\n\n#### [Get IDs for Flows Triggered by Segment](https://developers.klaviyo.com/en/v2025-01-15/reference/get_ids_for_flows_triggered_by_segment)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Segments.get_ids_for_flows_triggered_by_segment(id)\n```\n##### Method alias:\n```python\nklaviyo.Segments.get_flow_trigger_ids_for_segment(id)\n```\n##### Method alias:\n```python\nklaviyo.Segments.get_segment_relationships_flow_triggers(id)\n```\n\n\n\n\n#### [Get Profile IDs for Segment](https://developers.klaviyo.com/en/v2025-01-15/reference/get_profile_ids_for_segment)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# filter | str\n# page_cursor | str\n# page_size | int\n# sort | str\n\nklaviyo.Segments.get_profile_ids_for_segment(id, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n##### Method alias:\n```python\nklaviyo.Segments.get_segment_relationships_profiles(id, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n\n\n\n\n#### [Get Profiles for Segment](https://developers.klaviyo.com/en/v2025-01-15/reference/get_profiles_for_segment)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# additional_fields_profile | List[str]\n# fields_profile | List[str]\n# filter | str\n# page_cursor | str\n# page_size | int\n# sort | str\n\nklaviyo.Segments.get_profiles_for_segment(id, additional_fields_profile=additional_fields_profile, fields_profile=fields_profile, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n##### Method alias:\n```python\nklaviyo.Segments.get_segment_profiles(id, additional_fields_profile=additional_fields_profile, fields_profile=fields_profile, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n\n\n\n\n#### [Get Segment](https://developers.klaviyo.com/en/v2025-01-15/reference/get_segment)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# additional_fields_segment | List[str]\n# fields_flow | List[str]\n# fields_segment | List[str]\n# fields_tag | List[str]\n# include | List[str]\n\nklaviyo.Segments.get_segment(id, additional_fields_segment=additional_fields_segment, fields_flow=fields_flow, fields_segment=fields_segment, fields_tag=fields_tag, include=include)\n```\n\n\n\n\n#### [Get Segments](https://developers.klaviyo.com/en/v2025-01-15/reference/get_segments)\n\n```python\n\n## Keyword Arguments\n\n# fields_flow | List[str]\n# fields_segment | List[str]\n# fields_tag | List[str]\n# filter | str\n# include | List[str]\n# page_cursor | str\n# sort | str\n\nklaviyo.Segments.get_segments(fields_flow=fields_flow, fields_segment=fields_segment, fields_tag=fields_tag, filter=filter, include=include, page_cursor=page_cursor, sort=sort)\n```\n\n\n\n\n#### [Get Tag IDs for Segment](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tag_ids_for_segment)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Segments.get_tag_ids_for_segment(id)\n```\n##### Method alias:\n```python\nklaviyo.Segments.get_segment_relationships_tags(id)\n```\n\n\n\n\n#### [Get Tags for Segment](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tags_for_segment)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_tag | List[str]\n\nklaviyo.Segments.get_tags_for_segment(id, fields_tag=fields_tag)\n```\n##### Method alias:\n```python\nklaviyo.Segments.get_segment_tags(id, fields_tag=fields_tag)\n```\n\n\n\n\n#### [Update Segment](https://developers.klaviyo.com/en/v2025-01-15/reference/update_segment)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Segments.update_segment(id, body)\n```\n\n\n\n\n\n\n## Tags\n\n#### [Create Tag](https://developers.klaviyo.com/en/v2025-01-15/reference/create_tag)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Tags.create_tag(body)\n```\n\n\n\n\n#### [Create Tag Group](https://developers.klaviyo.com/en/v2025-01-15/reference/create_tag_group)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Tags.create_tag_group(body)\n```\n\n\n\n\n#### [Delete Tag](https://developers.klaviyo.com/en/v2025-01-15/reference/delete_tag)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Tags.delete_tag(id)\n```\n\n\n\n\n#### [Delete Tag Group](https://developers.klaviyo.com/en/v2025-01-15/reference/delete_tag_group)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Tags.delete_tag_group(id)\n```\n\n\n\n\n#### [Get Campaign IDs for Tag](https://developers.klaviyo.com/en/v2025-01-15/reference/get_campaign_ids_for_tag)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Tags.get_campaign_ids_for_tag(id)\n```\n##### Method alias:\n```python\nklaviyo.Tags.get_tag_relationships_campaigns(id)\n```\n\n\n\n\n#### [Get Flow IDs for Tag](https://developers.klaviyo.com/en/v2025-01-15/reference/get_flow_ids_for_tag)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Tags.get_flow_ids_for_tag(id)\n```\n##### Method alias:\n```python\nklaviyo.Tags.get_tag_relationships_flows(id)\n```\n\n\n\n\n#### [Get List IDs for Tag](https://developers.klaviyo.com/en/v2025-01-15/reference/get_list_ids_for_tag)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Tags.get_list_ids_for_tag(id)\n```\n##### Method alias:\n```python\nklaviyo.Tags.get_tag_relationships_lists(id)\n```\n\n\n\n\n#### [Get Segment IDs for Tag](https://developers.klaviyo.com/en/v2025-01-15/reference/get_segment_ids_for_tag)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Tags.get_segment_ids_for_tag(id)\n```\n##### Method alias:\n```python\nklaviyo.Tags.get_tag_relationships_segments(id)\n```\n\n\n\n\n#### [Get Tag](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tag)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_tag_group | List[str]\n# fields_tag | List[str]\n# include | List[str]\n\nklaviyo.Tags.get_tag(id, fields_tag_group=fields_tag_group, fields_tag=fields_tag, include=include)\n```\n\n\n\n\n#### [Get Tag Group](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tag_group)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_tag_group | List[str]\n\nklaviyo.Tags.get_tag_group(id, fields_tag_group=fields_tag_group)\n```\n\n\n\n\n#### [Get Tag Group for Tag](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tag_group_for_tag)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_tag_group | List[str]\n\nklaviyo.Tags.get_tag_group_for_tag(id, fields_tag_group=fields_tag_group)\n```\n##### Method alias:\n```python\nklaviyo.Tags.get_tag_tag_group(id, fields_tag_group=fields_tag_group)\n```\n##### Method alias:\n```python\nklaviyo.Tags.get_group_for_tag(id, fields_tag_group=fields_tag_group)\n```\n\n\n\n\n#### [Get Tag Group ID for Tag](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tag_group_id_for_tag)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Tags.get_tag_group_id_for_tag(id)\n```\n##### Method alias:\n```python\nklaviyo.Tags.get_tag_relationships_tag_group(id)\n```\n##### Method alias:\n```python\nklaviyo.Tags.get_group_id_for_tag(id)\n```\n##### Method alias:\n```python\nklaviyo.Tags.get_tag_relationships_group(id)\n```\n\n\n\n\n#### [Get Tag Groups](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tag_groups)\n\n```python\n\n## Keyword Arguments\n\n# fields_tag_group | List[str]\n# filter | str\n# page_cursor | str\n# sort | str\n\nklaviyo.Tags.get_tag_groups(fields_tag_group=fields_tag_group, filter=filter, page_cursor=page_cursor, sort=sort)\n```\n\n\n\n\n#### [Get Tag IDs for Tag Group](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tag_ids_for_tag_group)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Tags.get_tag_ids_for_tag_group(id)\n```\n##### Method alias:\n```python\nklaviyo.Tags.get_tag_group_relationships_tags(id)\n```\n\n\n\n\n#### [Get Tags](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tags)\n\n```python\n\n## Keyword Arguments\n\n# fields_tag_group | List[str]\n# fields_tag | List[str]\n# filter | str\n# include | List[str]\n# page_cursor | str\n# sort | str\n\nklaviyo.Tags.get_tags(fields_tag_group=fields_tag_group, fields_tag=fields_tag, filter=filter, include=include, page_cursor=page_cursor, sort=sort)\n```\n\n\n\n\n#### [Get Tags for Tag Group](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tags_for_tag_group)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_tag | List[str]\n\nklaviyo.Tags.get_tags_for_tag_group(id, fields_tag=fields_tag)\n```\n##### Method alias:\n```python\nklaviyo.Tags.get_tag_group_tags(id, fields_tag=fields_tag)\n```\n\n\n\n\n#### [Remove Tag from Campaigns](https://developers.klaviyo.com/en/v2025-01-15/reference/remove_tag_from_campaigns)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Tags.remove_tag_from_campaigns(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Tags.delete_tag_relationships_campaigns(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Tags.remove_campaigns_from_tag(id, body)\n```\n\n\n\n\n#### [Remove Tag from Flows](https://developers.klaviyo.com/en/v2025-01-15/reference/remove_tag_from_flows)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Tags.remove_tag_from_flows(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Tags.delete_tag_relationships_flows(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Tags.remove_flows_from_tag(id, body)\n```\n\n\n\n\n#### [Remove Tag from Lists](https://developers.klaviyo.com/en/v2025-01-15/reference/remove_tag_from_lists)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Tags.remove_tag_from_lists(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Tags.delete_tag_relationships_lists(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Tags.remove_lists_from_tag(id, body)\n```\n\n\n\n\n#### [Remove Tag from Segments](https://developers.klaviyo.com/en/v2025-01-15/reference/remove_tag_from_segments)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Tags.remove_tag_from_segments(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Tags.delete_tag_relationships_segments(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Tags.remove_segments_from_tag(id, body)\n```\n\n\n\n\n#### [Tag Campaigns](https://developers.klaviyo.com/en/v2025-01-15/reference/tag_campaigns)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Tags.tag_campaigns(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Tags.create_tag_relationships_campaign(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Tags.add_campaigns_to_tag(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Tags.create_tag_relationships_campaigns(id, body)\n```\n\n\n\n\n#### [Tag Flows](https://developers.klaviyo.com/en/v2025-01-15/reference/tag_flows)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Tags.tag_flows(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Tags.create_tag_relationships_flow(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Tags.add_flows_to_tag(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Tags.create_tag_relationships_flows(id, body)\n```\n\n\n\n\n#### [Tag Lists](https://developers.klaviyo.com/en/v2025-01-15/reference/tag_lists)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Tags.tag_lists(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Tags.create_tag_relationships_list(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Tags.add_lists_to_tag(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Tags.create_tag_relationships_lists(id, body)\n```\n\n\n\n\n#### [Tag Segments](https://developers.klaviyo.com/en/v2025-01-15/reference/tag_segments)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Tags.tag_segments(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Tags.create_tag_relationships_segment(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Tags.add_segments_to_tag(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Tags.create_tag_relationships_segments(id, body)\n```\n\n\n\n\n#### [Update Tag](https://developers.klaviyo.com/en/v2025-01-15/reference/update_tag)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Tags.update_tag(id, body)\n```\n\n\n\n\n#### [Update Tag Group](https://developers.klaviyo.com/en/v2025-01-15/reference/update_tag_group)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Tags.update_tag_group(id, body)\n```\n\n\n\n\n\n\n## Templates\n\n#### [Clone Template](https://developers.klaviyo.com/en/v2025-01-15/reference/clone_template)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Templates.clone_template(body)\n```\n##### Method alias:\n```python\nklaviyo.Templates.create_template_clone(body)\n```\n\n\n\n\n#### [Create Template](https://developers.klaviyo.com/en/v2025-01-15/reference/create_template)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Templates.create_template(body)\n```\n\n\n\n\n#### [Create Universal Content](https://developers.klaviyo.com/en/v2025-01-15/reference/create_universal_content)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Templates.create_universal_content(body)\n```\n##### Method alias:\n```python\nklaviyo.Templates.create_template_universal_content(body)\n```\n\n\n\n\n#### [Delete Template](https://developers.klaviyo.com/en/v2025-01-15/reference/delete_template)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Templates.delete_template(id)\n```\n\n\n\n\n#### [Delete Universal Content](https://developers.klaviyo.com/en/v2025-01-15/reference/delete_universal_content)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Templates.delete_universal_content(id)\n```\n##### Method alias:\n```python\nklaviyo.Templates.delete_template_universal_content(id)\n```\n\n\n\n\n#### [Get All Universal Content](https://developers.klaviyo.com/en/v2025-01-15/reference/get_all_universal_content)\n\n```python\n\n## Keyword Arguments\n\n# fields_template_universal_content | List[str]\n# filter | str\n# page_cursor | str\n# page_size | int\n# sort | str\n\nklaviyo.Templates.get_all_universal_content(fields_template_universal_content=fields_template_universal_content, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n##### Method alias:\n```python\nklaviyo.Templates.get_template_universal_content(fields_template_universal_content=fields_template_universal_content, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)\n```\n\n\n\n\n#### [Get Template](https://developers.klaviyo.com/en/v2025-01-15/reference/get_template)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_template | List[str]\n\nklaviyo.Templates.get_template(id, fields_template=fields_template)\n```\n\n\n\n\n#### [Get Templates](https://developers.klaviyo.com/en/v2025-01-15/reference/get_templates)\n\n```python\n\n## Keyword Arguments\n\n# fields_template | List[str]\n# filter | str\n# page_cursor | str\n# sort | str\n\nklaviyo.Templates.get_templates(fields_template=fields_template, filter=filter, page_cursor=page_cursor, sort=sort)\n```\n\n\n\n\n#### [Get Universal Content](https://developers.klaviyo.com/en/v2025-01-15/reference/get_universal_content)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_template_universal_content | List[str]\n\nklaviyo.Templates.get_universal_content(id, fields_template_universal_content=fields_template_universal_content)\n```\n\n\n\n\n#### [Render Template](https://developers.klaviyo.com/en/v2025-01-15/reference/render_template)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Templates.render_template(body)\n```\n##### Method alias:\n```python\nklaviyo.Templates.create_template_render(body)\n```\n\n\n\n\n#### [Update Template](https://developers.klaviyo.com/en/v2025-01-15/reference/update_template)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Templates.update_template(id, body)\n```\n\n\n\n\n#### [Update Universal Content](https://developers.klaviyo.com/en/v2025-01-15/reference/update_universal_content)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Templates.update_universal_content(id, body)\n```\n##### Method alias:\n```python\nklaviyo.Templates.update_template_universal_content(id, body)\n```\n\n\n\n\n\n\n## Tracking_Settings\n\n#### [Get Tracking Setting](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tracking_setting)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_tracking_setting | List[str]\n\nklaviyo.Tracking_Settings.get_tracking_setting(id, fields_tracking_setting=fields_tracking_setting)\n```\n\n\n\n\n#### [Get Tracking Settings](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tracking_settings)\n\n```python\n\n## Keyword Arguments\n\n# fields_tracking_setting | List[str]\n# page_cursor | str\n# page_size | int\n\nklaviyo.Tracking_Settings.get_tracking_settings(fields_tracking_setting=fields_tracking_setting, page_cursor=page_cursor, page_size=page_size)\n```\n\n\n\n\n#### [Update Tracking Setting](https://developers.klaviyo.com/en/v2025-01-15/reference/update_tracking_setting)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Tracking_Settings.update_tracking_setting(id, body)\n```\n\n\n\n\n\n\n## Webhooks\n\n#### [Create Webhook](https://developers.klaviyo.com/en/v2025-01-15/reference/create_webhook)\n\n```python\n## Positional Arguments\n\n# body | dict\n\nklaviyo.Webhooks.create_webhook(body)\n```\n\n\n\n\n#### [Delete Webhook](https://developers.klaviyo.com/en/v2025-01-15/reference/delete_webhook)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Webhooks.delete_webhook(id)\n```\n\n\n\n\n#### [Get Webhook](https://developers.klaviyo.com/en/v2025-01-15/reference/get_webhook)\n\n```python\n## Positional Arguments\n\n# id | str\n\n## Keyword Arguments\n\n# fields_webhook | List[str]\n# include | List[str]\n\nklaviyo.Webhooks.get_webhook(id, fields_webhook=fields_webhook, include=include)\n```\n\n\n\n\n#### [Get Webhook Topic](https://developers.klaviyo.com/en/v2025-01-15/reference/get_webhook_topic)\n\n```python\n## Positional Arguments\n\n# id | str\n\nklaviyo.Webhooks.get_webhook_topic(id)\n```\n\n\n\n\n#### [Get Webhook Topics](https://developers.klaviyo.com/en/v2025-01-15/reference/get_webhook_topics)\n\n```python\n\nklaviyo.Webhooks.get_webhook_topics()\n```\n\n\n\n\n#### [Get Webhooks](https://developers.klaviyo.com/en/v2025-01-15/reference/get_webhooks)\n\n```python\n\n## Keyword Arguments\n\n# fields_webhook | List[str]\n# include | List[str]\n\nklaviyo.Webhooks.get_webhooks(fields_webhook=fields_webhook, include=include)\n```\n\n\n\n\n#### [Update Webhook](https://developers.klaviyo.com/en/v2025-01-15/reference/update_webhook)\n\n```python\n## Positional Arguments\n\n# id | str\n# body | dict\n\nklaviyo.Webhooks.update_webhook(id, body)\n```\n\n\n\n\n# Appendix\n\n## Global Keyword Args\n\nNOTE: These are arguments that you can apply to any endpoint call, and which are unique to the SDK\n\nWe currently support the following global keyword args:\n- `_request_auth` : use this to override the client-level api_key which you define upon client instantiation\n\n## Refresher on catching exceptions:\n\n```python\ntry:\n    YOUR_CALL\nexcept Exception as e:\n    print(e.status)\n    print(e.reason)\n    print(e.body)\n    print(e.headers)\n```\n\n## Parameters \u0026 Arguments\n\nThe parameters follow the same naming conventions as the resource groups and operations.\n\nWe stick to the following convention for parameters/arguments\n\n1. All parameters are passed as function args.\n2. All query and path params that are tagged as `required` in the docs are passed as positional args.\n3. All optional query params are passed as keyword args.\n4. Where applicable, the `body` param is passed in as a positional arg, and is expected to be a native python dictionary. Within that dictionary, refer to the API docs to see which fields are required/optional, along with valid values.\n4. There is no need to pass in your private `api_key` for any operations, as it is defined upon client instantiation; public key is still required where applicable. However, you can pass in an optional `_request_auth` kwarg to override the client private key for a specific call (REMINDER: don't do this client-side).\n\n## Namespace\n\nIn the interest of making the SDK Pythonic, we made the following namespace changes *relative* to the language agnostic resources up top (API Docs, Guides, etc).\n\n- Resource names use Title + Snake Casing, (e.g. `Data_Privacy`)\n- function names and parameter names use snake case (e.g. `get_metrics`, and `profile_id`)\n\n## Renamed Fields\nAs of the 2024-05-15 release, some models fields are named differently than they appear in API documentation. These fields are\n\n- `datetime`: renamed to `datetime_`\n- `date`: renamed to `date_`\n\nThis is to manage compatibility with Pydantic v2. An example of this can be seen in [StaticScheduleOptions](src/openapi_client/models/static_schedule_options.py).\n\n```python\nclass StaticScheduleOptions(BaseModel):\n    \"\"\"\n    StaticScheduleOptions\n    \"\"\" # noqa: E501\n    datetime_: datetime = Field(description=\"The time to send at\", alias=\"datetime\")\n```\n\n### Usage\n```python\nschedule_options = StaticScheduleOptions(datetime_=datetime.datetime.strptime(\"2024-05-19T00:00:00+00:00\", \"%Y-%m-%dT%H:%M:%S%z\")\nprint(schedule_options.datetime_)\n```\n\n## Filter Builder\nUse this class to help construct filter query parameters.\n```python\nold_date = datetime.datetime(2023, 8, 15, 12, 30, 0, 0, tzinfo=datetime.timezone.utc)\n\nf = FilterBuilder()\nf.any(\"email\", [\"sarah.mason@klaviyo-demo.com\", \"sm@klaviyo-demo.com\"])\nf.greater_than(\"created\", old_date)\n\n# f.build() returns 'any(email,[\"sarah.mason@klaviyo-demo.com\",\"sm@klaviyo-demo.com\"]),greater-than(created,2023-08-15T12:30:00+00:00)'\nprofile_response = client.Profiles.get_profiles(filter=f.build())\n\n# You can also chain FilterBuilder methods\nf = FilterBuilder()\nfilters = f.any(\"email\", [\"sarah.mason@klaviyo-demo.com\", \"sm@klaviyo-demo.com\"]).greater_than(\"created\", date).build()\nassert filters == \"any(email,['sarah.mason@klaviyo-demo.com','sm@klaviyo-demo.com']),greater-than(created,2023-08-15T12:30:00+00:00)\"\n```\n\n## Typed Responses\nBy default, all API methods will return a type representing the response payload instead of dictionary, as was the case in previous versions of this SDK. Using the typed response, you can access fields of a response using dot notation, like so:\n```python\nfrom klaviyo_api import KlaviyoAPI\n\nclient = KlaviyoAPI(\n    api_key,\n    max_delay=0,\n    max_retries=0\n    )\n\nprofiles = client.Profiles.get_profiles()\nprofile_id = profiles.data[0].id\nprofile = client.Profiles.get_profile(profile_id)\nprofile_id = profile.data.id\nprofile_email = profile.data.attributes.email\n\nprint(type(profile).__name__) # prints GetProfileResponseCompoundDocument\n```\nThe class used in this example is found [here](src/openapi_client/models/get_profile_response_collection_compound_document.py).\n\nThis is a breaking change, as response objects will now require dot notation to access their fields versus the subscriptable access method used for dictionaries, i.e. `profile.data.id` vs `profile['data']['id']`. We have provided a [backwards compatibility strategy](#backwards-compatibility) to smooth the transition from dictionary responses to typed responses.\n\n### Backwards Compatibility\nTo maintain backwards compatibility with previous versions of this SDK, we have added an `options` argument that allows you to continue using dictionaries as response values. There are two ways to use this `options` argument:\n```python\nfrom klaviyo_api import KlaviyoAPI\nfrom openapi_client.api_arg_options import USE_DICTIONARY_FOR_RESPONSE_DATA\n\nclient = KlaviyoAPI(\n    api_key,\n    max_delay=0,\n    max_retries=0\n)\n\n# 1: Passing options to an individual API method\nprofiles = client.Profiles.get_profiles(options= {\n    USE_DICTIONARY_FOR_RESPONSE_DATA: True\n})\nprofile_id = profiles[\"data\"][0]['id']\nprofile_email = profiles[\"data\"][0]['attributes']['email']\n\n# 2: Passing options to API Client\ndictionary_client = KlaviyoAPI(\n    api_key,\n    max_delay=0,\n    max_retries=0,\n    options={USE_DICTIONARY_FOR_RESPONSE_DATA : True}\n)\nprofiles_ = dictionary_client.Profiles.get_profiles()\nprofile_0_id = profiles_[\"data\"][0]['id']\n\nprofile_0 = dictionary_client.Profiles.get_profile(id=profile_0_id)\nprofile_0_email = profile_0[\"data\"]['attributes']['email']\n```\nThe first way will only return a dictionary for that specific `get_profiles` call. The second makes it so that all API methods called using `dictionary_client` will return dictionaries as responses.\n\n## Untyped Response Data for Specific APIs\nSelect APIs do not yet have fully typed responses. Please use our API docs to inspect the schema of the response data for the following APIs.\n- **Segments** - The subproperty `conditions` is not yet typed in responses for the following APIs:\n    - [Create Segment](https://developers.klaviyo.com/en/reference/create_segment)\n    - [Update Segment](https://developers.klaviyo.com/en/reference/update_segment)\n    - [Get Segment](https://developers.klaviyo.com/en/reference/get_segment)\n    - [Get Segments](https://developers.klaviyo.com/en/reference/get_segments)\n- The `included` property is not typed in responses for the following APIs:\n    - [Get Event](https://developers.klaviyo.com/en/reference/get_event)\n    - [Get Events](https://developers.klaviyo.com/en/reference/get_events)\n    - [Get Profile](https://developers.klaviyo.com/en/reference/get_profile)\n    - [Get Profiles](https://developers.klaviyo.com/en/reference/get_profiles)\n    - [Get Flow](https://developers.klaviyo.com/en/reference/get_flow)\n    - [Get Flows](https://developers.klaviyo.com/en/reference/get_flows)\n    - [Get Flow Message](https://developers.klaviyo.com/en/reference/get_flow_message)\n    - [Get Campaign](https://developers.klaviyo.com/en/reference/get_campaign)\n    - [Get Campaigns](https://developers.klaviyo.com/en/reference/get_campaigns)\n- The `tracking_options` subproperty is not typed in responses for the following APIs:\n    - [Get Flow Action](https://developers.klaviyo.com/en/reference/get_flow_action)\n    - [Get Actions for Flow](https://developers.klaviyo.com/en/reference/get_actions_for_flow)\n    - [Create Campaign](https://developers.klaviyo.com/en/reference/create_campaign)\n    - [Update Campaign](https://developers.klaviyo.com/en/reference/update_campaign)\n    - [Get Campaign](https://developers.klaviyo.com/en/reference/get_campaign)\n    - [Get Campaigns](https://developers.klaviyo.com/en/reference/get_campaigns)\n- The `send_options` subproperty is not typed in responses for the following APIs:\n    - [Create Campaign](https://developers.klaviyo.com/en/reference/create_campaign)\n    - [Update Campaign](https://developers.klaviyo.com/en/reference/update_campaign)\n    - [Get Campaign](https://developers.klaviyo.com/en/reference/get_campaign)\n    - [Get Campaigns](https://developers.klaviyo.com/en/reference/get_campaigns)\n    - [Get Campaign for Campaign Message](https://developers.klaviyo.com/en/reference/get_campaign_for_campaign_message)\n    - [Get Messages for Campaign](https://developers.klaviyo.com/en/reference/get_messages_for_campaign)\n- The `content` subproperty is not typed in responses for the following APIs:\n    - [Get Flow Message](https://developers.klaviyo.com/en/reference/get_flow_message)\n    - [Get Messages for Flow Action](https://developers.klaviyo.com/en/reference/get_messages_for_flow_action)\n    - [Get Campaign for Campaign Message](https://developers.klaviyo.com/en/reference/get_campaign_for_campaign_message)\n    - [Get Messages for Campaign](https://developers.klaviyo.com/en/reference/get_messages_for_campaign)","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklaviyo%2Fklaviyo-api-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fklaviyo%2Fklaviyo-api-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklaviyo%2Fklaviyo-api-python/lists"}