Download the PHP package klaviyo/api without Composer
On this page you can find all versions of the php package klaviyo/api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Vendor klaviyo
Package api
Short Description PHP SDK for Klaviyo's API.
License MIT
Homepage https://developers.klaviyo.com
Package api
Short Description PHP SDK for Klaviyo's API.
License MIT
Homepage https://developers.klaviyo.com
FAQ
After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.
Example:
Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories.
In this case some credentials are needed to access such packages.
Please use the auth.json textarea to insert credentials, if a package is coming from a private repository.
You can look here for more information.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?
Informations about the package api
Klaviyo PHP SDK
- SDK version: 12.1.0
- API Revision: 2024-10-15
Helpful Resources
Design & Approach
This SDK is a thin wrapper around our API. See our API Reference for full documentation on behavior.
This SDK mirrors the organization and naming convention of the above language-agnostic resources, with a few namespace changes to conform to PHP idioms (details in Appendix).
Organization
This SDK is organized into the following resources:
-
Accounts
-
Campaigns
-
Catalogs
-
Coupons
-
DataPrivacy
-
Events
-
Flows
-
Forms
-
Images
-
Lists
-
Metrics
-
Profiles
-
Reporting
-
Reviews
-
Segments
-
Tags
-
Templates
-
TrackingSettings
- Webhooks
Installation
You can install this package using our Packagist package:
Usage Example
Note: The following examples use named arguments, which were introduced in PHP 8. If using an older version of PHP, you may need to explicitly pass omitted positional arguments. For example, if a given function has the following optional parameters
someFunction($a=1, $b=2, $c=3), and you wish to only set$b, you must pass insomeFunction($a=null, $b=$YOUR_VALUE).
Use Case Examples
How to use filtering, sorting, and spare fieldset JSON API features
Use Case: Get events associated with a specific metric, then return just the event properties sorted by oldest to newest datetime.
NOTE: the filter param values need to be url-encoded
How to filter based on datetime
Use Case: Get profiles that have been updated between two datetimes.
How to use pagination and the page[size] param
Use Case: Use cursor-based pagination to get the next 20 profile records.
NOTE: This page cursor value is exactly what is returned in the self/next/prev response values
How to add additional information to your API response via additional-fields and the includes parameter
Use Case: Get a specific profile, return an additional predictive analytics field, and also return the list objects associated with the profile.
How to use our relationship endpoints to see related resources
Use Case: Get all list memberships for a profile with the given profile_id.
How to see what Klaviyo objects are associated with a specific tag
Use Case: Get all campaigns associated with the given tag_id.
Uploading Image From File
When using $klaviyo->Images->uploadImageFromFile($file, $name), $file can be either a file path string OR a SplFileObject.
as a file path
as a SplFileObject
Retry behavior
- The SDK retries on resolvable errors, namely: rate limits (common) and server errors on Klaviyo's end (rare).
- The keyword arguments in the example above define retry behavior
- The time interval between retries is calculated using exponential backoff and the
Retry-Afterheader - If you wish to disable retries, set
$num_retries = 0 - the example is populated with the default values
- The time interval between retries is calculated using exponential backoff and the
- non-resolvable errors and resolvable errors which have timed out throw an
ApiException, detailed below.
Error Handling
This SDK throws an ApiException error when the server returns a non resolvable response, or a resolvable non-2XX response times out.
If you'd like to extend error handling beyond what the SDK supports natively, you can use the following methods to retrieve the corresponding attributes from the ApiException object:
getCode() : intgetMessage() : strgetResponseBody() : bytesgetResponseHeaders() : string[]
For example:
Important Notes
- The main difference between this SDK and the language-agnostic API Docs that the below endpoints link to is that this SDK automatically adds the
revisionheader corresponding to the SDK version. - Organization: Resource groups and functions 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. These summaries link directly to the corresponding section of the API reference.
- For example values / data types, as well as whether parameters are required/optional, please reference the corresponding API Reference link.
- Some keyword args are required for the API call to succeed, the API docs above are the source of truth regarding which keyword args are required.
- JSON payloads should be passed in as associative arrays
$api_keyis optional, as it is set at client-level. However, you can override the client key wherever by passing in$api_keyas the LAST optional param. Reminder: DO NOT use private API keys client-side / onsite.- Paging: Where applicable,
$page_cursorcan be passed in either as a parsed string, or as the entireself.linkresponse returned by paged API endpoints.
Comprehensive list of Operations & Parameters
Accounts
Get Account
Get Accounts
Campaigns
Assign Template to Campaign Message
Method alias:
Cancel Campaign Send
Method alias:
Create Campaign
Create Campaign Clone
Method alias:
Delete Campaign
Get Campaign
Get Campaign for Campaign Message
Method alias:
Get Campaign ID for Campaign Message
Method alias:
Get Campaign Message
Get Campaign Recipient Estimation
Get Campaign Recipient Estimation Job
Get Campaign Send Job
Get Campaigns
Get Message IDs for Campaign
Method alias:
Method alias:
Get Messages for Campaign
Method alias:
Method alias:
Get Tag IDs for Campaign
Method alias:
Get Tags for Campaign
Method alias:
Get Template for Campaign Message
Method alias:
Get Template ID for Campaign Message
Method alias:
Refresh Campaign Recipient Estimation
Method alias:
Send Campaign
Method alias:
Update Campaign
Update Campaign Message
Catalogs
Add Categories to Catalog Item
Method alias:
Method alias:
Method alias:
Add Items to Catalog Category
Method alias:
Method alias:
Bulk Create Catalog Categories
Method alias:
Method alias:
Bulk Create Catalog Items
Method alias:
Method alias:
Bulk Create Catalog Variants
Method alias:
Method alias:
Bulk Delete Catalog Categories
Method alias:
Method alias:
Bulk Delete Catalog Items
Method alias:
Method alias:
Bulk Delete Catalog Variants
Method alias:
Method alias:
Bulk Update Catalog Categories
Method alias:
Method alias:
Bulk Update Catalog Items
Method alias:
Method alias:
Bulk Update Catalog Variants
Method alias:
Method alias:
Create Back In Stock Subscription
Create Catalog Category
Create Catalog Item
Create Catalog Variant
Delete Catalog Category
Delete Catalog Item
Delete Catalog Variant
Get Bulk Create Catalog Items Job
Method alias:
Method alias:
Get Bulk Create Catalog Items Jobs
Method alias:
Method alias:
Get Bulk Delete Catalog Items Job
Method alias:
Method alias:
Get Bulk Delete Catalog Items Jobs
Method alias:
Method alias:
Get Bulk Update Catalog Items Job
Method alias:
Method alias:
Get Bulk Update Catalog Items Jobs
Method alias:
Method alias:
Get Catalog Categories
Get Catalog Category
Get Catalog Item
Get Catalog Items
Get Catalog Variant
Get Catalog Variants
Get Categories for Catalog Item
Method alias:
Get Category IDs for Catalog Item
Method alias:
Get Create Categories Job
Method alias:
Get Create Categories Jobs
Method alias:
Get Create Variants Job
Method alias:
Get Create Variants Jobs
Method alias:
Get Delete Categories Job
Method alias:
Get Delete Categories Jobs
Method alias:
Get Delete Variants Job
Method alias:
Get Delete Variants Jobs
Method alias:
Get Item IDs for Catalog Category
Method alias:
Get Items for Catalog Category
Method alias:
Get Update Categories Job
Method alias:
Get Update Categories Jobs
Method alias:
Get Update Variants Job
Method alias:
Get Update Variants Jobs
Method alias:
Get Variant IDs for Catalog Item
Method alias:
Get Variants for Catalog Item
Method alias:
Remove Categories from Catalog Item
Method alias:
Remove Items from Catalog Category
Method alias:
Update Catalog Category
Update Catalog Item
Update Catalog Variant
Update Categories for Catalog Item
Method alias:
Update Items for Catalog Category
Method alias:
Coupons
Bulk Create Coupon Codes
Method alias:
Method alias:
Create Coupon
Create Coupon Code
Delete Coupon
Delete Coupon Code
Get Bulk Create Coupon Code Jobs
Method alias:
Get Bulk Create Coupon Codes Job
Method alias:
Get Coupon
Get Coupon Code
Get Coupon Code IDs for Coupon
Method alias:
Method alias:
Method alias:
Get Coupon Codes
Get Coupon Codes for Coupon
Method alias:
Method alias:
Get Coupon For Coupon Code
Method alias:
Get Coupon ID for Coupon Code
Method alias:
Get Coupons
Update Coupon
Update Coupon Code
DataPrivacy
Request Profile Deletion
Method alias:
Events
Bulk Create Events
Method alias:
Create Event
Get Event
Get Events
Get Metric for Event
Method alias:
Get Metric ID for Event
## Positional Arguments
# $id | string
$klaviyo->Events->getMetricIdForEvent($id);Method alias:
$klaviyo->Events->getEventRelationshipsMetric($id);Get Profile for Event
## Positional Arguments
# $id | string
## Keyword Arguments
# $additional_fields_profile | string[]
# $fields_profile | string[]
$klaviyo->Events->getProfileForEvent($id, additional_fields_profile: $additional_fields_profile, fields_profile: $fields_profile);Method alias:
$klaviyo->Events->getEventProfile($id, additional_fields_profile: $additional_fields_profile, fields_profile: $fields_profile);Get Profile ID for Event
## Positional Arguments
# $id | string
$klaviyo->Events->getProfileIdForEvent($id);Method alias:
$klaviyo->Events->getEventRelationshipsProfile($id);Flows
Delete Flow
## Positional Arguments
# $id | string
$klaviyo->Flows->deleteFlow($id);Get Action for Flow Message
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_flow_action | string[]
$klaviyo->Flows->getActionForFlowMessage($id, fields_flow_action: $fields_flow_action);Method alias:
$klaviyo->Flows->getFlowMessageAction($id, fields_flow_action: $fields_flow_action);Get Action ID for Flow Message
## Positional Arguments
# $id | string
$klaviyo->Flows->getActionIdForFlowMessage($id);Method alias:
$klaviyo->Flows->getFlowMessageRelationshipsAction($id);Get Action IDs for Flow
## Positional Arguments
# $id | string
## Keyword Arguments
# $filter | string
# $page_size | int
# $sort | string
$klaviyo->Flows->getActionIdsForFlow($id, filter: $filter, page_size: $page_size, sort: $sort);Method alias:
$klaviyo->Flows->getFlowRelationshipsFlowActions($id, filter: $filter, page_size: $page_size, sort: $sort);Method alias:
$klaviyo->Flows->getFlowRelationshipsActions($id, filter: $filter, page_size: $page_size, sort: $sort);Get Actions for Flow
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_flow_action | string[]
# $filter | string
# $page_cursor | string
# $page_size | int
# $sort | string
$klaviyo->Flows->getActionsForFlow($id, fields_flow_action: $fields_flow_action, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Method alias:
$klaviyo->Flows->getFlowFlowActions($id, fields_flow_action: $fields_flow_action, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Method alias:
$klaviyo->Flows->getFlowActions($id, fields_flow_action: $fields_flow_action, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Get Flow
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_flow_action | string[]
# $fields_flow | string[]
# $fields_tag | string[]
# $include | string[]
$klaviyo->Flows->getFlow($id, fields_flow_action: $fields_flow_action, fields_flow: $fields_flow, fields_tag: $fields_tag, include: $include);Get Flow Action
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_flow_action | string[]
# $fields_flow_message | string[]
# $fields_flow | string[]
# $include | string[]
$klaviyo->Flows->getFlowAction($id, fields_flow_action: $fields_flow_action, fields_flow_message: $fields_flow_message, fields_flow: $fields_flow, include: $include);Get Flow for Flow Action
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_flow | string[]
$klaviyo->Flows->getFlowForFlowAction($id, fields_flow: $fields_flow);Method alias:
$klaviyo->Flows->getFlowActionFlow($id, fields_flow: $fields_flow);Get Flow ID for Flow Action
## Positional Arguments
# $id | string
$klaviyo->Flows->getFlowIdForFlowAction($id);Method alias:
$klaviyo->Flows->getFlowActionRelationshipsFlow($id);Get Flow Message
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_flow_action | string[]
# $fields_flow_message | string[]
# $fields_template | string[]
# $include | string[]
$klaviyo->Flows->getFlowMessage($id, fields_flow_action: $fields_flow_action, fields_flow_message: $fields_flow_message, fields_template: $fields_template, include: $include);Get Flows
## Keyword Arguments
# $fields_flow_action | string[]
# $fields_flow | string[]
# $fields_tag | string[]
# $filter | string
# $include | string[]
# $page_cursor | string
# $page_size | int
# $sort | string
$klaviyo->Flows->getFlows(fields_flow_action: $fields_flow_action, fields_flow: $fields_flow, fields_tag: $fields_tag, filter: $filter, include: $include, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Get Message IDs for Flow Action
## Positional Arguments
# $id | string
## Keyword Arguments
# $filter | string
# $page_cursor | string
# $page_size | int
# $sort | string
$klaviyo->Flows->getMessageIdsForFlowAction($id, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Method alias:
$klaviyo->Flows->getFlowActionRelationshipsMessages($id, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Get Messages for Flow Action
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_flow_message | string[]
# $filter | string
# $page_size | int
# $sort | string
$klaviyo->Flows->getMessagesForFlowAction($id, fields_flow_message: $fields_flow_message, filter: $filter, page_size: $page_size, sort: $sort);Method alias:
$klaviyo->Flows->getFlowActionMessages($id, fields_flow_message: $fields_flow_message, filter: $filter, page_size: $page_size, sort: $sort);Get Tag IDs for Flow
## Positional Arguments
# $id | string
$klaviyo->Flows->getTagIdsForFlow($id);Method alias:
$klaviyo->Flows->getFlowRelationshipsTags($id);Get Tags for Flow
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_tag | string[]
$klaviyo->Flows->getTagsForFlow($id, fields_tag: $fields_tag);Method alias:
$klaviyo->Flows->getFlowTags($id, fields_tag: $fields_tag);Get Template for Flow Message
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_template | string[]
$klaviyo->Flows->getTemplateForFlowMessage($id, fields_template: $fields_template);Method alias:
$klaviyo->Flows->getFlowMessageTemplate($id, fields_template: $fields_template);Get Template ID for Flow Message
## Positional Arguments
# $id | string
$klaviyo->Flows->getTemplateIdForFlowMessage($id);Method alias:
$klaviyo->Flows->getFlowMessageRelationshipsTemplate($id);Update Flow Status
## Positional Arguments
# $id | string
# $body | associative array
$klaviyo->Flows->updateFlow($id, $body);Forms
Get Form
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_form_version | string[]
# $fields_form | string[]
# $include | string[]
$klaviyo->Forms->getForm($id, fields_form_version: $fields_form_version, fields_form: $fields_form, include: $include);Get Form for Form Version
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_form | string[]
$klaviyo->Forms->getFormForFormVersion($id, fields_form: $fields_form);Method alias:
$klaviyo->Forms->getFormVersionForm($id, fields_form: $fields_form);Get Form ID for Form Version
## Positional Arguments
# $id | string
$klaviyo->Forms->getFormIdForFormVersion($id);Method alias:
$klaviyo->Forms->getFormVersionRelationshipsForm($id);Get Form Version
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_form_version | string[]
$klaviyo->Forms->getFormVersion($id, fields_form_version: $fields_form_version);Get Forms
## Keyword Arguments
# $fields_form | string[]
# $filter | string
# $page_cursor | string
# $page_size | int
# $sort | string
$klaviyo->Forms->getForms(fields_form: $fields_form, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Get Version IDs for Form
## Positional Arguments
# $id | string
## Keyword Arguments
# $filter | string
# $page_cursor | string
# $page_size | int
# $sort | string
$klaviyo->Forms->getVersionIdsForForm($id, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Method alias:
$klaviyo->Forms->getFormRelationshipsFormVersions($id, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Method alias:
$klaviyo->Forms->getFormRelationshipsVersions($id, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Get Versions for Form
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_form_version | string[]
# $filter | string
# $page_cursor | string
# $page_size | int
# $sort | string
$klaviyo->Forms->getVersionsForForm($id, fields_form_version: $fields_form_version, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Method alias:
$klaviyo->Forms->getFormFormVersions($id, fields_form_version: $fields_form_version, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Method alias:
$klaviyo->Forms->getFormVersions($id, fields_form_version: $fields_form_version, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Images
Get Image
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_image | string[]
$klaviyo->Images->getImage($id, fields_image: $fields_image);Get Images
## Keyword Arguments
# $fields_image | string[]
# $filter | string
# $page_cursor | string
# $page_size | int
# $sort | string
$klaviyo->Images->getImages(fields_image: $fields_image, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Update Image
## Positional Arguments
# $id | string
# $body | associative array
$klaviyo->Images->updateImage($id, $body);Upload Image From File
## Positional Arguments
# $file | \SplFileObject
## Keyword Arguments
# $name | string
# $hidden | bool
$klaviyo->Images->uploadImageFromFile($file, name: $name, hidden: $hidden);Method alias:
$klaviyo->Images->createImageUpload($file, name: $name, hidden: $hidden);Upload Image From URL
## Positional Arguments
# $body | associative array
$klaviyo->Images->uploadImageFromUrl($body);Method alias:
$klaviyo->Images->createImage($body);Lists
Add Profiles to List
## Positional Arguments
# $id | string
# $body | associative array
$klaviyo->Lists->addProfilesToList($id, $body);Method alias:
$klaviyo->Lists->createListRelationships($id, $body);Method alias:
$klaviyo->Lists->createListRelationshipsProfile($id, $body);Method alias:
$klaviyo->Lists->createListRelationshipsProfiles($id, $body);Create List
## Positional Arguments
# $body | associative array
$klaviyo->Lists->createList($body);Delete List
## Positional Arguments
# $id | string
$klaviyo->Lists->deleteList($id);Get Flows Triggered by List
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_flow | string[]
$klaviyo->Lists->getFlowsTriggeredByList($id, fields_flow: $fields_flow);Method alias:
$klaviyo->Lists->getFlowTriggersForList($id, fields_flow: $fields_flow);Method alias:
$klaviyo->Lists->getListFlowTriggers($id, fields_flow: $fields_flow);Get IDs for Flows Triggered by List
## Positional Arguments
# $id | string
$klaviyo->Lists->getIdsForFlowsTriggeredByList($id);Method alias:
$klaviyo->Lists->getFlowTriggerIdsForList($id);Method alias:
$klaviyo->Lists->getListRelationshipsFlowTriggers($id);Get List
## Positional Arguments
# $id | string
## Keyword Arguments
# $additional_fields_list | string[]
# $fields_flow | string[]
# $fields_list | string[]
# $fields_tag | string[]
# $include | string[]
$klaviyo->Lists->getList($id, additional_fields_list: $additional_fields_list, fields_flow: $fields_flow, fields_list: $fields_list, fields_tag: $fields_tag, include: $include);Get Lists
## Keyword Arguments
# $fields_flow | string[]
# $fields_list | string[]
# $fields_tag | string[]
# $filter | string
# $include | string[]
# $page_cursor | string
# $sort | string
$klaviyo->Lists->getLists(fields_flow: $fields_flow, fields_list: $fields_list, fields_tag: $fields_tag, filter: $filter, include: $include, page_cursor: $page_cursor, sort: $sort);Get Profile IDs for List
## Positional Arguments
# $id | string
## Keyword Arguments
# $filter | string
# $page_cursor | string
# $page_size | int
# $sort | string
$klaviyo->Lists->getProfileIdsForList($id, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Method alias:
$klaviyo->Lists->getListRelationshipsProfiles($id, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Get Profiles for List
## Positional Arguments
# $id | string
## Keyword Arguments
# $additional_fields_profile | string[]
# $fields_profile | string[]
# $filter | string
# $page_cursor | string
# $page_size | int
# $sort | string
$klaviyo->Lists->getProfilesForList($id, additional_fields_profile: $additional_fields_profile, fields_profile: $fields_profile, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Method alias:
$klaviyo->Lists->getListProfiles($id, additional_fields_profile: $additional_fields_profile, fields_profile: $fields_profile, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Get Tag IDs for List
## Positional Arguments
# $id | string
$klaviyo->Lists->getTagIdsForList($id);Method alias:
$klaviyo->Lists->getListRelationshipsTags($id);Get Tags for List
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_tag | string[]
$klaviyo->Lists->getTagsForList($id, fields_tag: $fields_tag);Method alias:
$klaviyo->Lists->getListTags($id, fields_tag: $fields_tag);Remove Profiles from List
## Positional Arguments
# $id | string
# $body | associative array
$klaviyo->Lists->removeProfilesFromList($id, $body);Method alias:
$klaviyo->Lists->deleteListRelationships($id, $body);Method alias:
$klaviyo->Lists->deleteListRelationshipsProfiles($id, $body);Update List
## Positional Arguments
# $id | string
# $body | associative array
$klaviyo->Lists->updateList($id, $body);Metrics
Get Flows Triggered by Metric
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_flow | string[]
$klaviyo->Metrics->getFlowsTriggeredByMetric($id, fields_flow: $fields_flow);Method alias:
$klaviyo->Metrics->getFlowTriggersForMetric($id, fields_flow: $fields_flow);Method alias:
$klaviyo->Metrics->getMetricFlowTriggers($id, fields_flow: $fields_flow);Get IDs for Flows Triggered by Metric
## Positional Arguments
# $id | string
$klaviyo->Metrics->getIdsForFlowsTriggeredByMetric($id);Method alias:
$klaviyo->Metrics->getFlowTriggerIdsForMetric($id);Method alias:
$klaviyo->Metrics->getMetricRelationshipsFlowTriggers($id);Get Metric
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_flow | string[]
# $fields_metric | string[]
# $include | string[]
$klaviyo->Metrics->getMetric($id, fields_flow: $fields_flow, fields_metric: $fields_metric, include: $include);Get Metric for Metric Property
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_metric | string[]
$klaviyo->Metrics->getMetricForMetricProperty($id, fields_metric: $fields_metric);Method alias:
$klaviyo->Metrics->getMetricPropertyMetric($id, fields_metric: $fields_metric);Get Metric ID for Metric Property
## Positional Arguments
# $id | string
$klaviyo->Metrics->getMetricIdForMetricProperty($id);Method alias:
$klaviyo->Metrics->getMetricPropertyRelationshipsMetric($id);Get Metric Property
## Positional Arguments
# $id | string
## Keyword Arguments
# $additional_fields_metric_property | string[]
# $fields_metric_property | string[]
# $fields_metric | string[]
# $include | string[]
$klaviyo->Metrics->getMetricProperty($id, additional_fields_metric_property: $additional_fields_metric_property, fields_metric_property: $fields_metric_property, fields_metric: $fields_metric, include: $include);Get Metrics
## Keyword Arguments
# $fields_flow | string[]
# $fields_metric | string[]
# $filter | string
# $include | string[]
# $page_cursor | string
$klaviyo->Metrics->getMetrics(fields_flow: $fields_flow, fields_metric: $fields_metric, filter: $filter, include: $include, page_cursor: $page_cursor);Get Properties for Metric
## Positional Arguments
# $id | string
## Keyword Arguments
# $additional_fields_metric_property | string[]
# $fields_metric_property | string[]
$klaviyo->Metrics->getPropertiesForMetric($id, additional_fields_metric_property: $additional_fields_metric_property, fields_metric_property: $fields_metric_property);Method alias:
$klaviyo->Metrics->getMetricMetricProperties($id, additional_fields_metric_property: $additional_fields_metric_property, fields_metric_property: $fields_metric_property);Method alias:
$klaviyo->Metrics->getMetricProperties($id, additional_fields_metric_property: $additional_fields_metric_property, fields_metric_property: $fields_metric_property);Get Property IDs for Metric
## Positional Arguments
# $id | string
$klaviyo->Metrics->getPropertyIdsForMetric($id);Method alias:
$klaviyo->Metrics->getMetricRelationshipsMetricProperties($id);Method alias:
$klaviyo->Metrics->getMetricRelationshipsProperties($id);Query Metric Aggregates
## Positional Arguments
# $body | associative array
$klaviyo->Metrics->queryMetricAggregates($body);Method alias:
$klaviyo->Metrics->createMetricAggregate($body);Profiles
Bulk Import Profiles
## Positional Arguments
# $body | associative array
$klaviyo->Profiles->bulkImportProfiles($body);Method alias:
$klaviyo->Profiles->spawnBulkProfileImportJob($body);Method alias:
$klaviyo->Profiles->createProfileBulkImportJob($body);Bulk Subscribe Profiles
## Positional Arguments
# $body | associative array
$klaviyo->Profiles->bulkSubscribeProfiles($body);Method alias:
$klaviyo->Profiles->subscribeProfiles($body);Method alias:
$klaviyo->Profiles->createProfileSubscriptionBulkCreateJob($body);Bulk Suppress Profiles
## Positional Arguments
# $body | associative array
$klaviyo->Profiles->bulkSuppressProfiles($body);Method alias:
$klaviyo->Profiles->suppressProfiles($body);Method alias:
$klaviyo->Profiles->createProfileSuppressionBulkCreateJob($body);Bulk Unsubscribe Profiles
## Positional Arguments
# $body | associative array
$klaviyo->Profiles->bulkUnsubscribeProfiles($body);Method alias:
$klaviyo->Profiles->unsubscribeProfiles($body);Method alias:
$klaviyo->Profiles->createProfileSubscriptionBulkDeleteJob($body);Bulk Unsuppress Profiles
## Positional Arguments
# $body | associative array
$klaviyo->Profiles->bulkUnsuppressProfiles($body);Method alias:
$klaviyo->Profiles->unsuppressProfiles($body);Method alias:
$klaviyo->Profiles->createProfileSuppressionBulkDeleteJob($body);Create or Update Profile
## Positional Arguments
# $body | associative array
## Keyword Arguments
# $additional_fields_profile | string[]
$klaviyo->Profiles->createOrUpdateProfile($body, additional_fields_profile: $additional_fields_profile);Method alias:
$klaviyo->Profiles->createProfileImport($body, additional_fields_profile: $additional_fields_profile);Create Profile
## Positional Arguments
# $body | associative array
## Keyword Arguments
# $additional_fields_profile | string[]
$klaviyo->Profiles->createProfile($body, additional_fields_profile: $additional_fields_profile);Create or Update Push Token
## Positional Arguments
# $body | associative array
$klaviyo->Profiles->createPushToken($body);Get Bulk Import Profiles Job
## Positional Arguments
# $job_id | string
## Keyword Arguments
# $fields_list | string[]
# $fields_profile_bulk_import_job | string[]
# $include | string[]
$klaviyo->Profiles->getBulkImportProfilesJob($job_id, fields_list: $fields_list, fields_profile_bulk_import_job: $fields_profile_bulk_import_job, include: $include);Method alias:
$klaviyo->Profiles->getBulkProfileImportJob($job_id, fields_list: $fields_list, fields_profile_bulk_import_job: $fields_profile_bulk_import_job, include: $include);Method alias:
$klaviyo->Profiles->getProfileBulkImportJob($job_id, fields_list: $fields_list, fields_profile_bulk_import_job: $fields_profile_bulk_import_job, include: $include);Get Bulk Import Profiles Jobs
## Keyword Arguments
# $fields_profile_bulk_import_job | string[]
# $filter | string
# $page_cursor | string
# $page_size | int
# $sort | string
$klaviyo->Profiles->getBulkImportProfilesJobs(fields_profile_bulk_import_job: $fields_profile_bulk_import_job, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Method alias:
$klaviyo->Profiles->getBulkProfileImportJobs(fields_profile_bulk_import_job: $fields_profile_bulk_import_job, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Method alias:
$klaviyo->Profiles->getProfileBulkImportJobs(fields_profile_bulk_import_job: $fields_profile_bulk_import_job, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Get Bulk Suppress Profiles Job
## Positional Arguments
# $job_id | string
## Keyword Arguments
# $fields_profile_suppression_bulk_create_job | string[]
$klaviyo->Profiles->getBulkSuppressProfilesJob($job_id, fields_profile_suppression_bulk_create_job: $fields_profile_suppression_bulk_create_job);Method alias:
$klaviyo->Profiles->getProfileSuppressionBulkCreateJob($job_id, fields_profile_suppression_bulk_create_job: $fields_profile_suppression_bulk_create_job);Get Bulk Suppress Profiles Jobs
## Keyword Arguments
# $fields_profile_suppression_bulk_create_job | string[]
# $filter | string
# $page_cursor | string
# $sort | string
$klaviyo->Profiles->getBulkSuppressProfilesJobs(fields_profile_suppression_bulk_create_job: $fields_profile_suppression_bulk_create_job, filter: $filter, page_cursor: $page_cursor, sort: $sort);Method alias:
$klaviyo->Profiles->getProfileSuppressionBulkCreateJobs(fields_profile_suppression_bulk_create_job: $fields_profile_suppression_bulk_create_job, filter: $filter, page_cursor: $page_cursor, sort: $sort);Get Bulk Unsuppress Profiles Job
## Positional Arguments
# $job_id | string
## Keyword Arguments
# $fields_profile_suppression_bulk_delete_job | string[]
$klaviyo->Profiles->getBulkUnsuppressProfilesJob($job_id, fields_profile_suppression_bulk_delete_job: $fields_profile_suppression_bulk_delete_job);Method alias:
$klaviyo->Profiles->getProfileSuppressionBulkDeleteJob($job_id, fields_profile_suppression_bulk_delete_job: $fields_profile_suppression_bulk_delete_job);Get Bulk Unsuppress Profiles Jobs
## Keyword Arguments
# $fields_profile_suppression_bulk_delete_job | string[]
# $filter | string
# $page_cursor | string
# $sort | string
$klaviyo->Profiles->getBulkUnsuppressProfilesJobs(fields_profile_suppression_bulk_delete_job: $fields_profile_suppression_bulk_delete_job, filter: $filter, page_cursor: $page_cursor, sort: $sort);Method alias:
$klaviyo->Profiles->getProfileSuppressionBulkDeleteJobs(fields_profile_suppression_bulk_delete_job: $fields_profile_suppression_bulk_delete_job, filter: $filter, page_cursor: $page_cursor, sort: $sort);Get Errors for Bulk Import Profiles Job
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_import_error | string[]
# $page_cursor | string
# $page_size | int
$klaviyo->Profiles->getErrorsForBulkImportProfilesJob($id, fields_import_error: $fields_import_error, page_cursor: $page_cursor, page_size: $page_size);Method alias:
$klaviyo->Profiles->getBulkProfileImportJobImportErrors($id, fields_import_error: $fields_import_error, page_cursor: $page_cursor, page_size: $page_size);Method alias:
$klaviyo->Profiles->getImportErrorsForProfileBulkImportJob($id, fields_import_error: $fields_import_error, page_cursor: $page_cursor, page_size: $page_size);Method alias:
$klaviyo->Profiles->getProfileBulkImportJobImportErrors($id, fields_import_error: $fields_import_error, page_cursor: $page_cursor, page_size: $page_size);Get List for Bulk Import Profiles Job
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_list | string[]
$klaviyo->Profiles->getListForBulkImportProfilesJob($id, fields_list: $fields_list);Method alias:
$klaviyo->Profiles->getBulkProfileImportJobLists($id, fields_list: $fields_list);Method alias:
$klaviyo->Profiles->getListsForProfileBulkImportJob($id, fields_list: $fields_list);Method alias:
$klaviyo->Profiles->getProfileBulkImportJobLists($id, fields_list: $fields_list);Get List IDs for Bulk Import Profiles Job
## Positional Arguments
# $id | string
$klaviyo->Profiles->getListIdsForBulkImportProfilesJob($id);Method alias:
$klaviyo->Profiles->getBulkProfileImportJobRelationshipsLists($id);Method alias:
$klaviyo->Profiles->getListIdsForProfileBulkImportJob($id);Method alias:
$klaviyo->Profiles->getProfileBulkImportJobRelationshipsLists($id);Get List IDs for Profile
## Positional Arguments
# $id | string
$klaviyo->Profiles->getListIdsForProfile($id);Method alias:
$klaviyo->Profiles->getProfileRelationshipsLists($id);Get Lists for Profile
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_list | string[]
$klaviyo->Profiles->getListsForProfile($id, fields_list: $fields_list);Method alias:
$klaviyo->Profiles->getProfileLists($id, fields_list: $fields_list);Get Profile
## Positional Arguments
# $id | string
## Keyword Arguments
# $additional_fields_profile | string[]
# $fields_list | string[]
# $fields_profile | string[]
# $fields_segment | string[]
# $include | string[]
$klaviyo->Profiles->getProfile($id, additional_fields_profile: $additional_fields_profile, fields_list: $fields_list, fields_profile: $fields_profile, fields_segment: $fields_segment, include: $include);Get Profile IDs for Bulk Import Profiles Job
## Positional Arguments
# $id | string
## Keyword Arguments
# $page_cursor | string
# $page_size | int
$klaviyo->Profiles->getProfileIdsForBulkImportProfilesJob($id, page_cursor: $page_cursor, page_size: $page_size);Method alias:
$klaviyo->Profiles->getBulkProfileImportJobRelationshipsProfiles($id, page_cursor: $page_cursor, page_size: $page_size);Method alias:
$klaviyo->Profiles->getProfileBulkImportJobRelationshipsProfiles($id, page_cursor: $page_cursor, page_size: $page_size);Method alias:
$klaviyo->Profiles->getProfileIdsForProfileBulkImportJob($id, page_cursor: $page_cursor, page_size: $page_size);Get Profiles
## Keyword Arguments
# $additional_fields_profile | string[]
# $fields_profile | string[]
# $filter | string
# $page_cursor | string
# $page_size | int
# $sort | string
$klaviyo->Profiles->getProfiles(additional_fields_profile: $additional_fields_profile, fields_profile: $fields_profile, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Get Profiles for Bulk Import Profiles Job
## Positional Arguments
# $id | string
## Keyword Arguments
# $additional_fields_profile | string[]
# $fields_profile | string[]
# $page_cursor | string
# $page_size | int
$klaviyo->Profiles->getProfilesForBulkImportProfilesJob($id, additional_fields_profile: $additional_fields_profile, fields_profile: $fields_profile, page_cursor: $page_cursor, page_size: $page_size);Method alias:
$klaviyo->Profiles->getBulkProfileImportJobProfiles($id, additional_fields_profile: $additional_fields_profile, fields_profile: $fields_profile, page_cursor: $page_cursor, page_size: $page_size);Method alias:
$klaviyo->Profiles->getProfileBulkImportJobProfiles($id, additional_fields_profile: $additional_fields_profile, fields_profile: $fields_profile, page_cursor: $page_cursor, page_size: $page_size);Method alias:
$klaviyo->Profiles->getProfilesForProfileBulkImportJob($id, additional_fields_profile: $additional_fields_profile, fields_profile: $fields_profile, page_cursor: $page_cursor, page_size: $page_size);Get Segment IDs for Profile
## Positional Arguments
# $id | string
$klaviyo->Profiles->getSegmentIdsForProfile($id);Method alias:
$klaviyo->Profiles->getProfileRelationshipsSegments($id);Get Segments for Profile
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_segment | string[]
$klaviyo->Profiles->getSegmentsForProfile($id, fields_segment: $fields_segment);Method alias:
$klaviyo->Profiles->getProfileSegments($id, fields_segment: $fields_segment);Merge Profiles
## Positional Arguments
# $body | associative array
$klaviyo->Profiles->mergeProfiles($body);Method alias:
$klaviyo->Profiles->createProfileMerge($body);Update Profile
## Positional Arguments
# $id | string
# $body | associative array
## Keyword Arguments
# $additional_fields_profile | string[]
$klaviyo->Profiles->updateProfile($id, $body, additional_fields_profile: $additional_fields_profile);Reporting
Query Campaign Values
## Positional Arguments
# $body | associative array
## Keyword Arguments
# $page_cursor | string
$klaviyo->Reporting->queryCampaignValues($body, page_cursor: $page_cursor);Method alias:
$klaviyo->Reporting->createCampaignValueReport($body, page_cursor: $page_cursor);Method alias:
$klaviyo->Reporting->createCampaignValuesReport($body, page_cursor: $page_cursor);Query Flow Series
## Positional Arguments
# $body | associative array
## Keyword Arguments
# $page_cursor | string
$klaviyo->Reporting->queryFlowSeries($body, page_cursor: $page_cursor);Method alias:
$klaviyo->Reporting->createFlowSeryReport($body, page_cursor: $page_cursor);Method alias:
$klaviyo->Reporting->createFlowSeriesReport($body, page_cursor: $page_cursor);Query Flow Values
## Positional Arguments
# $body | associative array
## Keyword Arguments
# $page_cursor | string
$klaviyo->Reporting->queryFlowValues($body, page_cursor: $page_cursor);Method alias:
$klaviyo->Reporting->createFlowValueReport($body, page_cursor: $page_cursor);Method alias:
$klaviyo->Reporting->createFlowValuesReport($body, page_cursor: $page_cursor);Query Form Series
## Positional Arguments
# $body | associative array
$klaviyo->Reporting->queryFormSeries($body);Method alias:
$klaviyo->Reporting->createFormSeryReport($body);Method alias:
$klaviyo->Reporting->createFormSeriesReport($body);Query Form Values
## Positional Arguments
# $body | associative array
$klaviyo->Reporting->queryFormValues($body);Method alias:
$klaviyo->Reporting->createFormValueReport($body);Method alias:
$klaviyo->Reporting->createFormValuesReport($body);Query Segment Series
## Positional Arguments
# $body | associative array
$klaviyo->Reporting->querySegmentSeries($body);Method alias:
$klaviyo->Reporting->createSegmentSeryReport($body);Method alias:
$klaviyo->Reporting->createSegmentSeriesReport($body);Query Segment Values
## Positional Arguments
# $body | associative array
$klaviyo->Reporting->querySegmentValues($body);Method alias:
$klaviyo->Reporting->createSegmentValueReport($body);Method alias:
$klaviyo->Reporting->createSegmentValuesReport($body);Reviews
Get Review
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_event | string[]
# $fields_review | string[]
# $include | string[]
$klaviyo->Reviews->getReview($id, fields_event: $fields_event, fields_review: $fields_review, include: $include);Get Reviews
## Keyword Arguments
# $fields_event | string[]
# $fields_review | string[]
# $filter | string
# $include | string[]
# $page_cursor | string
# $page_size | int
# $sort | string
$klaviyo->Reviews->getReviews(fields_event: $fields_event, fields_review: $fields_review, filter: $filter, include: $include, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Segments
Create Segment
## Positional Arguments
# $body | associative array
$klaviyo->Segments->createSegment($body);Delete Segment
## Positional Arguments
# $id | string
$klaviyo->Segments->deleteSegment($id);Get Flows Triggered by Segment
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_flow | string[]
$klaviyo->Segments->getFlowsTriggeredBySegment($id, fields_flow: $fields_flow);Method alias:
$klaviyo->Segments->getFlowTriggersForSegment($id, fields_flow: $fields_flow);Method alias:
$klaviyo->Segments->getSegmentFlowTriggers($id, fields_flow: $fields_flow);Get IDs for Flows Triggered by Segment
## Positional Arguments
# $id | string
$klaviyo->Segments->getIdsForFlowsTriggeredBySegment($id);Method alias:
$klaviyo->Segments->getFlowTriggerIdsForSegment($id);Method alias:
$klaviyo->Segments->getSegmentRelationshipsFlowTriggers($id);Get Profile IDs for Segment
## Positional Arguments
# $id | string
## Keyword Arguments
# $filter | string
# $page_cursor | string
# $page_size | int
# $sort | string
$klaviyo->Segments->getProfileIdsForSegment($id, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Method alias:
$klaviyo->Segments->getSegmentRelationshipsProfiles($id, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Get Profiles for Segment
## Positional Arguments
# $id | string
## Keyword Arguments
# $additional_fields_profile | string[]
# $fields_profile | string[]
# $filter | string
# $page_cursor | string
# $page_size | int
# $sort | string
$klaviyo->Segments->getProfilesForSegment($id, additional_fields_profile: $additional_fields_profile, fields_profile: $fields_profile, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Method alias:
$klaviyo->Segments->getSegmentProfiles($id, additional_fields_profile: $additional_fields_profile, fields_profile: $fields_profile, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Get Segment
## Positional Arguments
# $id | string
## Keyword Arguments
# $additional_fields_segment | string[]
# $fields_flow | string[]
# $fields_segment | string[]
# $fields_tag | string[]
# $include | string[]
$klaviyo->Segments->getSegment($id, additional_fields_segment: $additional_fields_segment, fields_flow: $fields_flow, fields_segment: $fields_segment, fields_tag: $fields_tag, include: $include);Get Segments
## Keyword Arguments
# $fields_flow | string[]
# $fields_segment | string[]
# $fields_tag | string[]
# $filter | string
# $include | string[]
# $page_cursor | string
# $sort | string
$klaviyo->Segments->getSegments(fields_flow: $fields_flow, fields_segment: $fields_segment, fields_tag: $fields_tag, filter: $filter, include: $include, page_cursor: $page_cursor, sort: $sort);Get Tag IDs for Segment
## Positional Arguments
# $id | string
$klaviyo->Segments->getTagIdsForSegment($id);Method alias:
$klaviyo->Segments->getSegmentRelationshipsTags($id);Get Tags for Segment
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_tag | string[]
$klaviyo->Segments->getTagsForSegment($id, fields_tag: $fields_tag);Method alias:
$klaviyo->Segments->getSegmentTags($id, fields_tag: $fields_tag);Update Segment
## Positional Arguments
# $id | string
# $body | associative array
$klaviyo->Segments->updateSegment($id, $body);Tags
Create Tag
## Positional Arguments
# $body | associative array
$klaviyo->Tags->createTag($body);Create Tag Group
## Positional Arguments
# $body | associative array
$klaviyo->Tags->createTagGroup($body);Delete Tag
## Positional Arguments
# $id | string
$klaviyo->Tags->deleteTag($id);Delete Tag Group
## Positional Arguments
# $id | string
$klaviyo->Tags->deleteTagGroup($id);Get Campaign IDs for Tag
## Positional Arguments
# $id | string
$klaviyo->Tags->getCampaignIdsForTag($id);Method alias:
$klaviyo->Tags->getTagRelationshipsCampaigns($id);Get Flow IDs for Tag
## Positional Arguments
# $id | string
$klaviyo->Tags->getFlowIdsForTag($id);Method alias:
$klaviyo->Tags->getTagRelationshipsFlows($id);Get List IDs for Tag
## Positional Arguments
# $id | string
$klaviyo->Tags->getListIdsForTag($id);Method alias:
$klaviyo->Tags->getTagRelationshipsLists($id);Get Segment IDs for Tag
## Positional Arguments
# $id | string
$klaviyo->Tags->getSegmentIdsForTag($id);Method alias:
$klaviyo->Tags->getTagRelationshipsSegments($id);Get Tag
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_tag_group | string[]
# $fields_tag | string[]
# $include | string[]
$klaviyo->Tags->getTag($id, fields_tag_group: $fields_tag_group, fields_tag: $fields_tag, include: $include);Get Tag Group
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_tag_group | string[]
$klaviyo->Tags->getTagGroup($id, fields_tag_group: $fields_tag_group);Get Tag Group for Tag
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_tag_group | string[]
$klaviyo->Tags->getTagGroupForTag($id, fields_tag_group: $fields_tag_group);Method alias:
$klaviyo->Tags->getTagTagGroup($id, fields_tag_group: $fields_tag_group);Method alias:
$klaviyo->Tags->getGroupForTag($id, fields_tag_group: $fields_tag_group);Get Tag Group ID for Tag
## Positional Arguments
# $id | string
$klaviyo->Tags->getTagGroupIdForTag($id);Method alias:
$klaviyo->Tags->getTagRelationshipsTagGroup($id);Method alias:
$klaviyo->Tags->getGroupIdForTag($id);Method alias:
$klaviyo->Tags->getTagRelationshipsGroup($id);Get Tag Groups
## Keyword Arguments
# $fields_tag_group | string[]
# $filter | string
# $page_cursor | string
# $sort | string
$klaviyo->Tags->getTagGroups(fields_tag_group: $fields_tag_group, filter: $filter, page_cursor: $page_cursor, sort: $sort);Get Tag IDs for Tag Group
## Positional Arguments
# $id | string
$klaviyo->Tags->getTagIdsForTagGroup($id);Method alias:
$klaviyo->Tags->getTagGroupRelationshipsTags($id);Get Tags
## Keyword Arguments
# $fields_tag_group | string[]
# $fields_tag | string[]
# $filter | string
# $include | string[]
# $page_cursor | string
# $sort | string
$klaviyo->Tags->getTags(fields_tag_group: $fields_tag_group, fields_tag: $fields_tag, filter: $filter, include: $include, page_cursor: $page_cursor, sort: $sort);Get Tags for Tag Group
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_tag | string[]
$klaviyo->Tags->getTagsForTagGroup($id, fields_tag: $fields_tag);Method alias:
$klaviyo->Tags->getTagGroupTags($id, fields_tag: $fields_tag);Remove Tag from Campaigns
## Positional Arguments
# $id | string
# $body | associative array
$klaviyo->Tags->removeTagFromCampaigns($id, $body);Method alias:
$klaviyo->Tags->deleteTagRelationshipsCampaigns($id, $body);Method alias:
$klaviyo->Tags->removeCampaignsFromTag($id, $body);Remove Tag from Flows
## Positional Arguments
# $id | string
# $body | associative array
$klaviyo->Tags->removeTagFromFlows($id, $body);Method alias:
$klaviyo->Tags->deleteTagRelationshipsFlows($id, $body);Method alias:
$klaviyo->Tags->removeFlowsFromTag($id, $body);Remove Tag from Lists
## Positional Arguments
# $id | string
# $body | associative array
$klaviyo->Tags->removeTagFromLists($id, $body);Method alias:
$klaviyo->Tags->deleteTagRelationshipsLists($id, $body);Method alias:
$klaviyo->Tags->removeListsFromTag($id, $body);Remove Tag from Segments
## Positional Arguments
# $id | string
# $body | associative array
$klaviyo->Tags->removeTagFromSegments($id, $body);Method alias:
$klaviyo->Tags->deleteTagRelationshipsSegments($id, $body);Method alias:
$klaviyo->Tags->removeSegmentsFromTag($id, $body);Tag Campaigns
## Positional Arguments
# $id | string
# $body | associative array
$klaviyo->Tags->tagCampaigns($id, $body);Method alias:
$klaviyo->Tags->createTagRelationshipsCampaign($id, $body);Method alias:
$klaviyo->Tags->addCampaignsToTag($id, $body);Method alias:
$klaviyo->Tags->createTagRelationshipsCampaigns($id, $body);Tag Flows
## Positional Arguments
# $id | string
# $body | associative array
$klaviyo->Tags->tagFlows($id, $body);Method alias:
$klaviyo->Tags->createTagRelationshipsFlow($id, $body);Method alias:
$klaviyo->Tags->addFlowsToTag($id, $body);Method alias:
$klaviyo->Tags->createTagRelationshipsFlows($id, $body);Tag Lists
## Positional Arguments
# $id | string
# $body | associative array
$klaviyo->Tags->tagLists($id, $body);Method alias:
$klaviyo->Tags->createTagRelationshipsList($id, $body);Method alias:
$klaviyo->Tags->addListsToTag($id, $body);Method alias:
$klaviyo->Tags->createTagRelationshipsLists($id, $body);Tag Segments
## Positional Arguments
# $id | string
# $body | associative array
$klaviyo->Tags->tagSegments($id, $body);Method alias:
$klaviyo->Tags->createTagRelationshipsSegment($id, $body);Method alias:
$klaviyo->Tags->addSegmentsToTag($id, $body);Method alias:
$klaviyo->Tags->createTagRelationshipsSegments($id, $body);Update Tag
## Positional Arguments
# $id | string
# $body | associative array
$klaviyo->Tags->updateTag($id, $body);Update Tag Group
## Positional Arguments
# $id | string
# $body | associative array
$klaviyo->Tags->updateTagGroup($id, $body);Templates
Clone Template
## Positional Arguments
# $body | associative array
$klaviyo->Templates->cloneTemplate($body);Method alias:
$klaviyo->Templates->createTemplateClone($body);Create Template
## Positional Arguments
# $body | associative array
$klaviyo->Templates->createTemplate($body);Create Universal Content
## Positional Arguments
# $body | associative array
$klaviyo->Templates->createUniversalContent($body);Method alias:
$klaviyo->Templates->createTemplateUniversalContent($body);Delete Template
## Positional Arguments
# $id | string
$klaviyo->Templates->deleteTemplate($id);Delete Universal Content
## Positional Arguments
# $id | string
$klaviyo->Templates->deleteUniversalContent($id);Method alias:
$klaviyo->Templates->deleteTemplateUniversalContent($id);Get All Universal Content
## Keyword Arguments
# $fields_template_universal_content | string[]
# $filter | string
# $page_cursor | string
# $page_size | int
# $sort | string
$klaviyo->Templates->getAllUniversalContent(fields_template_universal_content: $fields_template_universal_content, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Method alias:
$klaviyo->Templates->getTemplateUniversalContent(fields_template_universal_content: $fields_template_universal_content, filter: $filter, page_cursor: $page_cursor, page_size: $page_size, sort: $sort);Get Template
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_template | string[]
$klaviyo->Templates->getTemplate($id, fields_template: $fields_template);Get Templates
## Keyword Arguments
# $fields_template | string[]
# $filter | string
# $page_cursor | string
# $sort | string
$klaviyo->Templates->getTemplates(fields_template: $fields_template, filter: $filter, page_cursor: $page_cursor, sort: $sort);Get Universal Content
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_template_universal_content | string[]
$klaviyo->Templates->getUniversalContent($id, fields_template_universal_content: $fields_template_universal_content);Render Template
## Positional Arguments
# $body | associative array
$klaviyo->Templates->renderTemplate($body);Method alias:
$klaviyo->Templates->createTemplateRender($body);Update Template
## Positional Arguments
# $id | string
# $body | associative array
$klaviyo->Templates->updateTemplate($id, $body);Update Universal Content
## Positional Arguments
# $id | string
# $body | associative array
$klaviyo->Templates->updateUniversalContent($id, $body);Method alias:
$klaviyo->Templates->updateTemplateUniversalContent($id, $body);TrackingSettings
Get Tracking Setting
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_tracking_setting | string[]
$klaviyo->TrackingSettings->getTrackingSetting($id, fields_tracking_setting: $fields_tracking_setting);Get Tracking Settings
## Keyword Arguments
# $fields_tracking_setting | string[]
# $page_cursor | string
# $page_size | int
$klaviyo->TrackingSettings->getTrackingSettings(fields_tracking_setting: $fields_tracking_setting, page_cursor: $page_cursor, page_size: $page_size);Update Tracking Setting
## Positional Arguments
# $id | string
# $body | associative array
$klaviyo->TrackingSettings->updateTrackingSetting($id, $body);Webhooks
Create Webhook
## Positional Arguments
# $body | associative array
$klaviyo->Webhooks->createWebhook($body);Delete Webhook
## Positional Arguments
# $id | string
$klaviyo->Webhooks->deleteWebhook($id);Get Webhook
## Positional Arguments
# $id | string
## Keyword Arguments
# $fields_webhook | string[]
# $include | string[]
$klaviyo->Webhooks->getWebhook($id, fields_webhook: $fields_webhook, include: $include);Get Webhook Topic
## Positional Arguments
# $id | string
$klaviyo->Webhooks->getWebhookTopic($id);Get Webhook Topics
$klaviyo->Webhooks->getWebhookTopics();Get Webhooks
## Keyword Arguments
# $fields_webhook | string[]
# $include | string[]
$klaviyo->Webhooks->getWebhooks(fields_webhook: $fields_webhook, include: $include);Update Webhook
## Positional Arguments
# $id | string
# $body | associative array
$klaviyo->Webhooks->updateWebhook($id, $body);Appendix
Global Keyword args
NOTES:
- These are arguments that you can apply to any endpoint call, and which are unique to the SDK.
- They come LAST, AFTER ALL the endpoint-specific keyword args listed above, in the same order they are listed below.
- They are subject to the same quirks as any other PHP keyword args, in that to be included, they need to be preceeded by all keyword args listed before them. This includes all endpoint-specific keyword args for a given endpoint, along with any preceeding global keyword args listed below, if applicable. This holds even if those other keyword args are not being used; in that case, set those to
null, but again, they must be included.
We currently support the following global keyword args:
$apiKey: use this to override the client-levelapi_key, which you define upon client instantiation.
Namespace
In the interest of making the SDK conform to PHP idioms, we made the following namespace changes relative to the language agnostic resources up top (API Docs, Guides, etc).
- Underscores are stripped from function names (operation IDs)
- Function names use camelCase (e.g.
getMetrics) - Resource names use PascalCase (e.g.
Metrics) - Parameter names remain unchanged
Parameters & Arguments
We stick to the following convention for parameters/arguments
- All parameters are passed as function args.
- All optional params, as well as all Body and Form Data params (including required ones), are passed as keyword args.
- All query and path params that are tagged as
requiredin the docs are passed as positional args. $api_keyis optional, as it is set at client level. However, you can override the client key wherever by passing in$api_keyas the LAST optional param. Reminder: don't do this client-side.
All versions of api with dependencies
PHP Build Version
Package Version
Requires
php Version
^7.4 || ^8.0
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.3
guzzlehttp/psr7 Version ^1.7 || ^2.0
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.3
guzzlehttp/psr7 Version ^1.7 || ^2.0
The package klaviyo/api contains the following files
Loading the files please wait ....