PHP code example of klaviyo / api

1. Go to this page and download the library: Download klaviyo/api library. Choose the download type require.

2. Extract the ZIP file and open the index.php.

3. Add this code to the index.php.

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

klaviyo / api example snippets



KlaviyoAPI\KlaviyoAPI;

$klaviyo = new KlaviyoAPI(
    'YOUR_API_KEY',
    num_retries: 3,
    guzzle_options: [],
    user_agent_suffix: "/YOUR_APP_NAME");

$response = $klaviyo->Metrics->getMetrics();


$klaviyo->Events->getEvents(
    fields_event: ['event_properties'],
    filter: "equals(metric_id,\"UMTLbD\")",
    sort: '-datetime'
);


$klaviyo->Profiles->getProfiles(
    filter: 'less-than(updated,2023-04-26T00:00:00Z),greater-than(updated,2023-04-19T00:00:00Z)'
);


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


$klaviyo->Profiles->getProfile(
    '01F3ZZNHPY4YZFVGNBH5THCNXE', 
    additional_fields_profile: ['predictive_analytics'],


$klaviyo->Profiles->getProfileRelationshipsLists('01GDDKASAP8TKDDA2GRZDSVP4H');


$klaviyo->Tags->getTagRelationshipsCampaigns('f4bc6670-1aa5-47df-827a-d30a7e543088');


$filepath = '/path/to/image.png';
$klaviyo->Images->uploadImageFromFile($filepath);


$filepath = '/path/to/image.png';
$file = new SplFileObject($filepath);
$klaviyo->Images->uploadImageFromFile($file);


try { 
  $klaviyo.Metrics.getMetrics();
} catch (Exception $e) {
  if ($e->getCode() == SOME_INTEGER) {
    doSomething();
  }
}


## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_account | string[]

$klaviyo->Accounts->getAccount($id, fields_account: $fields_account);



## Keyword Arguments

# $fields_account | string[]

$klaviyo->Accounts->getAccounts(fields_account: $fields_account);


## Positional Arguments

# $body | associative array

$klaviyo->Campaigns->assignTemplateToCampaignMessage($body);


$klaviyo->Campaigns->createCampaignMessageAssignTemplate($body);


## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Campaigns->cancelCampaignSend($id, $body);


$klaviyo->Campaigns->updateCampaignSendJob($id, $body);


## Positional Arguments

# $body | associative array

$klaviyo->Campaigns->createCampaign($body);


## Positional Arguments

# $body | associative array

$klaviyo->Campaigns->createCampaignClone($body);


$klaviyo->Campaigns->cloneCampaign($body);


## Positional Arguments

# $id | string

$klaviyo->Campaigns->deleteCampaign($id);


## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_campaign_message | string[]
# $fields_campaign | string[]
# $fields_tag | string[]
# $ $


## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_campaign | string[]

$klaviyo->Campaigns->getCampaignForCampaignMessage($id, fields_campaign: $fields_campaign);


$klaviyo->Campaigns->getCampaignMessageCampaign($id, fields_campaign: $fields_campaign);


## Positional Arguments

# $id | string

$klaviyo->Campaigns->getCampaignIdForCampaignMessage($id);


$klaviyo->Campaigns->getCampaignMessageRelationshipsCampaign($id);


## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_campaign_message | string[]
# $fields_campaign | string[]
# $fields_template | string[]
# $te,


## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_campaign_recipient_estimation | string[]

$klaviyo->Campaigns->getCampaignRecipientEstimation($id, fields_campaign_recipient_estimation: $fields_campaign_recipient_estimation);


## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_campaign_recipient_estimation_job | string[]

$klaviyo->Campaigns->getCampaignRecipientEstimationJob($id, fields_campaign_recipient_estimation_job: $fields_campaign_recipient_estimation_job);


## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_campaign_send_job | string[]

$klaviyo->Campaigns->getCampaignSendJob($id, fields_campaign_send_job: $fields_campaign_send_job);


## Positional Arguments

# $filter | string

## Keyword Arguments

# $fields_campaign_message | string[]
# $fields_campaign | string[]
# $fields_tag | string[]
# $ampaign, fields_tag: $fields_tag,


## Positional Arguments

# $id | string

$klaviyo->Campaigns->getMessageIdsForCampaign($id);


$klaviyo->Campaigns->getCampaignRelationshipsCampaignMessages($id);


$klaviyo->Campaigns->getCampaignRelationshipsMessages($id);


## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_campaign_message | string[]
# $fields_campaign | string[]
# $fields_template | string[]
# $mplate,


$klaviyo->Campaigns->getCampaignCampaignMessages($id, fields_campaign_message: $fields_campaign_message, fields_campaign: $fields_campaign, fields_template: $fields_template,


$klaviyo->Campaigns->getCampaignMessages($id, fields_campaign_message: $fields_campaign_message, fields_campaign: $fields_campaign, fields_template: $fields_template,


## Positional Arguments

# $id | string

$klaviyo->Campaigns->getTagIdsForCampaign($id);


$klaviyo->Campaigns->getCampaignRelationshipsTags($id);


## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_tag | string[]

$klaviyo->Campaigns->getTagsForCampaign($id, fields_tag: $fields_tag);


$klaviyo->Campaigns->getCampaignTags($id, fields_tag: $fields_tag);


## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_template | string[]

$klaviyo->Campaigns->getTemplateForCampaignMessage($id, fields_template: $fields_template);


$klaviyo->Campaigns->getCampaignMessageTemplate($id, fields_template: $fields_template);


## Positional Arguments

# $id | string

$klaviyo->Campaigns->getTemplateIdForCampaignMessage($id);


$klaviyo->Campaigns->getCampaignMessageRelationshipsTemplate($id);


## Positional Arguments

# $body | associative array

$klaviyo->Campaigns->refreshCampaignRecipientEstimation($body);


$klaviyo->Campaigns->createCampaignRecipientEstimationJob($body);


## Positional Arguments

# $body | associative array

$klaviyo->Campaigns->sendCampaign($body);


$klaviyo->Campaigns->createCampaignSendJob($body);


## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Campaigns->updateCampaign($id, $body);


## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Campaigns->updateCampaignMessage($id, $body);


## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Catalogs->addCategoriesToCatalogItem($id, $body);


$klaviyo->Catalogs->addCategoryToCatalogItem($id, $body);


$klaviyo->Catalogs->createCatalogItemRelationshipsCategory($id, $body);


$klaviyo->Catalogs->createCatalogItemRelationshipsCategories($id, $body);


## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Catalogs->addItemsToCatalogCategory($id, $body);


$klaviyo->Catalogs->createCatalogCategoryRelationshipsItem($id, $body);


$klaviyo->Catalogs->createCatalogCategoryRelationshipsItems($id, $body);


## Positional Arguments

# $body | associative array

$klaviyo->Catalogs->bulkCreateCatalogCategories($body);


$klaviyo->Catalogs->spawnCreateCategoriesJob($body);


$klaviyo->Catalogs->createCatalogCategoryBulkCreateJob($body);


## Positional Arguments

# $body | associative array

$klaviyo->Catalogs->bulkCreateCatalogItems($body);


$klaviyo->Catalogs->spawnCreateItemsJob($body);


$klaviyo->Catalogs->createCatalogItemBulkCreateJob($body);


## Positional Arguments

# $body | associative array

$klaviyo->Catalogs->bulkCreateCatalogVariants($body);


$klaviyo->Catalogs->spawnCreateVariantsJob($body);


$klaviyo->Catalogs->createCatalogVariantBulkCreateJob($body);


## Positional Arguments

# $body | associative array

$klaviyo->Catalogs->bulkDeleteCatalogCategories($body);


$klaviyo->Catalogs->spawnDeleteCategoriesJob($body);


$klaviyo->Catalogs->createCatalogCategoryBulkDeleteJob($body);


## Positional Arguments

# $body | associative array

$klaviyo->Catalogs->bulkDeleteCatalogItems($body);


$klaviyo->Catalogs->spawnDeleteItemsJob($body);


$klaviyo->Catalogs->createCatalogItemBulkDeleteJob($body);


## Positional Arguments

# $body | associative array

$klaviyo->Catalogs->bulkDeleteCatalogVariants($body);


$klaviyo->Catalogs->spawnDeleteVariantsJob($body);


$klaviyo->Catalogs->createCatalogVariantBulkDeleteJob($body);


## Positional Arguments

# $body | associative array

$klaviyo->Catalogs->bulkUpdateCatalogCategories($body);


$klaviyo->Catalogs->spawnUpdateCategoriesJob($body);


$klaviyo->Catalogs->createCatalogCategoryBulkUpdateJob($body);


## Positional Arguments

# $body | associative array

$klaviyo->Catalogs->bulkUpdateCatalogItems($body);


$klaviyo->Catalogs->spawnUpdateItemsJob($body);


$klaviyo->Catalogs->createCatalogItemBulkUpdateJob($body);


## Positional Arguments

# $body | associative array

$klaviyo->Catalogs->bulkUpdateCatalogVariants($body);


$klaviyo->Catalogs->spawnUpdateVariantsJob($body);


$klaviyo->Catalogs->createCatalogVariantBulkUpdateJob($body);


## Positional Arguments

# $body | associative array

$klaviyo->Catalogs->createBackInStockSubscription($body);


## Positional Arguments

# $body | associative array

$klaviyo->Catalogs->createCatalogCategory($body);


## Positional Arguments

# $body | associative array

$klaviyo->Catalogs->createCatalogItem($body);


## Positional Arguments

# $body | associative array

$klaviyo->Catalogs->createCatalogVariant($body);


## Positional Arguments

# $id | string

$klaviyo->Catalogs->deleteCatalogCategory($id);


## Positional Arguments

# $id | string

$klaviyo->Catalogs->deleteCatalogItem($id);


## Positional Arguments

# $id | string

$klaviyo->Catalogs->deleteCatalogVariant($id);


## Positional Arguments

# $job_id | string

## Keyword Arguments

# $fields_catalog_item_bulk_create_job | string[]
# $fields_catalog_item | string[]
# $: $fields_catalog_item,


$klaviyo->Catalogs->getCreateItemsJob($job_id, fields_catalog_item_bulk_create_job: $fields_catalog_item_bulk_create_job, fields_catalog_item: $fields_catalog_item,


$klaviyo->Catalogs->getCatalogItemBulkCreateJob($job_id, fields_catalog_item_bulk_create_job: $fields_catalog_item_bulk_create_job, fields_catalog_item: $fields_catalog_item,



## Keyword Arguments

# $fields_catalog_item_bulk_create_job | string[]
# $filter | string
# $page_cursor | string

$klaviyo->Catalogs->getBulkCreateCatalogItemsJobs(fields_catalog_item_bulk_create_job: $fields_catalog_item_bulk_create_job, filter: $filter, page_cursor: $page_cursor);


$klaviyo->Catalogs->getCreateItemsJobs(fields_catalog_item_bulk_create_job: $fields_catalog_item_bulk_create_job, filter: $filter, page_cursor: $page_cursor);


$klaviyo->Catalogs->getCatalogItemBulkCreateJobs(fields_catalog_item_bulk_create_job: $fields_catalog_item_bulk_create_job, filter: $filter, page_cursor: $page_cursor);


## Positional Arguments

# $job_id | string

## Keyword Arguments

# $fields_catalog_item_bulk_delete_job | string[]

$klaviyo->Catalogs->getBulkDeleteCatalogItemsJob($job_id, fields_catalog_item_bulk_delete_job: $fields_catalog_item_bulk_delete_job);


$klaviyo->Catalogs->getDeleteItemsJob($job_id, fields_catalog_item_bulk_delete_job: $fields_catalog_item_bulk_delete_job);


$klaviyo->Catalogs->getCatalogItemBulkDeleteJob($job_id, fields_catalog_item_bulk_delete_job: $fields_catalog_item_bulk_delete_job);

php
## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_catalog_category | string[]

$klaviyo->Catalogs->getCatalogCategory($id, fields_catalog_category: $fields_catalog_category);

php
## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_catalog_item | string[]
# $fields_catalog_variant | string[]
# $e: $

php
## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_catalog_variant | string[]

$klaviyo->Catalogs->getCatalogVariant($id, fields_catalog_variant: $fields_catalog_variant);

php
$klaviyo->Catalogs->getCatalogItemCategories($id, fields_catalog_category: $fields_catalog_category, filter: $filter, page_cursor: $page_cursor, sort: $sort);

php
$klaviyo->Catalogs->getCatalogItemRelationshipsCategories($id, filter: $filter, page_cursor: $page_cursor, sort: $sort);

php
$klaviyo->Catalogs->getCatalogCategoryBulkCreateJob($job_id, fields_catalog_category_bulk_create_job: $fields_catalog_category_bulk_create_job, fields_catalog_category: $fields_catalog_category,

php
$klaviyo->Catalogs->getCatalogCategoryBulkCreateJobs(fields_catalog_category_bulk_create_job: $fields_catalog_category_bulk_create_job, filter: $filter, page_cursor: $page_cursor);

php
$klaviyo->Catalogs->getCatalogVariantBulkCreateJob($job_id, fields_catalog_variant_bulk_create_job: $fields_catalog_variant_bulk_create_job, fields_catalog_variant: $fields_catalog_variant,

php
$klaviyo->Catalogs->getCatalogVariantBulkCreateJobs(fields_catalog_variant_bulk_create_job: $fields_catalog_variant_bulk_create_job, filter: $filter, page_cursor: $page_cursor);

php
$klaviyo->Catalogs->getCatalogCategoryBulkDeleteJob($job_id, fields_catalog_category_bulk_delete_job: $fields_catalog_category_bulk_delete_job);

php
$klaviyo->Catalogs->getCatalogCategoryBulkDeleteJobs(fields_catalog_category_bulk_delete_job: $fields_catalog_category_bulk_delete_job, filter: $filter, page_cursor: $page_cursor);

php
$klaviyo->Catalogs->getCatalogVariantBulkDeleteJob($job_id, fields_catalog_variant_bulk_delete_job: $fields_catalog_variant_bulk_delete_job);

php
$klaviyo->Catalogs->getCatalogVariantBulkDeleteJobs(fields_catalog_variant_bulk_delete_job: $fields_catalog_variant_bulk_delete_job, filter: $filter, page_cursor: $page_cursor);

php
$klaviyo->Catalogs->getCatalogCategoryRelationshipsItems($id, filter: $filter, page_cursor: $page_cursor, sort: $sort);

php
$klaviyo->Catalogs->getCatalogCategoryBulkUpdateJob($job_id, fields_catalog_category_bulk_update_job: $fields_catalog_category_bulk_update_job, fields_catalog_category: $fields_catalog_category,

php
$klaviyo->Catalogs->getCatalogVariantBulkUpdateJob($job_id, fields_catalog_variant_bulk_update_job: $fields_catalog_variant_bulk_update_job, fields_catalog_variant: $fields_catalog_variant,

php
$klaviyo->Catalogs->getCatalogItemRelationshipsVariants($id, filter: $filter, page_cursor: $page_cursor, sort: $sort);

php
$klaviyo->Catalogs->getCatalogItemVariants($id, fields_catalog_variant: $fields_catalog_variant, filter: $filter, page_cursor: $page_cursor, sort: $sort);

php
## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Catalogs->removeCategoriesFromCatalogItem($id, $body);

php
$klaviyo->Catalogs->deleteCatalogItemRelationshipsCategories($id, $body);

php
## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Catalogs->removeItemsFromCatalogCategory($id, $body);

php
$klaviyo->Catalogs->deleteCatalogCategoryRelationshipsItems($id, $body);

php
## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Catalogs->updateCatalogCategory($id, $body);

php
## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Catalogs->updateCatalogItem($id, $body);

php
## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Catalogs->updateCatalogVariant($id, $body);

php
## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Catalogs->updateCategoriesForCatalogItem($id, $body);

php
$klaviyo->Catalogs->updateCatalogItemRelationshipsCategories($id, $body);

php
## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Catalogs->updateItemsForCatalogCategory($id, $body);

php
$klaviyo->Catalogs->updateCatalogCategoryRelationshipsItems($id, $body);

php
## Positional Arguments

# $body | associative array

$klaviyo->Coupons->bulkCreateCouponCodes($body);

php
$klaviyo->Coupons->spawnCouponCodeBulkCreateJob($body);

php
$klaviyo->Coupons->createCouponCodeBulkCreateJob($body);

php
## Positional Arguments

# $body | associative array

$klaviyo->Coupons->createCoupon($body);

php
## Positional Arguments

# $body | associative array

$klaviyo->Coupons->createCouponCode($body);

php
## Positional Arguments

# $id | string

$klaviyo->Coupons->deleteCoupon($id);

php
## Positional Arguments

# $id | string

$klaviyo->Coupons->deleteCouponCode($id);

php

## Keyword Arguments

# $fields_coupon_code_bulk_create_job | string[]
# $filter | string
# $page_cursor | string

$klaviyo->Coupons->getBulkCreateCouponCodeJobs(fields_coupon_code_bulk_create_job: $fields_coupon_code_bulk_create_job, filter: $filter, page_cursor: $page_cursor);

php
$klaviyo->Coupons->getCouponCodeBulkCreateJobs(fields_coupon_code_bulk_create_job: $fields_coupon_code_bulk_create_job, filter: $filter, page_cursor: $page_cursor);

php
$klaviyo->Coupons->getCouponCodeBulkCreateJob($job_id, fields_coupon_code_bulk_create_job: $fields_coupon_code_bulk_create_job, fields_coupon_code: $fields_coupon_code,

php
## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_coupon | string[]

$klaviyo->Coupons->getCoupon($id, fields_coupon: $fields_coupon);

php
## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_coupon_code | string[]
# $fields_coupon | string[]
# $;

php
$klaviyo->Coupons->getCouponCodeRelationshipsCoupon($id, filter: $filter, page_cursor: $page_cursor);

php
$klaviyo->Coupons->getCodeIdsForCoupon($id, filter: $filter, page_cursor: $page_cursor);

php
$klaviyo->Coupons->getCouponRelationshipsCodes($id, filter: $filter, page_cursor: $page_cursor);

php

## Keyword Arguments

# $fields_coupon_code | string[]
# $fields_coupon | string[]
# $filter | string
# $oupon: $fields_coupon, filter: $filter,

php
## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_coupon_code | string[]
# $filter | string
# $page_cursor | string

$klaviyo->Coupons->getCouponCodesForCoupon($id, fields_coupon_code: $fields_coupon_code, filter: $filter, page_cursor: $page_cursor);

php
$klaviyo->Coupons->getCouponCouponCodes($id, fields_coupon_code: $fields_coupon_code, filter: $filter, page_cursor: $page_cursor);

php
$klaviyo->Coupons->getCodesForCoupon($id, fields_coupon_code: $fields_coupon_code, filter: $filter, page_cursor: $page_cursor);

php
## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_coupon | string[]

$klaviyo->Coupons->getCouponForCouponCode($id, fields_coupon: $fields_coupon);

php
$klaviyo->Coupons->getCouponCodeCoupon($id, fields_coupon: $fields_coupon);

php
## Positional Arguments

# $id | string

$klaviyo->Coupons->getCouponIdForCouponCode($id);

php
$klaviyo->Coupons->getCouponRelationshipsCouponCodes($id);

php

## Keyword Arguments

# $fields_coupon | string[]
# $page_cursor | string

$klaviyo->Coupons->getCoupons(fields_coupon: $fields_coupon, page_cursor: $page_cursor);

php
## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Coupons->updateCoupon($id, $body);

php
## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Coupons->updateCouponCode($id, $body);

php
## Positional Arguments

# $body | associative array

$klaviyo->DataPrivacy->requestProfileDeletion($body);

php
$klaviyo->DataPrivacy->createDataPrivacyDeletionJob($body);

php
## Positional Arguments

# $body | associative array

$klaviyo->Events->bulkCreateEvents($body);

php
$klaviyo->Events->createEventBulkCreateJob($body);

php
## Positional Arguments

# $body | associative array

$klaviyo->Events->createEvent($body);

php
## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_event | string[]
# $fields_metric | string[]
# $fields_profile | string[]
# $

php
## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_metric | string[]

$klaviyo->Events->getMetricForEvent($id, fields_metric: $fields_metric);

php
$klaviyo->Events->getEventMetric($id, fields_metric: $fields_metric);