klaviyo-api 1.3.1

Klaviyo Python SDK

Klaviyo Python SDK

• SDK version: 1.3.1
• API revision: 2023-02-22

Helpful Resources

• API Reference
• API Guides
• Postman Workspace
• Interactive Guide (Jupyter Notebook)

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:

• Campaigns

• Catalogs

• Client

• Data_Privacy

• Events

• Flows

• Lists

• Metrics

• Profiles

• Segments

• Tags

• Templates

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() 

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 api_key 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

Campaigns

Create Campaign

## Positional Arguments

# body | dict

klaviyo.Campaigns.create_campaign(body)

Create Campaign Clone

## Positional Arguments

# body | dict

klaviyo.Campaigns.create_campaign_clone(body)

Assign Campaign Message Template

## Positional Arguments

# body | dict

klaviyo.Campaigns.create_campaign_message_assign_template(body)

Create Campaign Recipient Estimation Job

## Positional Arguments

# body | dict

klaviyo.Campaigns.create_campaign_recipient_estimation_job(body)

Create Campaign Send Job

## Positional Arguments

# body | dict

klaviyo.Campaigns.create_campaign_send_job(body)

Delete Campaign

## Positional Arguments

# id | str

klaviyo.Campaigns.delete_campaign(id)

Get Campaign

## Positional Arguments

# id | str

## Keyword Arguments

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

klaviyo.Campaigns.get_campaign(id, fields_campaign=fields_campaign, fields_tag=fields_tag, include=include)

Get Campaign Message

## Positional Arguments

# id | str

## Keyword Arguments

# fields_campaign_message | [str]

klaviyo.Campaigns.get_campaign_message(id, fields_campaign_message=fields_campaign_message)

Get Campaign Recipient Estimation

## Positional Arguments

# id | str

## Keyword Arguments

# fields_campaign_recipient_estimation | [str]

klaviyo.Campaigns.get_campaign_recipient_estimation(id, fields_campaign_recipient_estimation=fields_campaign_recipient_estimation)

Get Campaign Recipient Estimation Job

## Positional Arguments

# id | str

## Keyword Arguments

# fields_campaign_recipient_estimation_job | [str]

klaviyo.Campaigns.get_campaign_recipient_estimation_job(id, fields_campaign_recipient_estimation_job=fields_campaign_recipient_estimation_job)

Get Campaign Relationships

## Positional Arguments

# id | str
# related_resource | str

klaviyo.Campaigns.get_campaign_relationships(id, related_resource)

Get Campaign Send Job

## Positional Arguments

# id | str

## Keyword Arguments

# fields_campaign_send_job | [str]

klaviyo.Campaigns.get_campaign_send_job(id, fields_campaign_send_job=fields_campaign_send_job)

Get Campaign Tags

## Positional Arguments

# campaign_id | str

## Keyword Arguments

# fields_tag | [str]

klaviyo.Campaigns.get_campaign_tags(campaign_id, fields_tag=fields_tag)

Get Campaigns

## Keyword Arguments

# fields_campaign | [str]
# fields_tag | [str]
# filter | str
# include | [str]
# page_cursor | str
# sort | str

klaviyo.Campaigns.get_campaigns(fields_campaign=fields_campaign, fields_tag=fields_tag, filter=filter, include=include, page_cursor=page_cursor, sort=sort)

Update Campaign

## Positional Arguments

# id | str
# body | dict

klaviyo.Campaigns.update_campaign(id, body)

Update Campaign Message

## Positional Arguments

# id | str
# body | dict

klaviyo.Campaigns.update_campaign_message(id, body)

Update Campaign Send Job

## Positional Arguments

# id | str
# body | dict

klaviyo.Campaigns.update_campaign_send_job(id, body)

Catalogs

Create Catalog Category

## Positional Arguments

# body | dict

klaviyo.Catalogs.create_catalog_category(body)

Create Catalog Category Relationships

## Positional Arguments

# id | str
# related_resource | str
# body | dict

klaviyo.Catalogs.create_catalog_category_relationships(id, related_resource, body)

Create Catalog Item

## Positional Arguments

# body | dict

klaviyo.Catalogs.create_catalog_item(body)

Create Catalog Item Relationships

## Positional Arguments

# id | str
# related_resource | str
# body | dict

klaviyo.Catalogs.create_catalog_item_relationships(id, related_resource, body)

Create Catalog Variant

## Positional Arguments

# body | dict

klaviyo.Catalogs.create_catalog_variant(body)

Delete Catalog Category

## Positional Arguments

# id | str

klaviyo.Catalogs.delete_catalog_category(id)

Delete Catalog Category Relationships

## Positional Arguments

# id | str
# related_resource | str
# body | dict

klaviyo.Catalogs.delete_catalog_category_relationships(id, related_resource, body)

Delete Catalog Item

## Positional Arguments

# id | str

klaviyo.Catalogs.delete_catalog_item(id)

Delete Catalog Item Relationships

## Positional Arguments

# id | str
# related_resource | str
# body | dict

klaviyo.Catalogs.delete_catalog_item_relationships(id, related_resource, body)

Delete Catalog Variant

## Positional Arguments

# id | str

klaviyo.Catalogs.delete_catalog_variant(id)

Get Catalog Categories

## Keyword Arguments

# fields_catalog_category | [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)

Get Catalog Category

## Positional Arguments

# id | str

## Keyword Arguments

# fields_catalog_category | [str]

klaviyo.Catalogs.get_catalog_category(id, fields_catalog_category=fields_catalog_category)

Get Catalog Category Items

## Positional Arguments

# category_id | str

## Keyword Arguments

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

klaviyo.Catalogs.get_catalog_category_items(category_id, fields_catalog_item=fields_catalog_item, fields_catalog_variant=fields_catalog_variant, filter=filter, include=include, page_cursor=page_cursor, sort=sort)

Get Catalog Category Relationships

## Positional Arguments

# id | str
# related_resource | str

## Keyword Arguments

# page_cursor | str

klaviyo.Catalogs.get_catalog_category_relationships(id, related_resource, page_cursor=page_cursor)

Get Catalog Item

## Positional Arguments

# id | str

## Keyword Arguments

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

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

Get Catalog Item Categories

## Positional Arguments

# item_id | str

## Keyword Arguments

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

klaviyo.Catalogs.get_catalog_item_categories(item_id, fields_catalog_category=fields_catalog_category, filter=filter, page_cursor=page_cursor, sort=sort)

Get Catalog Item Relationships

## Positional Arguments

# id | str
# related_resource | str

## Keyword Arguments

# page_cursor | str

klaviyo.Catalogs.get_catalog_item_relationships(id, related_resource, page_cursor=page_cursor)

Get Catalog Item Variants

## Positional Arguments

# item_id | str

## Keyword Arguments

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

klaviyo.Catalogs.get_catalog_item_variants(item_id, fields_catalog_variant=fields_catalog_variant, filter=filter, page_cursor=page_cursor, sort=sort)

Get Catalog Items

## Keyword Arguments

# fields_catalog_item | [str]
# fields_catalog_variant | [str]
# filter | str
# include | [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)

Get Catalog Variant

## Positional Arguments

# id | str

## Keyword Arguments

# fields_catalog_variant | [str]

klaviyo.Catalogs.get_catalog_variant(id, fields_catalog_variant=fields_catalog_variant)

Get Catalog Variants

## Keyword Arguments

# fields_catalog_variant | [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)

Get Create Categories Job

## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_catalog_category_bulk_create_job | [str]
# fields_catalog_category | [str]
# include | [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)

Get Create Categories Jobs

## Keyword Arguments

# fields_catalog_category_bulk_create_job | [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)

Get Create Items Job

## Positional Arguments

# job_id | str

## Keyword Arguments

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

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)

Get Create Items Jobs

## Keyword Arguments

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

klaviyo.Catalogs.get_create_items_jobs(fields_catalog_item_bulk_create_job=fields_catalog_item_bulk_create_job, filter=filter, page_cursor=page_cursor)

Get Create Variants Job

## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_catalog_variant_bulk_create_job | [str]
# fields_catalog_variant | [str]
# include | [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)

Get Create Variants Jobs

## Keyword Arguments

# fields_catalog_variant_bulk_create_job | [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)

Get Delete Categories Job

## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_catalog_category_bulk_delete_job | [str]

klaviyo.Catalogs.get_delete_categories_job(job_id, fields_catalog_category_bulk_delete_job=fields_catalog_category_bulk_delete_job)

Get Delete Categories Jobs

## Keyword Arguments

# fields_catalog_category_bulk_delete_job | [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)

Get Delete Items Job

## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_catalog_item_bulk_delete_job | [str]

klaviyo.Catalogs.get_delete_items_job(job_id, fields_catalog_item_bulk_delete_job=fields_catalog_item_bulk_delete_job)

Get Delete Items Jobs

## Keyword Arguments

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

klaviyo.Catalogs.get_delete_items_jobs(fields_catalog_item_bulk_delete_job=fields_catalog_item_bulk_delete_job, filter=filter, page_cursor=page_cursor)

Get Delete Variants Job

## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_catalog_variant_bulk_delete_job | [str]

klaviyo.Catalogs.get_delete_variants_job(job_id, fields_catalog_variant_bulk_delete_job=fields_catalog_variant_bulk_delete_job)

Get Delete Variants Jobs

## Keyword Arguments

# fields_catalog_variant_bulk_delete_job | [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)

Get Update Categories Job

## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_catalog_category_bulk_update_job | [str]
# fields_catalog_category | [str]
# include | [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)

Get Update Categories Jobs

## Keyword Arguments

# fields_catalog_category_bulk_update_job | [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)

Get Update Items Job

## Positional Arguments

# job_id | str

## Keyword Arguments

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

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)

Get Update Items Jobs

## Keyword Arguments

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

klaviyo.Catalogs.get_update_items_jobs(fields_catalog_item_bulk_update_job=fields_catalog_item_bulk_update_job, filter=filter, page_cursor=page_cursor)

Get Update Variants Job

## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_catalog_variant_bulk_update_job | [str]
# fields_catalog_variant | [str]
# include | [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)

Get Update Variants Jobs

## Keyword Arguments

# fields_catalog_variant_bulk_update_job | [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)

Spawn Create Categories Job

## Positional Arguments

# body | dict

klaviyo.Catalogs.spawn_create_categories_job(body)

Spawn Create Items Job

## Positional Arguments

# body | dict

klaviyo.Catalogs.spawn_create_items_job(body)

Spawn Create Variants Job

## Positional Arguments

# body | dict

klaviyo.Catalogs.spawn_create_variants_job(body)

Spawn Delete Categories Job

## Positional Arguments

# body | dict

klaviyo.Catalogs.spawn_delete_categories_job(body)

Spawn Delete Items Job

## Positional Arguments

# body | dict

klaviyo.Catalogs.spawn_delete_items_job(body)

Spawn Delete Variants Job

## Positional Arguments

# body | dict

klaviyo.Catalogs.spawn_delete_variants_job(body)

Spawn Update Categories Job

## Positional Arguments

# body | dict

klaviyo.Catalogs.spawn_update_categories_job(body)

Spawn Update Items Job

## Positional Arguments

# body | dict

klaviyo.Catalogs.spawn_update_items_job(body)

Spawn Update Variants Job

## Positional Arguments

# body | dict

klaviyo.Catalogs.spawn_update_variants_job(body)

Update Catalog Category

## Positional Arguments

# id | str
# body | dict

klaviyo.Catalogs.update_catalog_category(id, body)

Update Catalog Category Relationships

## Positional Arguments

# id | str
# related_resource | str
# body | dict

klaviyo.Catalogs.update_catalog_category_relationships(id, related_resource, body)

Update Catalog Item

## Positional Arguments

# id | str
# body | dict

klaviyo.Catalogs.update_catalog_item(id, body)

Update Catalog Item Relationships

## Positional Arguments

# id | str
# related_resource | str
# body | dict

klaviyo.Catalogs.update_catalog_item_relationships(id, related_resource, body)

Update Catalog Variant

## Positional Arguments

# id | str
# body | dict

klaviyo.Catalogs.update_catalog_variant(id, body)

Client

Create Client Event

## Positional Arguments

# company_id | str
# body | dict

klaviyo.Client.create_client_event(company_id, body)

Create or Update Client Profile

## Positional Arguments

# company_id | str
# body | dict

klaviyo.Client.create_client_profile(company_id, body)

Create Client Subscription

## Positional Arguments

# company_id | str
# body | dict

klaviyo.Client.create_client_subscription(company_id, body)

Data_Privacy

Request Profile Deletion

## Positional Arguments

# body | dict

klaviyo.Data_Privacy.request_profile_deletion(body)

Events

Create Event

## Positional Arguments

# body | dict

klaviyo.Events.create_event(body)

Get Event

## Positional Arguments

# id | str

## Keyword Arguments

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

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

Get Event Metrics

## Positional Arguments

# id | str

## Keyword Arguments

# fields_metric | [str]

klaviyo.Events.get_event_metrics(id, fields_metric=fields_metric)

Get Event Profiles

## Positional Arguments

# id | str

## Keyword Arguments

# fields_profile | [str]

klaviyo.Events.get_event_profiles(id, fields_profile=fields_profile)

Get Event Relationships

## Positional Arguments

# id | str
# related_resource | str

klaviyo.Events.get_event_relationships(id, related_resource)

Get Events

## Keyword Arguments

# fields_event | [str]
# fields_metric | [str]
# fields_profile | [str]
# filter | str
# include | [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)

Flows

Get Flow

## Positional Arguments

# id | str

## Keyword Arguments

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

klaviyo.Flows.get_flow(id, fields_flow_action=fields_flow_action, fields_flow=fields_flow, include=include)

Get Flow Action

## Positional Arguments

# id | str

## Keyword Arguments

# fields_flow_action | [str]
# fields_flow_message | [str]
# fields_flow | [str]
# include | [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)

Get Flow For Flow Action

## Positional Arguments

# action_id | str

## Keyword Arguments

# fields_flow | [str]

klaviyo.Flows.get_flow_action_flow(action_id, fields_flow=fields_flow)

Get Messages For Flow Action

## Positional Arguments

# action_id | str

## Keyword Arguments

# fields_flow_message | [str]
# filter | str
# page_cursor | str
# sort | str

klaviyo.Flows.get_flow_action_messages(action_id, fields_flow_message=fields_flow_message, filter=filter, page_cursor=page_cursor, sort=sort)

Get Flow Action Relationships

## Positional Arguments

# id | str
# related_resource | str

## Keyword Arguments

# filter | str
# page_cursor | str
# sort | str

klaviyo.Flows.get_flow_action_relationships(id, related_resource, filter=filter, page_cursor=page_cursor, sort=sort)

Get Flow Actions For Flow

## Positional Arguments

# flow_id | str

## Keyword Arguments

# fields_flow_action | [str]
# filter | str
# page_cursor | str
# sort | str

klaviyo.Flows.get_flow_flow_actions(flow_id, fields_flow_action=fields_flow_action, filter=filter, page_cursor=page_cursor, sort=sort)

Get Flow Message

## Positional Arguments

# id | str

## Keyword Arguments

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

klaviyo.Flows.get_flow_message(id, fields_flow_action=fields_flow_action, fields_flow_message=fields_flow_message, include=include)

Get Flow Action For Message

## Positional Arguments

# message_id | str

## Keyword Arguments

# fields_flow_action | [str]

klaviyo.Flows.get_flow_message_action(message_id, fields_flow_action=fields_flow_action)

Get Flow Message Relationships

## Positional Arguments

# id | str
# related_resource | str

klaviyo.Flows.get_flow_message_relationships(id, related_resource)

Get Flow Relationships

## Positional Arguments

# id | str
# related_resource | str

klaviyo.Flows.get_flow_relationships(id, related_resource)

Get Flow Tags

## Positional Arguments

# flow_id | str

## Keyword Arguments

# fields_tag | [str]

klaviyo.Flows.get_flow_tags(flow_id, fields_tag=fields_tag)

Get Flows

## Keyword Arguments

# fields_flow_action | [str]
# fields_flow | [str]
# filter | str
# include | [str]
# page_cursor | str
# sort | str

klaviyo.Flows.get_flows(fields_flow_action=fields_flow_action, fields_flow=fields_flow, filter=filter, include=include, page_cursor=page_cursor, sort=sort)

Update Flow Status

## Positional Arguments

# id | str
# body | dict

klaviyo.Flows.update_flow(id, body)

Lists

Create List

## Positional Arguments

# body | dict

klaviyo.Lists.create_list(body)

Add Profile to List

## Positional Arguments

# id | str
# related_resource | str
# body | dict

klaviyo.Lists.create_list_relationships(id, related_resource, body)

Delete List

## Positional Arguments

# id | str

klaviyo.Lists.delete_list(id)

Remove Profile from List

## Positional Arguments

# id | str
# related_resource | str
# body | dict

klaviyo.Lists.delete_list_relationships(id, related_resource, body)

Get List

## Positional Arguments

# id | str

## Keyword Arguments

# fields_list | [str]

klaviyo.Lists.get_list(id, fields_list=fields_list)

Get List Profiles

## Positional Arguments

# list_id | str

## Keyword Arguments

# fields_profile | [str]
# filter | str
# page_cursor | str
# page_size | int

klaviyo.Lists.get_list_profiles(list_id, fields_profile=fields_profile, filter=filter, page_cursor=page_cursor, page_size=page_size)

Get List Relationships

## Positional Arguments

# id | str
# related_resource | str

## Keyword Arguments

# page_cursor | str

klaviyo.Lists.get_list_relationships(id, related_resource, page_cursor=page_cursor)

Get List Tags

## Positional Arguments

# list_id | str

## Keyword Arguments

# fields_tag | [str]

klaviyo.Lists.get_list_tags(list_id, fields_tag=fields_tag)

Get Lists

## Keyword Arguments

# fields_list | [str]
# filter | str
# page_cursor | str

klaviyo.Lists.get_lists(fields_list=fields_list, filter=filter, page_cursor=page_cursor)

Update List

## Positional Arguments

# id | str
# body | dict

klaviyo.Lists.update_list(id, body)

Metrics

Get Metric

## Positional Arguments

# id | str

## Keyword Arguments

# fields_metric | [str]

klaviyo.Metrics.get_metric(id, fields_metric=fields_metric)

Get Metrics

## Keyword Arguments

# fields_metric | [str]
# filter | str
# page_cursor | str

klaviyo.Metrics.get_metrics(fields_metric=fields_metric, filter=filter, page_cursor=page_cursor)

Query Metric Aggregates

## Positional Arguments

# body | dict

klaviyo.Metrics.query_metric_aggregates(body)

Profiles

Create Profile

## Positional Arguments

# body | dict

klaviyo.Profiles.create_profile(body)

Get Profile

## Positional Arguments

# id | str

## Keyword Arguments

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

klaviyo.Profiles.get_profile(id, fields_list=fields_list, fields_profile=fields_profile, fields_segment=fields_segment, include=include)

Get Profile Lists

## Positional Arguments

# profile_id | str

## Keyword Arguments

# fields_list | [str]

klaviyo.Profiles.get_profile_lists(profile_id, fields_list=fields_list)

Get Profile Relationships

## Positional Arguments

# id | str
# related_resource | str

klaviyo.Profiles.get_profile_relationships(id, related_resource)

Get Profile Segments

## Positional Arguments

# profile_id | str

## Keyword Arguments

# fields_segment | [str]

klaviyo.Profiles.get_profile_segments(profile_id, fields_segment=fields_segment)

Get Profiles

## Keyword Arguments

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

klaviyo.Profiles.get_profiles(fields_profile=fields_profile, filter=filter, page_cursor=page_cursor, sort=sort, page_size=page_size)

Subscribe Profiles

## Positional Arguments

# body | dict

klaviyo.Profiles.subscribe_profiles(body)

Suppress Profiles

## Positional Arguments

# body | dict

klaviyo.Profiles.suppress_profiles(body)

Unsubscribe Profiles

## Positional Arguments

# body | dict

klaviyo.Profiles.unsubscribe_profiles(body)

Unsuppress Profiles

## Positional Arguments

# body | dict

klaviyo.Profiles.unsuppress_profiles(body)

Update Profile

## Positional Arguments

# id | str
# body | dict

klaviyo.Profiles.update_profile(id, body)

Segments

Get Segment

## Positional Arguments

# id | str

## Keyword Arguments

# fields_segment | [str]

klaviyo.Segments.get_segment(id, fields_segment=fields_segment)

Get Segment Profiles

## Positional Arguments

# segment_id | str

## Keyword Arguments

# fields_profile | [str]
# filter | str
# page_cursor | str
# page_size | int

klaviyo.Segments.get_segment_profiles(segment_id, fields_profile=fields_profile, filter=filter, page_cursor=page_cursor, page_size=page_size)

Get Segment Relationships

## Positional Arguments

# id | str
# related_resource | str

## Keyword Arguments

# page_cursor | str

klaviyo.Segments.get_segment_relationships(id, related_resource, page_cursor=page_cursor)

Get Segment Tags

## Positional Arguments

# segment_id | str

## Keyword Arguments

# fields_tag | [str]

klaviyo.Segments.get_segment_tags(segment_id, fields_tag=fields_tag)

Get Segments

## Keyword Arguments

# fields_segment | [str]
# filter | str
# page_cursor | str

klaviyo.Segments.get_segments(fields_segment=fields_segment, filter=filter, page_cursor=page_cursor)

Update Segment

## Positional Arguments

# id | str
# body | dict

klaviyo.Segments.update_segment(id, body)

Tags

Create Tag

## Positional Arguments

# body | dict

klaviyo.Tags.create_tag(body)

Create Tag Group

## Positional Arguments

# body | dict

klaviyo.Tags.create_tag_group(body)

Create Tag Relationships

## Positional Arguments

# id | str
# related_resource | str
# body | dict

klaviyo.Tags.create_tag_relationships(id, related_resource, body)

Delete Tag

## Positional Arguments

# id | str

klaviyo.Tags.delete_tag(id)

Delete Tag Group

## Positional Arguments

# id | str

klaviyo.Tags.delete_tag_group(id)

Delete Tag Relationships

## Positional Arguments

# id | str
# related_resource | str
# body | dict

klaviyo.Tags.delete_tag_relationships(id, related_resource, body)

Get Tag

## Positional Arguments

# id | str

## Keyword Arguments

# fields_tag | [str]

klaviyo.Tags.get_tag(id, fields_tag=fields_tag)

Get Tag Group

## Positional Arguments

# id | str

## Keyword Arguments

# fields_tag_group | [str]

klaviyo.Tags.get_tag_group(id, fields_tag_group=fields_tag_group)

Get Tag Group Relationships

## Positional Arguments

# id | str
# related_resource | str

klaviyo.Tags.get_tag_group_relationships(id, related_resource)

Get Tag Group Tags

## Positional Arguments

# id | str

## Keyword Arguments

# fields_tag | [str]

klaviyo.Tags.get_tag_group_tags(id, fields_tag=fields_tag)

Get Tag Groups

## Keyword Arguments

# fields_tag_group | [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)

Get Tag Relationships

## Positional Arguments

# id | str
# related_resource | str

klaviyo.Tags.get_tag_relationships(id, related_resource)

Get Tag Tag Group

## Positional Arguments

# id | str

## Keyword Arguments

# fields_tag_group | [str]

klaviyo.Tags.get_tag_tag_group(id, fields_tag_group=fields_tag_group)

Get Tags

## Keyword Arguments

# fields_tag | [str]
# filter | str
# page_cursor | str
# sort | str

klaviyo.Tags.get_tags(fields_tag=fields_tag, filter=filter, page_cursor=page_cursor, sort=sort)

Update Tag

## Positional Arguments

# id | str
# body | dict

klaviyo.Tags.update_tag(id, body)

Update Tag Group

## Positional Arguments

# id | str
# body | dict

klaviyo.Tags.update_tag_group(id, body)

Templates

Create Template

## Positional Arguments

# body | dict

klaviyo.Templates.create_template(body)

Create Template Clone

## Positional Arguments

# body | dict

klaviyo.Templates.create_template_clone(body)

Create Template Render

## Positional Arguments

# body | dict

klaviyo.Templates.create_template_render(body)

Delete Template

## Positional Arguments

# id | str

klaviyo.Templates.delete_template(id)

Get Template

## Positional Arguments

# id | str

## Keyword Arguments

# fields_template | [str]

klaviyo.Templates.get_template(id, fields_template=fields_template)

Get Templates

## Keyword Arguments

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

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

Update Template

## Positional Arguments

# id | str
# body | dict

klaviyo.Templates.update_template(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:

• api_key : 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 api_key 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)