klaviyo-api-ruby

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

klaviyo-api-ruby

(★ 33)

Ruby SDK for Klaviyo API

klaviyo-api-ruby Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Klaviyo Ruby SDK

- SDK version: 18.0.0
- API revision: 2026-07-15

## Helpful Resources

- [API Reference](https://developers.klaviyo.com/en/v2026-07-15/reference)
- [API Guides](https://developers.klaviyo.com/en/v2026-07-15/docs)
- [Postman Workspace](https://www.postman.com/klaviyo/workspace/klaviyo-developers)

## Design & Approach

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

## Organization

This SDK is organized into the following resources:

- Accounts

- Campaigns

- Catalogs

- Client

- Conversations

- Coupons

- Custom Objects

- Data Privacy

- Events

- Flows

- Forms

- Images

- Lists

- Metrics

- Profiles

- Reporting

- Reviews

- Segments

- Tags

- Templates

- Tracking Settings

- Web Feeds

- Webhooks

## Installation

### Build

To build the Ruby code into a gem:

```shell
gem build klaviyo-api-sdk.gemspec
```

Then install the gem locally:

```shell
gem install ./klaviyo-api-sdk-18.0.0.gem
```

Finally add this to the Gemfile:

gem 'klaviyo-api-sdk', '~> 18.0.0'

To install directly from rubygems:

```shell
gem install klaviyo-api-sdk
```

### For macOS developers

To avoid compatability issues between macOS and the underlying HTTP client library (Typhoeus), add the following to your local bash file:

```
export OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES
```

As the issue only affects macOS, it should not affect your production environment. Check [this thread](https://github.com/rails/rails/issues/38560) for more information.

## Usage Example

### To load the gem

```ruby
# Load the gem
require 'klaviyo-api-sdk'

# Setup authorization
KlaviyoAPI.configure do |config|
  config.api_key['Klaviyo-API-Key'] = 'Klaviyo-API-Key your-api-key'
  #config.max_retries = 5 # optional
  #config.max_delay = 60 # optional
end
```

NOTE: 
* The SDK retries on resolvable errors, namely: rate limits (common) and server errors on klaviyo (rare).
* `max_retries` denotes the number of attempts the client will make in order to execute the request successfully.
  * Set to 0 to disable automatic retries
* `max_delay` denotes the maximum amount of time (in seconds) that will be spent retrying a request across all attempts.
* The time interval between retries is calculated using exponential backoff and the `Retry-After` header.

### To call the `get_catalog_items` operation:

```ruby
opts = {
  include: ['variants'],
  sort: 'created',
  filter: 'equals(published,false)',
  fields_catalog_item: ['external_id','title']
}

begin
  result = KlaviyoAPI::Catalogs.get_catalog_items(opts)
end
```

## OAuth Authentication

To use OAuth Authentication, pass an access token instead of an API key:

```ruby
KlaviyoAPI.configure do |config|
  config.access_token = 'your-oauth-access-token'
end
```

See our [guide](https://developers.klaviyo.com/en/docs/set_up_oauth) for an overview on setting up an OAuth integration.

## Error Handling

This SDK throws an `ApiException` error when the server returns a non-`2XX` response. 
```ruby
begin
  result = KlaviyoAPI::Catalogs.get_catalog_items(opts)
rescue KlaviyoAPI::ApiError => e
  puts "Error when calling get_catalog_items #{e}"
end
```

## Method signatures
- `get` operations can be passed an optional `opts` object (e.g. `get_list_profiles(opts)`).
`opts` describes the available options for fetching data (some operations only support a subset of these or none).
i.e.
```ruby
opts = {
  include: ['variants'], # includes
  sort: '-created', # sorting
  filter: 'equals(published,false)', # filters
  page_cursor: 'page_cursor_example', # cursor pagination
  fields_catalog_item: ['external_id','title'], # sparse fieldset
  fields_catalog_variant: ['external_id','title'], # sparse fieldset
  additional_fields_profile: ['predictive_analytics'], # for endpoints that support predictive analytics such as `get_profile`
}
```
For `GET` methods that require a filter, Pass the filter perameter as a query paraemeter not inside the `opts` object

```
    KlaviyoAPI::Campaigns.get_campaigns("equals(messages.channel,'email')")
   ```

**Note, for parameters that use square brackets such as `page[cursor]` or `fields[catalog-item]` ruby will replace the square brackets `[]` with `_` underscores.

- For `create`, `update` & some `delete` operations (i.e. `create_catalog_item` or `update_catalog_item` or `delete_catalog_category_relationships`)
the `body` object is required in the method signature (i.e. `create_catalog_item(body)`).
```ruby
body = {
  data: {
    type: "catalog-item",
    attributes: {
      external_id: "catalog-item-test",
      title: "Catalog Item Test",
      description: "this is a description",
      url: "http://catalog-item.klaviyo.com",
      published: true
    }
  }
}
KlaviyoAPI::Catalogs.create_catalog_item(body)
```

For uploading a file using the `Images.upload_image_from_file` simply pass in an opened file
```ruby
result = KlaviyoAPI::Images.upload_image_from_file(File.open('test_file.jpg', 'r'))
```

## Optional Parameters and Json Api Features

Here we will go over

- Pagination
- Page size
- Additional Fields
- Filtering
- Sparse Fields
- Sorting
- Relationships

### Quick rule

As a reminder, the optional parameters are named slightly different from how you would make the call without the SDK docs, query parameter names have variables that make bad Ruby names like
`page[cursor]` are transformed to `page_cursor`.

### Cursor based Pagination

All the endpoints that return list of results use cursor base pagination.

Obtain the cursor value from the call you want to get the next page for, then pass it under the `page_cursor` optional parameter. The page cursor looks like `WzE2NDA5OTUyMDAsICIzYzRjeXdGTndadyIsIHRydWVd`.

If you were using the api directly you would pass the cursor like:

```
https://a.klaviyo.com/api/profiles/?page[cursor]=WzE2NTcyMTM4NjQsICIzc042NjRyeHo0ciIsIHRydWVd
```

The same call in the sdk the call would look like this:

```ruby
opts = {
  page_cursor: 'WzE2NTcyMTM4NjQsICIzc042NjRyeHo0ciIsIHRydWVd',
}

response = KlaviyoAPI::Profiles.get_profiles(opts)
```

You get the cursor for the next page from `response[:links][:next]` returns the entire url of the next call but the sdk will accept the entire link and use only the relevant cursor.

Here is an example of getting the second next and passing in the page cursor:

```ruby
opts = {
  page_cursor: response[:links][:next], # previous response
}

response = KlaviyoAPI::Profiles.get_profiles(opts)
```

There are more page cursors than just next, check the endpoint's docs or the response type but often there is `first`, `last`, `next` and `prev`.

### Page Size
Some endpoint you can get a larger or smaller page size by using the `page_size` parameter.

if you were hitting the api directly this would look like

```
https://a.klaviyo.com/api/profiles/?page[size]=20
```

In the SDK this looks like:

```ruby
opts = {
  page_size: 20,
}

response = KlaviyoAPI::Profiles.get_profiles(opts)
```

### Additional Fields

Additional fields are used to populate part of the response that would be null otherwise.
For the `getProfile` endpoint you can pass in a request to get the predictive analytics of the profile. Using the `additional_fields` parameter often will change the rate limit of the endpoint so be sure to keep an eye on your usage.

The url would look like:
```
https://a.klaviyo.com/api/profiles/01GDDKASAP8TKDDA2GRZDSVP4H/?additional-fields[profile]=predictive_analytics
```

The SDK equivalent is:

```ruby
profile_id = '01GDDKASAP8TKDDA2GRZDSVP4H'
opts = {
  additional_fields_profile: ["predictive_analytics"]
}

response = KlaviyoAPI::Profiles.get_profile(profile_id, opts)

# If your profile has enough information for predictive analytis it will populate
pp(response[:data][:attributes][:predictive_analytics])
```

### Filtering

Filter by passing the filter as a string as under the optional parameter `filter`.

Read more about formatting your filter strings in our [developer documentation](https://developers.klaviyo.com/en/v2023-02-22/docs/filtering_)

Here is an example of a filter string for results between two date times: `less-than(updated,2023-04-26T00:00:00Z),greater-than(updated,2023-04-19T00:00:00Z)`

Here is a code example filter for profiles with the matching emails:

```
https://a.klaviyo.com/api/profiles/?filter=any(email,["henry.chan@klaviyo-demo.com","amanda.das@klaviyo-demo.com"]
```
For the sdk:
```ruby
opts = {
  filter: 'any(email,["henry.chan@klaviyo-demo.com","amanda.das@klaviyo-demo.com"])'
}

response = KlaviyoAPI::Profiles.get_profiles(opts)
```

### Sparse Fields

If you only want a specific subset of data from a specific query you can use sparse fields to request only the specific properties.
The SDK expands the optional sparse fields into their own option, where you can pass a list of the desired items to include.

To get a list of event properties the URL your would use is:
```
https://a.klaviyo.com/api/events/?fields[event]=event_properties
```

In the SDK you would use

```ruby
opts = {
  fields_event: ["event_properties"]
}

response = KlaviyoAPI::Events.get_events(opts)
```

### Sorting

Your can request the results of specific endpoints to be ordered by a given parameter. The direction of the sort can swapped by adding a `-` in front of the sort key.
For example `datetime` will be ascending while `-datetime` will be descending.

If you are unsure about the available sort fields you can always check the documentation for the endpoint you are using.
For a comprehensive list that links to the documentation for each function check the Endpoints section below.

Get events sorted by oldest to newest datetime.
```
https://a.klaviyo.com/api/events/?sort=-datetime
```
and via the sdk

```ruby
opts = {
  sort: '-datetime'
}

response = KlaviyoAPI::Events.get_events(opts)
```

### Includes

How to add additional information to your API response via additional-fields and the `includes` parameter.
This allows you to get information about two or more objects from a single api call.
Using the `includes` parameter often changes the rate limit of the endpoint so be sure to take note.

Using the URl to get profile information and the information about the lists the profile is in:

```
https://a.klaviyo.com/api/profiles/01GDDKASAP8TKDDA2GRZDSVP4H/?include=lists
```

In the sdk:

```ruby
profile_id = '01GDDKASAP8TKDDA2GRZDSVP4H'
opts = {
  include: ["lists"]
}

response = KlaviyoAPI::Profiles.get_profile(profile_id,opts)

# Profile information is accessed the same way with
pp(response[:data])
# Lists related to the profile with be accessible via the included array
pp(response[:included])
```

*Note about sparse fields and relationships:* you can request only specific fields of the included object as well.

```ruby
profile_id = '01GDDKASAP8TKDDA2GRZDSVP4H'
opts = {
  fields_list: ["name"],
  include: ["lists"]
}

response = KlaviyoAPI::Profiles.get_profile(profile_id,opts)

# Profile information is accessed the same way with
pp(response[:data])
# Lists related to the profile with be accessible via the included array
pp(response[:included])
```

### Relationships

The Klaviyo Api has a series of endpoints to expose the relationships between your different Klaviyo Items. You can read more about relationships in [our documentation](https://developers.klaviyo.com/en/v2023-02-22/docs/relationships_).

Here are some use cases and their examples:

How to get the list memberships for a profile with the given profile ID.

Via the URL:

```
https://a.klaviyo.com/api/profiles/01GDDKASAP8TKDDA2GRZDSVP4H/relationships/lists/
```

and for the SDK:

```ruby
profile_id = '01GDDKASAP8TKDDA2GRZDSVP4H'

response = KlaviyoAPI::Profiles.get_profile_relationships_lists(profile_id)
```

For another example:

Get all campaigns associated with the given `tag_id`.

the URL:

```
https://a.klaviyo.com/api/tags/9c8db7a0-5ab5-4e3c-9a37-a3224fd14382/relationships/campaigns/
```

Through the SDK:

```ruby
tag_id = '9c8db7a0-5ab5-4e3c-9a37-a3224fd14382'

response = KlaviyoAPI::Tags.get_tag_relationships_campaigns(tag_id)
```
### Combining

You can use any combination of the features outlines above in conjunction with one another.

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

```
https://a.klaviyo.com/api/events/?fields[event]=event_properties&filter=equals(metric_id,"URDbLg")&sort=-datetime
```
or
```ruby
opts = {
  filter: 'equals(metric_id,"URDbLg")',
  fields_event: ["event_properties"]
}

response = KlaviyoAPI::Events.get_events(opts)
```

## Comprehensive list of Operations & Parameters

_**NOTE:**_
- Organization: Resource groups and operation_ids are listed in alphabetical order, first by Resource name, then by **OpenAPI Summary**. Operation summaries are those listed in the right side bar of the [API Reference](https://developers.klaviyo.com/en/v2026-07-15/reference/get_events).
- For example values / data types, as well as whether parameters are required/optional, please reference the corresponding API Reference link.
- Some args are required for the API call to succeed, the API docs above are the source of truth regarding which params are required.

## Accounts

#### [Get Account](https://developers.klaviyo.com/en/v2026-07-15/reference/get_account)

```ruby
KlaviyoAPI::Accounts.get_account(id, opts)
```

#### [Get Accounts](https://developers.klaviyo.com/en/v2026-07-15/reference/get_accounts)

```ruby
KlaviyoAPI::Accounts.get_accounts(opts)
```

## Campaigns

#### [Assign Template to Campaign Message](https://developers.klaviyo.com/en/v2026-07-15/reference/assign_template_to_campaign_message)

```ruby
KlaviyoAPI::Campaigns.assign_template_to_campaign_message(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Campaigns.create_campaign_message_assign_template(body, opts)
```

#### [Cancel Campaign Send](https://developers.klaviyo.com/en/v2026-07-15/reference/cancel_campaign_send)

```ruby
KlaviyoAPI::Campaigns.cancel_campaign_send(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Campaigns.update_campaign_send_job(id, body)
```

#### [Create Campaign](https://developers.klaviyo.com/en/v2026-07-15/reference/create_campaign)

```ruby
KlaviyoAPI::Campaigns.create_campaign(body, opts)
```

#### [Create Campaign Clone](https://developers.klaviyo.com/en/v2026-07-15/reference/create_campaign_clone)

```ruby
KlaviyoAPI::Campaigns.create_campaign_clone(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Campaigns.clone_campaign(body, opts)
```

#### [Delete Campaign](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_campaign)

```ruby
KlaviyoAPI::Campaigns.delete_campaign(id)
```

#### [Get Campaign](https://developers.klaviyo.com/en/v2026-07-15/reference/get_campaign)

```ruby
KlaviyoAPI::Campaigns.get_campaign(id, opts)
```

#### [Get Campaign for Campaign Message](https://developers.klaviyo.com/en/v2026-07-15/reference/get_campaign_for_campaign_message)

```ruby
KlaviyoAPI::Campaigns.get_campaign_for_campaign_message(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Campaigns.get_campaign_message_campaign(id, opts)
```

#### [Get Campaign ID for Campaign Message](https://developers.klaviyo.com/en/v2026-07-15/reference/get_campaign_id_for_campaign_message)

```ruby
KlaviyoAPI::Campaigns.get_campaign_id_for_campaign_message(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Campaigns.get_campaign_message_relationships_campaign(id)
```

#### [Get Campaign Message](https://developers.klaviyo.com/en/v2026-07-15/reference/get_campaign_message)

```ruby
KlaviyoAPI::Campaigns.get_campaign_message(id, opts)
```

#### [Get Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2026-07-15/reference/get_campaign_recipient_estimation)

```ruby
KlaviyoAPI::Campaigns.get_campaign_recipient_estimation(id, opts)
```

#### [Get Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_campaign_recipient_estimation_job)

```ruby
KlaviyoAPI::Campaigns.get_campaign_recipient_estimation_job(id, opts)
```

#### [Get Campaign Send Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_campaign_send_job)

```ruby
KlaviyoAPI::Campaigns.get_campaign_send_job(id, opts)
```

#### [Get Campaigns](https://developers.klaviyo.com/en/v2026-07-15/reference/get_campaigns)

```ruby
KlaviyoAPI::Campaigns.get_campaigns(filter, opts)
```

#### [Get Image for Campaign Message](https://developers.klaviyo.com/en/v2026-07-15/reference/get_image_for_campaign_message)

```ruby
KlaviyoAPI::Campaigns.get_image_for_campaign_message(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Campaigns.get_campaign_message_image(id, opts)
```

#### [Get Image ID for Campaign Message](https://developers.klaviyo.com/en/v2026-07-15/reference/get_image_id_for_campaign_message)

```ruby
KlaviyoAPI::Campaigns.get_image_id_for_campaign_message(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Campaigns.get_campaign_message_relationships_image(id)
```

#### [Get Message IDs for Campaign](https://developers.klaviyo.com/en/v2026-07-15/reference/get_message_ids_for_campaign)

```ruby
KlaviyoAPI::Campaigns.get_message_ids_for_campaign(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Campaigns.get_campaign_relationships_campaign_messages(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Campaigns.get_campaign_relationships_messages(id)
```

#### [Get Messages for Campaign](https://developers.klaviyo.com/en/v2026-07-15/reference/get_messages_for_campaign)

```ruby
KlaviyoAPI::Campaigns.get_messages_for_campaign(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Campaigns.get_campaign_campaign_messages(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Campaigns.get_campaign_messages(id, opts)
```

#### [Get Tag IDs for Campaign](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tag_ids_for_campaign)

```ruby
KlaviyoAPI::Campaigns.get_tag_ids_for_campaign(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Campaigns.get_campaign_relationships_tags(id)
```

#### [Get Tags for Campaign](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tags_for_campaign)

```ruby
KlaviyoAPI::Campaigns.get_tags_for_campaign(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Campaigns.get_campaign_tags(id, opts)
```

#### [Get Template for Campaign Message](https://developers.klaviyo.com/en/v2026-07-15/reference/get_template_for_campaign_message)

```ruby
KlaviyoAPI::Campaigns.get_template_for_campaign_message(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Campaigns.get_campaign_message_template(id, opts)
```

#### [Get Template ID for Campaign Message](https://developers.klaviyo.com/en/v2026-07-15/reference/get_template_id_for_campaign_message)

```ruby
KlaviyoAPI::Campaigns.get_template_id_for_campaign_message(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Campaigns.get_campaign_message_relationships_template(id)
```

#### [Refresh Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2026-07-15/reference/refresh_campaign_recipient_estimation)

```ruby
KlaviyoAPI::Campaigns.refresh_campaign_recipient_estimation(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Campaigns.create_campaign_recipient_estimation_job(body, opts)
```

#### [Send Campaign](https://developers.klaviyo.com/en/v2026-07-15/reference/send_campaign)

```ruby
KlaviyoAPI::Campaigns.send_campaign(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Campaigns.create_campaign_send_job(body, opts)
```

#### [Update Campaign](https://developers.klaviyo.com/en/v2026-07-15/reference/update_campaign)

```ruby
KlaviyoAPI::Campaigns.update_campaign(id, body, opts)
```

#### [Update Campaign Message](https://developers.klaviyo.com/en/v2026-07-15/reference/update_campaign_message)

```ruby
KlaviyoAPI::Campaigns.update_campaign_message(id, body, opts)
```

#### [Update Image for Campaign Message](https://developers.klaviyo.com/en/v2026-07-15/reference/update_image_for_campaign_message)

```ruby
KlaviyoAPI::Campaigns.update_image_for_campaign_message(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Campaigns.update_campaign_message_relationships_image(id, body)
```

## Catalogs

#### [Add Categories to Catalog Item](https://developers.klaviyo.com/en/v2026-07-15/reference/add_categories_to_catalog_item)

```ruby
KlaviyoAPI::Catalogs.add_categories_to_catalog_item(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.add_category_to_catalog_item(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.create_catalog_item_relationships_category(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.create_catalog_item_relationships_categories(id, body)
```

#### [Add Items to Catalog Category](https://developers.klaviyo.com/en/v2026-07-15/reference/add_items_to_catalog_category)

```ruby
KlaviyoAPI::Catalogs.add_items_to_catalog_category(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.create_catalog_category_relationships_item(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.create_catalog_category_relationships_items(id, body)
```

#### [Bulk Create Catalog Categories](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_create_catalog_categories)

```ruby
KlaviyoAPI::Catalogs.bulk_create_catalog_categories(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.spawn_create_categories_job(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.create_catalog_category_bulk_create_job(body, opts)
```

#### [Bulk Create Catalog Items](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_create_catalog_items)

```ruby
KlaviyoAPI::Catalogs.bulk_create_catalog_items(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.spawn_create_items_job(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.create_catalog_item_bulk_create_job(body, opts)
```

#### [Bulk Create Catalog Variants](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_create_catalog_variants)

```ruby
KlaviyoAPI::Catalogs.bulk_create_catalog_variants(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.spawn_create_variants_job(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.create_catalog_variant_bulk_create_job(body, opts)
```

#### [Bulk Delete Catalog Categories](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_delete_catalog_categories)

```ruby
KlaviyoAPI::Catalogs.bulk_delete_catalog_categories(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.spawn_delete_categories_job(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.create_catalog_category_bulk_delete_job(body, opts)
```

#### [Bulk Delete Catalog Items](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_delete_catalog_items)

```ruby
KlaviyoAPI::Catalogs.bulk_delete_catalog_items(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.spawn_delete_items_job(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.create_catalog_item_bulk_delete_job(body, opts)
```

#### [Bulk Delete Catalog Variants](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_delete_catalog_variants)

```ruby
KlaviyoAPI::Catalogs.bulk_delete_catalog_variants(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.spawn_delete_variants_job(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.create_catalog_variant_bulk_delete_job(body, opts)
```

#### [Bulk Update Catalog Categories](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_update_catalog_categories)

```ruby
KlaviyoAPI::Catalogs.bulk_update_catalog_categories(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.spawn_update_categories_job(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.create_catalog_category_bulk_update_job(body, opts)
```

#### [Bulk Update Catalog Items](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_update_catalog_items)

```ruby
KlaviyoAPI::Catalogs.bulk_update_catalog_items(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.spawn_update_items_job(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.create_catalog_item_bulk_update_job(body, opts)
```

#### [Bulk Update Catalog Variants](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_update_catalog_variants)

```ruby
KlaviyoAPI::Catalogs.bulk_update_catalog_variants(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.spawn_update_variants_job(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.create_catalog_variant_bulk_update_job(body, opts)
```

#### [Create Back In Stock Subscription](https://developers.klaviyo.com/en/v2026-07-15/reference/create_back_in_stock_subscription)

```ruby
KlaviyoAPI::Catalogs.create_back_in_stock_subscription(body)
```

#### [Create Catalog Category](https://developers.klaviyo.com/en/v2026-07-15/reference/create_catalog_category)

```ruby
KlaviyoAPI::Catalogs.create_catalog_category(body, opts)
```

#### [Create Catalog Item](https://developers.klaviyo.com/en/v2026-07-15/reference/create_catalog_item)

```ruby
KlaviyoAPI::Catalogs.create_catalog_item(body, opts)
```

#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2026-07-15/reference/create_catalog_variant)

```ruby
KlaviyoAPI::Catalogs.create_catalog_variant(body, opts)
```

#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_catalog_category)

```ruby
KlaviyoAPI::Catalogs.delete_catalog_category(id)
```

#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_catalog_item)

```ruby
KlaviyoAPI::Catalogs.delete_catalog_item(id)
```

#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_catalog_variant)

```ruby
KlaviyoAPI::Catalogs.delete_catalog_variant(id)
```

#### [Get Bulk Create Catalog Items Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_create_catalog_items_job)

```ruby
KlaviyoAPI::Catalogs.get_bulk_create_catalog_items_job(job_id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_catalog_item_bulk_create_job(job_id, opts)
```

#### [Get Bulk Create Catalog Items Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_create_catalog_items_jobs)

```ruby
KlaviyoAPI::Catalogs.get_bulk_create_catalog_items_jobs(opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_create_items_jobs(opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_catalog_item_bulk_create_jobs(opts)
```

#### [Get Bulk Create Categories Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_create_categories_job)

```ruby
KlaviyoAPI::Catalogs.get_bulk_create_categories_job(job_id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_catalog_category_bulk_create_job(job_id, opts)
```

#### [Get Bulk Create Categories Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_create_categories_jobs)

```ruby
KlaviyoAPI::Catalogs.get_bulk_create_categories_jobs(opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_create_categories_jobs(opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_catalog_category_bulk_create_jobs(opts)
```

#### [Get Bulk Create Variants Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_create_variants_job)

```ruby
KlaviyoAPI::Catalogs.get_bulk_create_variants_job(job_id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_catalog_variant_bulk_create_job(job_id, opts)
```

#### [Get Bulk Create Variants Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_create_variants_jobs)

```ruby
KlaviyoAPI::Catalogs.get_bulk_create_variants_jobs(opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_create_variants_jobs(opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_catalog_variant_bulk_create_jobs(opts)
```

#### [Get Bulk Delete Catalog Items Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_delete_catalog_items_job)

```ruby
KlaviyoAPI::Catalogs.get_bulk_delete_catalog_items_job(job_id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_catalog_item_bulk_delete_job(job_id, opts)
```

#### [Get Bulk Delete Catalog Items Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_delete_catalog_items_jobs)

```ruby
KlaviyoAPI::Catalogs.get_bulk_delete_catalog_items_jobs(opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_delete_items_jobs(opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_catalog_item_bulk_delete_jobs(opts)
```

#### [Get Bulk Delete Categories Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_delete_categories_job)

```ruby
KlaviyoAPI::Catalogs.get_bulk_delete_categories_job(job_id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_catalog_category_bulk_delete_job(job_id, opts)
```

#### [Get Bulk Delete Categories Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_delete_categories_jobs)

```ruby
KlaviyoAPI::Catalogs.get_bulk_delete_categories_jobs(opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_catalog_category_bulk_delete_jobs(opts)
```

#### [Get Bulk Delete Variants Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_delete_variants_job)

```ruby
KlaviyoAPI::Catalogs.get_bulk_delete_variants_job(job_id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_catalog_variant_bulk_delete_job(job_id, opts)
```

#### [Get Bulk Delete Variants Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_delete_variants_jobs)

```ruby
KlaviyoAPI::Catalogs.get_bulk_delete_variants_jobs(opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_catalog_variant_bulk_delete_jobs(opts)
```

#### [Get Bulk Update Catalog Items Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_update_catalog_items_job)

```ruby
KlaviyoAPI::Catalogs.get_bulk_update_catalog_items_job(job_id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_catalog_item_bulk_update_job(job_id, opts)
```

#### [Get Bulk Update Catalog Items Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_update_catalog_items_jobs)

```ruby
KlaviyoAPI::Catalogs.get_bulk_update_catalog_items_jobs(opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_update_items_jobs(opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_catalog_item_bulk_update_jobs(opts)
```

#### [Get Bulk Update Categories Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_update_categories_job)

```ruby
KlaviyoAPI::Catalogs.get_bulk_update_categories_job(job_id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_catalog_category_bulk_update_job(job_id, opts)
```

#### [Get Bulk Update Categories Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_update_categories_jobs)

```ruby
KlaviyoAPI::Catalogs.get_bulk_update_categories_jobs(opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_update_categories_jobs(opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_catalog_category_bulk_update_jobs(opts)
```

#### [Get Bulk Update Variants Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_update_variants_job)

```ruby
KlaviyoAPI::Catalogs.get_bulk_update_variants_job(job_id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_catalog_variant_bulk_update_job(job_id, opts)
```

#### [Get Bulk Update Variants Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_update_variants_jobs)

```ruby
KlaviyoAPI::Catalogs.get_bulk_update_variants_jobs(opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_update_variants_jobs(opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_catalog_variant_bulk_update_jobs(opts)
```

#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2026-07-15/reference/get_catalog_categories)

```ruby
KlaviyoAPI::Catalogs.get_catalog_categories(opts)
```

#### [Get Catalog Category](https://developers.klaviyo.com/en/v2026-07-15/reference/get_catalog_category)

```ruby
KlaviyoAPI::Catalogs.get_catalog_category(id, opts)
```

#### [Get Catalog Item](https://developers.klaviyo.com/en/v2026-07-15/reference/get_catalog_item)

```ruby
KlaviyoAPI::Catalogs.get_catalog_item(id, opts)
```

#### [Get Catalog Items](https://developers.klaviyo.com/en/v2026-07-15/reference/get_catalog_items)

```ruby
KlaviyoAPI::Catalogs.get_catalog_items(opts)
```

#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2026-07-15/reference/get_catalog_variant)

```ruby
KlaviyoAPI::Catalogs.get_catalog_variant(id, opts)
```

#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2026-07-15/reference/get_catalog_variants)

```ruby
KlaviyoAPI::Catalogs.get_catalog_variants(opts)
```

#### [Get Categories for Catalog Item](https://developers.klaviyo.com/en/v2026-07-15/reference/get_categories_for_catalog_item)

```ruby
KlaviyoAPI::Catalogs.get_categories_for_catalog_item(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_catalog_item_categories(id, opts)
```

#### [Get Category IDs for Catalog Item](https://developers.klaviyo.com/en/v2026-07-15/reference/get_category_ids_for_catalog_item)

```ruby
KlaviyoAPI::Catalogs.get_category_ids_for_catalog_item(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_catalog_item_relationships_categories(id, opts)
```

#### [Get Item IDs for Catalog Category](https://developers.klaviyo.com/en/v2026-07-15/reference/get_item_ids_for_catalog_category)

```ruby
KlaviyoAPI::Catalogs.get_item_ids_for_catalog_category(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_catalog_category_relationships_items(id, opts)
```

#### [Get Items for Catalog Category](https://developers.klaviyo.com/en/v2026-07-15/reference/get_items_for_catalog_category)

```ruby
KlaviyoAPI::Catalogs.get_items_for_catalog_category(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_catalog_category_items(id, opts)
```

#### [Get Variant IDs for Catalog Item](https://developers.klaviyo.com/en/v2026-07-15/reference/get_variant_ids_for_catalog_item)

```ruby
KlaviyoAPI::Catalogs.get_variant_ids_for_catalog_item(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_catalog_item_relationships_variants(id, opts)
```

#### [Get Variants for Catalog Item](https://developers.klaviyo.com/en/v2026-07-15/reference/get_variants_for_catalog_item)

```ruby
KlaviyoAPI::Catalogs.get_variants_for_catalog_item(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.get_catalog_item_variants(id, opts)
```

#### [Remove Categories from Catalog Item](https://developers.klaviyo.com/en/v2026-07-15/reference/remove_categories_from_catalog_item)

```ruby
KlaviyoAPI::Catalogs.remove_categories_from_catalog_item(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.delete_catalog_item_relationships_categories(id, body)
```

#### [Remove Items from Catalog Category](https://developers.klaviyo.com/en/v2026-07-15/reference/remove_items_from_catalog_category)

```ruby
KlaviyoAPI::Catalogs.remove_items_from_catalog_category(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.delete_catalog_category_relationships_items(id, body)
```

#### [Update Catalog Category](https://developers.klaviyo.com/en/v2026-07-15/reference/update_catalog_category)

```ruby
KlaviyoAPI::Catalogs.update_catalog_category(id, body, opts)
```

#### [Update Catalog Item](https://developers.klaviyo.com/en/v2026-07-15/reference/update_catalog_item)

```ruby
KlaviyoAPI::Catalogs.update_catalog_item(id, body, opts)
```

#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2026-07-15/reference/update_catalog_variant)

```ruby
KlaviyoAPI::Catalogs.update_catalog_variant(id, body, opts)
```

#### [Update Categories for Catalog Item](https://developers.klaviyo.com/en/v2026-07-15/reference/update_categories_for_catalog_item)

```ruby
KlaviyoAPI::Catalogs.update_categories_for_catalog_item(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.update_catalog_item_relationships_categories(id, body)
```

#### [Update Items for Catalog Category](https://developers.klaviyo.com/en/v2026-07-15/reference/update_items_for_catalog_category)

```ruby
KlaviyoAPI::Catalogs.update_items_for_catalog_category(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Catalogs.update_catalog_category_relationships_items(id, body)
```

## Client

#### [Get Client IP Allowlist](https://developers.klaviyo.com/en/v2026-07-15/reference/get_client_ip_allowlist)

```ruby
KlaviyoAPI::Client.get_client_ip_allowlist(id, company_id, opts)
```

## Conversations

#### [Create Conversation Message](https://developers.klaviyo.com/en/v2026-07-15/reference/create_conversation_message)

```ruby
KlaviyoAPI::Conversations.create_conversation_message(body)
```

## Coupons

#### [Bulk Create Coupon Codes](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_create_coupon_codes)

```ruby
KlaviyoAPI::Coupons.bulk_create_coupon_codes(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Coupons.spawn_coupon_code_bulk_create_job(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Coupons.create_coupon_code_bulk_create_job(body, opts)
```

#### [Create Coupon](https://developers.klaviyo.com/en/v2026-07-15/reference/create_coupon)

```ruby
KlaviyoAPI::Coupons.create_coupon(body, opts)
```

#### [Create Coupon Code](https://developers.klaviyo.com/en/v2026-07-15/reference/create_coupon_code)

```ruby
KlaviyoAPI::Coupons.create_coupon_code(body, opts)
```

#### [Delete Coupon](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_coupon)

```ruby
KlaviyoAPI::Coupons.delete_coupon(id)
```

#### [Delete Coupon Code](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_coupon_code)

```ruby
KlaviyoAPI::Coupons.delete_coupon_code(id)
```

#### [Get Bulk Create Coupon Code Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_create_coupon_code_jobs)

```ruby
KlaviyoAPI::Coupons.get_bulk_create_coupon_code_jobs(opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Coupons.get_coupon_code_bulk_create_jobs(opts)
```

#### [Get Bulk Create Coupon Codes Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_create_coupon_codes_job)

```ruby
KlaviyoAPI::Coupons.get_bulk_create_coupon_codes_job(job_id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Coupons.get_coupon_code_bulk_create_job(job_id, opts)
```

#### [Get Coupon](https://developers.klaviyo.com/en/v2026-07-15/reference/get_coupon)

```ruby
KlaviyoAPI::Coupons.get_coupon(id, opts)
```

#### [Get Coupon Code](https://developers.klaviyo.com/en/v2026-07-15/reference/get_coupon_code)

```ruby
KlaviyoAPI::Coupons.get_coupon_code(id, opts)
```

#### [Get Coupon Code IDs for Coupon](https://developers.klaviyo.com/en/v2026-07-15/reference/get_coupon_code_ids_for_coupon)

```ruby
KlaviyoAPI::Coupons.get_coupon_code_ids_for_coupon(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Coupons.get_coupon_code_relationships_coupon(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Coupons.get_code_ids_for_coupon(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Coupons.get_coupon_relationships_codes(id, opts)
```

#### [Get Coupon Codes](https://developers.klaviyo.com/en/v2026-07-15/reference/get_coupon_codes)

```ruby
KlaviyoAPI::Coupons.get_coupon_codes(filter, opts)
```

#### [Get Coupon Codes for Coupon](https://developers.klaviyo.com/en/v2026-07-15/reference/get_coupon_codes_for_coupon)

```ruby
KlaviyoAPI::Coupons.get_coupon_codes_for_coupon(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Coupons.get_coupon_coupon_codes(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Coupons.get_codes_for_coupon(id, opts)
```

#### [Get Coupon For Coupon Code](https://developers.klaviyo.com/en/v2026-07-15/reference/get_coupon_for_coupon_code)

```ruby
KlaviyoAPI::Coupons.get_coupon_for_coupon_code(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Coupons.get_coupon_code_coupon(id, opts)
```

#### [Get Coupon ID for Coupon Code](https://developers.klaviyo.com/en/v2026-07-15/reference/get_coupon_id_for_coupon_code)

```ruby
KlaviyoAPI::Coupons.get_coupon_id_for_coupon_code(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Coupons.get_coupon_relationships_coupon_codes(id)
```

#### [Get Coupons](https://developers.klaviyo.com/en/v2026-07-15/reference/get_coupons)

```ruby
KlaviyoAPI::Coupons.get_coupons(opts)
```

#### [Update Coupon](https://developers.klaviyo.com/en/v2026-07-15/reference/update_coupon)

```ruby
KlaviyoAPI::Coupons.update_coupon(id, body, opts)
```

#### [Update Coupon Code](https://developers.klaviyo.com/en/v2026-07-15/reference/update_coupon_code)

```ruby
KlaviyoAPI::Coupons.update_coupon_code(id, body, opts)
```

## Custom Objects

#### [Bulk Create Data Source Records](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_create_data_source_records)

```ruby
KlaviyoAPI::CustomObjects.bulk_create_data_source_records(body)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.create_data_source_record_bulk_create_job(body)
```

#### [Bulk Delete Object Records](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_delete_object_records)

```ruby
KlaviyoAPI::CustomObjects.bulk_delete_object_records(body)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.create_object_record_bulk_delete_job(body)
```

#### [Create Data Source](https://developers.klaviyo.com/en/v2026-07-15/reference/create_data_source)

```ruby
KlaviyoAPI::CustomObjects.create_data_source(body, opts)
```

#### [Create Data Source Record](https://developers.klaviyo.com/en/v2026-07-15/reference/create_data_source_record)

```ruby
KlaviyoAPI::CustomObjects.create_data_source_record(body)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.create_data_source_record_create_job(body)
```

#### [Create Object Schema](https://developers.klaviyo.com/en/v2026-07-15/reference/create_object_schema)

```ruby
KlaviyoAPI::CustomObjects.create_object_schema(body, opts)
```

#### [Create Object Schema Relationship](https://developers.klaviyo.com/en/v2026-07-15/reference/create_object_schema_relationship)

```ruby
KlaviyoAPI::CustomObjects.create_object_schema_relationship(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.add_schemas_to_object_schema(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.create_object_schema_relationships_schemas(id, body)
```

#### [Create Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/create_object_type)

```ruby
KlaviyoAPI::CustomObjects.create_object_type(body, opts)
```

#### [Create Profile Schema Relationship](https://developers.klaviyo.com/en/v2026-07-15/reference/create_profile_schema_relationship)

```ruby
KlaviyoAPI::CustomObjects.create_profile_schema_relationship(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.add_profile_object_schemas_to_object_schema(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.create_object_schema_relationships_profile_object_schemas(id, body)
```

#### [Delete Data Source](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_data_source)

```ruby
KlaviyoAPI::CustomObjects.delete_data_source(id)
```

#### [Delete Object Schema Relationship](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_object_schema_relationship)

```ruby
KlaviyoAPI::CustomObjects.delete_object_schema_relationship(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.delete_object_schema_relationships_schemas(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.remove_schemas_from_object_schema(id, body)
```

#### [Delete Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_object_type)

```ruby
KlaviyoAPI::CustomObjects.delete_object_type(id)
```

#### [Delete Profile Schema Relationship](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_profile_schema_relationship)

```ruby
KlaviyoAPI::CustomObjects.delete_profile_schema_relationship(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.delete_object_schema_relationships_profile_object_schemas(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.remove_profile_object_schemas_from_object_schema(id, body)
```

#### [Get Current Schema for Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/get_current_schema_for_object_type)

```ruby
KlaviyoAPI::CustomObjects.get_current_schema_for_object_type(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.get_object_type_current_schema(id, opts)
```

#### [Get Current Schema ID for Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/get_current_schema_id_for_object_type)

```ruby
KlaviyoAPI::CustomObjects.get_current_schema_id_for_object_type(id)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.get_object_type_relationships_current_schema(id)
```

#### [Get Data Source](https://developers.klaviyo.com/en/v2026-07-15/reference/get_data_source)

```ruby
KlaviyoAPI::CustomObjects.get_data_source(id, opts)
```

#### [Get Data Sources](https://developers.klaviyo.com/en/v2026-07-15/reference/get_data_sources)

```ruby
KlaviyoAPI::CustomObjects.get_data_sources(opts)
```

#### [Get Draft Schema for Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/get_draft_schema_for_object_type)

```ruby
KlaviyoAPI::CustomObjects.get_draft_schema_for_object_type(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.get_object_type_draft_schema(id, opts)
```

#### [Get Draft Schema ID for Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/get_draft_schema_id_for_object_type)

```ruby
KlaviyoAPI::CustomObjects.get_draft_schema_id_for_object_type(id)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.get_object_type_relationships_draft_schema(id)
```

#### [Get Ingestion Log IDs for Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/get_ingestion_log_ids_for_object_type)

```ruby
KlaviyoAPI::CustomObjects.get_ingestion_log_ids_for_object_type(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.get_object_type_relationships_ingestion_logs(id, opts)
```

#### [Get Ingestion Logs for Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/get_ingestion_logs_for_object_type)

```ruby
KlaviyoAPI::CustomObjects.get_ingestion_logs_for_object_type(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.get_object_type_ingestion_logs(id, opts)
```

#### [Get Object Record](https://developers.klaviyo.com/en/v2026-07-15/reference/get_object_record)

```ruby
KlaviyoAPI::CustomObjects.get_object_record(id, opts)
```

#### [Get Object Schema](https://developers.klaviyo.com/en/v2026-07-15/reference/get_object_schema)

```ruby
KlaviyoAPI::CustomObjects.get_object_schema(id, opts)
```

#### [Get Object Schema Relationships](https://developers.klaviyo.com/en/v2026-07-15/reference/get_object_schema_relationships)

```ruby
KlaviyoAPI::CustomObjects.get_object_schema_relationships(id)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.get_object_schema_relationships_schemas(id)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.get_schema_ids_for_object_schema(id)
```

#### [Get Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/get_object_type)

```ruby
KlaviyoAPI::CustomObjects.get_object_type(id, opts)
```

#### [Get Object Type Relationships](https://developers.klaviyo.com/en/v2026-07-15/reference/get_object_type_relationships)

```ruby
KlaviyoAPI::CustomObjects.get_object_type_relationships(id)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.get_object_type_relationships_types(id)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.get_type_ids_for_object_type(id)
```

#### [Get Object Types](https://developers.klaviyo.com/en/v2026-07-15/reference/get_object_types)

```ruby
KlaviyoAPI::CustomObjects.get_object_types(opts)
```

#### [Get Profile Schema Relationships](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profile_schema_relationships)

```ruby
KlaviyoAPI::CustomObjects.get_profile_schema_relationships(id)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.get_object_schema_relationships_profile_object_schemas(id)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.get_profile_object_schema_ids_for_object_schema(id)
```

#### [Get Profile Type Relationships](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profile_type_relationships)

```ruby
KlaviyoAPI::CustomObjects.get_profile_type_relationships(id)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.get_object_type_relationships_profile_object_types(id)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.get_profile_object_type_ids_for_object_type(id)
```

#### [Get Record IDs for Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/get_record_ids_for_object_type)

```ruby
KlaviyoAPI::CustomObjects.get_record_ids_for_object_type(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.get_object_type_relationships_records(id, opts)
```

#### [Get Records for Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/get_records_for_object_type)

```ruby
KlaviyoAPI::CustomObjects.get_records_for_object_type(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.get_object_type_records(id, opts)
```

#### [Get Schema Version IDs for Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/get_schema_version_ids_for_object_type)

```ruby
KlaviyoAPI::CustomObjects.get_schema_version_ids_for_object_type(id)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.get_object_type_relationships_schema_versions(id)
```

#### [Get Schema Versions for Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/get_schema_versions_for_object_type)

```ruby
KlaviyoAPI::CustomObjects.get_schema_versions_for_object_type(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.get_object_type_schema_versions(id, opts)
```

#### [Get Source Mapping](https://developers.klaviyo.com/en/v2026-07-15/reference/get_source_mapping)

```ruby
KlaviyoAPI::CustomObjects.get_source_mapping(id, opts)
```

#### [Get Source Mapping for Object Schema](https://developers.klaviyo.com/en/v2026-07-15/reference/get_source_mapping_for_object_schema)

```ruby
KlaviyoAPI::CustomObjects.get_source_mapping_for_object_schema(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.get_object_schema_source_mapping(id, opts)
```

#### [Get Source Mapping ID for Object Schema](https://developers.klaviyo.com/en/v2026-07-15/reference/get_source_mapping_id_for_object_schema)

```ruby
KlaviyoAPI::CustomObjects.get_source_mapping_id_for_object_schema(id)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.get_object_schema_relationships_source_mapping(id)
```

#### [Update Object Schema](https://developers.klaviyo.com/en/v2026-07-15/reference/update_object_schema)

```ruby
KlaviyoAPI::CustomObjects.update_object_schema(id, body, opts)
```

#### [Update Object Schema Relationship](https://developers.klaviyo.com/en/v2026-07-15/reference/update_object_schema_relationship)

```ruby
KlaviyoAPI::CustomObjects.update_object_schema_relationship(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.update_object_schema_relationships_schemas(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.update_schemas_for_object_schema(id, body)
```

#### [Update Profile Schema Relationship](https://developers.klaviyo.com/en/v2026-07-15/reference/update_profile_schema_relationship)

```ruby
KlaviyoAPI::CustomObjects.update_profile_schema_relationship(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.update_object_schema_relationships_profile_object_schemas(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::CustomObjects.update_profile_object_schemas_for_object_schema(id, body)
```

#### [Update Source Mapping](https://developers.klaviyo.com/en/v2026-07-15/reference/update_source_mapping)

```ruby
KlaviyoAPI::CustomObjects.update_source_mapping(id, body, opts)
```

## Data Privacy

#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2026-07-15/reference/request_profile_deletion)

```ruby
KlaviyoAPI::DataPrivacy.request_profile_deletion(body)
```
##### Method alias:
```ruby
KlaviyoAPI::DataPrivacy.create_data_privacy_deletion_job(body)
```

## Events

#### [Bulk Create Events](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_create_events)

```ruby
KlaviyoAPI::Events.bulk_create_events(body)
```
##### Method alias:
```ruby
KlaviyoAPI::Events.create_event_bulk_create_job(body)
```

#### [Create Event](https://developers.klaviyo.com/en/v2026-07-15/reference/create_event)

```ruby
KlaviyoAPI::Events.create_event(body)
```

#### [Get Event](https://developers.klaviyo.com/en/v2026-07-15/reference/get_event)

```ruby
KlaviyoAPI::Events.get_event(id, opts)
```

#### [Get Events](https://developers.klaviyo.com/en/v2026-07-15/reference/get_events)

```ruby
KlaviyoAPI::Events.get_events(opts)
```

#### [Get Metric for Event](https://developers.klaviyo.com/en/v2026-07-15/reference/get_metric_for_event)

```ruby
KlaviyoAPI::Events.get_metric_for_event(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Events.get_event_metric(id, opts)
```

#### [Get Metric ID for Event](https://developers.klaviyo.com/en/v2026-07-15/reference/get_metric_id_for_event)

```ruby
KlaviyoAPI::Events.get_metric_id_for_event(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Events.get_event_relationships_metric(id)
```

#### [Get Profile for Event](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profile_for_event)

```ruby
KlaviyoAPI::Events.get_profile_for_event(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Events.get_event_profile(id, opts)
```

#### [Get Profile ID for Event](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profile_id_for_event)

```ruby
KlaviyoAPI::Events.get_profile_id_for_event(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Events.get_event_relationships_profile(id)
```

## Flows

#### [Create Flow](https://developers.klaviyo.com/en/v2026-07-15/reference/create_flow)

```ruby
KlaviyoAPI::Flows.create_flow(body, opts)
```

#### [Delete Flow](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_flow)

```ruby
KlaviyoAPI::Flows.delete_flow(id)
```

#### [Delete Flow Action](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_flow_action)

```ruby
KlaviyoAPI::Flows.delete_flow_action(id)
```

#### [Get Action for Flow Message](https://developers.klaviyo.com/en/v2026-07-15/reference/get_action_for_flow_message)

```ruby
KlaviyoAPI::Flows.get_action_for_flow_message(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Flows.get_flow_message_action(id, opts)
```

#### [Get Action ID for Flow Message](https://developers.klaviyo.com/en/v2026-07-15/reference/get_action_id_for_flow_message)

```ruby
KlaviyoAPI::Flows.get_action_id_for_flow_message(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Flows.get_flow_message_relationships_action(id)
```

#### [Get Action IDs for Flow](https://developers.klaviyo.com/en/v2026-07-15/reference/get_action_ids_for_flow)

```ruby
KlaviyoAPI::Flows.get_action_ids_for_flow(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Flows.get_flow_relationships_flow_actions(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Flows.get_flow_relationships_actions(id, opts)
```

#### [Get Actions for Flow](https://developers.klaviyo.com/en/v2026-07-15/reference/get_actions_for_flow)

```ruby
KlaviyoAPI::Flows.get_actions_for_flow(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Flows.get_flow_flow_actions(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Flows.get_flow_actions(id, opts)
```

#### [Get Flow](https://developers.klaviyo.com/en/v2026-07-15/reference/get_flow)

```ruby
KlaviyoAPI::Flows.get_flow(id, opts)
```

#### [Get Flow Action](https://developers.klaviyo.com/en/v2026-07-15/reference/get_flow_action)

```ruby
KlaviyoAPI::Flows.get_flow_action(id, opts)
```

#### [Get Messages For Flow Action](https://developers.klaviyo.com/en/v2026-07-15/reference/get_flow_action_messages)

```ruby
KlaviyoAPI::Flows.get_flow_action_messages(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Flows.get_messages_for_flow_action(id, opts)
```

#### [Get Flow for Flow Action](https://developers.klaviyo.com/en/v2026-07-15/reference/get_flow_for_flow_action)

```ruby
KlaviyoAPI::Flows.get_flow_for_flow_action(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Flows.get_flow_action_flow(id, opts)
```

#### [Get Flow ID for Flow Action](https://developers.klaviyo.com/en/v2026-07-15/reference/get_flow_id_for_flow_action)

```ruby
KlaviyoAPI::Flows.get_flow_id_for_flow_action(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Flows.get_flow_action_relationships_flow(id)
```

#### [Get Flow Message](https://developers.klaviyo.com/en/v2026-07-15/reference/get_flow_message)

```ruby
KlaviyoAPI::Flows.get_flow_message(id, opts)
```

#### [Get Flows](https://developers.klaviyo.com/en/v2026-07-15/reference/get_flows)

```ruby
KlaviyoAPI::Flows.get_flows(opts)
```

#### [Get Message IDs for Flow Action](https://developers.klaviyo.com/en/v2026-07-15/reference/get_message_ids_for_flow_action)

```ruby
KlaviyoAPI::Flows.get_message_ids_for_flow_action(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Flows.get_flow_action_relationships_messages(id, opts)
```

#### [Get Tag IDs for Flow](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tag_ids_for_flow)

```ruby
KlaviyoAPI::Flows.get_tag_ids_for_flow(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Flows.get_flow_relationships_tags(id)
```

#### [Get Tags for Flow](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tags_for_flow)

```ruby
KlaviyoAPI::Flows.get_tags_for_flow(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Flows.get_flow_tags(id, opts)
```

#### [Get Template for Flow Message](https://developers.klaviyo.com/en/v2026-07-15/reference/get_template_for_flow_message)

```ruby
KlaviyoAPI::Flows.get_template_for_flow_message(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Flows.get_flow_message_template(id, opts)
```

#### [Get Template ID for Flow Message](https://developers.klaviyo.com/en/v2026-07-15/reference/get_template_id_for_flow_message)

```ruby
KlaviyoAPI::Flows.get_template_id_for_flow_message(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Flows.get_flow_message_relationships_template(id)
```

#### [Update Flow Status](https://developers.klaviyo.com/en/v2026-07-15/reference/update_flow)

```ruby
KlaviyoAPI::Flows.update_flow(id, body, opts)
```

#### [Update Flow Action](https://developers.klaviyo.com/en/v2026-07-15/reference/update_flow_action)

```ruby
KlaviyoAPI::Flows.update_flow_action(id, body, opts)
```

## Forms

#### [Create Form](https://developers.klaviyo.com/en/v2026-07-15/reference/create_form)

```ruby
KlaviyoAPI::Forms.create_form(body, opts)
```

#### [Delete Form](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_form)

```ruby
KlaviyoAPI::Forms.delete_form(id)
```

#### [Get Form](https://developers.klaviyo.com/en/v2026-07-15/reference/get_form)

```ruby
KlaviyoAPI::Forms.get_form(id, opts)
```

#### [Get Form for Form Version](https://developers.klaviyo.com/en/v2026-07-15/reference/get_form_for_form_version)

```ruby
KlaviyoAPI::Forms.get_form_for_form_version(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Forms.get_form_version_form(id, opts)
```

#### [Get Form ID for Form Version](https://developers.klaviyo.com/en/v2026-07-15/reference/get_form_id_for_form_version)

```ruby
KlaviyoAPI::Forms.get_form_id_for_form_version(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Forms.get_form_version_relationships_form(id)
```

#### [Get Form Version](https://developers.klaviyo.com/en/v2026-07-15/reference/get_form_version)

```ruby
KlaviyoAPI::Forms.get_form_version(id, opts)
```

#### [Get Forms](https://developers.klaviyo.com/en/v2026-07-15/reference/get_forms)

```ruby
KlaviyoAPI::Forms.get_forms(opts)
```

#### [Get Version IDs for Form](https://developers.klaviyo.com/en/v2026-07-15/reference/get_version_ids_for_form)

```ruby
KlaviyoAPI::Forms.get_version_ids_for_form(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Forms.get_form_relationships_form_versions(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Forms.get_form_relationships_versions(id, opts)
```

#### [Get Versions for Form](https://developers.klaviyo.com/en/v2026-07-15/reference/get_versions_for_form)

```ruby
KlaviyoAPI::Forms.get_versions_for_form(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Forms.get_form_form_versions(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Forms.get_form_versions(id, opts)
```

## Images

#### [Get Image](https://developers.klaviyo.com/en/v2026-07-15/reference/get_image)

```ruby
KlaviyoAPI::Images.get_image(id, opts)
```

#### [Get Images](https://developers.klaviyo.com/en/v2026-07-15/reference/get_images)

```ruby
KlaviyoAPI::Images.get_images(opts)
```

#### [Update Image](https://developers.klaviyo.com/en/v2026-07-15/reference/update_image)

```ruby
KlaviyoAPI::Images.update_image(id, body, opts)
```

#### [Upload Image From File](https://developers.klaviyo.com/en/v2026-07-15/reference/upload_image_from_file)

```ruby
KlaviyoAPI::Images.upload_image_from_file(file, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Images.create_image_upload(file, opts)
```

#### [Upload Image From URL](https://developers.klaviyo.com/en/v2026-07-15/reference/upload_image_from_url)

```ruby
KlaviyoAPI::Images.upload_image_from_url(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Images.create_image(body, opts)
```

## Lists

#### [Add Profiles to List](https://developers.klaviyo.com/en/v2026-07-15/reference/add_profiles_to_list)

```ruby
KlaviyoAPI::Lists.add_profiles_to_list(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Lists.create_list_relationships(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Lists.create_list_relationships_profile(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Lists.create_list_relationships_profiles(id, body)
```

#### [Create List](https://developers.klaviyo.com/en/v2026-07-15/reference/create_list)

```ruby
KlaviyoAPI::Lists.create_list(body, opts)
```

#### [Delete List](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_list)

```ruby
KlaviyoAPI::Lists.delete_list(id)
```

#### [Get Flows Triggered by List](https://developers.klaviyo.com/en/v2026-07-15/reference/get_flows_triggered_by_list)

```ruby
KlaviyoAPI::Lists.get_flows_triggered_by_list(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Lists.get_flow_triggers_for_list(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Lists.get_list_flow_triggers(id, opts)
```

#### [Get IDs for Flows Triggered by List](https://developers.klaviyo.com/en/v2026-07-15/reference/get_ids_for_flows_triggered_by_list)

```ruby
KlaviyoAPI::Lists.get_ids_for_flows_triggered_by_list(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Lists.get_flow_trigger_ids_for_list(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Lists.get_list_relationships_flow_triggers(id)
```

#### [Get List](https://developers.klaviyo.com/en/v2026-07-15/reference/get_list)

```ruby
KlaviyoAPI::Lists.get_list(id, opts)
```

#### [Get Lists](https://developers.klaviyo.com/en/v2026-07-15/reference/get_lists)

```ruby
KlaviyoAPI::Lists.get_lists(opts)
```

#### [Get Profile IDs for List](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profile_ids_for_list)

```ruby
KlaviyoAPI::Lists.get_profile_ids_for_list(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Lists.get_list_relationships_profiles(id, opts)
```

#### [Get Profiles for List](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profiles_for_list)

```ruby
KlaviyoAPI::Lists.get_profiles_for_list(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Lists.get_list_profiles(id, opts)
```

#### [Get Tag IDs for List](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tag_ids_for_list)

```ruby
KlaviyoAPI::Lists.get_tag_ids_for_list(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Lists.get_list_relationships_tags(id)
```

#### [Get Tags for List](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tags_for_list)

```ruby
KlaviyoAPI::Lists.get_tags_for_list(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Lists.get_list_tags(id, opts)
```

#### [Remove Profiles from List](https://developers.klaviyo.com/en/v2026-07-15/reference/remove_profiles_from_list)

```ruby
KlaviyoAPI::Lists.remove_profiles_from_list(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Lists.delete_list_relationships(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Lists.delete_list_relationships_profiles(id, body)
```

#### [Update List](https://developers.klaviyo.com/en/v2026-07-15/reference/update_list)

```ruby
KlaviyoAPI::Lists.update_list(id, body, opts)
```

## Metrics

#### [Create Custom Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/create_custom_metric)

```ruby
KlaviyoAPI::Metrics.create_custom_metric(body, opts)
```

#### [Delete Custom Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_custom_metric)

```ruby
KlaviyoAPI::Metrics.delete_custom_metric(id)
```

#### [Get Custom Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_custom_metric)

```ruby
KlaviyoAPI::Metrics.get_custom_metric(id, opts)
```

#### [Get Custom Metric for Mapped Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_custom_metric_for_mapped_metric)

```ruby
KlaviyoAPI::Metrics.get_custom_metric_for_mapped_metric(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Metrics.get_mapped_metric_custom_metric(id, opts)
```

#### [Get Custom Metric ID for Mapped Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_custom_metric_id_for_mapped_metric)

```ruby
KlaviyoAPI::Metrics.get_custom_metric_id_for_mapped_metric(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Metrics.get_mapped_metric_relationships_custom_metric(id)
```

#### [Get Custom Metrics](https://developers.klaviyo.com/en/v2026-07-15/reference/get_custom_metrics)

```ruby
KlaviyoAPI::Metrics.get_custom_metrics(opts)
```

#### [Get Flows Triggered by Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_flows_triggered_by_metric)

```ruby
KlaviyoAPI::Metrics.get_flows_triggered_by_metric(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Metrics.get_flow_triggers_for_metric(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Metrics.get_metric_flow_triggers(id, opts)
```

#### [Get IDs for Flows Triggered by Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_ids_for_flows_triggered_by_metric)

```ruby
KlaviyoAPI::Metrics.get_ids_for_flows_triggered_by_metric(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Metrics.get_flow_trigger_ids_for_metric(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Metrics.get_metric_relationships_flow_triggers(id)
```

#### [Get Mapped Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_mapped_metric)

```ruby
KlaviyoAPI::Metrics.get_mapped_metric(id, opts)
```

#### [Get Mapped Metrics](https://developers.klaviyo.com/en/v2026-07-15/reference/get_mapped_metrics)

```ruby
KlaviyoAPI::Metrics.get_mapped_metrics(opts)
```

#### [Get Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_metric)

```ruby
KlaviyoAPI::Metrics.get_metric(id, opts)
```

#### [Get Metric for Mapped Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_metric_for_mapped_metric)

```ruby
KlaviyoAPI::Metrics.get_metric_for_mapped_metric(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Metrics.get_mapped_metric_metric(id, opts)
```

#### [Get Metric for Metric Property](https://developers.klaviyo.com/en/v2026-07-15/reference/get_metric_for_metric_property)

```ruby
KlaviyoAPI::Metrics.get_metric_for_metric_property(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Metrics.get_metric_property_metric(id, opts)
```

#### [Get Metric ID for Mapped Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_metric_id_for_mapped_metric)

```ruby
KlaviyoAPI::Metrics.get_metric_id_for_mapped_metric(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Metrics.get_mapped_metric_relationships_metric(id)
```

#### [Get Metric ID for Metric Property](https://developers.klaviyo.com/en/v2026-07-15/reference/get_metric_id_for_metric_property)

```ruby
KlaviyoAPI::Metrics.get_metric_id_for_metric_property(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Metrics.get_metric_property_relationships_metric(id)
```

#### [Get Metric IDs for Custom Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_metric_ids_for_custom_metric)

```ruby
KlaviyoAPI::Metrics.get_metric_ids_for_custom_metric(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Metrics.get_custom_metric_relationships_metrics(id)
```

#### [Get Metric Property](https://developers.klaviyo.com/en/v2026-07-15/reference/get_metric_property)

```ruby
KlaviyoAPI::Metrics.get_metric_property(id, opts)
```

#### [Get Metrics](https://developers.klaviyo.com/en/v2026-07-15/reference/get_metrics)

```ruby
KlaviyoAPI::Metrics.get_metrics(opts)
```

#### [Get Metrics for Custom Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_metrics_for_custom_metric)

```ruby
KlaviyoAPI::Metrics.get_metrics_for_custom_metric(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Metrics.get_custom_metric_metrics(id, opts)
```

#### [Get Properties for Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_properties_for_metric)

```ruby
KlaviyoAPI::Metrics.get_properties_for_metric(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Metrics.get_metric_metric_properties(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Metrics.get_metric_properties(id, opts)
```

#### [Get Property IDs for Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_property_ids_for_metric)

```ruby
KlaviyoAPI::Metrics.get_property_ids_for_metric(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Metrics.get_metric_relationships_metric_properties(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Metrics.get_metric_relationships_properties(id)
```

#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2026-07-15/reference/query_metric_aggregates)

```ruby
KlaviyoAPI::Metrics.query_metric_aggregates(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Metrics.create_metric_aggregate(body, opts)
```

#### [Update Custom Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/update_custom_metric)

```ruby
KlaviyoAPI::Metrics.update_custom_metric(id, body, opts)
```

#### [Update Mapped Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/update_mapped_metric)

```ruby
KlaviyoAPI::Metrics.update_mapped_metric(id, body, opts)
```

## Profiles

#### [Bulk Import Profiles](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_import_profiles)

```ruby
KlaviyoAPI::Profiles.bulk_import_profiles(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.spawn_bulk_profile_import_job(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.create_profile_bulk_import_job(body, opts)
```

#### [Bulk Subscribe Profiles](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_subscribe_profiles)

```ruby
KlaviyoAPI::Profiles.bulk_subscribe_profiles(body)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.subscribe_profiles(body)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.create_profile_subscription_bulk_create_job(body)
```

#### [Bulk Suppress Profiles](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_suppress_profiles)

```ruby
KlaviyoAPI::Profiles.bulk_suppress_profiles(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.suppress_profiles(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.create_profile_suppression_bulk_create_job(body, opts)
```

#### [Bulk Unsubscribe Profiles](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_unsubscribe_profiles)

```ruby
KlaviyoAPI::Profiles.bulk_unsubscribe_profiles(body)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.unsubscribe_profiles(body)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.create_profile_subscription_bulk_delete_job(body)
```

#### [Bulk Unsuppress Profiles](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_unsuppress_profiles)

```ruby
KlaviyoAPI::Profiles.bulk_unsuppress_profiles(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.unsuppress_profiles(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.create_profile_suppression_bulk_delete_job(body, opts)
```

#### [Create or Update Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/create_or_update_profile)

```ruby
KlaviyoAPI::Profiles.create_or_update_profile(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.create_profile_import(body, opts)
```

#### [Create Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/create_profile)

```ruby
KlaviyoAPI::Profiles.create_profile(body, opts)
```

#### [Create or Update Push Token](https://developers.klaviyo.com/en/v2026-07-15/reference/create_push_token)

```ruby
KlaviyoAPI::Profiles.create_push_token(body)
```

#### [Delete Push Token](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_push_token)

```ruby
KlaviyoAPI::Profiles.delete_push_token(id)
```

#### [Get Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_import_profiles_job)

```ruby
KlaviyoAPI::Profiles.get_bulk_import_profiles_job(job_id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_bulk_profile_import_job(job_id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_profile_bulk_import_job(job_id, opts)
```

#### [Get Bulk Import Profiles Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_import_profiles_jobs)

```ruby
KlaviyoAPI::Profiles.get_bulk_import_profiles_jobs(opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_bulk_profile_import_jobs(opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_profile_bulk_import_jobs(opts)
```

#### [Get Bulk Suppress Profiles Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_suppress_profiles_job)

```ruby
KlaviyoAPI::Profiles.get_bulk_suppress_profiles_job(job_id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_profile_suppression_bulk_create_job(job_id, opts)
```

#### [Get Bulk Suppress Profiles Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_suppress_profiles_jobs)

```ruby
KlaviyoAPI::Profiles.get_bulk_suppress_profiles_jobs(opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_profile_suppression_bulk_create_jobs(opts)
```

#### [Get Bulk Unsuppress Profiles Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_unsuppress_profiles_job)

```ruby
KlaviyoAPI::Profiles.get_bulk_unsuppress_profiles_job(job_id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_profile_suppression_bulk_delete_job(job_id, opts)
```

#### [Get Bulk Unsuppress Profiles Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_unsuppress_profiles_jobs)

```ruby
KlaviyoAPI::Profiles.get_bulk_unsuppress_profiles_jobs(opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_profile_suppression_bulk_delete_jobs(opts)
```

#### [Get Conversation for Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/get_conversation_for_profile)

```ruby
KlaviyoAPI::Profiles.get_conversation_for_profile(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_profile_conversation(id, opts)
```

#### [Get Conversation ID for Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/get_conversation_id_for_profile)

```ruby
KlaviyoAPI::Profiles.get_conversation_id_for_profile(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_profile_relationships_conversation(id)
```

#### [Get Conversation IDs for Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/get_conversation_ids_for_profile)

```ruby
KlaviyoAPI::Profiles.get_conversation_ids_for_profile(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_profile_relationships_conversations(id)
```

#### [Get Conversations for Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/get_conversations_for_profile)

```ruby
KlaviyoAPI::Profiles.get_conversations_for_profile(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_profile_conversations(id, opts)
```

#### [Get Errors for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_errors_for_bulk_import_profiles_job)

```ruby
KlaviyoAPI::Profiles.get_errors_for_bulk_import_profiles_job(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_bulk_profile_import_job_import_errors(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_import_errors_for_profile_bulk_import_job(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_profile_bulk_import_job_import_errors(id, opts)
```

#### [Get List for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_list_for_bulk_import_profiles_job)

```ruby
KlaviyoAPI::Profiles.get_list_for_bulk_import_profiles_job(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_bulk_profile_import_job_lists(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_lists_for_profile_bulk_import_job(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_profile_bulk_import_job_lists(id, opts)
```

#### [Get List IDs for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_list_ids_for_bulk_import_profiles_job)

```ruby
KlaviyoAPI::Profiles.get_list_ids_for_bulk_import_profiles_job(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_lists(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_list_ids_for_profile_bulk_import_job(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_profile_bulk_import_job_relationships_lists(id)
```

#### [Get List IDs for Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/get_list_ids_for_profile)

```ruby
KlaviyoAPI::Profiles.get_list_ids_for_profile(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_profile_relationships_lists(id)
```

#### [Get Lists for Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/get_lists_for_profile)

```ruby
KlaviyoAPI::Profiles.get_lists_for_profile(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_profile_lists(id, opts)
```

#### [Get Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profile)

```ruby
KlaviyoAPI::Profiles.get_profile(id, opts)
```

#### [Get Profile for Push Token](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profile_for_push_token)

```ruby
KlaviyoAPI::Profiles.get_profile_for_push_token(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_push_token_profile(id, opts)
```

#### [Get Profile ID for Push Token](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profile_id_for_push_token)

```ruby
KlaviyoAPI::Profiles.get_profile_id_for_push_token(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_push_token_relationships_profile(id)
```

#### [Get Profile IDs for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profile_ids_for_bulk_import_profiles_job)

```ruby
KlaviyoAPI::Profiles.get_profile_ids_for_bulk_import_profiles_job(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_profiles(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_profile_bulk_import_job_relationships_profiles(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_profile_ids_for_profile_bulk_import_job(id, opts)
```

#### [Get Profiles](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profiles)

```ruby
KlaviyoAPI::Profiles.get_profiles(opts)
```

#### [Get Profiles for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profiles_for_bulk_import_profiles_job)

```ruby
KlaviyoAPI::Profiles.get_profiles_for_bulk_import_profiles_job(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_bulk_profile_import_job_profiles(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_profile_bulk_import_job_profiles(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_profiles_for_profile_bulk_import_job(id, opts)
```

#### [Get Push Token](https://developers.klaviyo.com/en/v2026-07-15/reference/get_push_token)

```ruby
KlaviyoAPI::Profiles.get_push_token(id, opts)
```

#### [Get Push Token IDs for Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/get_push_token_ids_for_profile)

```ruby
KlaviyoAPI::Profiles.get_push_token_ids_for_profile(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_profile_relationships_push_tokens(id)
```

#### [Get Push Tokens](https://developers.klaviyo.com/en/v2026-07-15/reference/get_push_tokens)

```ruby
KlaviyoAPI::Profiles.get_push_tokens(opts)
```

#### [Get Push Tokens for Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/get_push_tokens_for_profile)

```ruby
KlaviyoAPI::Profiles.get_push_tokens_for_profile(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_profile_push_tokens(id, opts)
```

#### [Get Segment IDs for Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/get_segment_ids_for_profile)

```ruby
KlaviyoAPI::Profiles.get_segment_ids_for_profile(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_profile_relationships_segments(id)
```

#### [Get Segments for Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/get_segments_for_profile)

```ruby
KlaviyoAPI::Profiles.get_segments_for_profile(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.get_profile_segments(id, opts)
```

#### [Merge Profiles](https://developers.klaviyo.com/en/v2026-07-15/reference/merge_profiles)

```ruby
KlaviyoAPI::Profiles.merge_profiles(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Profiles.create_profile_merge(body, opts)
```

#### [Update Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/update_profile)

```ruby
KlaviyoAPI::Profiles.update_profile(id, body, opts)
```

## Reporting

#### [Query Campaign Values](https://developers.klaviyo.com/en/v2026-07-15/reference/query_campaign_values)

```ruby
KlaviyoAPI::Reporting.query_campaign_values(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Reporting.create_campaign_value_report(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Reporting.create_campaign_values_report(body, opts)
```

#### [Query Flow Series](https://developers.klaviyo.com/en/v2026-07-15/reference/query_flow_series)

```ruby
KlaviyoAPI::Reporting.query_flow_series(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Reporting.create_flow_sery_report(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Reporting.create_flow_series_report(body, opts)
```

#### [Query Flow Values](https://developers.klaviyo.com/en/v2026-07-15/reference/query_flow_values)

```ruby
KlaviyoAPI::Reporting.query_flow_values(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Reporting.create_flow_value_report(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Reporting.create_flow_values_report(body, opts)
```

#### [Query Form Series](https://developers.klaviyo.com/en/v2026-07-15/reference/query_form_series)

```ruby
KlaviyoAPI::Reporting.query_form_series(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Reporting.create_form_sery_report(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Reporting.create_form_series_report(body, opts)
```

#### [Query Form Values](https://developers.klaviyo.com/en/v2026-07-15/reference/query_form_values)

```ruby
KlaviyoAPI::Reporting.query_form_values(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Reporting.create_form_value_report(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Reporting.create_form_values_report(body, opts)
```

#### [Query Segment Series](https://developers.klaviyo.com/en/v2026-07-15/reference/query_segment_series)

```ruby
KlaviyoAPI::Reporting.query_segment_series(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Reporting.create_segment_sery_report(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Reporting.create_segment_series_report(body, opts)
```

#### [Query Segment Values](https://developers.klaviyo.com/en/v2026-07-15/reference/query_segment_values)

```ruby
KlaviyoAPI::Reporting.query_segment_values(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Reporting.create_segment_value_report(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Reporting.create_segment_values_report(body, opts)
```

## Reviews

#### [Get Review](https://developers.klaviyo.com/en/v2026-07-15/reference/get_review)

```ruby
KlaviyoAPI::Reviews.get_review(id, opts)
```

#### [Get Reviews](https://developers.klaviyo.com/en/v2026-07-15/reference/get_reviews)

```ruby
KlaviyoAPI::Reviews.get_reviews(opts)
```

#### [Update Review](https://developers.klaviyo.com/en/v2026-07-15/reference/update_review)

```ruby
KlaviyoAPI::Reviews.update_review(id, body, opts)
```

## Segments

#### [Create Segment](https://developers.klaviyo.com/en/v2026-07-15/reference/create_segment)

```ruby
KlaviyoAPI::Segments.create_segment(body, opts)
```

#### [Delete Segment](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_segment)

```ruby
KlaviyoAPI::Segments.delete_segment(id)
```

#### [Get Flows Triggered by Segment](https://developers.klaviyo.com/en/v2026-07-15/reference/get_flows_triggered_by_segment)

```ruby
KlaviyoAPI::Segments.get_flows_triggered_by_segment(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Segments.get_flow_triggers_for_segment(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Segments.get_segment_flow_triggers(id, opts)
```

#### [Get IDs for Flows Triggered by Segment](https://developers.klaviyo.com/en/v2026-07-15/reference/get_ids_for_flows_triggered_by_segment)

```ruby
KlaviyoAPI::Segments.get_ids_for_flows_triggered_by_segment(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Segments.get_flow_trigger_ids_for_segment(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Segments.get_segment_relationships_flow_triggers(id)
```

#### [Get Profile IDs for Segment](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profile_ids_for_segment)

```ruby
KlaviyoAPI::Segments.get_profile_ids_for_segment(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Segments.get_segment_relationships_profiles(id, opts)
```

#### [Get Profiles for Segment](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profiles_for_segment)

```ruby
KlaviyoAPI::Segments.get_profiles_for_segment(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Segments.get_segment_profiles(id, opts)
```

#### [Get Segment](https://developers.klaviyo.com/en/v2026-07-15/reference/get_segment)

```ruby
KlaviyoAPI::Segments.get_segment(id, opts)
```

#### [Get Segments](https://developers.klaviyo.com/en/v2026-07-15/reference/get_segments)

```ruby
KlaviyoAPI::Segments.get_segments(opts)
```

#### [Get Tag IDs for Segment](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tag_ids_for_segment)

```ruby
KlaviyoAPI::Segments.get_tag_ids_for_segment(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Segments.get_segment_relationships_tags(id)
```

#### [Get Tags for Segment](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tags_for_segment)

```ruby
KlaviyoAPI::Segments.get_tags_for_segment(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Segments.get_segment_tags(id, opts)
```

#### [Update Segment](https://developers.klaviyo.com/en/v2026-07-15/reference/update_segment)

```ruby
KlaviyoAPI::Segments.update_segment(id, body, opts)
```

## Tags

#### [Create Tag](https://developers.klaviyo.com/en/v2026-07-15/reference/create_tag)

```ruby
KlaviyoAPI::Tags.create_tag(body, opts)
```

#### [Create Tag Group](https://developers.klaviyo.com/en/v2026-07-15/reference/create_tag_group)

```ruby
KlaviyoAPI::Tags.create_tag_group(body, opts)
```

#### [Delete Tag](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_tag)

```ruby
KlaviyoAPI::Tags.delete_tag(id)
```

#### [Delete Tag Group](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_tag_group)

```ruby
KlaviyoAPI::Tags.delete_tag_group(id)
```

#### [Get Campaign IDs for Tag](https://developers.klaviyo.com/en/v2026-07-15/reference/get_campaign_ids_for_tag)

```ruby
KlaviyoAPI::Tags.get_campaign_ids_for_tag(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.get_tag_relationships_campaigns(id)
```

#### [Get Flow IDs for Tag](https://developers.klaviyo.com/en/v2026-07-15/reference/get_flow_ids_for_tag)

```ruby
KlaviyoAPI::Tags.get_flow_ids_for_tag(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.get_tag_relationships_flows(id)
```

#### [Get List IDs for Tag](https://developers.klaviyo.com/en/v2026-07-15/reference/get_list_ids_for_tag)

```ruby
KlaviyoAPI::Tags.get_list_ids_for_tag(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.get_tag_relationships_lists(id)
```

#### [Get Segment IDs for Tag](https://developers.klaviyo.com/en/v2026-07-15/reference/get_segment_ids_for_tag)

```ruby
KlaviyoAPI::Tags.get_segment_ids_for_tag(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.get_tag_relationships_segments(id)
```

#### [Get Tag](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tag)

```ruby
KlaviyoAPI::Tags.get_tag(id, opts)
```

#### [Get Tag Group](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tag_group)

```ruby
KlaviyoAPI::Tags.get_tag_group(id, opts)
```

#### [Get Tag Group for Tag](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tag_group_for_tag)

```ruby
KlaviyoAPI::Tags.get_tag_group_for_tag(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.get_tag_tag_group(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.get_group_for_tag(id, opts)
```

#### [Get Tag Group ID for Tag](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tag_group_id_for_tag)

```ruby
KlaviyoAPI::Tags.get_tag_group_id_for_tag(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.get_tag_relationships_tag_group(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.get_group_id_for_tag(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.get_tag_relationships_group(id)
```

#### [Get Tag Groups](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tag_groups)

```ruby
KlaviyoAPI::Tags.get_tag_groups(opts)
```

#### [Get Tag IDs for Tag Group](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tag_ids_for_tag_group)

```ruby
KlaviyoAPI::Tags.get_tag_ids_for_tag_group(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.get_tag_group_relationships_tags(id)
```

#### [Get Tags](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tags)

```ruby
KlaviyoAPI::Tags.get_tags(opts)
```

#### [Get Tags for Tag Group](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tags_for_tag_group)

```ruby
KlaviyoAPI::Tags.get_tags_for_tag_group(id, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.get_tag_group_tags(id, opts)
```

#### [Remove Tag from Campaigns](https://developers.klaviyo.com/en/v2026-07-15/reference/remove_tag_from_campaigns)

```ruby
KlaviyoAPI::Tags.remove_tag_from_campaigns(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.delete_tag_relationships_campaigns(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.remove_campaigns_from_tag(id, body)
```

#### [Remove Tag from Flows](https://developers.klaviyo.com/en/v2026-07-15/reference/remove_tag_from_flows)

```ruby
KlaviyoAPI::Tags.remove_tag_from_flows(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.delete_tag_relationships_flows(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.remove_flows_from_tag(id, body)
```

#### [Remove Tag from Lists](https://developers.klaviyo.com/en/v2026-07-15/reference/remove_tag_from_lists)

```ruby
KlaviyoAPI::Tags.remove_tag_from_lists(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.delete_tag_relationships_lists(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.remove_lists_from_tag(id, body)
```

#### [Remove Tag from Segments](https://developers.klaviyo.com/en/v2026-07-15/reference/remove_tag_from_segments)

```ruby
KlaviyoAPI::Tags.remove_tag_from_segments(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.delete_tag_relationships_segments(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.remove_segments_from_tag(id, body)
```

#### [Tag Campaigns](https://developers.klaviyo.com/en/v2026-07-15/reference/tag_campaigns)

```ruby
KlaviyoAPI::Tags.tag_campaigns(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.create_tag_relationships_campaign(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.add_campaigns_to_tag(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.create_tag_relationships_campaigns(id, body)
```

#### [Tag Flows](https://developers.klaviyo.com/en/v2026-07-15/reference/tag_flows)

```ruby
KlaviyoAPI::Tags.tag_flows(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.create_tag_relationships_flow(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.add_flows_to_tag(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.create_tag_relationships_flows(id, body)
```

#### [Tag Lists](https://developers.klaviyo.com/en/v2026-07-15/reference/tag_lists)

```ruby
KlaviyoAPI::Tags.tag_lists(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.create_tag_relationships_list(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.add_lists_to_tag(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.create_tag_relationships_lists(id, body)
```

#### [Tag Segments](https://developers.klaviyo.com/en/v2026-07-15/reference/tag_segments)

```ruby
KlaviyoAPI::Tags.tag_segments(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.create_tag_relationships_segment(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.add_segments_to_tag(id, body)
```
##### Method alias:
```ruby
KlaviyoAPI::Tags.create_tag_relationships_segments(id, body)
```

#### [Update Tag](https://developers.klaviyo.com/en/v2026-07-15/reference/update_tag)

```ruby
KlaviyoAPI::Tags.update_tag(id, body)
```

#### [Update Tag Group](https://developers.klaviyo.com/en/v2026-07-15/reference/update_tag_group)

```ruby
KlaviyoAPI::Tags.update_tag_group(id, body)
```

## Templates

#### [Clone Template](https://developers.klaviyo.com/en/v2026-07-15/reference/clone_template)

```ruby
KlaviyoAPI::Templates.clone_template(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Templates.create_template_clone(body, opts)
```

#### [Create Template](https://developers.klaviyo.com/en/v2026-07-15/reference/create_template)

```ruby
KlaviyoAPI::Templates.create_template(body, opts)
```

#### [Create Universal Content](https://developers.klaviyo.com/en/v2026-07-15/reference/create_universal_content)

```ruby
KlaviyoAPI::Templates.create_universal_content(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Templates.create_template_universal_content(body, opts)
```

#### [Delete Template](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_template)

```ruby
KlaviyoAPI::Templates.delete_template(id)
```

#### [Delete Universal Content](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_universal_content)

```ruby
KlaviyoAPI::Templates.delete_universal_content(id)
```
##### Method alias:
```ruby
KlaviyoAPI::Templates.delete_template_universal_content(id)
```

#### [Get All Universal Content](https://developers.klaviyo.com/en/v2026-07-15/reference/get_all_universal_content)

```ruby
KlaviyoAPI::Templates.get_all_universal_content(opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Templates.get_template_universal_content(opts)
```

#### [Get Template](https://developers.klaviyo.com/en/v2026-07-15/reference/get_template)

```ruby
KlaviyoAPI::Templates.get_template(id, opts)
```

#### [Get Templates](https://developers.klaviyo.com/en/v2026-07-15/reference/get_templates)

```ruby
KlaviyoAPI::Templates.get_templates(opts)
```

#### [Get Universal Content](https://developers.klaviyo.com/en/v2026-07-15/reference/get_universal_content)

```ruby
KlaviyoAPI::Templates.get_universal_content(id, opts)
```

#### [Render Template](https://developers.klaviyo.com/en/v2026-07-15/reference/render_template)

```ruby
KlaviyoAPI::Templates.render_template(body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Templates.create_template_render(body, opts)
```

#### [Update Template](https://developers.klaviyo.com/en/v2026-07-15/reference/update_template)

```ruby
KlaviyoAPI::Templates.update_template(id, body, opts)
```

#### [Update Universal Content](https://developers.klaviyo.com/en/v2026-07-15/reference/update_universal_content)

```ruby
KlaviyoAPI::Templates.update_universal_content(id, body, opts)
```
##### Method alias:
```ruby
KlaviyoAPI::Templates.update_template_universal_content(id, body, opts)
```

## Tracking Settings

#### [Get Tracking Setting](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tracking_setting)

```ruby
KlaviyoAPI::TrackingSettings.get_tracking_setting(id, opts)
```

#### [Get Tracking Settings](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tracking_settings)

```ruby
KlaviyoAPI::TrackingSettings.get_tracking_settings(opts)
```

#### [Update Tracking Setting](https://developers.klaviyo.com/en/v2026-07-15/reference/update_tracking_setting)

```ruby
KlaviyoAPI::TrackingSettings.update_tracking_setting(id, body, opts)
```

## Web Feeds

#### [Create Web Feed](https://developers.klaviyo.com/en/v2026-07-15/reference/create_web_feed)

```ruby
KlaviyoAPI::WebFeeds.create_web_feed(body, opts)
```

#### [Delete Web Feed](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_web_feed)

```ruby
KlaviyoAPI::WebFeeds.delete_web_feed(id)
```

#### [Get Web Feed](https://developers.klaviyo.com/en/v2026-07-15/reference/get_web_feed)

```ruby
KlaviyoAPI::WebFeeds.get_web_feed(id, opts)
```

#### [Get Web Feeds](https://developers.klaviyo.com/en/v2026-07-15/reference/get_web_feeds)

```ruby
KlaviyoAPI::WebFeeds.get_web_feeds(opts)
```

#### [Update Web Feed](https://developers.klaviyo.com/en/v2026-07-15/reference/update_web_feed)

```ruby
KlaviyoAPI::WebFeeds.update_web_feed(id, body, opts)
```

## Webhooks

#### [Create Webhook](https://developers.klaviyo.com/en/v2026-07-15/reference/create_webhook)

```ruby
KlaviyoAPI::Webhooks.create_webhook(body, opts)
```

#### [Delete Webhook](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_webhook)

```ruby
KlaviyoAPI::Webhooks.delete_webhook(id)
```

#### [Get Webhook](https://developers.klaviyo.com/en/v2026-07-15/reference/get_webhook)

```ruby
KlaviyoAPI::Webhooks.get_webhook(id, opts)
```

#### [Get Webhook Topic](https://developers.klaviyo.com/en/v2026-07-15/reference/get_webhook_topic)

```ruby
KlaviyoAPI::Webhooks.get_webhook_topic(id, opts)
```

#### [Get Webhook Topics](https://developers.klaviyo.com/en/v2026-07-15/reference/get_webhook_topics)

```ruby
KlaviyoAPI::Webhooks.get_webhook_topics(opts)
```

#### [Get Webhooks](https://developers.klaviyo.com/en/v2026-07-15/reference/get_webhooks)

```ruby
KlaviyoAPI::Webhooks.get_webhooks(opts)
```

#### [Update Webhook](https://developers.klaviyo.com/en/v2026-07-15/reference/update_webhook)

```ruby
KlaviyoAPI::Webhooks.update_webhook(id, body, opts)
```

# Appendix

## Per Request API key
```ruby
response = KlaviyoAPI::Catalogs.get_catalog_items({
  header_params: {
    'Authorization': 'Klaviyo-API-Key your-api-key',
  },
  debug_auth_names: []
})
```

klaviyo-api-ruby

klaviyo-api-ruby Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

klaviyo-api-ruby

klaviyo-api-ruby Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README