Skip to content

klaviyo/klaviyo-api-python

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

68 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Klaviyo Python SDK

  • SDK version: 14.0.0
  • API revision: 2024-10-15

Table of Contents

Helpful Resources

Design & Approach

This SDK is a thin wrapper around our API. See our API Reference for full documentation on behavior.

This 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).

Organization

This SDK is organized into the following resources:

  • Accounts

  • Campaigns

  • Catalogs

  • Coupons

  • Data_Privacy

  • Events

  • Flows

  • Forms

  • Images

  • Lists

  • Metrics

  • Profiles

  • Reporting

  • Reviews

  • Segments

  • Tags

  • Templates

  • Tracking_Settings

  • Webhooks

Installation

You can install this library using our pip package here.

Depending on your system configuration, you will need to run one of the following shell commands:

pip install klaviyo-api

OR

pip3 install klaviyo-api

Usage Example

To instantiate the client

NOTE:

  • The SDK retries on resolvable errors, namely: rate limits (common) and server errors (rare).
  • The keyword arguments define some advanced settings; the example is populated with the default values.
  • max_delay denotes total delay (in seconds) across all attempts.
from klaviyo_api import KlaviyoAPI

klaviyo = KlaviyoAPI("YOUR_API_KEY_HERE", max_delay=60, max_retries=3, test_host=None)

Example request

klaviyo.Metrics.get_metrics() 

Use Case Examples

How to use filtering, sorting, and spare fieldset JSON API features

Use Case: Get events associated with a specific metric, then return just the event properties sorted by oldest to newest datetime.

klaviyo.Events.get_events(
    fields_event=['event_properties'], 
    filter="equals(metric_id,\"aBc123\")", 
    sort='-datetime'
    )

How to filter based on datetime

Use Case: Get profiles that have been updated between two datetimes.

klaviyo.Profiles.get_profiles(
    filter='less-than(updated,2023-04-26T00:00:00Z),greater-than(updated,2023-04-19T00:00:00Z)'
    )

How to use pagination and the page[size] param

Use Case: Use cursor-based pagination to get the next 20 profile records.

klaviyo.Profiles.get_profiles(
    page_cursor="https://a.klaviyo.com/api/profiles/?page%5Bcursor%5D=bmV4dDo6aWQ6OjAxRjNaWk5ITlRYMUtFVEhQMzJTUzRBN0ZY",
    page_size=20
)

NOTE: This page cursor value is exactly what is returned in the self/next/prev response values

How to add additional information to your API response via additional-fields and the includes parameter

Use Case: Get a specific profile, return an additional predictive analytics field, and also return the list objects associated with the profile.

klaviyo.Profiles.get_profile(
    '01GDDKASAP8TKDDA2GRZDSVP4H', 
    additional_fields_profile=['predictive_analytics'], 
    include=['lists']
)

How to use our relationship endpoints to see related resources

Use Case: Get all list memberships for a profile with the given profile_id.

klaviyo.Profiles.get_profile_relationships_lists('01GDDKASAP8TKDDA2GRZDSVP4H')

How to see what Klaviyo objects are associated with a specific tag

Use Case: Get all campaigns associated with the given tag_id.

klaviyo.Tags.get_tag_relationships_campaigns('9c8db7a0-5ab5-4e3c-9a37-a3224fd14382')

Uploading Image From File

When using Images.upload_image_from_file(file, name=name), `file`` can be either a file path string OR a bytearray.

NOTE: 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

as a file path

filepath = '/path/to/image.png'
klaviyo.Images.upload_image_from_file(file, name=name)

as a bytearray

filepath = '/path/to/image.png'
with open(filepath, 'rb') as f:
    file = f.read()
klaviyo.Images.upload_image_from_file(file, name=name)

Error Handling

This SDK throws an ApiException error when the server returns a non-2XX response.

An ApiException consists of the following attributes:

  • status : int
  • reason : str
  • body : bytes
    • this can be decoded into a native python dictionary as follows:
      # to decode to a dictionary
      import json
      BODY_DICT = json.loads(YOUR_EXCEPTION.body)
      
      # to decode to a string
      BODY_STRING = YOUR_EXCEPTION.body.decode('utf-8')
  • headers : class 'urllib3._collections.HTTPHeaderDict'
    • This can be interacted with as a normal dictionary:
      • ex:
        date = YOUR_EXCEPTION.headers['Date']
        keys = YOUR_EXCEPTION.headers.keys()
        values = YOUR_EXCEPTION.headers.values()
        

Important Notes

  • 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.
  • 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.
  • For example values / data types, as well as whether parameters are required/optional, please reference the corresponding API Reference link.
  • 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.
  • JSON payloads should be passed in as native python dictionaries.
  • 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.

Comprehensive List of Operations & Parameters

Accounts

## Positional Arguments

# id | str

## Keyword Arguments

# fields_account | List[str]

klaviyo.Accounts.get_account(id, fields_account=fields_account)
## Keyword Arguments

# fields_account | List[str]

klaviyo.Accounts.get_accounts(fields_account=fields_account)

Campaigns

## Positional Arguments

# body | dict

klaviyo.Campaigns.assign_template_to_campaign_message(body)
Method alias:
klaviyo.Campaigns.create_campaign_message_assign_template(body)
## Positional Arguments

# id | str
# body | dict

klaviyo.Campaigns.cancel_campaign_send(id, body)
Method alias:
klaviyo.Campaigns.update_campaign_send_job(id, body)
## Positional Arguments

# body | dict

klaviyo.Campaigns.create_campaign(body)
## Positional Arguments

# body | dict

klaviyo.Campaigns.create_campaign_clone(body)
Method alias:
klaviyo.Campaigns.clone_campaign(body)
## Positional Arguments

# id | str

klaviyo.Campaigns.delete_campaign(id)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_campaign_message | List[str]
# fields_campaign | List[str]
# fields_tag | List[str]
# include | List[str]

klaviyo.Campaigns.get_campaign(id, fields_campaign_message=fields_campaign_message, fields_campaign=fields_campaign, fields_tag=fields_tag, include=include)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_campaign | List[str]

klaviyo.Campaigns.get_campaign_for_campaign_message(id, fields_campaign=fields_campaign)
Method alias:
klaviyo.Campaigns.get_campaign_message_campaign(id, fields_campaign=fields_campaign)
## Positional Arguments

# id | str

klaviyo.Campaigns.get_campaign_id_for_campaign_message(id)
Method alias:
klaviyo.Campaigns.get_campaign_message_relationships_campaign(id)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_campaign_message | List[str]
# fields_campaign | List[str]
# fields_template | List[str]
# include | List[str]

klaviyo.Campaigns.get_campaign_message(id, fields_campaign_message=fields_campaign_message, fields_campaign=fields_campaign, fields_template=fields_template, include=include)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_campaign_recipient_estimation | List[str]

klaviyo.Campaigns.get_campaign_recipient_estimation(id, fields_campaign_recipient_estimation=fields_campaign_recipient_estimation)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_campaign_recipient_estimation_job | List[str]

klaviyo.Campaigns.get_campaign_recipient_estimation_job(id, fields_campaign_recipient_estimation_job=fields_campaign_recipient_estimation_job)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_campaign_send_job | List[str]

klaviyo.Campaigns.get_campaign_send_job(id, fields_campaign_send_job=fields_campaign_send_job)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_tag | List[str]

klaviyo.Campaigns.get_campaign_tags(id, fields_tag=fields_tag)
## Positional Arguments

# filter | str

## Keyword Arguments

# fields_campaign_message | List[str]
# fields_campaign | List[str]
# fields_tag | List[str]
# include | List[str]
# page_cursor | str
# sort | str

klaviyo.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)
## Positional Arguments

# id | str

klaviyo.Campaigns.get_message_ids_for_campaign(id)
Method alias:
klaviyo.Campaigns.get_campaign_relationships_campaign_messages(id)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_campaign_message | List[str]
# fields_campaign | List[str]
# fields_template | List[str]
# include | List[str]

klaviyo.Campaigns.get_messages_for_campaign(id, fields_campaign_message=fields_campaign_message, fields_campaign=fields_campaign, fields_template=fields_template, include=include)
Method alias:
klaviyo.Campaigns.get_campaign_campaign_messages(id, fields_campaign_message=fields_campaign_message, fields_campaign=fields_campaign, fields_template=fields_template, include=include)
## Positional Arguments

# id | str

klaviyo.Campaigns.get_tag_ids_for_campaign(id)
Method alias:
klaviyo.Campaigns.get_campaign_relationships_tags(id)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_template | List[str]

klaviyo.Campaigns.get_template_for_campaign_message(id, fields_template=fields_template)
Method alias:
klaviyo.Campaigns.get_campaign_message_template(id, fields_template=fields_template)
## Positional Arguments

# id | str

klaviyo.Campaigns.get_template_id_for_campaign_message(id)
Method alias:
klaviyo.Campaigns.get_campaign_message_relationships_template(id)
## Positional Arguments

# body | dict

klaviyo.Campaigns.refresh_campaign_recipient_estimation(body)
Method alias:
klaviyo.Campaigns.create_campaign_recipient_estimation_job(body)
## Positional Arguments

# body | dict

klaviyo.Campaigns.send_campaign(body)
Method alias:
klaviyo.Campaigns.create_campaign_send_job(body)
## Positional Arguments

# id | str
# body | dict

klaviyo.Campaigns.update_campaign(id, body)
## Positional Arguments

# id | str
# body | dict

klaviyo.Campaigns.update_campaign_message(id, body)

Catalogs

## Positional Arguments

# id | str
# body | dict

klaviyo.Catalogs.add_category_to_catalog_item(id, body)
Method alias:
klaviyo.Catalogs.create_catalog_item_relationships_categories(id, body)
Method alias:
klaviyo.Catalogs.create_catalog_item_relationships_category(id, body)
## Positional Arguments

# id | str
# body | dict

klaviyo.Catalogs.add_items_to_catalog_category(id, body)
Method alias:
klaviyo.Catalogs.create_catalog_category_relationships_items(id, body)
Method alias:
klaviyo.Catalogs.create_catalog_category_relationships_item(id, body)
## Positional Arguments

# body | dict

klaviyo.Catalogs.bulk_create_catalog_categories(body)
Method alias:
klaviyo.Catalogs.spawn_create_categories_job(body)
Method alias:
klaviyo.Catalogs.create_catalog_category_bulk_create_job(body)
## Positional Arguments

# body | dict

klaviyo.Catalogs.bulk_create_catalog_items(body)
Method alias:
klaviyo.Catalogs.spawn_create_items_job(body)
Method alias:
klaviyo.Catalogs.create_catalog_item_bulk_create_job(body)
## Positional Arguments

# body | dict

klaviyo.Catalogs.bulk_create_catalog_variants(body)
Method alias:
klaviyo.Catalogs.spawn_create_variants_job(body)
Method alias:
klaviyo.Catalogs.create_catalog_variant_bulk_create_job(body)
## Positional Arguments

# body | dict

klaviyo.Catalogs.bulk_delete_catalog_categories(body)
Method alias:
klaviyo.Catalogs.spawn_delete_categories_job(body)
Method alias:
klaviyo.Catalogs.create_catalog_category_bulk_delete_job(body)
## Positional Arguments

# body | dict

klaviyo.Catalogs.bulk_delete_catalog_items(body)
Method alias:
klaviyo.Catalogs.spawn_delete_items_job(body)
Method alias:
klaviyo.Catalogs.create_catalog_item_bulk_delete_job(body)
## Positional Arguments

# body | dict

klaviyo.Catalogs.bulk_delete_catalog_variants(body)
Method alias:
klaviyo.Catalogs.spawn_delete_variants_job(body)
Method alias:
klaviyo.Catalogs.create_catalog_variant_bulk_delete_job(body)
## Positional Arguments

# body | dict

klaviyo.Catalogs.bulk_update_catalog_categories(body)
Method alias:
klaviyo.Catalogs.spawn_update_categories_job(body)
Method alias:
klaviyo.Catalogs.create_catalog_category_bulk_update_job(body)
## Positional Arguments

# body | dict

klaviyo.Catalogs.bulk_update_catalog_items(body)
Method alias:
klaviyo.Catalogs.spawn_update_items_job(body)
Method alias:
klaviyo.Catalogs.create_catalog_item_bulk_update_job(body)
## Positional Arguments

# body | dict

klaviyo.Catalogs.bulk_update_catalog_variants(body)
Method alias:
klaviyo.Catalogs.spawn_update_variants_job(body)
Method alias:
klaviyo.Catalogs.create_catalog_variant_bulk_update_job(body)
## Positional Arguments

# body | dict

klaviyo.Catalogs.create_back_in_stock_subscription(body)
## Positional Arguments

# body | dict

klaviyo.Catalogs.create_catalog_category(body)
## Positional Arguments

# body | dict

klaviyo.Catalogs.create_catalog_item(body)
## Positional Arguments

# body | dict

klaviyo.Catalogs.create_catalog_variant(body)
## Positional Arguments

# id | str

klaviyo.Catalogs.delete_catalog_category(id)
## Positional Arguments

# id | str

klaviyo.Catalogs.delete_catalog_item(id)
## Positional Arguments

# id | str

klaviyo.Catalogs.delete_catalog_variant(id)
## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_catalog_item_bulk_create_job | List[str]
# fields_catalog_item | List[str]
# include | List[str]

klaviyo.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)
Method alias:
klaviyo.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)
Method alias:
klaviyo.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)
## Keyword Arguments

# fields_catalog_item_bulk_create_job | List[str]
# filter | str
# page_cursor | str

klaviyo.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)
Method alias:
klaviyo.Catalogs.get_create_items_jobs(fields_catalog_item_bulk_create_job=fields_catalog_item_bulk_create_job, filter=filter, page_cursor=page_cursor)
Method alias:
klaviyo.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)
## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_catalog_item_bulk_delete_job | List[str]

klaviyo.Catalogs.get_bulk_delete_catalog_items_job(job_id, fields_catalog_item_bulk_delete_job=fields_catalog_item_bulk_delete_job)
Method alias:
klaviyo.Catalogs.get_delete_items_job(job_id, fields_catalog_item_bulk_delete_job=fields_catalog_item_bulk_delete_job)
Method alias:
klaviyo.Catalogs.get_catalog_item_bulk_delete_job(job_id, fields_catalog_item_bulk_delete_job=fields_catalog_item_bulk_delete_job)
## Keyword Arguments

# fields_catalog_item_bulk_delete_job | List[str]
# filter | str
# page_cursor | str

klaviyo.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)
Method alias:
klaviyo.Catalogs.get_delete_items_jobs(fields_catalog_item_bulk_delete_job=fields_catalog_item_bulk_delete_job, filter=filter, page_cursor=page_cursor)
Method alias:
klaviyo.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)
## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_catalog_item_bulk_update_job | List[str]
# fields_catalog_item | List[str]
# include | List[str]

klaviyo.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)
Method alias:
klaviyo.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)
Method alias:
klaviyo.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)
## Keyword Arguments

# fields_catalog_item_bulk_update_job | List[str]
# filter | str
# page_cursor | str

klaviyo.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)
Method alias:
klaviyo.Catalogs.get_update_items_jobs(fields_catalog_item_bulk_update_job=fields_catalog_item_bulk_update_job, filter=filter, page_cursor=page_cursor)
Method alias:
klaviyo.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)
## Keyword Arguments

# fields_catalog_category | List[str]
# filter | str
# page_cursor | str
# sort | str

klaviyo.Catalogs.get_catalog_categories(fields_catalog_category=fields_catalog_category, filter=filter, page_cursor=page_cursor, sort=sort)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_catalog_category | List[str]

klaviyo.Catalogs.get_catalog_category(id, fields_catalog_category=fields_catalog_category)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_catalog_item | List[str]
# fields_catalog_variant | List[str]
# include | List[str]

klaviyo.Catalogs.get_catalog_item(id, fields_catalog_item=fields_catalog_item, fields_catalog_variant=fields_catalog_variant, include=include)
## Keyword Arguments

# fields_catalog_item | List[str]
# fields_catalog_variant | List[str]
# filter | str
# include | List[str]
# page_cursor | str
# sort | str

klaviyo.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)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_catalog_variant | List[str]

klaviyo.Catalogs.get_catalog_variant(id, fields_catalog_variant=fields_catalog_variant)
## Keyword Arguments

# fields_catalog_variant | List[str]
# filter | str
# page_cursor | str
# sort | str

klaviyo.Catalogs.get_catalog_variants(fields_catalog_variant=fields_catalog_variant, filter=filter, page_cursor=page_cursor, sort=sort)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_catalog_category | List[str]
# filter | str
# page_cursor | str
# sort | str

klaviyo.Catalogs.get_categories_for_catalog_item(id, fields_catalog_category=fields_catalog_category, filter=filter, page_cursor=page_cursor, sort=sort)
Method alias:
klaviyo.Catalogs.get_catalog_item_categories(id, fields_catalog_category=fields_catalog_category, filter=filter, page_cursor=page_cursor, sort=sort)
## Positional Arguments

# id | str

## Keyword Arguments

# page_cursor | str

klaviyo.Catalogs.get_category_ids_for_catalog_item(id, page_cursor=page_cursor)
Method alias:
klaviyo.Catalogs.get_catalog_item_relationships_categories(id, page_cursor=page_cursor)
## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_catalog_category_bulk_create_job | List[str]
# fields_catalog_category | List[str]
# include | List[str]

klaviyo.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)
Method alias:
klaviyo.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)
## Keyword Arguments

# fields_catalog_category_bulk_create_job | List[str]
# filter | str
# page_cursor | str

klaviyo.Catalogs.get_create_categories_jobs(fields_catalog_category_bulk_create_job=fields_catalog_category_bulk_create_job, filter=filter, page_cursor=page_cursor)
Method alias:
klaviyo.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)
## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_catalog_variant_bulk_create_job | List[str]
# fields_catalog_variant | List[str]
# include | List[str]

klaviyo.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)
Method alias:
klaviyo.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)
## Keyword Arguments

# fields_catalog_variant_bulk_create_job | List[str]
# filter | str
# page_cursor | str

klaviyo.Catalogs.get_create_variants_jobs(fields_catalog_variant_bulk_create_job=fields_catalog_variant_bulk_create_job, filter=filter, page_cursor=page_cursor)
Method alias:
klaviyo.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)
## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_catalog_category_bulk_delete_job | List[str]

klaviyo.Catalogs.get_delete_categories_job(job_id, fields_catalog_category_bulk_delete_job=fields_catalog_category_bulk_delete_job)
Method alias:
klaviyo.Catalogs.get_catalog_category_bulk_delete_job(job_id, fields_catalog_category_bulk_delete_job=fields_catalog_category_bulk_delete_job)
## Keyword Arguments

# fields_catalog_category_bulk_delete_job | List[str]
# filter | str
# page_cursor | str

klaviyo.Catalogs.get_delete_categories_jobs(fields_catalog_category_bulk_delete_job=fields_catalog_category_bulk_delete_job, filter=filter, page_cursor=page_cursor)
Method alias:
klaviyo.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)
## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_catalog_variant_bulk_delete_job | List[str]

klaviyo.Catalogs.get_delete_variants_job(job_id, fields_catalog_variant_bulk_delete_job=fields_catalog_variant_bulk_delete_job)
Method alias:
klaviyo.Catalogs.get_catalog_variant_bulk_delete_job(job_id, fields_catalog_variant_bulk_delete_job=fields_catalog_variant_bulk_delete_job)
## Keyword Arguments

# fields_catalog_variant_bulk_delete_job | List[str]
# filter | str
# page_cursor | str

klaviyo.Catalogs.get_delete_variants_jobs(fields_catalog_variant_bulk_delete_job=fields_catalog_variant_bulk_delete_job, filter=filter, page_cursor=page_cursor)
Method alias:
klaviyo.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)
## Positional Arguments

# id | str

## Keyword Arguments

# page_cursor | str

klaviyo.Catalogs.get_item_ids_for_catalog_category(id, page_cursor=page_cursor)
Method alias:
klaviyo.Catalogs.get_catalog_category_relationships_items(id, page_cursor=page_cursor)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_catalog_item | List[str]
# fields_catalog_variant | List[str]
# filter | str
# include | List[str]
# page_cursor | str
# sort | str

klaviyo.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)
Method alias:
klaviyo.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)
## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_catalog_category_bulk_update_job | List[str]
# fields_catalog_category | List[str]
# include | List[str]

klaviyo.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)
Method alias:
klaviyo.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)
## Keyword Arguments

# fields_catalog_category_bulk_update_job | List[str]
# filter | str
# page_cursor | str

klaviyo.Catalogs.get_update_categories_jobs(fields_catalog_category_bulk_update_job=fields_catalog_category_bulk_update_job, filter=filter, page_cursor=page_cursor)
Method alias:
klaviyo.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)
## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_catalog_variant_bulk_update_job | List[str]
# fields_catalog_variant | List[str]
# include | List[str]

klaviyo.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)
Method alias:
klaviyo.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)
## Keyword Arguments

# fields_catalog_variant_bulk_update_job | List[str]
# filter | str
# page_cursor | str

klaviyo.Catalogs.get_update_variants_jobs(fields_catalog_variant_bulk_update_job=fields_catalog_variant_bulk_update_job, filter=filter, page_cursor=page_cursor)
Method alias:
klaviyo.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)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_catalog_variant | List[str]
# filter | str
# page_cursor | str
# sort | str

klaviyo.Catalogs.get_variants_for_catalog_item(id, fields_catalog_variant=fields_catalog_variant, filter=filter, page_cursor=page_cursor, sort=sort)
Method alias:
klaviyo.Catalogs.get_catalog_item_variants(id, fields_catalog_variant=fields_catalog_variant, filter=filter, page_cursor=page_cursor, sort=sort)
## Positional Arguments

# id | str
# body | dict

klaviyo.Catalogs.remove_categories_from_catalog_item(id, body)
Method alias:
klaviyo.Catalogs.delete_catalog_item_relationships_categories(id, body)
## Positional Arguments

# id | str
# body | dict

klaviyo.Catalogs.remove_items_from_catalog_category(id, body)
Method alias:
klaviyo.Catalogs.delete_catalog_category_relationships_items(id, body)
## Positional Arguments

# id | str
# body | dict

klaviyo.Catalogs.update_catalog_category(id, body)
## Positional Arguments

# id | str
# body | dict

klaviyo.Catalogs.update_catalog_item(id, body)
## Positional Arguments

# id | str
# body | dict

klaviyo.Catalogs.update_catalog_variant(id, body)
## Positional Arguments

# id | str
# body | dict

klaviyo.Catalogs.update_categories_for_catalog_item(id, body)
Method alias:
klaviyo.Catalogs.update_catalog_item_relationships_categories(id, body)
## Positional Arguments

# id | str
# body | dict

klaviyo.Catalogs.update_items_for_catalog_category(id, body)
Method alias:
klaviyo.Catalogs.update_catalog_category_relationships_items(id, body)

Coupons

## Positional Arguments

# body | dict

klaviyo.Coupons.bulk_create_coupon_codes(body)
Method alias:
klaviyo.Coupons.spawn_coupon_code_bulk_create_job(body)
Method alias:
klaviyo.Coupons.create_coupon_code_bulk_create_job(body)
## Positional Arguments

# body | dict

klaviyo.Coupons.create_coupon(body)
## Positional Arguments

# body | dict

klaviyo.Coupons.create_coupon_code(body)
## Positional Arguments

# id | str

klaviyo.Coupons.delete_coupon(id)
## Positional Arguments

# id | str

klaviyo.Coupons.delete_coupon_code(id)
## Keyword Arguments

# fields_coupon_code_bulk_create_job | List[str]
# filter | str
# page_cursor | str

klaviyo.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)
Method alias:
klaviyo.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)
## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_coupon_code_bulk_create_job | List[str]
# fields_coupon_code | List[str]
# include | List[str]

klaviyo.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)
Method alias:
klaviyo.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)
## Positional Arguments

# id | str

## Keyword Arguments

# page_cursor | str

klaviyo.Coupons.get_code_ids_for_coupon(id, page_cursor=page_cursor)
Method alias:
klaviyo.Coupons.get_coupon_code_relationships_coupon(id, page_cursor=page_cursor)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_coupon | List[str]

klaviyo.Coupons.get_coupon(id, fields_coupon=fields_coupon)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_coupon_code | List[str]
# fields_coupon | List[str]
# include | List[str]

klaviyo.Coupons.get_coupon_code(id, fields_coupon_code=fields_coupon_code, fields_coupon=fields_coupon, include=include)
## Keyword Arguments

# fields_coupon_code | List[str]
# fields_coupon | List[str]
# filter | str
# include | List[str]
# page_cursor | str

klaviyo.Coupons.get_coupon_codes(fields_coupon_code=fields_coupon_code, fields_coupon=fields_coupon, filter=filter, include=include, page_cursor=page_cursor)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_coupon_code | List[str]
# filter | str
# page_cursor | str

klaviyo.Coupons.get_coupon_codes_for_coupon(id, fields_coupon_code=fields_coupon_code, filter=filter, page_cursor=page_cursor)
Method alias:
klaviyo.Coupons.get_coupon_coupon_codes(id, fields_coupon_code=fields_coupon_code, filter=filter, page_cursor=page_cursor)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_coupon | List[str]

klaviyo.Coupons.get_coupon_for_coupon_code(id, fields_coupon=fields_coupon)
Method alias:
klaviyo.Coupons.get_coupon_code_coupon(id, fields_coupon=fields_coupon)
## Positional Arguments

# id | str

klaviyo.Coupons.get_coupon_id_for_coupon_code(id)
Method alias:
klaviyo.Coupons.get_coupon_relationships_coupon_codes(id)
## Keyword Arguments

# fields_coupon | List[str]
# page_cursor | str

klaviyo.Coupons.get_coupons(fields_coupon=fields_coupon, page_cursor=page_cursor)
## Positional Arguments

# id | str
# body | dict

klaviyo.Coupons.update_coupon(id, body)
## Positional Arguments

# id | str
# body | dict

klaviyo.Coupons.update_coupon_code(id, body)

Data_Privacy

## Positional Arguments

# body | dict

klaviyo.Data_Privacy.request_profile_deletion(body)
Method alias:
klaviyo.Data_Privacy.create_data_privacy_deletion_job(body)

Events

## Positional Arguments

# body | dict

klaviyo.Events.bulk_create_events(body)
Method alias:
klaviyo.Events.create_event_bulk_create_job(body)
## Positional Arguments

# body | dict

klaviyo.Events.create_event(body)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_event | List[str]
# fields_metric | List[str]
# fields_profile | List[str]
# include | List[str]

klaviyo.Events.get_event(id, fields_event=fields_event, fields_metric=fields_metric, fields_profile=fields_profile, include=include)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_metric | List[str]

klaviyo.Events.get_event_metric(id, fields_metric=fields_metric)
## Positional Arguments

# id | str

## Keyword Arguments

# additional_fields_profile | List[str]
# fields_profile | List[str]

klaviyo.Events.get_event_profile(id, additional_fields_profile=additional_fields_profile, fields_profile=fields_profile)
## Keyword Arguments

# fields_event | List[str]
# fields_metric | List[str]
# fields_profile | List[str]
# filter | str
# include | List[str]
# page_cursor | str
# sort | str

klaviyo.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)
## Positional Arguments

# id | str

klaviyo.Events.get_metric_id_for_event(id)
Method alias:
klaviyo.Events.get_event_relationships_metric(id)
## Positional Arguments

# id | str

klaviyo.Events.get_profile_id_for_event(id)
Method alias:
klaviyo.Events.get_event_relationships_profile(id)

Flows

## Positional Arguments

# id | str

klaviyo.Flows.delete_flow(id)
## Positional Arguments

# id | str

klaviyo.Flows.get_action_id_for_flow_message(id)
Method alias:
klaviyo.Flows.get_flow_message_relationships_action(id)
## Positional Arguments

# id | str

## Keyword Arguments

# filter | str
# page_size | int
# sort | str

klaviyo.Flows.get_action_ids_for_flow(id, filter=filter, page_size=page_size, sort=sort)
Method alias:
klaviyo.Flows.get_flow_relationships_flow_actions(id, filter=filter, page_size=page_size, sort=sort)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_flow_action | List[str]
# filter | str
# page_cursor | str
# page_size | int
# sort | str

klaviyo.Flows.get_actions_for_flow(id, fields_flow_action=fields_flow_action, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)
Method alias:
klaviyo.Flows.get_flow_flow_actions(id, fields_flow_action=fields_flow_action, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_flow_action | List[str]
# fields_flow | List[str]
# fields_tag | List[str]
# include | List[str]

klaviyo.Flows.get_flow(id, fields_flow_action=fields_flow_action, fields_flow=fields_flow, fields_tag=fields_tag, include=include)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_flow_action | List[str]
# fields_flow_message | List[str]
# fields_flow | List[str]
# include | List[str]

klaviyo.Flows.get_flow_action(id, fields_flow_action=fields_flow_action, fields_flow_message=fields_flow_message, fields_flow=fields_flow, include=include)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_flow | List[str]

klaviyo.Flows.get_flow_action_flow(id, fields_flow=fields_flow)
## Positional Arguments

# id | str

klaviyo.Flows.get_flow_id_for_flow_action(id)
Method alias:
klaviyo.Flows.get_flow_action_relationships_flow(id)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_flow_action | List[str]
# fields_flow_message | List[str]
# fields_template | List[str]
# include | List[str]

klaviyo.Flows.get_flow_message(id, fields_flow_action=fields_flow_action, fields_flow_message=fields_flow_message, fields_template=fields_template, include=include)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_flow_action | List[str]

klaviyo.Flows.get_flow_message_action(id, fields_flow_action=fields_flow_action)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_tag | List[str]

klaviyo.Flows.get_flow_tags(id, fields_tag=fields_tag)
## Keyword Arguments

# fields_flow_action | List[str]
# fields_flow | List[str]
# fields_tag | List[str]
# filter | str
# include | List[str]
# page_cursor | str
# page_size | int
# sort | str

klaviyo.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)
## Positional Arguments

# id | str

## Keyword Arguments

# filter | str
# page_cursor | str
# page_size | int
# sort | str

klaviyo.Flows.get_message_ids_for_flow_action(id, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)
Method alias:
klaviyo.Flows.get_flow_action_relationships_messages(id, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_flow_message | List[str]
# filter | str
# page_size | int
# sort | str

klaviyo.Flows.get_messages_for_flow_action(id, fields_flow_message=fields_flow_message, filter=filter, page_size=page_size, sort=sort)
Method alias:
klaviyo.Flows.get_flow_action_messages(id, fields_flow_message=fields_flow_message, filter=filter, page_size=page_size, sort=sort)
## Positional Arguments

# id | str

klaviyo.Flows.get_tag_ids_for_flow(id)
Method alias:
klaviyo.Flows.get_flow_relationships_tags(id)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_template | List[str]

klaviyo.Flows.get_template_for_flow_message(id, fields_template=fields_template)
Method alias:
klaviyo.Flows.get_flow_message_template(id, fields_template=fields_template)
## Positional Arguments

# id | str

klaviyo.Flows.get_template_id_for_flow_message(id)
Method alias:
klaviyo.Flows.get_flow_message_relationships_template(id)
## Positional Arguments

# id | str
# body | dict

klaviyo.Flows.update_flow(id, body)

Forms

## Positional Arguments

# id | str

## Keyword Arguments

# fields_form_version | List[str]
# fields_form | List[str]
# include | List[str]

klaviyo.Forms.get_form(id, fields_form_version=fields_form_version, fields_form=fields_form, include=include)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_form | List[str]

klaviyo.Forms.get_form_for_form_version(id, fields_form=fields_form)
Method alias:
klaviyo.Forms.get_form_version_form(id, fields_form=fields_form)
## Positional Arguments

# id | str

klaviyo.Forms.get_form_id_for_form_version(id)
Method alias:
klaviyo.Forms.get_form_version_relationships_form(id)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_form_version | List[str]

klaviyo.Forms.get_form_version(id, fields_form_version=fields_form_version)
## Keyword Arguments

# fields_form | List[str]
# filter | str
# page_cursor | str
# page_size | int
# sort | str

klaviyo.Forms.get_forms(fields_form=fields_form, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)
## Positional Arguments

# id | str

klaviyo.Forms.get_version_ids_for_form(id)
Method alias:
klaviyo.Forms.get_form_relationships_form_versions(id)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_form_version | List[str]
# filter | str
# page_cursor | str
# page_size | int
# sort | str

klaviyo.Forms.get_versions_for_form(id, fields_form_version=fields_form_version, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)
Method alias:
klaviyo.Forms.get_form_form_versions(id, fields_form_version=fields_form_version, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)

Images

## Positional Arguments

# id | str

## Keyword Arguments

# fields_image | List[str]

klaviyo.Images.get_image(id, fields_image=fields_image)
## Keyword Arguments

# fields_image | List[str]
# filter | str
# page_cursor | str
# page_size | int
# sort | str

klaviyo.Images.get_images(fields_image=fields_image, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)
## Positional Arguments

# id | str
# body | dict

klaviyo.Images.update_image(id, body)
## Positional Arguments

# file | bytearray

## Keyword Arguments

# name | str
# hidden | bool

klaviyo.Images.upload_image_from_file(file, name=name, hidden=hidden)
Method alias:
klaviyo.Images.create_image_upload(file, name=name, hidden=hidden)
## Positional Arguments

# body | dict

klaviyo.Images.upload_image_from_url(body)
Method alias:
klaviyo.Images.create_image(body)

Lists

## Positional Arguments

# body | dict

klaviyo.Lists.create_list(body)
## Positional Arguments

# id | str
# body | dict

klaviyo.Lists.create_list_relationships(id, body)
Method alias:
klaviyo.Lists.create_list_relationships_profile(id, body)
## Positional Arguments

# id | str

klaviyo.Lists.delete_list(id)
## Positional Arguments

# id | str
# body | dict

klaviyo.Lists.delete_list_relationships(id, body)
Method alias:
klaviyo.Lists.delete_list_relationships_profiles(id, body)
## Positional Arguments

# id | str

## Keyword Arguments

# additional_fields_list | List[str]
# fields_flow | List[str]
# fields_list | List[str]
# fields_tag | List[str]
# include | List[str]

klaviyo.Lists.get_list(id, additional_fields_list=additional_fields_list, fields_flow=fields_flow, fields_list=fields_list, fields_tag=fields_tag, include=include)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_flow | List[str]

klaviyo.Lists.get_list_flow_triggers(id, fields_flow=fields_flow)
## Positional Arguments

# id | str

## Keyword Arguments

# additional_fields_profile | List[str]
# fields_profile | List[str]
# filter | str
# page_cursor | str
# page_size | int
# sort | str

klaviyo.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)
## Positional Arguments

# id | str

klaviyo.Lists.get_list_relationships_flow_triggers(id)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_tag | List[str]

klaviyo.Lists.get_list_tags(id, fields_tag=fields_tag)
## Keyword Arguments

# fields_flow | List[str]
# fields_list | List[str]
# fields_tag | List[str]
# filter | str
# include | List[str]
# page_cursor | str
# sort | str

klaviyo.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)
## Positional Arguments

# id | str

## Keyword Arguments

# filter | str
# page_cursor | str
# page_size | int
# sort | str

klaviyo.Lists.get_profile_ids_for_list(id, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)
Method alias:
klaviyo.Lists.get_list_relationships_profiles(id, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)
## Positional Arguments

# id | str

klaviyo.Lists.get_tag_ids_for_list(id)
Method alias:
klaviyo.Lists.get_list_relationships_tags(id)
## Positional Arguments

# id | str
# body | dict

klaviyo.Lists.update_list(id, body)

Metrics

## Positional Arguments

# id | str

## Keyword Arguments

# fields_flow | List[str]
# fields_metric | List[str]
# include | List[str]

klaviyo.Metrics.get_metric(id, fields_flow=fields_flow, fields_metric=fields_metric, include=include)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_flow | List[str]

klaviyo.Metrics.get_metric_flow_triggers(id, fields_flow=fields_flow)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_metric | List[str]

klaviyo.Metrics.get_metric_for_metric_property(id, fields_metric=fields_metric)
Method alias:
klaviyo.Metrics.get_metric_property_metric(id, fields_metric=fields_metric)
## Positional Arguments

# id | str

klaviyo.Metrics.get_metric_id_for_metric_property(id)
Method alias:
klaviyo.Metrics.get_metric_property_relationships_metric(id)
## Positional Arguments

# id | str

## Keyword Arguments

# additional_fields_metric_property | List[str]
# fields_metric_property | List[str]
# fields_metric | List[str]
# include | List[str]

klaviyo.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)
## Positional Arguments

# id | str

klaviyo.Metrics.get_metric_relationships_flow_triggers(id)
## Keyword Arguments

# fields_flow | List[str]
# fields_metric | List[str]
# filter | str
# include | List[str]
# page_cursor | str

klaviyo.Metrics.get_metrics(fields_flow=fields_flow, fields_metric=fields_metric, filter=filter, include=include, page_cursor=page_cursor)
## Positional Arguments

# id | str

## Keyword Arguments

# additional_fields_metric_property | List[str]
# fields_metric_property | List[str]

klaviyo.Metrics.get_properties_for_metric(id, additional_fields_metric_property=additional_fields_metric_property, fields_metric_property=fields_metric_property)
Method alias:
klaviyo.Metrics.get_metric_metric_properties(id, additional_fields_metric_property=additional_fields_metric_property, fields_metric_property=fields_metric_property)
## Positional Arguments

# id | str

klaviyo.Metrics.get_property_ids_for_metric(id)
Method alias:
klaviyo.Metrics.get_metric_relationships_metric_properties(id)
## Positional Arguments

# body | dict

klaviyo.Metrics.query_metric_aggregates(body)
Method alias:
klaviyo.Metrics.create_metric_aggregate(body)

Profiles

## Positional Arguments

# body | dict

klaviyo.Profiles.bulk_subscribe_profiles(body)
Method alias:
klaviyo.Profiles.subscribe_profiles(body)
Method alias:
klaviyo.Profiles.create_profile_subscription_bulk_create_job(body)
## Positional Arguments

# body | dict

klaviyo.Profiles.bulk_suppress_profiles(body)
Method alias:
klaviyo.Profiles.suppress_profiles(body)
Method alias:
klaviyo.Profiles.create_profile_suppression_bulk_create_job(body)
## Positional Arguments

# body | dict

klaviyo.Profiles.bulk_unsubscribe_profiles(body)
Method alias:
klaviyo.Profiles.unsubscribe_profiles(body)
Method alias:
klaviyo.Profiles.create_profile_subscription_bulk_delete_job(body)
## Positional Arguments

# body | dict

klaviyo.Profiles.bulk_unsuppress_profiles(body)
Method alias:
klaviyo.Profiles.unsuppress_profiles(body)
Method alias:
klaviyo.Profiles.create_profile_suppression_bulk_delete_job(body)
## Positional Arguments

# body | dict

klaviyo.Profiles.create_or_update_profile(body)
Method alias:
klaviyo.Profiles.create_profile_import(body)
## Positional Arguments

# body | dict

klaviyo.Profiles.create_profile(body)
## Positional Arguments

# body | dict

klaviyo.Profiles.create_push_token(body)
## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_list | List[str]
# fields_profile_bulk_import_job | List[str]
# include | List[str]

klaviyo.Profiles.get_bulk_import_profiles_job(job_id, fields_list=fields_list, fields_profile_bulk_import_job=fields_profile_bulk_import_job, include=include)
Method alias:
klaviyo.Profiles.get_bulk_profile_import_job(job_id, fields_list=fields_list, fields_profile_bulk_import_job=fields_profile_bulk_import_job, include=include)
Method alias:
klaviyo.Profiles.get_profile_bulk_import_job(job_id, fields_list=fields_list, fields_profile_bulk_import_job=fields_profile_bulk_import_job, include=include)
## Keyword Arguments

# fields_profile_bulk_import_job | List[str]
# filter | str
# page_cursor | str
# page_size | int
# sort | str

klaviyo.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)
Method alias:
klaviyo.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)
Method alias:
klaviyo.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)
## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_profile_suppression_bulk_create_job | List[str]

klaviyo.Profiles.get_bulk_suppress_profiles_job(job_id, fields_profile_suppression_bulk_create_job=fields_profile_suppression_bulk_create_job)
Method alias:
klaviyo.Profiles.get_profile_suppression_bulk_create_job(job_id, fields_profile_suppression_bulk_create_job=fields_profile_suppression_bulk_create_job)
## Keyword Arguments

# fields_profile_suppression_bulk_create_job | List[str]
# filter | str
# page_cursor | str
# sort | str

klaviyo.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)
Method alias:
klaviyo.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)
## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_profile_suppression_bulk_delete_job | List[str]

klaviyo.Profiles.get_bulk_unsuppress_profiles_job(job_id, fields_profile_suppression_bulk_delete_job=fields_profile_suppression_bulk_delete_job)
Method alias:
klaviyo.Profiles.get_profile_suppression_bulk_delete_job(job_id, fields_profile_suppression_bulk_delete_job=fields_profile_suppression_bulk_delete_job)
## Keyword Arguments

# fields_profile_suppression_bulk_delete_job | List[str]
# filter | str
# page_cursor | str
# sort | str

klaviyo.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)
Method alias:
klaviyo.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)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_import_error | List[str]
# page_cursor | str
# page_size | int

klaviyo.Profiles.get_errors_for_bulk_import_profiles_job(id, fields_import_error=fields_import_error, page_cursor=page_cursor, page_size=page_size)
Method alias:
klaviyo.Profiles.get_bulk_profile_import_job_import_errors(id, fields_import_error=fields_import_error, page_cursor=page_cursor, page_size=page_size)
Method alias:
klaviyo.Profiles.get_profile_bulk_import_job_import_errors(id, fields_import_error=fields_import_error, page_cursor=page_cursor, page_size=page_size)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_list | List[str]

klaviyo.Profiles.get_list_for_bulk_import_profiles_job(id, fields_list=fields_list)
Method alias:
klaviyo.Profiles.get_bulk_profile_import_job_lists(id, fields_list=fields_list)
Method alias:
klaviyo.Profiles.get_profile_bulk_import_job_lists(id, fields_list=fields_list)
## Positional Arguments

# id | str

klaviyo.Profiles.get_list_ids_for_bulk_import_profiles_job(id)
Method alias:
klaviyo.Profiles.get_bulk_profile_import_job_relationships_lists(id)
Method alias:
klaviyo.Profiles.get_profile_bulk_import_job_relationships_lists(id)
## Positional Arguments

# id | str

klaviyo.Profiles.get_list_ids_for_profile(id)
Method alias:
klaviyo.Profiles.get_profile_relationships_lists(id)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_list | List[str]

klaviyo.Profiles.get_lists_for_profile(id, fields_list=fields_list)
Method alias:
klaviyo.Profiles.get_profile_lists(id, fields_list=fields_list)
## Positional Arguments

# id | str

## Keyword Arguments

# additional_fields_profile | List[str]
# fields_list | List[str]
# fields_profile | List[str]
# fields_segment | List[str]
# include | List[str]

klaviyo.Profiles.get_profile(id, additional_fields_profile=additional_fields_profile, fields_list=fields_list, fields_profile=fields_profile, fields_segment=fields_segment, include=include)
## Positional Arguments

# id | str

## Keyword Arguments

# page_cursor | str
# page_size | int

klaviyo.Profiles.get_profile_ids_for_bulk_import_profiles_job(id, page_cursor=page_cursor, page_size=page_size)
Method alias:
klaviyo.Profiles.get_bulk_profile_import_job_relationships_profiles(id, page_cursor=page_cursor, page_size=page_size)
Method alias:
klaviyo.Profiles.get_profile_bulk_import_job_relationships_profiles(id, page_cursor=page_cursor, page_size=page_size)
## Keyword Arguments

# additional_fields_profile | List[str]
# fields_profile | List[str]
# filter | str
# page_cursor | str
# page_size | int
# sort | str

klaviyo.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)
## Positional Arguments

# id | str

## Keyword Arguments

# additional_fields_profile | List[str]
# fields_profile | List[str]
# page_cursor | str
# page_size | int

klaviyo.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)
Method alias:
klaviyo.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)
Method alias:
klaviyo.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)
## Positional Arguments

# id | str

klaviyo.Profiles.get_segment_ids_for_profile(id)
Method alias:
klaviyo.Profiles.get_profile_relationships_segments(id)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_segment | List[str]

klaviyo.Profiles.get_segments_for_profile(id, fields_segment=fields_segment)
Method alias:
klaviyo.Profiles.get_profile_segments(id, fields_segment=fields_segment)
## Positional Arguments

# body | dict

klaviyo.Profiles.merge_profiles(body)
Method alias:
klaviyo.Profiles.create_profile_merge(body)
## Positional Arguments

# body | dict

klaviyo.Profiles.spawn_bulk_profile_import_job(body)
Method alias:
klaviyo.Profiles.bulk_import_profiles(body)
Method alias:
klaviyo.Profiles.create_profile_bulk_import_job(body)
## Positional Arguments

# id | str
# body | dict

klaviyo.Profiles.update_profile(id, body)

Reporting

## Positional Arguments

# body | dict

## Keyword Arguments

# page_cursor | str

klaviyo.Reporting.query_campaign_values(body, page_cursor=page_cursor)
Method alias:
klaviyo.Reporting.create_campaign_value_report(body, page_cursor=page_cursor)
## Positional Arguments

# body | dict

## Keyword Arguments

# page_cursor | str

klaviyo.Reporting.query_flow_series(body, page_cursor=page_cursor)
Method alias:
klaviyo.Reporting.create_flow_sery_report(body, page_cursor=page_cursor)
## Positional Arguments

# body | dict

## Keyword Arguments

# page_cursor | str

klaviyo.Reporting.query_flow_values(body, page_cursor=page_cursor)
Method alias:
klaviyo.Reporting.create_flow_value_report(body, page_cursor=page_cursor)
## Positional Arguments

# body | dict

klaviyo.Reporting.query_form_series(body)
Method alias:
klaviyo.Reporting.create_form_sery_report(body)
## Positional Arguments

# body | dict

klaviyo.Reporting.query_form_values(body)
Method alias:
klaviyo.Reporting.create_form_value_report(body)
## Positional Arguments

# body | dict

klaviyo.Reporting.query_segment_series(body)
Method alias:
klaviyo.Reporting.create_segment_sery_report(body)
## Positional Arguments

# body | dict

klaviyo.Reporting.query_segment_values(body)
Method alias:
klaviyo.Reporting.create_segment_value_report(body)

Reviews

## Positional Arguments

# id | str

## Keyword Arguments

# fields_event | List[str]
# fields_review | List[str]
# include | List[str]

klaviyo.Reviews.get_review(id, fields_event=fields_event, fields_review=fields_review, include=include)
## Keyword Arguments

# fields_event | List[str]
# fields_review | List[str]
# filter | str
# include | List[str]
# page_cursor | str
# page_size | int
# sort | str

klaviyo.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)

Segments

## Positional Arguments

# body | dict

klaviyo.Segments.create_segment(body)
## Positional Arguments

# id | str

klaviyo.Segments.delete_segment(id)
## Positional Arguments

# id | str

## Keyword Arguments

# filter | str
# page_cursor | str
# page_size | int
# sort | str

klaviyo.Segments.get_profile_ids_for_segment(id, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)
Method alias:
klaviyo.Segments.get_segment_relationships_profiles(id, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)
## Positional Arguments

# id | str

## Keyword Arguments

# additional_fields_profile | List[str]
# fields_profile | List[str]
# filter | str
# page_cursor | str
# page_size | int
# sort | str

klaviyo.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)
Method alias:
klaviyo.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)
## Positional Arguments

# id | str

## Keyword Arguments

# additional_fields_segment | List[str]
# fields_flow | List[str]
# fields_segment | List[str]
# fields_tag | List[str]
# include | List[str]

klaviyo.Segments.get_segment(id, additional_fields_segment=additional_fields_segment, fields_flow=fields_flow, fields_segment=fields_segment, fields_tag=fields_tag, include=include)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_flow | List[str]

klaviyo.Segments.get_segment_flow_triggers(id, fields_flow=fields_flow)
## Positional Arguments

# id | str

klaviyo.Segments.get_segment_relationships_flow_triggers(id)
## Keyword Arguments

# fields_flow | List[str]
# fields_segment | List[str]
# fields_tag | List[str]
# filter | str
# include | List[str]
# page_cursor | str
# sort | str

klaviyo.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)
## Positional Arguments

# id | str

klaviyo.Segments.get_tag_ids_for_segment(id)
Method alias:
klaviyo.Segments.get_segment_relationships_tags(id)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_tag | List[str]

klaviyo.Segments.get_tags_for_segment(id, fields_tag=fields_tag)
Method alias:
klaviyo.Segments.get_segment_tags(id, fields_tag=fields_tag)
## Positional Arguments

# id | str
# body | dict

klaviyo.Segments.update_segment(id, body)

Tags

## Positional Arguments

# body | dict

klaviyo.Tags.create_tag(body)
## Positional Arguments

# body | dict

klaviyo.Tags.create_tag_group(body)
## Positional Arguments

# id | str

klaviyo.Tags.delete_tag(id)
## Positional Arguments

# id | str

klaviyo.Tags.delete_tag_group(id)
## Positional Arguments

# id | str

klaviyo.Tags.get_campaign_ids_for_tag(id)
Method alias:
klaviyo.Tags.get_tag_relationships_campaigns(id)
## Positional Arguments

# id | str

klaviyo.Tags.get_flow_ids_for_tag(id)
Method alias:
klaviyo.Tags.get_tag_relationships_flows(id)
## Positional Arguments

# id | str

klaviyo.Tags.get_list_ids_for_tag(id)
Method alias:
klaviyo.Tags.get_tag_relationships_lists(id)
## Positional Arguments

# id | str

klaviyo.Tags.get_segment_ids_for_tag(id)
Method alias:
klaviyo.Tags.get_tag_relationships_segments(id)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_tag_group | List[str]
# fields_tag | List[str]
# include | List[str]

klaviyo.Tags.get_tag(id, fields_tag_group=fields_tag_group, fields_tag=fields_tag, include=include)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_tag_group | List[str]

klaviyo.Tags.get_tag_group(id, fields_tag_group=fields_tag_group)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_tag_group | List[str]

klaviyo.Tags.get_tag_group_for_tag(id, fields_tag_group=fields_tag_group)
Method alias:
klaviyo.Tags.get_tag_tag_group(id, fields_tag_group=fields_tag_group)
## Positional Arguments

# id | str

klaviyo.Tags.get_tag_group_id_for_tag(id)
Method alias:
klaviyo.Tags.get_tag_relationships_tag_group(id)
## Keyword Arguments

# fields_tag_group | List[str]
# filter | str
# page_cursor | str
# sort | str

klaviyo.Tags.get_tag_groups(fields_tag_group=fields_tag_group, filter=filter, page_cursor=page_cursor, sort=sort)
## Positional Arguments

# id | str

klaviyo.Tags.get_tag_ids_for_tag_group(id)
Method alias:
klaviyo.Tags.get_tag_group_relationships_tags(id)
## Keyword Arguments

# fields_tag_group | List[str]
# fields_tag | List[str]
# filter | str
# include | List[str]
# page_cursor | str
# sort | str

klaviyo.Tags.get_tags(fields_tag_group=fields_tag_group, fields_tag=fields_tag, filter=filter, include=include, page_cursor=page_cursor, sort=sort)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_tag | List[str]

klaviyo.Tags.get_tags_for_tag_group(id, fields_tag=fields_tag)
Method alias:
klaviyo.Tags.get_tag_group_tags(id, fields_tag=fields_tag)
## Positional Arguments

# id | str
# body | dict

klaviyo.Tags.remove_tag_from_campaigns(id, body)
Method alias:
klaviyo.Tags.delete_tag_relationships_campaigns(id, body)
## Positional Arguments

# id | str
# body | dict

klaviyo.Tags.remove_tag_from_flows(id, body)
Method alias:
klaviyo.Tags.delete_tag_relationships_flows(id, body)
## Positional Arguments

# id | str
# body | dict

klaviyo.Tags.remove_tag_from_lists(id, body)
Method alias:
klaviyo.Tags.delete_tag_relationships_lists(id, body)
## Positional Arguments

# id | str
# body | dict

klaviyo.Tags.remove_tag_from_segments(id, body)
Method alias:
klaviyo.Tags.delete_tag_relationships_segments(id, body)
## Positional Arguments

# id | str
# body | dict

klaviyo.Tags.tag_campaigns(id, body)
Method alias:
klaviyo.Tags.create_tag_relationships_campaigns(id, body)
Method alias:
klaviyo.Tags.create_tag_relationships_campaign(id, body)
## Positional Arguments

# id | str
# body | dict

klaviyo.Tags.tag_flows(id, body)
Method alias:
klaviyo.Tags.create_tag_relationships_flows(id, body)
Method alias:
klaviyo.Tags.create_tag_relationships_flow(id, body)
## Positional Arguments

# id | str
# body | dict

klaviyo.Tags.tag_lists(id, body)
Method alias:
klaviyo.Tags.create_tag_relationships_lists(id, body)
Method alias:
klaviyo.Tags.create_tag_relationships_list(id, body)
## Positional Arguments

# id | str
# body | dict

klaviyo.Tags.tag_segments(id, body)
Method alias:
klaviyo.Tags.create_tag_relationships_segments(id, body)
Method alias:
klaviyo.Tags.create_tag_relationships_segment(id, body)
## Positional Arguments

# id | str
# body | dict

klaviyo.Tags.update_tag(id, body)
## Positional Arguments

# id | str
# body | dict

klaviyo.Tags.update_tag_group(id, body)

Templates

## Positional Arguments

# body | dict

klaviyo.Templates.clone_template(body)
Method alias:
klaviyo.Templates.create_template_clone(body)
## Positional Arguments

# body | dict

klaviyo.Templates.create_template(body)
## Positional Arguments

# body | dict

klaviyo.Templates.create_universal_content(body)
Method alias:
klaviyo.Templates.create_template_universal_content(body)
## Positional Arguments

# id | str

klaviyo.Templates.delete_template(id)
## Positional Arguments

# id | str

klaviyo.Templates.delete_universal_content(id)
Method alias:
klaviyo.Templates.delete_template_universal_content(id)
## Keyword Arguments

# fields_template_universal_content | List[str]
# filter | str
# page_cursor | str
# page_size | int
# sort | str

klaviyo.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)
Method alias:
klaviyo.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)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_template | List[str]

klaviyo.Templates.get_template(id, fields_template=fields_template)
## Keyword Arguments

# fields_template | List[str]
# filter | str
# page_cursor | str
# sort | str

klaviyo.Templates.get_templates(fields_template=fields_template, filter=filter, page_cursor=page_cursor, sort=sort)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_template_universal_content | List[str]

klaviyo.Templates.get_universal_content(id, fields_template_universal_content=fields_template_universal_content)
## Positional Arguments

# body | dict

klaviyo.Templates.render_template(body)
Method alias:
klaviyo.Templates.create_template_render(body)
## Positional Arguments

# id | str
# body | dict

klaviyo.Templates.update_template(id, body)
## Positional Arguments

# id | str
# body | dict

klaviyo.Templates.update_universal_content(id, body)
Method alias:
klaviyo.Templates.update_template_universal_content(id, body)

Tracking_Settings

## Positional Arguments

# id | str

## Keyword Arguments

# fields_tracking_setting | List[str]

klaviyo.Tracking_Settings.get_tracking_setting(id, fields_tracking_setting=fields_tracking_setting)
## Keyword Arguments

# fields_tracking_setting | List[str]
# page_cursor | str
# page_size | int

klaviyo.Tracking_Settings.get_tracking_settings(fields_tracking_setting=fields_tracking_setting, page_cursor=page_cursor, page_size=page_size)
## Positional Arguments

# id | str
# body | dict

klaviyo.Tracking_Settings.update_tracking_setting(id, body)

Webhooks

## Positional Arguments

# body | dict

klaviyo.Webhooks.create_webhook(body)
## Positional Arguments

# id | str

klaviyo.Webhooks.delete_webhook(id)
## Positional Arguments

# id | str

## Keyword Arguments

# fields_webhook | List[str]
# include | List[str]

klaviyo.Webhooks.get_webhook(id, fields_webhook=fields_webhook, include=include)
## Positional Arguments

# id | str

klaviyo.Webhooks.get_webhook_topic(id)
klaviyo.Webhooks.get_webhook_topics()
## Keyword Arguments

# fields_webhook | List[str]
# include | List[str]

klaviyo.Webhooks.get_webhooks(fields_webhook=fields_webhook, include=include)
## Positional Arguments

# id | str
# body | dict

klaviyo.Webhooks.update_webhook(id, body)

Appendix

Global Keyword Args

NOTE: These are arguments that you can apply to any endpoint call, and which are unique to the SDK

We currently support the following global keyword args:

  • _request_auth : use this to override the client-level api_key which you define upon client instantiation

Refresher on catching exceptions:

try:
    YOUR_CALL
except Exception as e:
    print(e.status)
    print(e.reason)
    print(e.body)
    print(e.headers)

Parameters & Arguments

The parameters follow the same naming conventions as the resource groups and operations.

We stick to the following convention for parameters/arguments

  1. All parameters are passed as function args.
  2. All query and path params that are tagged as required in the docs are passed as positional args.
  3. All optional query params are passed as keyword args.
  4. 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.
  5. 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).

Namespace

In 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).

  • Resource names use Title + Snake Casing, (e.g. Data_Privacy)
  • function names and parameter names use snake case (e.g. get_metrics, and profile_id)

Renamed Fields

As of the 2024-05-15 release, some models fields are named differently than they appear in API documentation. These fields are

  • datetime: renamed to datetime_
  • date: renamed to date_

This is to manage compatibility with Pydantic v2. An example of this can be seen in StaticScheduleOptions.

class StaticScheduleOptions(BaseModel):
    """
    StaticScheduleOptions
    """ # noqa: E501
    datetime_: datetime = Field(description="The time to send at", alias="datetime")

Usage

schedule_options = StaticScheduleOptions(datetime_=datetime.datetime.strptime("2024-05-19T00:00:00+00:00", "%Y-%m-%dT%H:%M:%S%z")
print(schedule_options.datetime_)