- Content that promotes, condones, encourages or facilitates
- hate, violence or discrimination against people based on race,
- ethnicity, color, national origin, religion, age, gender,
- gender identity, sexual orientation, disability, medical
- condition, veteran status or any other characteristic;
-
- Content that violates, encourages or furthers conduct that
- would violate any applicable laws;
-
-
-
-
-
-
- Content that infringes or misappropriates intellectual
- property rights, or otherwise violates a third party’s rights;
-
-
-
-
-
- Any of the following types of data or information: (a) any
- information defined under Regulation (EU) 2016/679 (EU GDPR)
- or the United Kingdom General Data Protection Regulation as a
- “special category”; (b) medical records or health information,
- including Protected Health Information as defined in the
- Health Insurance Portability and Accountability Act; (c) any
- non-public government identification numbers or financial
- account information such as (i) Social Security number or
- local equivalents, passport numbers, driver’s license number
- or similar identifiers or (ii) financial account information
- including credit or debit card number; and (d) information
- related to children under the age of 13 (or in the EEA, under
- 16);
-
-
-
-
-
- Spam or commercial electronic messages in violation of the
- CAN-SPAM Act, Canada’s Anti-Spam Legislation, the General Data
- Protection Regulation or any other applicable law or
- regulation; or 16);
-
-
-
-
-
- SMS, MMS, or other text messages or push notifications that
- violate the Telephone Consumer Protection Act or any other
- applicable telemarketing or telephone consumer protection law
- or regulation.
-
-
-
-
-
-
-
-
-
- );
-};
-export default Rp;
diff --git a/apps/web/app/routes/copyright-dispute-policy.tsx b/apps/web/app/routes/copyright-dispute-policy.tsx
deleted file mode 100644
index 6ff2fe1..0000000
--- a/apps/web/app/routes/copyright-dispute-policy.tsx
+++ /dev/null
@@ -1,239 +0,0 @@
-import { Box, Flex, Heading, Link, Text } from "gestalt";
-import React from "react";
-import BigContainer from "../components/BigContainer";
-import Footer2 from "../components/Footer/Footer2";
-import UnauthMobileNav2 from "../components/MobileNav/UnauthMobileNav2";
-import UnauthNav2 from "../components/Navigation/UnauthNav2";
-
-const Rp: React.FC = () => {
- return (
- <>
-
-
-
-
-
- Documents
-
-
- Terms of service
-
-
- Privacy policy
-
-
- Refund policy
-
-
- Content guidelines
-
-
- Data processing agreement
-
-
- Copyright dispute policy
-
-
-
-
- Copyright Dispute Policy
-
-
-
-
- It is Bespoke’s policy to respond to notices alleging that any
- material uploaded by users of the Services infringes another
- person’s copyright. If you believe any material accessible on or
- from the Bespoke's website or the Services infringes your
- copyright, you may request removal of those materials (or access
- thereto) from this website or the Services by contacting the
- Bespoke, Inc. copyright agent (identified below) and providing the
- following information:
-
-
-
-
-
-
- Identification of the copyrighted work that you believe to be
- infringed. Please describe the work, and where possible
- include a copy or the location (URL) of an authorized version
- of the work.
-
-
-
-
-
- Identification of the material that you believe to be
- infringing and its location. Please describe the material and
- provide us with its URL or any other pertinent information
- that will allow us to locate the material.
-
-
-
-
-
-
- {" "}
- Your name, address, telephone number and (if available) email
- address.
-
-
-
-
-
-
- A statement that you have a good faith belief that the use of
- the materials is not authorized by the copyright owner, its
- agent, or the law.
-
-
-
-
-
-
- A statement that the information that you have supplied is
- accurate, and indicating that “under penalty of perjury,” you
- are the copyright owner or are authorized to act on the
- copyright owner’s behalf.
-
-
-
-
-
- A signature or the electronic equivalent from the copyright
- holder or authorized representative.
-
-
-
-
-
-
-
- Submitting a DMCA takedown request is the start of a pre-defined
- process. Your request will be reviewed for accuracy, validity, and
- completeness. If your request has satisfied the requirements
- above, Bespoke will take action on the request – which includes
- removing or disabling access to the allegedly infringing material
- and forwarding a full copy of your request (including your name
- and contact information) to the user(s) engaged in the allegedly
- infringing activity. Bespoke will make a good faith effort to
- contact the affected user(s) with information concerning the
- removal or disabling of access.
-
-
-
- If you are the recipient of a takedown request, please take time
- to read through Bespoke’s communication to you, which will include
- information on the request we received. If you believe that the
- allegedly infringing material reported in the takedown request was
- misidentified, is not infringing, or was removed or disabled in
- error, you may send Bespoke a counter-notification or you may seek
- a retraction of the takedown request from the requester.
-
-
-
- A counter-notification is a request for Bespoke to reinstate the
- removed or disabled material. You may file a counter-notification
- if you believe that the allegedly infringing material was
- misidentified, is not infringing, or you have a good faith belief
- that the material should not have been removed and/or disabled. If
- you’re not sure whether you should file a counter-notification,
- you should consult with an attorney.
-
-
-
- To submit a counter-notification, you will need to provide Bespoke
- with the following information:
-
-
-
-
A physical or electronic signature.
-
-
-
-
- Identification of the material that has been removed or to which
- access has been disabled and the location at which the material
- appeared before it was removed or access to it was disabled.
-
-
-
-
-
- A statement under penalty of perjury that you have a good faith
- belief that the material was removed or disabled as a result of
- mistake or misidentification of the material to be removed or
- disabled.
-
-
-
-
-
- Your name, address, and telephone number, and a statement that
- you consent to the jurisdiction of Federal District Court for
- the judicial district in which the address is located, or if the
- subscriber’s address is outside of the United States, for any
- judicial district in which Bespoke may be found, and that you
- will accept service of process from the original requester or an
- agent of such person.
-
-
-
-
- Once we receive a valid counter-notification, we will promptly
- forward a copy (including your name and contact information) to
- the person who submitted the original request. If the original
- requester disagrees that the content was removed or disabled in
- error or misidentification, they may pursue legal action against
- you. If we do not receive notice within 10 business days that
- the original requester is seeking a court order to prevent
- further infringement of the material at issue, we may replace or
- cease disabling access to the material that was removed.
-
-
-
-
- Bespoke may, at its discretion, share a copy of your takedown
- request or counter-notification with third parties (including
- for publication). If you are uncomfortable sharing your contact
- information, you may wish to consider appointing an agent to
- submit your request or counter-notification on your behalf. Your
- agent will be required to submit the request or
- counter-notification with valid contact information and identify
- you as the party that they are representing.
-
-
-
-
- Please think twice before submitting a takedown request or
- counter-notification, especially if you’re not sure whether you
- are the actual copyright holder or authorized to act on behalf
- of the copyright holder. There are legal and financial
- consequences for fraudulent and/or bad faith submissions.
-
-
-
-
- Bespoke has adopted a policy of terminating, in appropriate
- circumstances, accounts of users of the Services who are deemed
- to have repeatedly uploaded content that infringes the
- intellectual property rights of others.
-
-
-
-
-
-
-
- );
-};
-export default Rp;
diff --git a/apps/web/app/routes/data-processing-agreement.tsx b/apps/web/app/routes/data-processing-agreement.tsx
deleted file mode 100644
index f46a98b..0000000
--- a/apps/web/app/routes/data-processing-agreement.tsx
+++ /dev/null
@@ -1,454 +0,0 @@
-import { Box, Flex, Heading, Link, Text } from "gestalt";
-import React from "react";
-import BigContainer from "../components/BigContainer";
-import Footer2 from "../components/Footer/Footer2";
-import UnauthMobileNav2 from "../components/MobileNav/UnauthMobileNav2";
-import UnauthNav2 from "../components/Navigation/UnauthNav2";
-
-const Rp: React.FC = () => {
- return (
- <>
-
-
-
-
-
- Documents
-
-
- Terms of service
-
-
- Privacy policy
-
-
- Refund policy
-
-
- Content guidelines
-
-
- Data processing agreement
-
-
- Copyright dispute policy
-
-
-
-
- Data Processing Agreement
-
-
-
-
- This Data Processing Agreement is incorporated by reference into
- the Bespoke's Privacy Policy. While the framework used here is
- based in the provisions of the California Consumer Privacy Act of
- 2018 (“CCPA”), we provide the rights described here to all our
- users. If you are a California resident, please note that the
- processing of certain personal data about you may be subject to
- the California Consumer Privacy Act (“CCPA”) and other applicable
- California state privacy laws. Any capitalized terms not defined
- in this CCPA Policy have the same meaning given to them in our
- Privacy Policy, Terms of Use, and/or the CCPA.
-
-
-
- No Sale of Personal Information
-
- We do not sell personal information.
-
-
-
- Individual Rights
-
-
- The CCPA provides California consumers with several individual
- rights with respect to Personal Information. Note that these
- rights apply to individual consumers, not to companies. This
- section describes those rights in detail and provides
- information on how to exercise those rights.
-
-
-
-
- Exercising Your Rights
-
-
- To exercise any of the rights described in this section, please
- contact us at support@bespoke.surf with (i) a complete
- description of your request, including the specific right(s) you
- wish to exercise and (ii) sufficient information about you so we
- can confirm that your request is a verifiable customer request,
- including at a minimum your name and email address. Once we have
- received your verifiable consumer request, we will respond
- consistent with applicable law.
-
-
-
-
- Access and Data Portability Rights
-
-
- You have a right to request information about our collection,
- use, and disclosure of your personal information over the prior
- 12 months, and ask that we provide you with the following
- information:
-
-
-
- Categories of and specific pieces of personal information we
- have collected about you.
-
-
-
-
- Categories of sources from which we collect personal
- information.
-
-
-
-
- Purposes for collecting, using, or selling personal
- information.
-
-
-
-
- Categories of third parties with which we share personal
- information.
-
-
-
-
- Categories of personal information disclosed about you for a
- business purpose.
-
-
-
-
- If applicable, categories of personal information sold about
- you and the categories of third parties to which the personal
- information was sold, by category or categories of personal
- information for each third party to which the personal
- information was sold.
-
-
-
-
-
- Deletion Rights
-
-
- You have the right to request that we delete Personal
- Information about you that we have collected, subject to certain
- exceptions.
-
-
-
-
-
- The Right to Opt Out
-
-
- You have the right to opt out of the sale of your personal
- information. Were we ever to sell personal information, we would
- provide information on our opt out process here.
-
-
-
-
-
- Non-Discrimination Rights
-
-
- You have the right not to receive discriminatory treatment for
- the exercise of your rights under the CCPA.
-
-
-
-
- Personal Data Collected
-
-
- The list below describes the category of Personal Information we
- collect by reference to the categories specified by the CCPA:
-
-
-
-
-
- Category:{" "}
-
- Identifiers
-
-
-
- We collect:{" "}
-
-
- Your name, IP address, email address and Twitter handle
-
-
-
-
- Source(s):{" "}
-
-
- You; automatic collection (IP address only); Bespoke
- publishers who migrate subscribers to our platform (email
- address only)
-
-
-
-
-
-
- Category:{" "}
-
- Customer Record Information
-
-
-
- We collect:{" "}
-
-
- Your name, your email address, your user bio, your
- subscriptions and unsubscriptions, your settings and
- preferences with our service, reactions you submit to posts
- and comments (“likes”), user comments, user photos, user
- profile information, public Twitter profile information, and
- publication and authorship information, your search history on
- the Website. For Publishers, we may also collect information
- on city or country of residence and mailing address.
-
-
-
-
- Source(s):{" "}
-
-
- You; Twitter (with your permission). We may collect Publisher
- city or country of residence information from information
- Publishers have made publicly available online.
-
-
-
-
-
-
- Category:{" "}
-
- Commercial information
-
-
-
- We collect:{" "}
-
-
- Records of products/services purchased by you on the Website
-
-
-
-
- Source(s):{" "}
-
- You
-
-
-
-
-
- Category:{" "}
-
- Internet or other network activity
-
-
-
- We collect:{" "}
-
-
- Browsing history, search history, and interaction data on your
- use of our Website and from links in Bespoke emails
-
-
-
-
- Source(s):{" "}
-
- You; automatic collection
-
-
-
-
-
- Category:{" "}
-
- Geolocation data
-
-
-
- We collect:{" "}
-
- Your IP address
-
-
-
- Source(s):{" "}
-
- You; Automatic collection
-
-
-
-
-
- Category:{" "}
-
- Sensory Data
-
-
-
- We collect:{" "}
-
- User photos, Twitter profile photo
-
-
-
- Source(s):{" "}
-
- You, Twitter (with your permission)
-
-
-
-
- Use of Personal Information
-
-
- In the last 12 months, we have used or disclosed certain
- Personal Information we collected for the following business
- purposes:
-
-
-
-
-
- Business Purpose:{" "}
-
-
- To provide, support, and develop our website, products, and
- services
-
-
-
-
- Categories of Personal Information:{" "}
-
-
- Identifiers, Customer Record Information, Sensory Data,
- Internet or other network activity
-
-
-
-
-
-
- Business Purpose:{" "}
-
-
- To create, maintain, customize, and secure your account with
- us
-
-
-
-
- Categories of Personal Information:{" "}
-
- Identifiers, Customer Record Information
-
-
-
-
-
- Business Purpose:{" "}
-
-
- To process your requests, purchases, transactions, and
- payments and prevent transactional fraud
-
-
-
-
- Categories of Personal Information:{" "}
-
- Commercial Information
-
-
-
-
-
- Business Purpose:{" "}
-
-
- To directly respond to your requests or inquiries, including
- to investigate and address your concerns and monitor and
- improve our responses, or to otherwise meet the reason for
- which you provided the information.
-
-
-
-
- Categories of Personal Information:{" "}
-
-
- Identifiers, Customer Record Information, Commercial
- Information, Sensory Data, Internet or other network activity
-
-
-
-
-
-
- Business Purpose:{" "}
-
-
- To help maintain the safety, security, and integrity of our
- website, products and services, databases and other technology
- assets, and business
-
-
-
-
- Categories of Personal Information:{" "}
-
- Identifiers
-
-
-
- We may further disclose each category of Personal Information to
- our affiliates, to our professional advisors, in connection with
- our compliance and protection activities and in connection with
- business transfers as described in our Privacy Policy.
-
-
-
- Contact Us
-
-
- You many contact us by emaling us at support@bespoke.surf
-
-
-
-
-
-
-
- );
-};
-export default Rp;
diff --git a/apps/web/app/routes/index/LandingPage.tsx b/apps/web/app/routes/index/LandingPage.tsx
index fd37622..a4392d8 100644
--- a/apps/web/app/routes/index/LandingPage.tsx
+++ b/apps/web/app/routes/index/LandingPage.tsx
@@ -1,11 +1,8 @@
-import { useRouteLoaderData } from "@remix-run/react";
-import { Box, Callout, Flex, Heading, Text, Upsell } from "gestalt";
+import { Box, Callout, Flex, Heading, Text } from "gestalt";
import UnauthPageLayot from "../../components/PageLayout/UnauthPageLayout";
-import type { RootData } from "../../root";
import ComparisonTable from "./LandingPage/ComparisonTable";
export default function LandingPage() {
- const rootLoaderData = useRouteLoaderData("root") as RootData;
return (
+
+ The open source Mailchimp alternative
@@ -23,52 +32,7 @@ export default function LandingPage() {
- {rootLoaderData.ENV.OPEN_SOURCE === "true" ? null : (
-
- )}
- {rootLoaderData.ENV.OPEN_SOURCE === "true" ? (
-
- ) : (
-
- )}
);
diff --git a/apps/web/app/routes/index/LandingPage/ComparisonTable.tsx b/apps/web/app/routes/index/LandingPage/ComparisonTable.tsx
index 3d78ee5..58b67f6 100644
--- a/apps/web/app/routes/index/LandingPage/ComparisonTable.tsx
+++ b/apps/web/app/routes/index/LandingPage/ComparisonTable.tsx
@@ -1,7 +1,4 @@
-import { useRouteLoaderData } from "@remix-run/react";
import { Box, Flex, Icon, Table, Text } from "gestalt";
-import type { RootData } from "../../../root";
-import CloudTable from "./CloudTable";
/*
*/
@@ -57,22 +54,22 @@ const data: IData[] = [
// mailchimp: "yes",
// },
- {
- text: "You can execute new campaigns based on personalized or segmented data",
- readiness: "ready",
- klaviyo: "yes",
- bespoke: "partial",
- substack: "no",
- mailchimp: "yes",
- },
- {
- text: "You can ask questions with surveys and then do personalised targeting via Automations and Campaigns",
- readiness: "ready",
- klaviyo: "no",
- bespoke: "partial",
- substack: "no",
- mailchimp: "yes",
- },
+ // {
+ // text: "You can execute new campaigns based on personalized or segmented data",
+ // readiness: "ready",
+ // klaviyo: "yes",
+ // bespoke: "partial",
+ // substack: "no",
+ // mailchimp: "yes",
+ // },
+ // {
+ // text: "You can ask questions with surveys and then do personalised targeting via Automations and Campaigns",
+ // readiness: "ready",
+ // klaviyo: "no",
+ // bespoke: "partial",
+ // substack: "no",
+ // mailchimp: "yes",
+ // },
// {
// text: "You can create an unique personalized brand expierence for your customers'",
@@ -93,7 +90,6 @@ const data: IData[] = [
];
export default function ComparisonTable() {
- const rootLoaderData = useRouteLoaderData("root") as RootData;
return (
-
-
- );
-};
diff --git a/apps/web/app/routes/pricing/index.tsx b/apps/web/app/routes/pricing/index.tsx
deleted file mode 100644
index bd1f8ae..0000000
--- a/apps/web/app/routes/pricing/index.tsx
+++ /dev/null
@@ -1,113 +0,0 @@
-import clayStyles from "@clayui/css/lib/css/atlas.css";
-import type { LinksFunction } from "@remix-run/node";
-import {
- Box,
- Container,
- Flex,
- PageHeader,
- SegmentedControl,
- Text,
- Upsell,
-} from "gestalt";
-import { useState } from "react";
-import BigContainer from "../../components/BigContainer";
-import { UnauthNav } from "../../components/Navigation/UnauthNav";
-import { GenericCatchBoundary } from "../../route-containers/GenericCatchBoundry";
-import { GenericErrorBoundary } from "../../route-containers/GenericErrorBoundry";
-import { AdditionalFeatures } from "./AdditionalFeatures";
-import { AdvancedPlan } from "./AdvancedPlan";
-import { BasicPlan } from "./BasicPlan";
-import { FreePlan, FreePlanHosted } from "./FreePlan";
-export const links: LinksFunction = () => {
- return [{ rel: "stylesheet", href: clayStyles }];
-};
-
-export {
- GenericCatchBoundary as CatchBoundary,
- GenericErrorBoundary as ErrorBoundary,
-};
-
-export default function Pricing() {
- const [type, setType] = useState<"hosted" | "cloud">("cloud");
- return (
-
-
-
-
-
-
-
-
- {
- if (activeIndex === 0) {
- setType("hosted");
- } else {
- setType("cloud");
- }
- }}
- items={["Self-Hosted", "Cloud"]}
- selectedItemIndex={type === "hosted" ? 0 : 1}
- responsive
- />
-
- {type === "cloud" ? (
- <>
-
-
-
-
-
-
-
- ) : (
- <>
-
-
-
- )}
-
-
-
-
- FULL FEATURE BREAKDOWN
-
-
-
- Choose exactly what you need.
-
-
- Compare the features and benefits of each plan
-
-
-
-
-
-
-
-
-
-
-
-
- );
-}
diff --git a/apps/web/app/routes/privacy-policy.tsx b/apps/web/app/routes/privacy-policy.tsx
deleted file mode 100644
index 3cd9083..0000000
--- a/apps/web/app/routes/privacy-policy.tsx
+++ /dev/null
@@ -1,581 +0,0 @@
-import { redirect } from "@remix-run/node";
-import { Box, Flex, Heading, Link, Text } from "gestalt";
-import React from "react";
-import BigContainer from "../components/BigContainer";
-import Footer2 from "../components/Footer/Footer2";
-import UnauthMobileNav2 from "../components/MobileNav/UnauthMobileNav2";
-import UnauthNav2 from "../components/Navigation/UnauthNav2";
-
-export async function loader() {
- if (ENV.OPEN_SOURCE === "true") {
- return redirect("/");
- }
- return {};
-}
-
-const Pp: React.FC = () => {
- return (
- <>
-
-
-
-
-
- Documents
-
-
- Terms of service
-
-
- Privacy policy
-
-
- Refund policy
-
-
- Content guidelines
-
-
- Data processing agreement
-
-
- Copyright dispute policy
-
-
-
-
-
- Privacy Policy
-
-
-
- AGREEMENT TO TERMS
-
-
- Thank you for choosing to be part of our community at Cartegan
- Software Private Limited, doing business
- as Bespoke("**Bespoke**", "**we**", "**us**", "**our**"). We are
- committed to protecting your personal information and your right
- to privacy. If you have any questions or concerns about this
- privacy notice, or our practices with regards to your personal
- information, please contact us at info@cartegan.com. When
- you visit our
- website [https://bespoke.surf](https://bespoke.surf/) (the
- "**Website**"), use our mobile application, as the case may be
- (the "**App**") and more generally, use any of our services (the
- "**Services**", which include the Website and App), we
- appreciate that you are trusting us with your personal
- information. We take your privacy very seriously. In this
- privacy notice, we seek to explain to you in the clearest way
- possible what information we collect, how we use it and what
- rights you have in relation to it. We hope you take some time to
- read through it carefully, as it is important. If there are any
- terms in this privacy notice that you do not agree with, please
- discontinue use of our Services immediately. This privacy notice
- applies to all information collected through our Services
- (which, as described above, includes our Website and App), as
- well as, any related services, sales, marketing or events.
-
-
-
- Please read this privacy notice carefully as it will help you
- understand what we do with the information that we collect.
-
-
-
-
- ANY CAPITALIZED WORDS USED HENCEFORTH SHALL HAVE THE MEANING
- ACCORDED TO THEM UNDER THIS AGREEMENT. FURTHER, ALL HEADING USED
- HEREIN ARE ONLY FOR THE PURPOSE OF ARRANGING THE VARIOUS
- PROVISIONS OF THE AGREEMENT IN ANY MANNER. NEITHER THE USER NOR
- THE CREATORS OF THIS PRIVACY POLICY MAY USE THE HEADING TO
- INTERPRET THE PROVISIONS CONTAINED WITHIN IT IN ANY MANNER.
-
-
-
- WHAT INFORMATION DO WE COLLECT?
-
- Personal information you disclose to us
-
-
- We collect personal information that you voluntarily provide to
- us when you register on the Services, express an interest in
- obtaining information about us or our products and Services,
- when you participate in activities on the Services (such as by
- posting messages in our online forums or entering competitions,
- contests or giveaways) or otherwise when you contact us.
-
-
-
-
- The personal information that we collect depends on the context
- of your interactions with us and the Services, the choices you
- make and the products and features you use. The personal
- information we collect may include the following:
-
-
-
-
- Personal Information Provided by You. We collect names; phone
- numbers; email addresses; usernames; passwords; billing
- addresses; debit/credit card numbers; contact or authentication
- data; and other similar information.
-
-
-
-
- Payment Data. We may collect data necessary to process your
- payment if you make purchases, such as your payment instrument
- number (such as a credit card number), and the security code
- associated with your payment instrument. All payment data is
- stored by Razorpay. You may find their privacy notice link(s)
- here: https://razorpay.com/privacy/.
-
-
-
- Social Media Login Data. We may provide you with the option to
- register with us using your existing social media account
- details, like your Facebook, Twitter or other social media
- account. If you choose to register in this way, we will collect
- the information described in the section called "HOW DO WE
- HANDLE YOUR SOCIAL LOGINS" below.
-
-
-
- All personal information that you provide to us must be true,
- complete and accurate, and you must notify us of any changes to
- such personal information.
-
-
- Information automatically collected
-
-
- We automatically collect certain information when you visit, use
- or navigate the Services. This information does not reveal your
- specific identity (like your name or contact information) but may
- include device and usage information, such as your IP address,
- browser and device characteristics, operating system, language
- preferences, referring URLs, device name, country, location,
- information about how and when you use our Services and other
- technical information. This information is primarily needed to
- maintain the security and operation of our Services, and for our
- internal analytics and reporting purposes.
-
-
-
- Like many businesses, we also collect information through cookies
- and similar technologies.
-
-
- The information we collect includes:
-
-
-
- Log and Usage Data. Log and usage data is service-related,
- diagnostic, usage and performance information our servers
- automatically collect when you access or use our Services and
- which we record in log files. Depending on how you interact with
- us, this log data may include your IP address, device
- information, browser type and settings and information about
- your activity in the Services (such as the date/time stamps
- associated with your usage, pages and files viewed, searches and
- other actions you take such as which features you use), device
- event information (such as system activity, error reports
- (sometimes called 'crash dumps') and hardware settings).
-
-
-
-
-
- Device Data. We collect device data such as information about
- your computer, phone, tablet or other device you use to access
- the Services. Depending on the device used, this device data may
- include information such as your IP address (or proxy server),
- device and application identification numbers, location, browser
- type, hardware model Internet service provider and/or mobile
- carrier, operating system and system configuration information.
-
-
-
-
-
- Location Data. We collect location data such as information
- about your device's location, which can be either precise or
- imprecise. How much information we collect depends on the type
- and settings of the device you use to access the Services. For
- example, we may use GPS and other technologies to collect
- geolocation data that tells us your current location (based on
- your IP address). You can opt out of allowing us to collect this
- information either by refusing access to the information or by
- disabling your Location setting on your device. Note however, if
- you choose to opt out, you may not be able to use certain
- aspects of the Services.
-
-
-
- Information automatically collected
-
- The information we collect includes:
-
-
-
- Geo-Location Information. We may request access or permission to
- and track location-based information from your mobile device,
- either continuously or while you are using our App, to provide
- certain location-based services. If you wish to change our
- access or permissions, you may do so in your device's settings.
-
-
-
-
-
- Mobile Device Access. We may request access or permission to
- certain features from your mobile device, including your mobile
- device's, and other features. If you wish to change our access
- or permissions, you may do so in your device's settings. Camera,
- microphone, contacts, sms Messages, storage
-
-
-
-
-
- Push Notifications. We may request to send you push
- notifications regarding your account or certain features of the
- App. If you wish to opt-out from receiving these types of
- communications, you may turn them off in your device's settings.
-
-
-
-
- This information is primarily needed to maintain the security and
- operation of our App, for troubleshooting and for our internal
- analytics and reporting purposes.
-
-
- HOW DO WE USE YOUR INFORMATION?
-
-
- We use personal information collected via our Services for a
- variety of business purposes described below. We process your
- personal information for these purposes in reliance on our
- legitimate business interests, in order to enter into or perform
- a contract with you, with your consent, and/or for compliance
- with our legal obligations. We indicate the specific processing
- grounds we rely on next to each purpose listed below.
-
-
-
- We use the information we collect or receive:
-
-
-
-
- To facilitate account creation and logon process. If you
- choose to link your account with us to a third-party account
- (such as your Google or Facebook account), we use the
- information you allowed us to collect from those third parties
- to facilitate account creation and logon process for the
- performance of the contract. See the section below headed "HOW
- DO WE HANDLE YOUR SOCIAL LOGINS" for further information.
-
-
-
-
-
- To post testimonials. We post testimonials on
- our Services that may contain personal information. Prior to
- posting a testimonial, we will obtain your consent to use your
- name and the content of the testimonial. If you wish to
- update, or delete your testimonial, please contact us at and
- be sure to include your name, testimonial location, and
- contact information.
-
-
-
-
-
- Request feedback. We may use your information to request
- feedback and to contact you about your use of our Services.
-
-
-
-
-
- To enable user-to-user communications. We may use your
- information in order to enable user-to-user communications
- with each user's consent.
-
-
-
-
-
- To manage user accounts. We may use your information for the
- purposes of managing our account and keeping it in working
- order.
-
-
-
-
- WILL YOUR INFORMATION BE SHARED WITH ANYONE?
-
-
-
- We may process or share your data that we hold based on the
- following legal basis:
-
-
-
-
- We may process or share your data that we hold based on the
- following legal basis:
-
-
-
-
-
- Legitimate Interests: We may process your data when it is
- reasonably necessary to achieve our legitimate business
- interests.
-
-
-
-
-
- Performance of a Contract: Where we have entered into a
- contract with you, we may process your personal information to
- fulfill the terms of our contract.
-
-
-
-
-
- Legal Obligations: We may disclose your information where we
- are legally required to do so in order to comply with
- applicable law, governmental requests, a judicial proceeding,
- court order, or legal process, such as in response to a court
- order or a subpoena (including in response to public
- authorities to meet national security or law enforcement
- requirements).
-
-
-
-
-
- Vital Interests: We may disclose your information where we
- believe it is necessary to investigate, prevent, or take
- action regarding potential violations of our policies,
- suspected fraud, situations involving potential threats to the
- safety of any person and illegal activities, or as evidence in
- litigation in which we are involved.
-
-
-
-
- We may process or share your data that we hold based on the
- following legal basis:
-
-
-
-
- Business Transfers. We may share or transfer your information
- in connection with, or during negotiations of, any merger,
- sale of company assets, financing, or acquisition of all or a
- portion of our business to another company.
-
-
-
-
-
- DO WE USE COOKIES AND OTHER TRACKING TECHNOLOGIES?
-
-
-
- We may use cookies and similar tracking technologies (like web
- beacons and pixels) to access or store information. Specific
- information about how we use such technologies and how you can
- refuse certain cookies is set out in our Cookie Notice.
-
-
- DO WE USE GOOGLE MAPS PLATFORM APIS?
-
-
- This Website or App uses Google Maps Platform APIs which are
- subject to Google’s Terms of Service. You may find the Google
- Maps Platform Terms of Service.
-
-
- HOW DO WE HANDLE YOUR SOCIAL LOGINS?
-
-
- Our Services offers you the ability to register and login using
- your third-party social media account details (like your
- Facebook or Twitter logins). Where you choose to do this, we
- will receive certain profile information about you from your
- social media provider. The profile information we receive may
- vary depending on the social media provider concerned, but will
- often include your name, email address, friends list, profile
- picture as well as other information you choose to make public
- on such social media platform. We will use the information we
- receive only for the purposes that are described in this privacy
- notice or that are otherwise made clear to you on the
- relevant Services. Please note that we do not control, and are
- not responsible for, other uses of your personal information by
- your third-party social media provider. We recommend that you
- review their privacy notice to understand how they collect, use
- and share your personal information, and how you can set your
- privacy preferences on their sites and apps.
-
-
-
- HOW LONG DO WE KEEP YOUR INFORMATION?
-
-
- We will only keep your personal information for as long as it is
- necessary for the purposes set out in this privacy notice,
- unless a longer retention period is required or permitted by law
- (such as tax, accounting or other legal requirements). No
- purpose in this notice will require us keeping your personal
- information for longer than the period of time in which users
- have an account with us.
-
-
-
-
- When we have no ongoing legitimate business need to process your
- personal information, we will either delete or anonymize such
- information, or, if this is not possible (for example, because
- your personal information has been stored in backup archives),
- then we will securely store your personal information and
- isolate it from any further processing until deletion is
- possible.
-
-
- HOW DO WE KEEP YOUR INFORMATION SAFE?
-
-
- We have implemented appropriate technical and organizational
- security measures designed to protect the security of any
- personal information we process. However, despite our safeguards
- and efforts to secure your information, no electronic
- transmission over the Internet or information storage technology
- can be guaranteed to be 100% secure, so we cannot promise or
- guarantee that hackers, cybercriminals, or other unauthorized
- third parties will not be able to defeat our security, and
- improperly collect, access, steal, or modify your information.
- Although we will do our best to protect your personal
- information, transmission of personal information to and from
- our Services is at your own risk. You should only access
- the Services within a secure environment.
-
-
-
-
- ACCESSING, REVIEWING AND CHANGING YOUR PROFILE
-
-
-
- Following registration, you can review and change the
- information you submitted at the stage of registration, except
- Email ID and mobile number. An option for facilitating such
- change shall be present on the Platform and such change shall be
- facilitated by the User. If you change any information, we may
- or may not keep track of your old information. We will not
- retain in our files information you have requested to remove for
- certain circumstances, such as to resolve disputes, troubleshoot
- problems and enforce our terms and conditions. Such prior
- information shall be completely removed from our databases,
- including stored ‘back up’ systems. If you believe that any
- information, we are holding on you is incorrect or incomplete,
- or to remove your profile so that others cannot view it, the
- User needs to remediate, and promptly correct any such incorrect
- information.
-
-
-
-
- CONTROL OF YOUR PASSWORD
-
-
- You are entirely responsible for maintaining the confidentiality
- of your password. It is important that you protect it against
- unauthorized access of your account and information by choosing
- your password carefully and keeping your password and computer
- secure by signing out after using our services. You agree not to
- use the account, username, email address or password of another
- Member at any time or to disclose your password to any third
- party. You are responsible for all actions taken with your login
- information and password, including fees. If you lose control of
- your password, you may lose substantial control over your
- personally identifiable information and may be subject to legally
- binding actions taken on your behalf. Therefore, if your password
- has been compromised for any reason, you should immediately change
- your password. You agree to notify us immediately if you suspect
- any consistent unauthorized use of your account or access to your
- password even after changing it.
-
-
- SECURITY
-
-
- We treat data as an asset that must be protected against loss and
- unauthorized access. We employ many different security techniques
- to protect such data from unauthorized access by members inside
- and outside the Company. We follow generally accepted industry
- standards to protect the Personal Information submitted to us and
- information that we have accessed. However, as effective as
- encryption technology is, no security system is impenetrable. Our
- Companycannot guarantee the security of our database, nor can we
- guarantee that information you provide won’t be intercepted while
- being transmitted to the Companyover the Internet.
-
-
- SEVERABILITY
-
-
- Each paragraph of this Privacy Policy shall be and remain separate
- from and independent of and severable from all and any other
- paragraphs herein except where otherwise expressly indicated or
- indicated by the context of the agreement. The decision or
- declaration that one or more of the paragraphs are null and void
- shall have no effect on the remaining paragraphs of this privacy
- policy.
-
-
-
- CONSENT WITHDRAWAL, DATA DOWNLOAD & DATA REMOVAL REQUESTS
-
-
-
- To withdraw your consent, or to request the download or delete
- your data with us for any or all our services & services at any
- time, please email to info@cartegan.com
-
-
- DO WE MAKE UPDATES TO THIS NOTICE?
-
-
-
- We may update this privacy notice from time to time. The updated
- version will be indicated by an updated "Revised" date and the
- updated version will be effective as soon as it is accessible. If
- we make material changes to this privacy notice, we may notify you
- either by prominently posting a notice of such changes or by
- directly sending you a notification. We encourage you to review
- this privacy notice frequently to be informed of how we are
- protecting your information.
-
-
-
-
-
-
- );
-};
-export default Pp;
diff --git a/apps/web/app/routes/refund-policy.tsx b/apps/web/app/routes/refund-policy.tsx
deleted file mode 100644
index 2c0cbb7..0000000
--- a/apps/web/app/routes/refund-policy.tsx
+++ /dev/null
@@ -1,120 +0,0 @@
-import { redirect } from "@remix-run/node";
-import { Box, Flex, Heading, Link, Text } from "gestalt";
-import React from "react";
-import BigContainer from "../components/BigContainer";
-import Footer2 from "../components/Footer/Footer2";
-import UnauthMobileNav2 from "../components/MobileNav/UnauthMobileNav2";
-import UnauthNav2 from "../components/Navigation/UnauthNav2";
-
-export async function loader() {
- if (ENV.OPEN_SOURCE === "true") {
- return redirect("/");
- }
- return {};
-}
-const Rp: React.FC = () => {
- return (
- <>
-
-
-
-
-
- Documents
-
-
- Terms of service
-
-
- Privacy policy
-
-
- Refund policy
-
-
- Content guidelines
-
-
- Data processing agreement
-
-
- Copyright dispute policy
-
-
-
-
- Refund and Cancellation
-
-
-
-
- We thank you and appreciate using our services. Please read the
- policy, conditions and process carefully as they will give you
- important information and guidelines about your rights and
- obligations as our customer. The policy concerning the processing
- of the refund, shall be following the clauses as set forth:
-
-
-
- PROCESSING OF REFUND
-
-
- Bespoke will charge Customer the Fees for the Services in
- advance for each billing period on or after the first day of
- such billing period. All Fees for Services are due and payable
- in US Dollars and are non-refundable.
-
-
-
-
-
-
- CANCELLATION IN CASE OF TECHNICAL ERROR
-
-
-
- The Company at its sole discretion may cancel any service(s):
-
-
-
-
- if it suspects a User has undertaken a fraudulent transaction,
- or
-
-
-
-
-
- if it suspects a User has undertaken a transaction which is
- not following the Terms of Use, or
-
-
-
-
-
-
in case of unavailability of a service, or
-
-
-
-
-
- if the Company does not want to do business with the User
-
-
-
-
-
-
-
-
-
- );
-};
-export default Rp;
diff --git a/apps/web/app/routes/terms-of-service.tsx b/apps/web/app/routes/terms-of-service.tsx
deleted file mode 100644
index b00bdc8..0000000
--- a/apps/web/app/routes/terms-of-service.tsx
+++ /dev/null
@@ -1,1275 +0,0 @@
-import { redirect } from "@remix-run/node";
-import { Box, Flex, Heading, Link, Text } from "gestalt";
-import React from "react";
-import BigContainer from "../components/BigContainer";
-import Footer2 from "../components/Footer/Footer2";
-import UnauthMobileNav2 from "../components/MobileNav/UnauthMobileNav2";
-import UnauthNav2 from "../components/Navigation/UnauthNav2";
-
-export async function loader() {
- if (ENV.OPEN_SOURCE === "true") {
- return redirect("/");
- }
- return {};
-}
-
-const Tos: React.FC = () => {
- return (
- <>
-
-
-
-
-
- Documents
-
-
- Terms of service
-
-
- Privacy policy
-
-
- Refund policy
-
-
- Content guidelines
-
-
- Data processing agreement
-
-
- Copyright dispute policy
-
-
-
-
- Terms of Service
-
-
-
- AGREEMENT TO TERMS
-
-
-
- These Terms of Use constitute a legally binding agreement made
- between you, whether personally or on behalf of an entity
- (“you”) and Cartegan Software Private Limited ("Company", “we”,
- “us”, or “our”) doing business as Bespoke("Bespoke", "we", "us",
- "our") concerning your access to and use of
- the [https://bespoke.surf](https://bespoke.surf/) website as
- well as any other media form, media channel, mobile website or
- mobile application related, linked, or otherwise connected
- thereto (collectively, the “Site”). You agree that by accessing
- the Site, you have read, understood, and agreed to be bound by
- all of these Terms of Use. IF YOU DO NOT AGREE WITH ALL OF THESE
- TERMS OF USE, THEN YOU ARE EXPRESSLY PROHIBITED FROM USING THE
- SITE AND YOU MUST DISCONTINUE USE IMMEDIATELY. Supplemental
- terms and conditions or documents that may be posted on the Site
- from time to time are hereby expressly incorporated herein by
- reference. We reserve the right, in our sole discretion, to make
- changes or modifications to these Terms of Use at any time and
- for any reason. We will alert you about any changes by updating
- the “Last updated” date of these Terms of Use, and you waive any
- right to receive specific notice of each such change. It is your
- responsibility to periodically review these Terms of Use to stay
- informed of updates. You will be subject to, and will be deemed
- to have been made aware of and to have accepted, the changes in
- any revised Terms of Use by your continued use of the Site after
- the date such revised Terms of Use are posted. The information
- provided on the Site is not intended for distribution to or use
- by any person or entity in any jurisdiction or country where
- such distribution or use would be contrary to law or regulation
- or which would subject us to any registration requirement within
- such jurisdiction or country. Accordingly, those persons who
- choose to access the Site from other locations do so on their
- own initiative and are solely responsible for compliance with
- local laws, if and to the extent local laws are applicable. The
- Site is intended for users who are at least 18 years old.
- Persons under the age of 18 are not permitted to use or register
- for the Site.
-
-
- GENERAL TERMS
-
-
-
- 1. The headings of each section in these Terms are only for the
- purpose of organizing the various provisions under these Terms
- in an orderly manner and shall not be used by either Party to
- interpret the provisions contained herein in any manner.
- Further, it is specifically agreed to by the Parties that the
- headings shall have no legal or contractual value.
-
-
-
-
- 2. The use of this Platform by the you is solely governed by
- these Terms as well as the Privacy Policy, and any modifications
- or amendments made thereto by the Company, from time to time, at
- its sole discretion. If you continue to access and use this
- Platform, you are agreeing to comply with and be bound by the
- following Terms and Conditions of Use and Our Privacy Policy.
- You expressly agrees and acknowledges that these Terms and
- Policy are co-terminus in nature and that expiry/termination of
- either one will lead to the termination of the other.
-
-
-
-
- 3. You unequivocally agrees that these Terms and the
- aforementioned Policy constitute a legally binding agreement
- between the you and the Company, and that you shall be subject
- to the rules, guidelines, policies, terms, and conditions
- applicable to any service that is provided by the Platform, and
- that the same shall be deemed to be incorporated into these
- Terms, and shall be treated as part and parcel of the same. You
- acknowledges and agrees that no signature or express act is
- required to make these Terms and the Policy binding on you and
- that you act of visiting any part of the Platform constitutes
- you the full and final acceptance of these Terms and the
- aforementioned Policy.
-
-
-
-
- 4. The Company reserves the sole and exclusive right to amend or
- modify these Terms without any prior permission or intimation to
- you, and the you expressly agrees that any such amendments or
- modifications shall come into effect immediately. If you do not
- adhere to the changes, they must stop using the Services at
- once. Their continuous use of the Services will signify your
- acceptance of the changed terms.
-
-
- INTELLECTUAL PROPERTY RIGHTS
-
-
-
- Unless otherwise indicated, the Site is our proprietary property
- and all source code, databases, functionality, software, website
- designs, audio, video, text, photographs, and graphics on the
- Site (collectively, the “Content”) and the trademarks, service
- marks, and logos contained therein (the “Marks”) are owned or
- controlled by us or licensed to us, and are protected by
- copyright and trademark laws and various other intellectual
- property rights and unfair competition laws of the United
- States, international copyright laws, and international
- conventions. The Content and the Marks are provided on the Site
- “AS IS” for your information and personal use only. Except as
- expressly provided in these Terms of Use, no part of the Site
- and no Content or Marks may be copied, reproduced, aggregated,
- republished, uploaded, posted, publicly displayed, encoded,
- translated, transmitted, distributed, sold, licensed, or
- otherwise exploited for any commercial purpose whatsoever,
- without our express prior written permission. Provided that you
- are eligible to use the Site, you are granted a limited license
- to access and use the Site and to download or print a copy of
- any portion of the Content to which you have properly gained
- access solely for your personal, non-commercial use. We reserve
- all rights not expressly granted to you in and to the Site, the
- Content and the Marks.
-
-
- USER REPRESENTATIONS
-
-
-
- By using the Site, you represent and warrant that: (1) all
- registration information you submit will be true, accurate,
- current, and complete; (2) you will maintain the accuracy of
- such information and promptly update such registration
- information as necessary; (3) you have the legal capacity and
- you agree to comply with these Terms of Use; (4) you are not a
- minor in the jurisdiction in which you reside; (5) you will not
- access the Site through automated or non-human means, whether
- through a bot, script or otherwise; (6) you will not use the
- Site for any illegal or unauthorized purpose; and (7) your use
- of the Site will not violate any applicable law or regulation.
- If you provide any information that is untrue, inaccurate, not
- current, or incomplete, we have the right to suspend or
- terminate your account and refuse any and all current or future
- use of the Site (or any portion thereof).
-
-
- USER REGISTRATION
-
-
-
- You may be required to register with the Site. You agree to keep
- your password confidential and will be responsible for all use
- of your account and password. We reserve the right to remove,
- reclaim, or change a username you select if we determine, in our
- sole discretion, that such username is inappropriate, obscene,
- or otherwise objectionable.
-
-
-
- SERVICE OVERVIEW
-
-
- Customer shall be responsible for setting up and configuring the
- Services, including without limitation any provisioning of
- access to the Services to its Authorized Users. Customer shall
- be responsible for obtaining and maintaining, at Customer’s
- expense, all of the necessary telecommunications, computer
- hardware, software, services and Internet connectivity required
- by Customer or any Authorized User to access the Services from
- the Internet. In the event that Bespoke assists or advises
- Customer with any Services setup, configuration or support, in
- no event shall such assistance or advice be construed as legal
- advice. Customer is solely responsible for protecting and
- safeguarding Customer’s account and passwords and/or keys or
- other access protocols that have been provided to Customer or
- that are generated in connection with Customer’s use of the
- Services. Customer shall use commercially reasonable efforts to
- prevent unauthorized access to or use of its account and the
- Services. Customer is solely and fully responsible for all
- activities, including accrued charges, that occur in connection
- with its account and its use of the Services. In the event
- Customer believes Customer’s account or the Services have been
- compromised, including any unauthorized use or access of the
- Services or any other known or suspected breach of security,
- Customer shall immediately notify Bespoke by email to
- support@bespoke.surf, but in no event more than twenty-four (24)
- hours following discovery of such breach.
-
-
-
- ELIGIBILITY
-
-
-
- 1. The User has to be of sound mind and must be capable of
- making informed decisions after referring to the guides on the
- Website and Mobile Application.
-
-
-
-
- 2. You hereby represent and warrant that you are at least
- eighteen (18) years of age or above and are fully able and
- competent to understand and agree the terms, conditions,
- obligations, affirmations, representations, and warranties set
- forth in these Terms.
-
-
-
- PAYMENT
-
-
- Bespoke will charge Customer the Fees for the Services in
- advance for each billing period on or after the first day of
- such billing period. All Fees for Services are due and payable
- in US Dollars and are non-refundable. If Customer is paying by
- credit card or eCheck, (a) Customer hereby irrevocably
- authorizes Bespoke to charge the credit card or other payment
- method provided for any such amounts when due, (b) amounts due
- will be automatically charged, (c) if Customer’s credit card is
- declined, Bespoke will attempt to reach out to Customer for a
- new payment method, and (d) if Customer’s credit card expires,
- Customer hereby gives Bespoke permission to submit the credit
- card charge with a later expiration date. If Bespoke fails to
- resolve an issue with Customer resulting from a credit card
- decline or expiration, Bespoke may terminate the account due to
- non-payment. Customer agrees to notify Bespoke of all billing
- disputes within fourteen (14) days of delivery of the billing
- statement or invoice, and disputes not made within that time are
- waived. Late payments, including those resulting from credit
- card declines, will accrue interest at a rate of one and
- one-half percent (1.5%) per month, or the highest rate allowed
- by applicable law, whichever is lower. If Bespoke must initiate
- a collections process to recover Fees due and payable hereunder,
- then Bespoke shall be entitled to recover from Customer all
- costs associated with such collections efforts, including but
- not limited to reasonable attorneys’ fees. In the event Bespoke
- delivers to Customer an invoice for any Fees or interest
- payments owed hereunder, such invoiced amounts shall be due upon
- receipt, unless otherwise set forth in the Service Order.
-
-
-
- USER GENERATED CONTRIBUTIONS
-
-
-
- The Site may invite you to chat, contribute to, or participate
- in blogs, message boards, online forums, and other
- functionality, and may provide you with the opportunity to
- create, submit, post, display, trasmit, perform, publish,
- distribute, or broadcast content and materials to us or on the
- Site, including but not limited to text, writings, video, audio,
- photographs, graphics, comments, suggestions, or personal
- information or other material (collectively, "Contributions").
- Contributions may be viewable by other users of the Site and the
- Marketplace Offerings and through third-party websites. As such,
- any Contributions you transmiit may be treated as
- non-confidential and non-proprietary. When you create or make
- available any Contributions, you thereby represent and warrant
- that:
-
-
-
-
- 1. The creation, distribution, transmission, public display, or
- performance, and the accessing, downloading, or copying of your
- Contributions do not and will not infringe the proprietary
- rights, including but not limited to the copyright, patent,
- trademark, trade secret, or moral rights of any third party.2.
- You are the creator and owner of or have the necessary
- licenses, rights, consents, releases, and permissions to use and
- to authorize us, the Site, and other users of the Site to use
- your Contributions in any manner contemplated by the Site and
- these Terms of Use.3. You have the written consent, release,
- and/or permission of each and every identifiable individual
- person in your Contributions to use the name or likeness of each
- and every such identifiable individual person to enable
- inclusion and use of your Contributions in any manner
- contemplated by the Site and these Terms of Use.4. Your
- Contributions are not false, inaccurate, or misleading.5. Your
- Contributions are not unsolicited or unauthorized advertising,
- promotional materials, pyramid schemes, chain letters, spam,
- mass mailings, or other forms of solicitation.6. Your
- Contributions are not obscene, lewd, lascivious, filthy,
- violent, harassing, libelous, slanderous, or otherwise
- objectionable (as determined by us).7. Your Contributions do
- not ridicule, mock, disparage, intimidate, or abuse anyone.8.
- Your Contributions are not used to harass or threaten (in the
- legal sense of those terms) any other person and to promote
- violence against a specific person or class of people.9. Your
- Contributions do not violate any applicable law, regulation, or
- rule.10. Your Contributions do not violate the privacy or
- publicity rights of any third party.11. Your Contributions do
- not contain any material that solicits personal information from
- anyone under the age of 18 or exploits people under the age of
- 18 in a sexual or violent manner.12. Your Contributions do not
- violate any applicable law concerning child pornography, or
- otherwise intended to protect the health or well-being of
- minors;13. Your Contributions do not include any offensive
- comments that are connected to race, national origin, gender,
- sexual preference, or physical handicap.14. Your Contributions
- do not otherwise violate, or link to material that violates, any
- provision of these Terms of Use, or any applicable law or
- regulation. Any use of the Site or the Marketplace Offerings in
- violation of the foregoing violates these Terms of Use and may
- result in, among other things, termination or suspension of your
- rights to use the Site and the Marketplace Offerings.
-
-
-
-
- CONTRIBUTION LICENSE
-
-
-
- By posting your Contributions to any part of the Site or making
- Contributions accessible to the Site by linking your account from
- the Site to any of your social networking accounts, you
- automatically grant, and you represent and warrant that you have
- the right to grant, to us an unrestricted, unlimited, irrevocable,
- perpetual, non-exclusive, transferable, royalty-free, fully-paid,
- worldwide right, and license to host, use, copy, reproduce,
- disclose, sell, resell, publish, broadcast, retitle, archive,
- store, cache, publicly perform, publicly display, reformat,
- translate, transmit, excerpt (in whole or in part), and distribute
- such Contributions (including, without limitation, your image and
- voice) for any purpose, commercial, advertising, or otherwise, and
- to prepare derivative works of, or incorporate into other works,
- such Contributions, and grant and authorize sublicenses of the
- foregoing. The use and distribution may occur in any media formats
- and through any media channels.
-
-
-
- This license will apply to any form, media, or technology now
- known or hereafter developed, and includes our use of your name,
- company name, and franchise name, as applicable, and any of the
- trademarks, service marks, trade names, logos, and personal and
- commercial images you provide. You waive all moral rights in your
- Contributions, and you warrant that moral rights have not
- otherwise been asserted in your Contributions.
-
-
-
- We do not assert any ownership over your Contributions. You retain
- full ownership of all of your Contributions and any intellectual
- property rights or other proprietary rights associated with your
- Contributions. We are not liable for any statements or
- representations in your Contributions provided by you in any area
- on the Site. You are solely responsible for your Contributions to
- the Site and you expressly agree to exonerate us from any and all
- responsibility and to refrain from any legal action against us
- regarding your Contributions.
-
-
-
- We have the right, in our sole and absolute discretion, (1) to
- edit, redact, or otherwise change any Contributions; (2) to
- re-categorize any Contributions to place them in more appropriate
- locations on the Site; and (3) to pre-screen or delete any
- Contributions at any time and for any reason, without notice. We
- have no obligation to monitor your Contributions.
-
-
- MOBILE APPLICATION LICENSE
- Use License
-
-
-
- If you access the Marketplace Offerings via a mobile application,
- then we grant you a revocable, non-exclusive, non-transferable,
- limited right to install and use the mobile application on
- wireless electronic devices owned or controlled by you, and to
- access and use the mobile application on such devices strictly in
- accordance with the terms and conditions of this mobile
- application license contained in these Terms of Use. You shall
- not: (1) decompile, reverse engineer, disassemble, attempt to
- derive the source code of, or decrypt the application; (2) make
- any modification, adaptation, improvement, enhancement,
- translation, or derivative work from the application; (3) violate
- any applicable laws, rules, or regulations in connection with your
- access or use of the application; (4) remove, alter, or obscure
- any proprietary notice (including any notice of copyright or
- trademark) posted by us or the licensors of the application; (5)
- use the application for any revenue generating endeavor,
- commercial enterprise, or other purpose for which it is not
- designed or intended; (6) make the application available over a
- network or other environment permitting access or use by multiple
- devices or users at the same time; (7) use the application for
- creating a product, service, or software that is, directly or
- indirectly, competitive with or in any way a substitute for the
- application; (8) use the application to send automated queries to
- any website or to send any unsolicited commercial e-mail; or (9)
- use any proprietary information or any of our interfaces or our
- other intellectual property in the design, development,
- manufacture, licensing, or distribution of any applications,
- accessories, or devices for use with the application.
-
-
- Apple and Android Devices
-
-
-
- The following terms apply when you use a mobile application
- obtained from either the Apple Store or Google Play (each an “App
- Distributor”) to access the Marketplace Offerings: (1) the license
- granted to you for our mobile application is limited to a
- non-transferable license to use the application on a device that
- utilizes the Apple iOS or Android operating systems, as
- applicable, and in accordance with the usage rules set forth in
- the applicable App Distributor’s terms of service; (2) we are
- responsible for providing any maintenance and support services
- with respect to the mobile application as specified in the terms
- and conditions of this mobile application license contained in
- these Terms of Use or as otherwise required under applicable law,
- and you acknowledge that each App Distributor has no obligation
- whatsoever to furnish any maintenance and support services with
- respect to the mobile application; (3) in the event of any failure
- of the mobile application to conform to any applicable warranty,
- you may notify the applicable App Distributor, and the App
- Distributor, in accordance with its terms and policies, may refund
- the purchase price, if any, paid for the mobile application, and
- to the maximum extent permitted by applicable law, the App
- Distributor will have no other warranty obligation whatsoever with
- respect to the mobile application; (4) you represent and warrant
- that (i) you are not located in a country that is subject to a
- U.S. government embargo, or that has been designated by the U.S.
- government as a “terrorist supporting” country and (ii) you are
- not listed on any U.S. government list of prohibited or restricted
- parties; (5) you must comply with applicable third-party terms of
- agreement when using the mobile application, e.g., if you have a
- VoIP application, then you must not be in violation of their
- wireless data service agreement when using the mobile application;
- and (6) you acknowledge and agree that the App Distributors are
- third-party beneficiaries of the terms and conditions in this
- mobile application license contained in these Terms of Use, and
- that each App Distributor will have the right (and will be deemed
- to have accepted the right) to enforce the terms and conditions in
- this mobile application license contained in these Terms of Use
- against you as a third-party beneficiary thereof.
-
-
- SOCIAL MEDIA
-
-
-
- As part of the functionality of the Site, you may link your
- account with online accounts you have with third-party service
- providers (each such account, a “Third-Party Account”) by either:
- (1) providing your Third-Party Account login information through
- the Site; or (2) allowing us to access your Third-Party Account,
- as is permitted under the applicable terms and conditions that
- govern your use of each Third-Party Account. You represent and
- warrant that you are entitled to disclose your Third-Party Account
- login information to us and/or grant us access to
- your Third-Party Account, without breach by you of any of the
- terms and conditions that govern your use of the
- applicable Third-Party Account, and without obligating us to pay
- any fees or making us subject to any usage limitations imposed by
- the third-party service provider of the Third-Party Account. By
- granting us access to any Third-Party Accounts, you understand
- that (1) we may access, make available, and store (if applicable)
- any content that you have provided to and stored in
- your Third-Party Account (the “Social Network Content”) so that it
- is available on and through the Site via your account, including
- without limitation any friend lists and (2) we may submit to and
- receive from your Third-Party Account additional information to
- the extent you are notified when you link your account with
- the Third-Party Account. Depending on the Third-Party Accounts you
- choose and subject to the privacy settings that you have set in
- such Third-Party Accounts, personally identifiable information
- that you post to your Third-Party Accounts may be available on and
- through your account on the Site. Please note that if
- a Third-Party Account or associated service becomes unavailable or
- our access to such Third-Party Account is terminated by the
- third-party service provider, then Social Network Content may no
- longer be available on and through the Site. You will have the
- ability to disable the connection between your account on the Site
- and your Third-Party Accounts at any time. PLEASE NOTE THAT YOUR
- RELATIONSHIP WITH THE THIRD-PARTY SERVICE PROVIDERS ASSOCIATED
- WITH YOUR THIRD-PARTY ACCOUNTS IS GOVERNED SOLELY BY YOUR
- AGREEMENT(S) WITH SUCH THIRD-PARTY SERVICE PROVIDERS. We make no
- effort to review any Social Network Content for any purpose,
- including but not limited to, for accuracy, legality, or
- non-infringement, and we are not responsible for any Social
- Network Content. You acknowledge and agree that we may access your
- email address book associated with a Third-Party Account and your
- contacts list stored on your mobile device or tablet computer
- solely for purposes of identifying and informing you of those
- contacts who have also registered to use the Site. You can
- deactivate the connection between the Site and
- your Third-Party Account by contacting us using the contact
- information below or through your account settings (if
- applicable). We will attempt to delete any information stored on
- our servers that was obtained through such Third-Party Account,
- except the username and profile picture that become associated
- with your account.
-
-
- 14. Continued Obligation.
-
-
-
-
- Even if you close your account or we terminate your Subscription,
- you will still be responsible for indemnifying us for breaches
- that took place while you used the Site and Services. Obligations
- you owed to us and other Site users, which by their nature are
- intended to survive closing or termination, will survive.
-
-
- SUBMISSIONS
-
-
-
- You acknowledge and agree that any questions, comments,
- suggestions, ideas, feedback, or other information regarding the
- Site or the Marketplace Offerings ("Submissions") provided by you
- to us are non-confidential and shall become our sole property. We
- shall own exclusive rights, including all intellectual property
- rights, and shall be entitled to the unrestricted use and
- dissemination of these Submissions for any lawful purpose,
- commercial or otherwise, without acknowledgment or compensation to
- you. You hereby waive all moral rights to any such Submissions,
- and you hereby warrant that any such Submissions are original with
- you or that you have the right to submit such Submissions. You
- agree there shall be no recourse against us for any alleged or
- actual infringement or misappropriation of any proprietary right
- in your Submissions.
-
-
- THIRD-PARTY WEBSITES AND CONTENT
-
-
-
- The Site may contain (or you may be sent via the Site or the
- Marketplace Offerings) links to other websites
- ("Third-Party Websites") as well as articles, photographs, text,
- graphics, pictures, designs, music, sound, video, information,
- applications, software, and other content or items belonging to or
- originating from third parties ("Third-Party Content").
- Such Third-Party Websites and Third-Party Content are not
- investigated, monitored, or checked for accuracy, appropriateness,
- or completeness by us, and we are not responsible for any Third
- Party Websites accessed through the Site or
- any Third-Party Content posted on, available through, or installed
- from the Site, including the content, accuracy, offensiveness,
- opinions, reliability, privacy practices, or other policies of or
- contained in the Third-Party Websites or the Third-Party Content.
- Inclusion of, linking to, or permitting the use or installation of
- any Third-Party Websites or any Third-PartyContent does not imply
- approval or endorsement thereof by us. If you decide to leave the
- Site and access the Third-Party Websites or to use or install
- any Third-Party Content, you do so at your own risk, and you
- should be aware these Terms of Use no longer govern. You should
- review the applicable terms and policies, including privacy and
- data gathering practices, of any website to which you navigate
- from the Site or relating to any applications you use or install
- from the Site. Any purchases you make through Third-Party Websites
- will be through other websites and from other companies, and we
- take no responsibility whatsoever in relation to such purchases
- which are exclusively between you and the applicable third party.
- You agree and acknowledge that we do not endorse the products or
- services offered on Third-Party Websites and you shall hold us
- harmless from any harm caused by your purchase of such products or
- services. Additionally, you shall hold us harmless from any losses
- sustained by you or harm caused to you relating to or resulting in
- any way from any Third-Party Content or any contact
- with Third-Party Websites.
-
-
- SITE MANAGEMENT
-
-
-
- We reserve the right, but not the obligation, to: (1) monitor the
- Site for violations of these Terms of Use; (2) take appropriate
- legal action against anyone who, in our sole discretion, violates
- the law or these Terms of Use, including without limitation,
- reporting such user to law enforcement authorities; (3) in our
- sole discretion and without limitation, refuse, restrict access
- to, limit the availability of, or disable (to the extent
- technologically feasible) any of your Contributions or any portion
- thereof; (4) in our sole discretion and without limitation,
- notice, or liability, to remove from the Site or otherwise disable
- all files and content that are excessive in size or are in any way
- burdensome to our systems; and (5) otherwise manage the Site in a
- manner designed to protect our rights and property and to
- facilitate the proper functioning of the Site and the Marketplace
- Offerings.
-
-
- PRIVACY POLICY
-
-
- We care about data privacy and security. Please review our{" "}
-
- Privacy Policy
-
- . By using the Site or the Marketplace Offerings, you agree to be
- bound by our Privacy Policy, which is incorporated into these
- Terms of Use. Please be advised the Site and the Marketplace
- Offerings are hosted in India. If you access the Site or the
- Marketplace Offerings from any other region of the world with laws
- or other requirements governing personal data collection, use, or
- disclosure that differ from applicable laws in India, then through
- your continued use of the Site, you are transferring your data
- to India, and you expressly consent to have your data transferred
- to and processed
-
-
- TERM AND TERMINATION
-
-
- These Terms of Use shall remain in full force and effect while you
- use the Site. WITHOUT LIMITING ANY OTHER PROVISION OF THESE TERMS
- OF USE, WE RESERVE THE RIGHT TO, IN OUR SOLE DISCRETION AND
- WITHOUT NOTICE OR LIABILITY, DENY ACCESS TO AND USE OF THE SITE
- AND THE MARKETPLACE OFFERINGS (INCLUDING BLOCKING CERTAIN IP
- ADDRESSES), TO ANY PERSON FOR ANY REASON OR FOR NO REASON,
- INCLUDING WITHOUT LIMITATION FOR BREACH OF ANY REPRESENTATION,
- WARRANTY, OR COVENANT CONTAINED IN THESE TERMS OF USE OR OF ANY
- APPLICABLE LAW OR REGULATION. WE MAY TERMINATE YOUR USE OR
- PARTICIPATION IN THE SITE AND THE MARKETPLACE OFFERINGS OR
- DELETE YOUR ACCOUNT AND ANY CONTENT OR INFORMATION THAT YOU POSTED
- AT ANY TIME, WITHOUT WARNING, IN OUR SOLE DISCRETION.
-
-
-
- If we terminate or suspend your account for any reason, you are
- prohibited from registering and creating a new account under your
- name, a fake or borrowed name, or the name of any third party,
- even if you may be acting on behalf of the third party. In
- addition to terminating or suspending your account, we reserve the
- right to take appropriate legal action, including without
- limitation pursuing civil, criminal, and injunctive redress.
-
-
- MODIFICATIONS AND INTERRUPTIONS
-
-
- We reserve the right to change, modify, or remove the contents of
- the Site at any time or for any reason at our sole discretion
- without notice. However, we have no obligation to update any
- information on our Site. We also reserve the right to modify or
- discontinue all or part of the Marketplace Offerings without
- notice at any time. We will not be liable to you or any third
- party for any modification, price change, suspension, or
- discontinuance of the Site or the Marketplace Offerings.
-
-
-
- We cannot guarantee the Site and the Marketplace Offerings will be
- available at all times. We may experience hardware, software, or
- other problems or need to perform maintenance related to the Site,
- resulting in interruptions, delays, or errors. We reserve the
- right to change, revise, update, suspend, discontinue, or
- otherwise modify the Site or the Marketplace Offerings at any time
- or for any reason without notice to you. You agree that we have no
- liability whatsoever for any loss, damage, or inconvenience caused
- by your inability to access or use the Site or the Marketplace
- Offerings during any downtime or discontinuance of the Site or the
- Marketplace Offerings. Nothing in these Terms of Use will be
- construed to obligate us to maintain and support the Site or the
- Marketplace Offerings or to supply any corrections, updates, or
- releases in connection therewith.
-
-
- COMMUNICATION
-
-
- By using this Services and Platforms, and providing his/her
- identity and contact information to the Company through the
- Platform, the User hereby agrees and consents to receive calls,
- e-mails or SMS from the Company or any of its representatives at
- any time.
-
-
-
- Users can report to the Company any grievances or suggestions that
- they have through e-mail, if they find any discrepancy with regard
- to the information generated on the Platform, the Company will
- take necessary action after an investigation. The response with
- resolution (if any issues found) shall be dependent on the time
- that is taken for investigation.
-
-
-
- USER OBLIGATIONS AND FORMAL UNDERTAKINGS AS TO CONDUCT
-
-
-
- The User agrees and acknowledges that they are a restricted user
- of this Platform and that they:
-
-
-
-
- Authorize the Platform to use, store or otherwise process
- certain personal information and all published Content, reviews
- and ratings, comments and feedback for personalization of
- Services, marketing, and promotional purposes and for
- optimization of Userrelated options and Services.
-
-
-
-
-
- Agree not to access (or attempt to access) the Platform and/or
- the materials or Services by any means other than through the
- interface provided by the Platform.
-
-
-
-
-
- Expressly agree and acknowledge that the Content displayed on
- the Platform is for purpose of reference only, under no
- circumstance shall the User construe the same as expert/
- professional advice. The User may, however, report any offensive
- or objectionable content, which the Company may then remove from
- the Platform, at its sole discretion.
-
-
-
-
-
- Expressly agrees to make good any losses suffered by the Company
- or platform which result as a consequence of any act committed
- by the User including but not limited to acts of fraud,
- misrepresentation of information provided on the Company as
- expert advice or posting slanderous or libelous content in the
- form of comments or feedback.
-
-
-
-
-
- Agrees that they are using the services of the Platform and
- accessing the platform at their own risk with their prudent
- judgment and the Company or Platform shall not be responsible
- for any resultant losses suffered.
-
-
-
-
-
- Agrees that the platform will be used by him solely for
- non-commercial use with the intent of gaining information about
- the featured services in the form of guides. No commercial
- endorsements will be made on the platform. This includes
- providing links to other platforms which may or may or may not
- be competitors of the Company. In the event of detection of
- commercial activity by a user, the Platform will have the right
- to bar him from posting further comments or content on the
- Platform.
-
-
-
-
- Further:
-
-
-
-
- The User hereby expressly authorizes the Company /Platform to
- disclose any and all information relating to the User in the
- possession of the Company /Platform to law enforcement or other
- government officials, as the Company may in its sole discretion,
- believe necessary or appropriate in connection with the
- investigation and/or resolution of possible crimes, especially
- those involve personal injury and theft/infringement of
- intellectual property. The User further understands that the
- Company /Platform might with to disclose any information
- (including the identity of persons providing information or
- materials on the Platform) as necessary to satisfy any judicial
- Order, law, regulation or valid governmental request.
-
-
-
-
-
- The User agrees to use the services provided by the Company, its
- affiliates, consultants and contracted companies, for lawful
- purposes only.
-
-
-
-
-
- The User agrees not to post any material on the Website and
- Mobile Application that is defamatory, offensive, obscene,
- indecent, abusive, or needlessly distressful, or advertising any
- goods or services. More specifically, the User agrees not to
- host, display, upload, update, publish, modify, transmit, or in
- any manner share any information that:
-
-
-
-
-
- belongs to another person and to which the User has no right to;
- is grossly harmful, harassing, blasphemous, defamatory, obscene,
- pornographic, pedophile, libelous, invasive of another's
- privacy, hateful, or racially, ethnically objectionable,
- disparaging, or otherwise unlawful in any manner whatever; but
- not limited to "indecent representation of women" within the
- meaning of the Indecent Representation of Women (Prohibition)
- Act, 1986;
-
-
-
-
-
violates any law for the time being in force;
-
-
-
-
deceives or misleads the other users
-
-
- INTELLECTUAL PROPERTY RIGHTS
-
-
- Unless expressly agreed to in writing, nothing contained herein
- shall give the User a right to use any of the Platform’s Content
- which includes but is not limited to trade names, trademarks,
- service marks, logos, domain names, information, questions,
- answers, solutions, reports, illustrations, photographs, write-ups
- save and other distinctive brand features according to the
- provisions of these Terms.
-
-
- FORCE MAJEURE
-
-
- Neither the Company nor the Platform shall be liable for damages
- for any delay or failure to perform its obligations hereunder if
- such delay or failure is due to cause beyond its control or
- without its fault or negligence, due to Force Majeure events
- including but not limited to acts of war, acts of God, earthquake,
- riot, fire, festive activities sabotage, labour shortage or
- dispute, internet interruption, technical failure, breakage of sea
- cable, hacking, piracy, cheating, illegal or unauthorized.
-
-
- DISPUTE RESOLUTION AND JURISDICTION
-
-
- It is expressly agreed to by the Parties hereto that the
- formation, interpretation, and performance of these Terms and any
- disputes arising therefrom will be resolved through a two-step
- Alternate Dispute Resolution (“ADR”) mechanism. It is further
- agreed to by the Parties that the contents of this Section shall
- survive even after the termination or expiry of the Terms and/or
- Policy.
-
-
-
- Mediation:
-
-
- In case of any dispute between the parties, the Parties will
- attempt to resolve the same amicably amongst themselves, to the
- mutual satisfaction of all parties. In the event that the Parties
- are unable to reach such an amicable solution within thirty (30)
- days of one Party communicating the existence of a dispute to any
- other Party, the dispute will be resolved by arbitration, as
- detailed herein below;
-
-
- Arbitration:
-
-
- In the event that the Parties are unable to amicably resolve a
- dispute by mediation, said dispute will be referred to arbitration
- by a sole arbitrator to be appointed by the Company, and the award
- passed by such sole arbitrator will be valid and binding on all
- parties. The Parties shall bear their own costs for the
- proceedings, although the sole arbitrator may, in his/her sole
- discretion, direct either Party to bear the entire cost of the
- proceedings. The arbitration shall be conducted in English, and
- the seat of Arbitration shall be the city of Kochi.
-
-
- CORRECTIONS
-
-
- There may be information on the Site that contains typographical
- errors, inaccuracies, or omissions that may relate to the
- Marketplace Offerings, including descriptions, pricing,
- availability, and various other information. We reserve the right
- to correct any errors, inaccuracies, or omissions and to change or
- update the information on the Site at any time, without prior
- notice.
-
-
- DISCLAIMER
-
-
- THE SITE IS PROVIDED ON AN AS-IS AND AS-AVAILABLE BASIS. YOU AGREE
- THAT YOUR USE OF THE SITE SERVICES WILL BE AT YOUR SOLE RISK. TO
- THE FULLEST EXTENT PERMITTED BY LAW, WE DISCLAIM ALL WARRANTIES,
- EXPRESS OR IMPLIED, IN CONNECTION WITH THE SITE AND YOUR USE
- THEREOF, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
- NON-INFRINGEMENT. WE MAKE NO WARRANTIES OR REPRESENTATIONS ABOUT
- THE ACCURACY OR COMPLETENESS OF THE SITE’S CONTENT OR THE CONTENT
- OF ANY WEBSITES LINKED TO THIS SITE AND WE WILL ASSUME NO
- LIABILITY OR RESPONSIBILITY FOR ANY (1) ERRORS, MISTAKES, OR
- INACCURACIES OF CONTENT AND MATERIALS, (2) PERSONAL INJURY OR
- PROPERTY DAMAGE, OF ANY NATURE WHATSOEVER, RESULTING FROM YOUR
- ACCESS TO AND USE OF THE SITE, (3) ANY UNAUTHORIZED ACCESS TO OR
- USE OF OUR SECURE SERVERS AND/OR ANY AND ALL PERSONAL INFORMATION
- AND/OR FINANCIAL INFORMATION STORED THEREIN, (4) ANY INTERRUPTION
- OR CESSATION OF transmISSION TO OR FROM THE SITE, (5) ANY BUGS,
- VIRUSES, TROJAN HORSES, OR THE LIKE WHICH MAY BE transmITTED TO OR
- THROUGH THE SITE BY ANY THIRD PARTY, AND/OR (6) ANY ERRORS OR
- OMISSIONS IN ANY CONTENT AND MATERIALS OR FOR ANY LOSS OR DAMAGE
- OF ANY KIND INCURRED AS A RESULT OF THE USE OF ANY CONTENT POSTED,
- transmITTED, OR OTHERWISE MADE AVAILABLE VIA THE SITE. WE DO NOT
- WARRANT, ENDORSE, GUARANTEE, OR ASSUME RESPONSIBILITY FOR ANY
- PRODUCT OR SERVICE ADVERTISED OR OFFERED BY A THIRD PARTY THROUGH
- THE SITE, ANY HYPERLINKED WEBSITE, OR ANY WEBSITE OR MOBILE
- APPLICATION FEATURED IN ANY BANNER OR OTHER ADVERTISING, AND WE
- WILL NOT BE A PARTY TO OR IN ANY WAY BE RESPONSIBLE FOR MONITORING
- ANY TRANSACTION BETWEEN YOU AND ANY THIRD-PARTY PROVIDERS OF
- PRODUCTS OR SERVICES. AS WITH THE PURCHASE OF A PRODUCT OR SERVICE
- THROUGH ANY MEDIUM OR IN ANY ENVIRONMENT, YOU SHOULD USE YOUR BEST
- JUDGMENT AND EXERCISE CAUTION WHERE APPROPRIATE.
-
-
-
- THE FIRM WILL NOT BE RESPONSIBLE FOR ANY DAMAGE SUFFERED BY
- VENDORS FROM USE OR PURCHASE OF THE PRODUCTS OR SERVICES ON THIS
- PLATFORM. THIS INCLUDES BUT IS NOT LIMITED TO, LOSS OF
- REVENUE/DATA RESULTING FROM DELAYS, NON-DELIVERIES, MISSED
- DELIVERIES, OR SERVICE INTERRUPTIONS AS MAY OCCUR BECAUSE OF ANY
- ACT/OMISSION OF PARTIES. THIS DISCLAIMER OF LIABILITY ALSO APPLIES
- TO ANY DAMAGES OR INJURY CAUSED BY ANY FAILURE OF PERFORMANCE,
- ERROR, OMISSION, INTERRUPTION, DELETION, DEFECT, DELAY IN
- OPERATION OR transmISSION, COMPUTER VIRUS, COMMUNICATION LINE
- FAILURE, THEFT OR DESTRUCTION OR UNAUTHORIZED ACCESS TO,
- ALTERATION OF, OR USE OF RECORD, WHETHER FOR BREACH OF CONTRACT,
- TORTUOUS BEHAVIOUR, NEGLIGENCE, OR UNDER ANY OTHER CAUSE OF
- ACTION.
-
-
-
- THE FIRM ALSO MAKES IT CLEAR THAT IT SHALL NOT BE HELD LIABLE FOR
- ANY DAMAGE/HURT/INCONVENIENCE CAUSED TO THE VENDOR THROUGH THE
- COURSE OF THE PROVISION OF SERVICES OR AS A RESULT OF THE VENDORS’
- ACTIONS. THE FIRM MAKES NO REPRESENTATIONS OR WARRANTIES AS TO THE
- CONDUCT OF THE VENDORS. THE FIRM TAKES NO RESPONSIBILITY FOR ANY
- CONTENT THAT VENDORS SEND OR RECEIVE FROM OTHER VENDORS OR
- THIRD-PARTY POSTS THROUGH THE WEBSITE OR PLATFORM. ANY MATERIAL
- DOWNLOADED OR OTHERWISE OBTAINED THROUGH USE OF THE SERVICE IS
- ACCESSED AT THE VENDORS OWN DISCRETION AND RISK.
-
-
-
- THE SERVICES ON THE PLATFORM ARE INTENDED TO BE SUBJECT TO
- AVAILABILITY, WITHOUT ANY PROMISES OR GUARANTEES ON THE SAME BY
- THE FIRM, AND WHILE CERTAIN INFORMATION AVAILABLE ON THE PLATFORM
- IS THE PROPERTY OF THE FIRM AND THE FIRM ENDEAVOURS TO KEEP THE
- SAID INFORMATION UPDATED AND ACCURATE, THE FIRM SHALL NOT MAKE NO
- REPRESENTATIONS OR WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED,
- ABOUT THE COMPLETENESS, ACCURACY, RELIABILITY, SUITABILITY OR
- AVAILABILITY WITH RESPECT TO THE PLATFORM OR THE INFORMATION,
- CUSTOMERS, SERVICES, OR RELATED GRAPHICS CONTAINED ON THE PLATFORM
- FOR ANY PURPOSE. ANY RELIANCE YOU PLACE ON SUCH INFORMATION IS
- THEREFORE STRICTLY AT YOUR OWN RISK.
-
-
-
- THE SERVICES ON THE PLATFORM ARE BASED ON THE INFORMATION THAT IS
- GIVEN BY THE USER AND THE CORRECTNESS OF AUTHENTICITY OF THE SAME
- IS ASSURED BY THE USERS, THE USERS CANNOT HOLD THE PLATFORM
- ACCOUNTABLE FOR THE MISTAKES CAUSED BY ANY ERROR IN THE
- INFORMATION.
-
-
-
- ANY AND OR ALL THE INTELLECTUAL PROPERTY ON THE FIRM PLATFORM MAY
- HAVE BEEN TRADEMARKED OR COPYRIGHTED BY THE FIRM AND OR ANY OTHER
- SUCH PERSON AND ANY USE, MISUSE OR MANIPULATIONS THAT MAY BE IN
- RELATION TO THE INTELLECTUAL PROPERTY SHALL BE THE RESPONSIBILITY
- OF THE VENDOR. HOWEVER, WHEN BROUGHT TO THE NOTICE OF THE FIRM,
- THERE SHALL BE IMMEDIATE LEGAL ACTION TAKEN.
-
-
-
- THE FIRM BEARS NO RESPONSIBILITY WHATSOEVER FOR ANY CONSEQUENCES
- ARISING FROM THE USE OF THE SAID SERVICES BY VENDORS. THE USE OF
- THE SERVICES IN THE PLATFORM IS THE SOLE RESPONSIBILITY OF THE
- VENDOR(OR LEGALLY AUTHORISED PERSON ON BEHALF OF THE VENDOR), AND
- IN CASE OF ANY NEGLIGENCE ON THE PART OF THE VENDOR IN ACTING ON
- THE SAME SHALL NOT BE CONSTRUED AS IMPOSING ANY LIABILITY, DIRECT
- OR INDIRECT, ON THE FIRM/PLATFORM.
-
-
-
- THE FIRM SHALL DISCLAIM ALL RESPONSIBILITY AND OWNS NO LIABILITY
- TO VENDORS FOR ANY OUTCOME (INCIDENTAL, DIRECT, INDIRECT OR
- OTHERWISE) FROM THE USE OF THE SERVICES. IN NO EVENT WILL THE FIRM
- BE LIABLE FOR ANY LOSS OR DAMAGE INCLUDING WITHOUT LIMITATION,
- INDIRECT OR CONSEQUENTIAL LOSS OR DAMAGE, OR ANY LOSS OR DAMAGE
- WHATSOEVER ARISING FROM LOSS OF DATA OR PROFITS ARISING OUT OF, OR
- IN CONNECTION WITH, THE USE OF THE PLATFORM.
-
-
-
- THROUGH THIS PLATFORM, YOU MAY ABLE TO LINK TO OTHER PLATFORMS
- WHICH ARE NOT UNDER THE CONTROL OF THE FIRM. WE HAVE NO CONTROL
- OVER NATURE, CONTENT AND AVAILABILITY OF THOSE SITES. THE
- INCLUSION OF ANY LINKS DOES NOT NECESSARILY IMPLY A RECOMMENDATION
- OR ENDORSE THE VIEWS EXPRESSED WITHIN THEM. EVERY EFFORT IS MADE
- TO KEEP THE PLATFORM UP AND RUNNING SMOOTHLY. HOWEVER, THE FIRM
- TAKES NO RESPONSIBILITY FOR, AND WILL NOT BE LIABLE FOR, THE
- PLATFORM BEING TEMPORARILY UNAVAILABLE DUE TO TECHNICAL ISSUES
- BEYOND OUR CONTROL.
-
-
-
- TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, WE WILL HAVE NO
- LIABILITY RELATED TO VENDOR CONTENT ARISING UNDER INTELLECTUAL
- PROPERTY RIGHTS, LIBEL, PRIVACY, PUBLICITY, OBSCENITY OR OTHER
- LAWS. WEBSITE ALSO DISCLAIMS ALL LIABILITY WITH RESPECT TO THE
- MISUSE, LOSS, MODIFICATION OR UNAVAILABILITY OF ANY VENDOR
- CONTENT.
-
-
-
- THE VENDOR UNDERSTANDS AND AGREES THAT ANY MATERIAL OR DATA
- DOWNLOADED OR OTHERWISE OBTAINED THROUGH THE PLATFORM IS DONE
- ENTIRELY AT HIS/HER OWN DISCRETION AND RISK AND HE/SHE WILL BE
- SOLELY RESPONSIBLE FOR ANY DAMAGE TO HIS/HER COMPUTER SYSTEMS OR
- LOSS OF DATA THAT RESULTS FROM THE DOWNLOAD OF SUCH MATERIAL OR
- DATA. WE ARE NOT RESPONSIBLE FOR ANY TYPOGRAPHICAL ERROR LEADING
- TO AN INVALID COUPON. PLATFORM ACCEPTS NO LIABILITY FOR ANY ERRORS
- OR OMISSIONS, WITH RESPECT TO ANY INFORMATION PROVIDED TO YOU
- WHETHER ON BEHALF OF ITSELF OR THIRD PARTIES.
-
-
-
- YOU AGREE THAT YOUR USE OF THE WEBSITE AND USE OF THE SERVICES
- GIVEN BY THE FIRM SHALL BE AT YOUR OWN RISK. TO THE FULLEST EXTENT
- PERMITTED BY LAW, AND CARTAGENA SOFTWARE PVT. LTD AND ITS
- OFFICERS, MANAGERS, MEMBERS, DIRECTORS, EMPLOYEES, SUCCESSORS,
- ASSIGNS, SUBSIDIARIES, AFFILIATES, SERVICE PROFESSIONALS,
- SUPPLIERS, AND AGENTS DISCLAIM ALL WARRANTIES, EXPRESS, IMPLIED,
- STATUTORY OR OTHERWISE, AND MAKE NO WARRANTIES, REPRESENTATIONS,
- OR GUARANTEES IN CONNECTION WITH THIS WEBSITE, THE SERVICES
- OFFERED ON OR THROUGH THIS WEBSITE, ANY DATA, MATERIALS, SUBMITTED
- CONTENT, RELATING TO THE QUALITY, SUITABILITY, TRUTH, ACCURACY OR
- COMPLETENESS OF ANY INFORMATION OR MATERIAL CONTAINED OR PRESENTED
- ON THIS WEBSITE, INCLUDING WITHOUT LIMITATION THE MATERIALS, DATA
- AND SUBMITTED CONTENT OF OTHER VENDORS OF THIS SITE OR OTHER THIRD
- PARTIES. UNLESS OTHERWISE EXPLICITLY STATED, TO THE MAXIMUM EXTENT
- PERMITTED BY APPLICABLE LAW, THIS WEBSITE, THE SERVICES OFFERED ON
- OR THROUGH THIS WEBSITE, DATA, MATERIALS, SUBMITTED CONTENT, AND
- ANY INFORMATION OR MATERIAL CONTAINED OR PRESENTED ON THIS WEBSITE
- IS PROVIDED TO YOU ON AN “AS IS”, “AS AVAILABLE” AND “WHERE-IS”
- BASIS WITH, NON-INFRINGEMENT OF THIRD-PARTY RIGHTS. FIRM DOES NOT
- PROVIDE ANY WARRANTIES AGAINST ERRORS, MISTAKES, OR INACCURACIES
- OF DATA, CONTENT, INFORMATION, MATERIALS, SUBSTANCE OF THE WEBSITE
- OR SUBMITTED CONTENT, ANY UNAUTHORIZED ACCESS TO OR USE OF OUR
- SECURE SERVERS AND/OR ANY AND ALL PERSONAL INFORMATION AND/OR
- FINANCIAL INFORMATION STORED THEREIN, ANY BUGS, VIRUSES, TROJAN
- HORSES, OR THE LIKE WHICH MAY BE transmITTED TO OR THROUGH THE
- WEBSITE BY ANY THIRD PARTY, ANY INTERRUPTION OR CESSATION OF
- transmISSION TO OR FROM THE WEBSITE, ANY DEFAMATORY, OFFENSIVE, OR
- ILLEGAL CONDUCT OF ANY THIRD PARTY OR SERVICE VENDOR OR SERVICE
- PROVIDER, OR ANY LOSS OR DAMAGE OF ANY KIND INCURRED AS A RESULT
- OF THE USE OF ANY DATA, CONTENT, INFORMATION, MATERIALS, SUBSTANCE
- OF THE WEBSITE OR SUBMITTED CONTENT POSTED, EMAILED, transmITTED,
- OR OTHERWISE MADE AVAILABLE VIA THE WEBSITE. FIRM WILL NOT BE A
- PARTY TO OR IN ANY WAY BE RESPONSIBLE FOR MONITORING ANY
- TRANSACTION BETWEEN YOU AND ANY PARTY, INCLUDING THIRD PARTY
- SERVICE PROFESSIONALS OF PRODUCTS OR SERVICES. AS WITH THE USE OF
- ANY PRODUCT OR SERVICE, AND THE PUBLISHING OR POSTING OF ANY
- MATERIAL THROUGH ANY MEDIUM OR IN ANY ENVIRONMENT, YOU SHOULD USE
- YOUR BEST JUDGMENT AND EXERCISE CAUTION WHERE APPROPRIATE.
-
-
- LIMITATIONS OF LIABILITY
-
-
- IN NO EVENT WILL WE OR OUR DIRECTORS, EMPLOYEES, OR AGENTS BE
- LIABLE TO YOU OR ANY THIRD PARTY FOR ANY DIRECT, INDIRECT,
- CONSEQUENTIAL, EXEMPLARY, INCIDENTAL, SPECIAL, OR PUNITIVE
- DAMAGES, INCLUDING LOST PROFIT, LOST REVENUE, LOSS OF DATA, OR
- OTHER DAMAGES ARISING FROM YOUR USE OF THE SITE, EVEN IF WE HAVE
- BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
-
-
- INDEMNIFICATION
-
-
- You agree to defend, indemnify, and hold us harmless, including
- our subsidiaries, affiliates, and all of our respective officers,
- agents, partners, and employees, from and against any loss,
- damage, liability, claim, or demand, including reasonable
- attorneys’ fees and expenses, made by any third party due to or
- arising out of: (1) your Contributions; (2) use of the Site; (3)
- breach of these Terms of Use; (4) any breach of your
- representations and warranties set forth in these Terms of Use;
- (5) your violation of the rights of a third party, including but
- not limited to intellectual property rights; or (6) any overt
- harmful act toward any other user of the Site with whom you
- connected via the Site. Notwithstanding the foregoing, we reserve
- the right, at your expense, to assume the exclusive defense and
- control of any matter for which you are required to indemnify us,
- and you agree to cooperate, at your expense, with our defense of
- such claims. We will use reasonable efforts to notify you of any
- such claim, action, or proceeding which is subject to this
- indemnification upon becoming aware of it.
-
-
- USER DATA
-
-
- We will maintain certain data that you transmit to the Site for
- the purpose of managing the performance of the Site, as well as
- data relating to your use of the Site. Although we perform regular
- routine backups of data, you are solely responsible for all data
- that you transmit or that relates to any activity you have
- undertaken using the Site. You agree that we shall have no
- liability to you for any loss or corruption of any such data, and
- you hereby waive any right of action against us arising from any
- such loss or corruption of such data.
-
-
- MISCELLANEOUS PROVISIONS
-
- Entire Agreement:
-
-
- These Terms, read with the Policy, form the complete and final
- contract between the User and the Company with respect to the
- subject matter hereof and supersedes all other communications,
- representations, and agreements (whether oral, written or
- otherwise) relating thereto.
-
-
- Waiver:
-
-
- The failure of either Party at any time to require performance
- of any provision of these Terms shall in no manner affect such
- Party's right at a later time to enforce the same. No waiver by
- either party of any breach of these Terms, whether by conduct or
- otherwise, in any one or more instances, shall be deemed to be
- or construed as a further or continuing waiver of any such
- breach, or a waiver of any other breach of these Terms.
-
-
- Severability:
-
-
- If any provision/clause of these Terms is held to be invalid,
- illegal or unenforceable by any court or authority of competent
- jurisdiction, the validity, legality, and enforceability of the
- remaining provisions/clauses of these Terms shall in no way be
- affected or impaired thereby, and each such provision/clause of
- these Terms shall be valid and enforceable to the fullest extent
- permitted by law. In such case, these Terms shall be reformed to
- the minimum extent necessary to correct any invalidity,
- illegality or unenforceability, while preserving to the maximum
- extent the original rights, intentions and commercial
- expectations of the Parties hereto, as expressed herein.
-
-
-
- MISCELLANEOUS
-
-
- These Terms of Use and any policies or operating rules posted by
- us on the Site or in respect to the Site constitute the entire
- agreement and understanding between you and us. Our failure to
- exercise or enforce any right or provision of these Terms of Use
- shall not operate as a waiver of such right or provision. These
- Terms of Use operate to the fullest extent permissible by law. We
- may assign any or all of our rights and obligations to others at
- any time. We shall not be responsible or liable for any loss,
- damage, delay, or failure to act caused by any cause beyond our
- reasonable control. If any provision or part of a provision of
- these Terms of Use is determined to be unlawful, void, or
- unenforceable, that provision or part of the provision is deemed
- severable from these Terms of Use and does not affect the validity
- and enforceability of any remaining provisions. There is no joint
- venture, partnership, employment or agency relationship created
- between you and us as a result of these Terms of Use or use of the
- Site. You agree that these Terms of Use will not be construed
- against us by virtue of having drafted them. You hereby waive any
- and all defenses you may have based on the electronic form of
- these Terms of Use and the lack of signing by the parties hereto
- to execute these Terms of Use.
-
-
- CONTACT US
-
-
- In order to resolve a complaint regarding the Site or to receive
- further information regarding use of the Site, please contact us
- at:
-
-
- Cartegan Software Private Limited
-
- info@cartegan.com
-
-
-
-
-
- );
-};
-
-export default Tos;
diff --git a/stable.json b/stable.json
deleted file mode 100644
index 9eb29f2..0000000
--- a/stable.json
+++ /dev/null
@@ -1,29453 +0,0 @@
-{
- "openapi": "3.0.2",
- "info": {
- "title": "Klaviyo API",
- "version": "2023-02-22",
- "description": "The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.",
- "contact": {
- "name": "Klaviyo Developer Experience Team",
- "email": "developers@klaviyo.com",
- "url": "https://developers.klaviyo.com"
- },
- "termsOfService": "https://www.klaviyo.com/legal/api-terms",
- "license": {
- "name": "License",
- "url": "https://www.klaviyo.com/legal"
- }
- },
- "servers": [
- {
- "url": "https://a.klaviyo.com",
- "description": "Production"
- }
- ],
- "paths": {
- "/api/campaigns/": {
- "get": {
- "operationId": "get_campaigns",
- "summary": "Get Campaigns",
- "description": "Returns some or all campaigns based on [optional] filters
*Rate limits*: Burst: `75/s` Steady: `700/m`\n\n**Scopes:**\n`catalogs:write`",
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
- "required": true,
- "schema": {
- "description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
- }
- },
- {
- "name": "revision",
- "in": "header",
- "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
- "required": true,
- "schema": {
- "type": "string",
- "default": "2023-02-22"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CatalogItemUpdateQuery"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PatchCatalogItemResponse"
- }
- }
- }
- },
- "4XX": {
- "description": "",
- "$ref": "#/components/responses/ClientError"
- },
- "5XX": {
- "description": "",
- "$ref": "#/components/responses/ServerError"
- }
- },
- "tags": [
- "Catalogs"
- ],
- "x-klaviyo-pre-release": "None",
- "x-klaviyo-ratelimit": {
- "burst": "75/s",
- "steady": "700/m"
- },
- "x-klaviyo-scopes": [
- "catalogs:write"
- ],
- "x-klaviyo-subtag": "Items"
- },
- "delete": {
- "operationId": "delete_catalog_item",
- "summary": "Delete Catalog Item",
- "description": "Delete a catalog item with the given item ID.
*Rate limits*: Burst: `75/s` Steady: `700/m`\n\n**Scopes:**\n`catalogs:write`",
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
- "required": true,
- "schema": {
- "description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
- }
- },
- {
- "name": "revision",
- "in": "header",
- "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
- "required": true,
- "schema": {
- "type": "string",
- "default": "2023-02-22"
- }
- }
- ],
- "responses": {
- "204": {
- "description": ""
- },
- "4XX": {
- "description": "",
- "$ref": "#/components/responses/ClientError"
- },
- "5XX": {
- "description": "",
- "$ref": "#/components/responses/ServerError"
- }
- },
- "tags": [
- "Catalogs"
- ],
- "x-klaviyo-pre-release": "None",
- "x-klaviyo-ratelimit": {
- "burst": "75/s",
- "steady": "700/m"
- },
- "x-klaviyo-scopes": [
- "catalogs:write"
- ],
- "x-klaviyo-subtag": "Items"
- }
- },
- "/api/catalog-categories/{category_id}/items/": {
- "get": {
- "operationId": "get_catalog_category_items",
- "summary": "Get Catalog Category Items",
- "description": "Get all items in a category with the given category ID.\nItems can be sorted by the following fields, in ascending and descending order: `created`\nInclude parameters can be provided to get the following related resource data: `variants`\nReturns a maximum of 100 items per request.
*Rate limits*: Burst: `350/s` Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`",
- "parameters": [
- {
- "name": "category_id",
- "in": "path",
- "description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
- "required": true,
- "schema": {
- "description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
- }
- },
- {
- "name": "fields[catalog-item]",
- "in": "query",
- "description": "For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets",
- "required": false,
- "schema": {
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "external_id",
- "title",
- "description",
- "price",
- "url",
- "image_full_url",
- "image_thumbnail_url",
- "images",
- "custom_metadata",
- "published",
- "created",
- "updated"
- ]
- }
- },
- "explode": false
- },
- {
- "name": "fields[catalog-variant]",
- "in": "query",
- "description": "For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets",
- "required": false,
- "schema": {
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "external_id",
- "title",
- "description",
- "sku",
- "inventory_policy",
- "inventory_quantity",
- "price",
- "url",
- "image_full_url",
- "image_thumbnail_url",
- "images",
- "custom_metadata",
- "published",
- "created",
- "updated"
- ]
- }
- },
- "explode": false
- },
- {
- "name": "filter",
- "in": "query",
- "description": "For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering Allowed field(s)/operator(s): `ids`: `any` `category`: `equals` `title`: `contains` `published`: `equals`",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "include",
- "in": "query",
- "description": "For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships",
- "schema": {
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "variants"
- ]
- }
- }
- },
- {
- "name": "page[cursor]",
- "in": "query",
- "description": "For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination",
- "required": false,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "sort",
- "in": "query",
- "description": "For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting",
- "schema": {
- "type": "string",
- "enum": [
- "created",
- "-created"
- ]
- }
- },
- {
- "name": "revision",
- "in": "header",
- "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
- "required": true,
- "schema": {
- "type": "string",
- "default": "2023-02-22"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GetCatalogItemResponseCollectionCompoundDocument"
- }
- }
- }
- },
- "4XX": {
- "description": "",
- "$ref": "#/components/responses/ClientError"
- },
- "5XX": {
- "description": "",
- "$ref": "#/components/responses/ServerError"
- }
- },
- "tags": [
- "Catalogs"
- ],
- "x-klaviyo-pre-release": "None",
- "x-klaviyo-ratelimit": {
- "burst": "350/s",
- "steady": "3500/m"
- },
- "x-klaviyo-scopes": [
- "catalogs:read"
- ],
- "x-klaviyo-subtag": "Items"
- }
- },
- "/api/catalog-variants/": {
- "get": {
- "operationId": "get_catalog_variants",
- "summary": "Get Catalog Variants",
- "description": "Get all variants in an account.\nVariants can be sorted by the following fields, in ascending and descending order: `created`\nReturns a maximum of 100 variants per request.
*Rate limits*: Burst: `10/s` Steady: `150/m`\n\n**Scopes:**\n`metrics:read`",
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "description": "Metric ID",
- "required": true,
- "schema": {
- "description": "Metric ID",
- "type": "string"
- }
- },
- {
- "name": "fields[metric]",
- "in": "query",
- "description": "For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets",
- "required": false,
- "schema": {
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "name",
- "created",
- "updated",
- "integration"
- ]
- }
- },
- "explode": false
- },
- {
- "name": "revision",
- "in": "header",
- "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
- "required": true,
- "schema": {
- "type": "string",
- "default": "2023-02-22"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GetMetricResponse"
- }
- }
- }
- },
- "4XX": {
- "description": "",
- "$ref": "#/components/responses/ClientError"
- },
- "5XX": {
- "description": "",
- "$ref": "#/components/responses/ServerError"
- }
- },
- "tags": [
- "Metrics"
- ],
- "x-klaviyo-pre-release": "None",
- "x-klaviyo-ratelimit": {
- "burst": "10/s",
- "steady": "150/m"
- },
- "x-klaviyo-scopes": [
- "metrics:read"
- ]
- }
- },
- "/api/metric-aggregates/": {
- "post": {
- "operationId": "query_metric_aggregates",
- "summary": "Query Metric Aggregates",
- "description": "Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events. Queries must be passed in the JSON body of your `POST` request.\n\nResults can be filtered and grouped by time, event, or profile dimensions.\n\nTo learn more about how to use this endpoint, check out our new [Using the Query Metric Aggregates Endpoint guide](https://developers.klaviyo.com/en/docs/using-the-query-metric-aggregates-endpoint).\n\n**Request body parameters** (nested under `attributes`):\n\n* `return_fields`: request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/reference/api_overview#sparse-fieldsets)\n* `sort`: sort results by a specified field, such as `\"-timestamp\"`\n* `page_cursor`: results can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/reference/api_overview#pagination)\n* `page_size`: limit the number of returned results per page\n* `by`: optional attributes used to group by the aggregation function\n * When using `by` attributes, an empty `dimensions` response is expected when the counts for the events do not have the associated dimension requested by the set `by` attribute. For example, a query including `\"by\": [\"$flow\"]` will return an empty dimensions response for counts of metrics not associated with a `$flow`\n* `measurement`: the measurement key supports the following values:\n * `\"sum_value\"`: perform a summation of the `_Event Value_`, optionally partitioned over any dimension provided in the `by` field\n * `\"count\"`: counts the number of events associated to a metric, optionally partitioned over any dimension provided in the `by` field\n * `\"unique\"` counts the number of unique customers associated to a metric, optionally partitioned over any dimension provided in the `by` field\n* `interval`: aggregation interval, such as `\"hour\"`,`\"day\"`,`\"week\"`, and `\"month\"`\n* `metric_id`: the metric ID used in the aggregation\n* `filter`: list of filters for specific fields, must include time range using ISO 8601 format (`\"YYYY-MM-DDTHH:MM:SS.mmmmmm\"`)\n * The time range can be filtered by providing a `greater-or-equal` filter on the datetime field, such as `\"greater-or-equal(datetime,2021-07-01T00:00:00)\"` and a `less-than` filter on the same datetime field, such as `\"less-than(datetime,2022-07-01T00:00:00)\"`\n * The time range may span a maximum of one year. Time range dates may be set to a maximum of 5 years prior to the current date\n * Filter the list of supported aggregate dimensions using the common filter syntax, such as `\"equals(URL,\\\"https://www.klaviyo.com/\\\")\"`\n* `timezone`: the timezone used when processing the query. Case sensitive. This field is validated against a list of common timezones from the [IANA Time Zone Database](https://www.iana.org/time-zones)\n * While the payload accepts a timezone, the response datetimes returned will be in UTC.\n\nFor a comprehensive list of native Klaviyo metrics and their associated attributes for grouping and filtering, please refer to the [metrics attributes guide](https://developers.klaviyo.com/en/docs/supported_metrics_and_attributes).
*Rate limits*: Burst: `75/s` Steady: `700/m`\n\n**Scopes:**\n`profiles:write`\n`subscriptions:write`",
- "parameters": [
- {
- "name": "revision",
- "in": "header",
- "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
- "required": true,
- "schema": {
- "type": "string",
- "default": "2023-02-22"
- }
- }
- ],
- "requestBody": {
- "description": "Suppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, one will be created and immediately suppressed.",
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/SuppressionCreateJobCreateQuery"
- }
- }
- }
- },
- "responses": {
- "202": {
- "description": ""
- },
- "4XX": {
- "description": "",
- "$ref": "#/components/responses/ClientError"
- },
- "5XX": {
- "description": "",
- "$ref": "#/components/responses/ServerError"
- }
- },
- "tags": [
- "Profiles"
- ],
- "x-klaviyo-pre-release": "None",
- "x-klaviyo-ratelimit": {
- "burst": "75/s",
- "steady": "700/m"
- },
- "x-klaviyo-scopes": [
- "profiles:write",
- "subscriptions:write"
- ]
- }
- },
- "/api/profile-unsuppression-bulk-create-jobs/": {
- "post": {
- "operationId": "unsuppress_profiles",
- "summary": "Unsuppress Profiles",
- "description": "Unsuppress one or more profiles, this will remove any Manual Suppressions (USER_SUPPRESSED) on these profiles. A profile may receive email marketing after a manual suppression is removed so long as they have not revoked consent, i.e. unsubscribed.\nNot supported for SMS marketing. Only manual suppressions (USER_SUPPRESSED) will be removed. `UNSUBSCRIBE` and `SPAM_REPORT` suppressions are removed whenever a [profile resubscribes](https://developers.klaviyo.com/en/reference/subscribe_profiles). `INVALID_EMAIL` and `HARD_BOUNCE` suppressions cannot be removed by the API.\nMaximum number of profile can be submitted for unsuppression: 100
*Rate limits*: Burst: `75/s` Steady: `700/m`\n\n**Scopes:**\n`subscriptions:write`",
- "parameters": [
- {
- "name": "revision",
- "in": "header",
- "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
- "required": true,
- "schema": {
- "type": "string",
- "default": "2023-02-22"
- }
- }
- ],
- "requestBody": {
- "description": "Unsuppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, no action will be taken.",
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/UnsuppressionCreateJobCreateQuery"
- }
- }
- }
- },
- "responses": {
- "202": {
- "description": ""
- },
- "4XX": {
- "description": "",
- "$ref": "#/components/responses/ClientError"
- },
- "5XX": {
- "description": "",
- "$ref": "#/components/responses/ServerError"
- }
- },
- "tags": [
- "Profiles"
- ],
- "x-klaviyo-pre-release": "None",
- "x-klaviyo-ratelimit": {
- "burst": "75/s",
- "steady": "700/m"
- },
- "x-klaviyo-scopes": [
- "subscriptions:write"
- ]
- }
- },
- "/api/profile-subscription-bulk-create-jobs/": {
- "post": {
- "operationId": "subscribe_profiles",
- "summary": "Subscribe Profiles",
- "description": "Subscribe one or more profiles to email marketing, SMS marketing, or both. If the list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message.\nTo add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships).\nThis API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about suppressed profiles in [this document](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1).\nMaximum number of profile can be submitted for subscription: 100
*Rate limits*: Burst: `75/s` Steady: `700/m`\n\n**Scopes:**\n`list:write`\n`profiles:write`\n`subscriptions:write`",
- "parameters": [
- {
- "name": "revision",
- "in": "header",
- "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
- "required": true,
- "schema": {
- "type": "string",
- "default": "2023-02-22"
- }
- }
- ],
- "requestBody": {
- "description": "Subscribes one or more profiles to marketing. Currently, supports email and SMS only. All profiles will be added to the provided list. Either email or phone number is required. Both may be specified to subscribe to both channels. If a profile cannot be found matching the given identifier(s), a new profile will be created and then subscribed.",
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/SubscriptionCreateJobCreateQuery"
- }
- }
- }
- },
- "responses": {
- "202": {
- "description": ""
- },
- "4XX": {
- "description": "",
- "$ref": "#/components/responses/ClientError"
- },
- "5XX": {
- "description": "",
- "$ref": "#/components/responses/ServerError"
- }
- },
- "tags": [
- "Profiles"
- ],
- "x-klaviyo-pre-release": "None",
- "x-klaviyo-ratelimit": {
- "burst": "75/s",
- "steady": "700/m"
- },
- "x-klaviyo-scopes": [
- "list:write",
- "profiles:write",
- "subscriptions:write"
- ]
- }
- },
- "/api/profile-unsubscription-bulk-create-jobs/": {
- "post": {
- "operationId": "unsubscribe_profiles",
- "summary": "Unsubscribe Profiles",
- "description": "Unsubscribe one or more profiles to email marketing, SMS marketing, or both.\nTo remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/reference/delete_list_relationships).\nMaximum number of profile can be submitted for unsubscription: 100
*Rate limits*: Burst: `75/s` Steady: `700/m`\n\n**Scopes:**\n`list:write`\n`profiles:write`\n`subscriptions:write`",
- "parameters": [
- {
- "name": "revision",
- "in": "header",
- "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
- "required": true,
- "schema": {
- "type": "string",
- "default": "2023-02-22"
- }
- }
- ],
- "requestBody": {
- "description": "Unsubscribes one or more profiles from marketing. Currently, supports email and SMS only. All profiles will be removed from the provided list. Either email or phone number is required. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed.",
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/UnsubscriptionCreateJobCreateQuery"
- }
- }
- }
- },
- "responses": {
- "202": {
- "description": ""
- },
- "4XX": {
- "description": "",
- "$ref": "#/components/responses/ClientError"
- },
- "5XX": {
- "description": "",
- "$ref": "#/components/responses/ServerError"
- }
- },
- "tags": [
- "Profiles"
- ],
- "x-klaviyo-pre-release": "None",
- "x-klaviyo-ratelimit": {
- "burst": "75/s",
- "steady": "700/m"
- },
- "x-klaviyo-scopes": [
- "list:write",
- "profiles:write",
- "subscriptions:write"
- ]
- }
- },
- "/api/profiles/{id}/relationships/lists/": {
- "get": {
- "operationId": "get_profile_relationships_lists",
- "summary": "Get Profile Relationships Lists",
- "description": "Get list memberships for a profile with the given profile ID.
*Rate limits*: Burst: `100/s` Steady: `100/m`\n\n**Scopes:**\n`subscriptions:write`",
- "parameters": [
- {
- "name": "company_id",
- "in": "query",
- "description": "Your company ID.",
- "required": true,
- "schema": {
- "description": "Your company ID.",
- "type": "string",
- "example": "COMPANY_ID"
- }
- },
- {
- "name": "revision",
- "in": "header",
- "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
- "required": true,
- "schema": {
- "type": "string",
- "default": "2023-02-22"
- }
- }
- ],
- "requestBody": {
- "description": "Creates a subscription and consent records for Email and or SMS channels based on the provided email and phone_number attributes respectively. One of either email or phone_number must be provided. To create a subscription and consent record for only one channel but still include the other channel as a profile property the consent channel can be provided as a top level attribute and the other channel can be included in the properties object.",
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/OnsiteSubscriptionCreateQuery"
- }
- }
- }
- },
- "responses": {
- "202": {
- "description": ""
- }
- },
- "security": [],
- "tags": [
- "Client"
- ],
- "x-klaviyo-pre-release": "None",
- "x-klaviyo-ratelimit": {
- "burst": "100/s",
- "steady": "100/m"
- },
- "x-klaviyo-scopes": [
- "subscriptions:write"
- ]
- }
- },
- "/client/events/": {
- "post": {
- "operationId": "create_client_event",
- "summary": "Create Client Event",
- "description": "Create a new event to track a profile's activity.\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only. To create events from server-based applications, please use [POST /api/events](https://developers.klaviyo.com/en/reference/create_event)
*Rate limits*: Burst: `350/s` Steady: `3500/m`\n\n**Scopes:**\n`events:write`",
- "parameters": [
- {
- "name": "company_id",
- "in": "query",
- "description": "ID of the Company to create event",
- "required": true,
- "schema": {
- "description": "ID of the Company to create event",
- "type": "string",
- "example": "YOUR_COMPANY_ID"
- }
- },
- {
- "name": "revision",
- "in": "header",
- "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
- "required": true,
- "schema": {
- "type": "string",
- "default": "2023-02-22"
- }
- }
- ],
- "requestBody": {
- "description": "Event to create.",
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/EventCreateQuery"
- }
- }
- }
- },
- "responses": {
- "202": {
- "description": ""
- },
- "4XX": {
- "description": "",
- "$ref": "#/components/responses/ClientError"
- },
- "5XX": {
- "description": "",
- "$ref": "#/components/responses/ServerError"
- }
- },
- "security": [],
- "tags": [
- "Client"
- ],
- "x-klaviyo-pre-release": "None",
- "x-klaviyo-ratelimit": {
- "burst": "350/s",
- "steady": "3500/m"
- },
- "x-klaviyo-scopes": [
- "events:write"
- ]
- }
- },
- "/client/profiles/": {
- "post": {
- "operationId": "create_client_profile",
- "summary": "Create or Update Client Profile",
- "description": "Create and update properties about a profile without tracking an associated event.\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only. To create profiles from server applications (e.g. custom server-side scripts / applications), please use [POST /api/profiles](https://developers.klaviyo.com/en/reference/create_profile)
*Rate limits*: Burst: `350/s` Steady: `3500/m`\n\n**Scopes:**\n`profiles:write`",
- "parameters": [
- {
- "name": "company_id",
- "in": "query",
- "description": "",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "revision",
- "in": "header",
- "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
- "required": true,
- "schema": {
- "type": "string",
- "default": "2023-02-22"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/OnsiteProfileCreateQuery"
- }
- }
- }
- },
- "responses": {
- "202": {
- "description": ""
- },
- "4XX": {
- "description": "",
- "$ref": "#/components/responses/ClientError"
- },
- "5XX": {
- "description": "",
- "$ref": "#/components/responses/ServerError"
- }
- },
- "security": [],
- "tags": [
- "Client"
- ],
- "x-klaviyo-pre-release": "None",
- "x-klaviyo-ratelimit": {
- "burst": "350/s",
- "steady": "3500/m"
- },
- "x-klaviyo-scopes": [
- "profiles:write"
- ]
- }
- }
- },
- "components": {
- "schemas": {
- "CatalogItemResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogItemEnum"
- },
- "id": {
- "description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "external_id": {
- "description": "The ID of the catalog item in an external system.",
- "type": "string",
- "example": "SAMPLE-DATA-ITEM-1"
- },
- "title": {
- "description": "The title of the catalog item.",
- "type": "string",
- "example": "Ocean Blue Shirt (Sample)"
- },
- "description": {
- "description": "A description of the catalog item.",
- "type": "string",
- "example": "Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns."
- },
- "price": {
- "description": "This field can be used to set the price on the catalog item, which is what gets displayed for the item when included in emails. For most price-update use cases, you will also want to update the `price` on any child variants, using the [Update Catalog Variant Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_variant).",
- "type": "number",
- "example": 42
- },
- "url": {
- "description": "URL pointing to the location of the catalog item on your website.",
- "type": "string",
- "example": "https://via.placeholder.com/150"
- },
- "image_full_url": {
- "description": "URL pointing to the location of a full image of the catalog item.",
- "type": "string",
- "example": "https://via.placeholder.com/300"
- },
- "image_thumbnail_url": {
- "description": "URL pointing to the location of an image thumbnail of the catalog item",
- "type": "string",
- "example": "https://via.placeholder.com/150"
- },
- "images": {
- "description": "List of URLs pointing to the locations of images of the catalog item.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": [
- "https://via.placeholder.com/150"
- ]
- },
- "custom_metadata": {
- "description": "Flat JSON blob to provide custom metadata about the catalog item. May not exceed 100kb.",
- "type": "object",
- "example": {
- "Top Pick": true
- }
- },
- "published": {
- "description": "Boolean value indicating whether the catalog item is published.",
- "type": "boolean",
- "example": true
- },
- "created": {
- "description": "Date and time when the catalog item was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated": {
- "description": "Date and time when the catalog item was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- },
- "GetCatalogItemResponseCollectionCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CatalogItemResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "variants": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-variant"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- },
- "included": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogVariantResponseObjectResource"
- }
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetCatalogItemResponseCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CatalogItemResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "variants": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-variant"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- },
- "included": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogVariantResponseObjectResource"
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogVariantResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogVariantEnum"
- },
- "id": {
- "description": "The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "external_id": {
- "description": "The ID of the catalog item variant in an external system.",
- "type": "string",
- "example": "SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM"
- },
- "title": {
- "description": "The title of the catalog item variant.",
- "type": "string",
- "example": "Ocean Blue Shirt (Sample) Variant Medium"
- },
- "description": {
- "description": "A description of the catalog item variant.",
- "type": "string",
- "example": "Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns."
- },
- "sku": {
- "description": "The SKU of the catalog item variant.",
- "type": "string",
- "example": "OBS-MD"
- },
- "inventory_policy": {
- "description": "This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values:\n`1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock.\n`0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity.\n",
- "type": "integer",
- "example": 2,
- "enum": [
- 0,
- 1,
- 2
- ]
- },
- "inventory_quantity": {
- "description": "The quantity of the catalog item variant currently in stock.",
- "type": "number",
- "example": 25
- },
- "price": {
- "description": "This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the [Update Catalog Item Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_item).",
- "type": "number",
- "example": 42
- },
- "url": {
- "description": "URL pointing to the location of the catalog item variant on your website.",
- "type": "string",
- "example": "https://via.placeholder.com/150"
- },
- "image_full_url": {
- "description": "URL pointing to the location of a full image of the catalog item variant.",
- "type": "string",
- "example": "https://via.placeholder.com/300"
- },
- "image_thumbnail_url": {
- "description": "URL pointing to the location of an image thumbnail of the catalog item variant.",
- "type": "string",
- "example": "https://via.placeholder.com/150"
- },
- "images": {
- "description": "List of URLs pointing to the locations of images of the catalog item variant.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": [
- "https://via.placeholder.com/150"
- ]
- },
- "custom_metadata": {
- "description": "Flat JSON blob to provide custom metadata about the catalog item variant. May not exceed 100kb.",
- "type": "object",
- "example": {
- "Top Pick": true
- }
- },
- "published": {
- "description": "Boolean value indicating whether the catalog item variant is published.",
- "type": "boolean",
- "example": true
- },
- "created": {
- "description": "Date and time when the catalog item variant was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated": {
- "description": "Date and time when the catalog item variant was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- },
- "GetCatalogVariantResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CatalogVariantResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "items": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-item"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetCatalogVariantResponse": {
- "type": "object",
- "properties": {
- "data": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CatalogVariantResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "items": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-item"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogCategoryResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogCategoryEnum"
- },
- "id": {
- "description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "external_id": {
- "description": "The ID of the catalog category in an external system.",
- "type": "string",
- "example": "SAMPLE-DATA-CATEGORY-APPAREL"
- },
- "name": {
- "description": "The name of the catalog category.",
- "type": "string",
- "example": "Sample Data Category Apparel"
- },
- "updated": {
- "description": "Date and time when the catalog category was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- },
- "GetCatalogCategoryResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CatalogCategoryResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "items": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-item"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetCatalogCategoryResponse": {
- "type": "object",
- "properties": {
- "data": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CatalogCategoryResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "items": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-item"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "GetCatalogCategoryItemListResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-item"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "GetCatalogItemCategoryListResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-category"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "EventResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/EventEnum"
- },
- "id": {
- "description": "The Event ID",
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "metric_id": {
- "description": "The Metric ID",
- "type": "string"
- },
- "profile_id": {
- "description": "Profile ID of the associated profile, if available",
- "type": "string"
- },
- "timestamp": {
- "description": "Event timestamp in seconds",
- "type": "string"
- },
- "event_properties": {
- "description": "Event properties, can include attribution data, identifiers and extra properties",
- "type": "object"
- },
- "datetime": {
- "description": "Event timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string"
- },
- "uuid": {
- "description": "A unique identifier for the event, this can be used as a cursor in pagination",
- "type": "string"
- }
- },
- "required": [
- "metric_id"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- },
- "GetEventResponseCollectionCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/EventResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "profiles": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "profile"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "metrics": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "metric"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- },
- "included": {
- "type": "array",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/MetricResponseObjectResource"
- },
- {
- "$ref": "#/components/schemas/ProfileResponseObjectResource"
- }
- ]
- }
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetEventResponseCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "allOf": [
- {
- "$ref": "#/components/schemas/EventResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "profiles": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "profile"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "metrics": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "metric"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- },
- "included": {
- "type": "array",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/MetricResponseObjectResource"
- },
- {
- "$ref": "#/components/schemas/ProfileResponseObjectResource"
- }
- ]
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "MetricResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/MetricEnum"
- },
- "id": {
- "description": "The Metric ID",
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the metric",
- "type": "string"
- },
- "created": {
- "description": "Creation time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string"
- },
- "updated": {
- "description": "Last updated time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string"
- },
- "integration": {
- "description": "The integration associated with the event",
- "type": "object"
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- },
- "GetMetricResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/MetricResponseObjectResource"
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "ProfileLocation": {
- "type": "object",
- "properties": {
- "address1": {
- "description": "First line of street address",
- "type": "string",
- "example": "89 E 42nd St"
- },
- "address2": {
- "description": "Second line of street address",
- "type": "string",
- "example": "1st floor"
- },
- "city": {
- "description": "City name",
- "type": "string",
- "example": "New York"
- },
- "country": {
- "description": "Country name",
- "type": "string",
- "example": "United States"
- },
- "latitude": {
- "description": "Latitude coordinate. We recommend providing a precision of four decimal places.",
- "example": "40.7128",
- "oneOf": [
- {
- "type": "string"
- },
- {
- "type": "number"
- }
- ]
- },
- "longitude": {
- "description": "Longitude coordinate. We recommend providing a precision of four decimal places.",
- "example": "74.0060",
- "oneOf": [
- {
- "type": "string"
- },
- {
- "type": "number"
- }
- ]
- },
- "region": {
- "description": "Region within a country, such as state or province",
- "type": "string",
- "example": "NY"
- },
- "zip": {
- "description": "Zip code",
- "type": "string",
- "example": "10017"
- },
- "timezone": {
- "description": "Time zone name. We recommend using time zones from the IANA Time Zone Database.",
- "type": "string",
- "example": "America/New_York"
- }
- }
- },
- "EmailMarketingSuppression": {
- "type": "object",
- "properties": {
- "reason": {
- "description": "The reason the profile was suppressed from the list.",
- "type": "string",
- "example": "HARD_BOUNCE"
- },
- "timestamp": {
- "description": "The timestamp when the profile was suppressed from the list, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2023-02-21T20:07:38+00:00"
- }
- },
- "required": [
- "reason",
- "timestamp"
- ]
- },
- "EmailMarketingListSuppression": {
- "type": "object",
- "properties": {
- "list_id": {
- "description": "The ID of list to which the suppression applies.",
- "type": "string",
- "example": "Y6nRLr"
- },
- "reason": {
- "description": "The reason the profile was suppressed from the list.",
- "type": "string",
- "example": "USER_SUPPRESSED"
- },
- "timestamp": {
- "description": "The timestamp when the profile was suppressed from the list, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2023-02-21T20:07:38+00:00"
- }
- },
- "required": [
- "list_id",
- "reason",
- "timestamp"
- ]
- },
- "EmailMarketing": {
- "type": "object",
- "properties": {
- "consent": {
- "description": "The consent status for email marketing.",
- "type": "string",
- "example": "SUBSCRIBED"
- },
- "timestamp": {
- "description": "The timestamp when consent record or updated for email marketing, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2023-02-21T20:07:38+00:00"
- },
- "method": {
- "description": "The method by which the profile was subscribed to email marketing.",
- "type": "string",
- "example": "PREFERENCE_PAGE"
- },
- "method_detail": {
- "description": "Additional details about the method by which the profile was subscribed to SMS marketing. This may be empty if no details were provided.",
- "type": "string",
- "example": "mydomain.com/signup"
- },
- "custom_method_detail": {
- "description": "Additional detail provided by the caller when the profile was subscribed. This may be empty if no details were provided.",
- "type": "string",
- "example": "marketing drive"
- },
- "double_optin": {
- "description": "Whether the profile was subscribed to email marketing using a double opt-in.",
- "type": "boolean",
- "example": "True"
- },
- "suppressions": {
- "description": "The global email marketing suppressions for this profile.",
- "$ref": "#/components/schemas/EmailMarketingSuppression"
- },
- "list_suppressions": {
- "description": "The list suppressions for this profile.",
- "$ref": "#/components/schemas/EmailMarketingListSuppression"
- }
- },
- "required": [
- "consent",
- "method"
- ]
- },
- "EmailChannel": {
- "type": "object",
- "properties": {
- "marketing": {
- "description": "The email marketing subscription.",
- "$ref": "#/components/schemas/EmailMarketing"
- }
- }
- },
- "SMSMarketing": {
- "type": "object",
- "properties": {
- "consent": {
- "description": "The consent status for SMS marketing.",
- "type": "string",
- "example": "SUBSCRIBED"
- },
- "timestamp": {
- "description": "The timestamp when consent record or updated for SMS marketing, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2023-02-21T20:07:38+00:00"
- },
- "method": {
- "description": "The method by which the profile was subscribed to SMS marketing.",
- "type": "string",
- "example": "TEXT"
- },
- "method_detail": {
- "description": "Additional details about the method which the profile was subscribed to SMS marketing. This may be empty if no details were provided.",
- "type": "string",
- "example": "JOIN"
- }
- },
- "required": [
- "consent",
- "timestamp",
- "method",
- "method_detail"
- ]
- },
- "SMSChannel": {
- "type": "object",
- "properties": {
- "marketing": {
- "description": "The SMS marketing subscription.",
- "$ref": "#/components/schemas/SMSMarketing"
- }
- }
- },
- "Subscriptions": {
- "type": "object",
- "properties": {
- "email": {
- "description": "The email channel subscription.",
- "$ref": "#/components/schemas/EmailChannel"
- },
- "sms": {
- "description": "The SMS channel subscription.",
- "$ref": "#/components/schemas/SMSChannel"
- }
- }
- },
- "PredictiveAnalytics": {
- "type": "object",
- "properties": {
- "historic_clv": {
- "description": "Total value of all historically placed orders",
- "type": "number",
- "example": 93.87
- },
- "predicted_clv": {
- "description": "Predicted value of all placed orders in the next 365 days",
- "type": "number",
- "example": 27.24
- },
- "total_clv": {
- "description": "Sum of historic and predicted CLV",
- "type": "number",
- "example": 121.11
- },
- "historic_number_of_orders": {
- "description": "Number of already placed orders",
- "type": "integer",
- "example": 2
- },
- "predicted_number_of_orders": {
- "description": "Predicted number of placed orders in the next 365 days",
- "type": "number",
- "example": 0.54
- },
- "average_days_between_orders": {
- "description": "Average number of days between orders (None if only one order has been placed)",
- "type": "number",
- "example": 189
- },
- "average_order_value": {
- "description": "Average value of placed orders",
- "type": "number",
- "example": 46.94
- },
- "churn_probability": {
- "description": "Probability the customer has churned",
- "type": "number",
- "example": 0.89
- },
- "expected_date_of_next_order": {
- "description": "Expected date of next order, as calculated at the time of their most recent order",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- }
- }
- },
- "ProfileResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/ProfileEnum"
- },
- "id": {
- "description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
- "type": "string",
- "example": "01GDDKASAP8TKDDA2GRZDSVP4H"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "email": {
- "description": "Individual's email address",
- "type": "string",
- "example": "sarah.mason@klaviyo-demo.com"
- },
- "phone_number": {
- "description": "Individual's phone number in E.164 format",
- "type": "string",
- "example": "+15005550006"
- },
- "external_id": {
- "description": "A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.",
- "type": "string",
- "example": "63f64a2b-c6bf-40c7-b81f-bed08162edbe"
- },
- "first_name": {
- "description": "Individual's first name",
- "type": "string",
- "example": "Sarah"
- },
- "last_name": {
- "description": "Individual's last name",
- "type": "string",
- "example": "Mason"
- },
- "organization": {
- "description": "Name of the company or organization within the company for whom the individual works",
- "type": "string",
- "example": "Klaviyo"
- },
- "title": {
- "description": "Individual's job title",
- "type": "string",
- "example": "Engineer"
- },
- "image": {
- "description": "URL pointing to the location of a profile image",
- "type": "string",
- "example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg"
- },
- "created": {
- "description": "Date and time when the profile was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated": {
- "description": "Date and time when the profile was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "last_event_date": {
- "description": "Date and time of the most recent event the triggered an update to the profile, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "location": {
- "$ref": "#/components/schemas/ProfileLocation"
- },
- "properties": {
- "description": "An object containing key/value pairs for any custom properties assigned to this profile",
- "type": "object",
- "example": {
- "pseudonym": "Dr. Octopus"
- }
- },
- "subscriptions": {
- "$ref": "#/components/schemas/Subscriptions"
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- },
- "GetProfileResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/ProfileResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "lists": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "list"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "segments": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "segment"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- },
- {
- "properties": {
- "type": {
- "$ref": "#/components/schemas/ProfileEnum"
- },
- "attributes": {
- "properties": {
- "predictive_analytics": {
- "$ref": "#/components/schemas/PredictiveAnalytics"
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetEventMetricsRelationshipListResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "metric"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "GetEventProfilesRelationshipListResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "profile"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "GetMetricResponse": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/MetricResponseObjectResource"
- }
- },
- "required": [
- "data"
- ]
- },
- "ListResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/ListEnum"
- },
- "id": {
- "description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
- "type": "string",
- "example": "Y6nRLr"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "A helpful name to label the list",
- "type": "string",
- "example": "Newsletter"
- },
- "created": {
- "description": "Date and time when the list was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated": {
- "description": "Date and time when the list was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- },
- "GetListResponseCollectionCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/ListResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "profiles": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "profile"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "tags": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetListResponseCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "allOf": [
- {
- "$ref": "#/components/schemas/ListResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "profiles": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "profile"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "tags": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "GetListTagRelationshipListResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "ListTagResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/TagEnum"
- },
- "id": {
- "description": "The Tag ID",
- "type": "string",
- "example": "abcd1234-ef56-gh78-ij90-abcdef123456"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The Tag name",
- "type": "string",
- "example": "My Tag"
- }
- },
- "required": [
- "name"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- },
- "GetListTagResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/ListTagResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "tag-group": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag-group"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "lists": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "list"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "segments": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "segment"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "campaigns": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "campaign"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "flows": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetListRelationshipsResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "profile"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "SegmentResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/SegmentEnum"
- },
- "id": {
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "A helpful name to label the segment ",
- "type": "string",
- "example": "Repeat Purchasers"
- },
- "created": {
- "description": "Date and time when the segment was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated": {
- "description": "Date and time when the segment was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- },
- "GetSegmentResponseCollectionCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/SegmentResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "profiles": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "profile"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "tags": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetSegmentResponseCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "allOf": [
- {
- "$ref": "#/components/schemas/SegmentResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "profiles": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "profile"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "tags": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "GetSegmentTagRelationshipListResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "SegmentTagResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/TagEnum"
- },
- "id": {
- "description": "The Tag ID",
- "type": "string",
- "example": "abcd1234-ef56-gh78-ij90-abcdef123456"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The Tag name",
- "type": "string",
- "example": "My Tag"
- }
- },
- "required": [
- "name"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- },
- "GetSegmentTagResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/SegmentTagResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "tag-group": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag-group"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "lists": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "list"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "segments": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "segment"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "campaigns": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "campaign"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "flows": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetSegmentRelationshipsResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "profile"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "GetProfileResponseCollectionCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/ProfileResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "lists": {
- "type": "object",
- "properties": {
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- }
- },
- "segments": {
- "type": "object",
- "properties": {
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- }
- }
- }
- }
- }
- },
- {
- "properties": {
- "type": {
- "$ref": "#/components/schemas/ProfileEnum"
- },
- "attributes": {
- "properties": {
- "predictive_analytics": {
- "$ref": "#/components/schemas/PredictiveAnalytics"
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetProfileResponseCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "allOf": [
- {
- "$ref": "#/components/schemas/ProfileResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "lists": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "list"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "segments": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "segment"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- },
- {
- "properties": {
- "type": {
- "$ref": "#/components/schemas/ProfileEnum"
- },
- "attributes": {
- "properties": {
- "predictive_analytics": {
- "$ref": "#/components/schemas/PredictiveAnalytics"
- }
- }
- }
- }
- }
- ]
- },
- "included": {
- "type": "array",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/ListResponseObjectResource"
- },
- {
- "$ref": "#/components/schemas/SegmentResponseObjectResource"
- }
- ]
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "GetListResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/ListResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "profiles": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "profile"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "tags": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetProfileListRelationshipsResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "list"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "GetSegmentResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/SegmentResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "profiles": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "profile"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "tags": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetProfileSegmentRelationshipsResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "segment"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "FlowResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/FlowEnum"
- },
- "id": {
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "status": {
- "type": "string"
- },
- "archived": {
- "type": "boolean"
- },
- "created": {
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated": {
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "trigger_type": {
- "type": "string"
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- },
- "GetFlowResponseCollectionCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/FlowResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "flow-actions": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow-action"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "tags": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- },
- "included": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/FlowActionResponseObjectResource"
- }
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetFlowResponseCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "allOf": [
- {
- "$ref": "#/components/schemas/FlowResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "flow-actions": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow-action"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "tags": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- },
- "included": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/FlowActionResponseObjectResource"
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "UtmParamInfo": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "value": {
- "type": "string"
- }
- },
- "required": [
- "name",
- "value"
- ]
- },
- "EmailTrackingOptions": {
- "type": "object",
- "properties": {
- "add_utm": {
- "type": "boolean"
- },
- "utm_params": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/UtmParamInfo"
- }
- },
- "is_tracking_opens": {
- "type": "boolean"
- },
- "is_tracking_clicks": {
- "type": "boolean"
- }
- },
- "required": [
- "add_utm",
- "utm_params",
- "is_tracking_opens",
- "is_tracking_clicks"
- ]
- },
- "SMSTrackingOptions": {
- "type": "object",
- "properties": {
- "add_utm": {
- "type": "boolean"
- },
- "utm_params": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/UtmParamInfo"
- }
- }
- },
- "required": [
- "add_utm",
- "utm_params"
- ]
- },
- "SendOptions": {
- "type": "object",
- "properties": {
- "use_smart_sending": {
- "type": "boolean"
- },
- "is_transactional": {
- "type": "boolean"
- }
- },
- "required": [
- "use_smart_sending",
- "is_transactional"
- ]
- },
- "SMSRenderOptions": {
- "type": "object",
- "properties": {
- "shorten_links": {
- "type": "boolean"
- },
- "add_org_prefix": {
- "type": "boolean"
- },
- "add_info_link": {
- "type": "boolean"
- },
- "add_opt_out_language": {
- "type": "boolean"
- }
- },
- "required": [
- "shorten_links",
- "add_org_prefix",
- "add_info_link",
- "add_opt_out_language"
- ]
- },
- "FlowActionResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/FlowActionEnum"
- },
- "id": {
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "action_type": {
- "type": "string"
- },
- "status": {
- "type": "string"
- },
- "created": {
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated": {
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "settings": {
- "type": "object"
- },
- "tracking_options": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/EmailTrackingOptions"
- },
- {
- "$ref": "#/components/schemas/SMSTrackingOptions"
- }
- ]
- },
- "send_options": {
- "$ref": "#/components/schemas/SendOptions"
- },
- "render_options": {
- "$ref": "#/components/schemas/SMSRenderOptions"
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- },
- "GetFlowActionResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/FlowActionResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "flows": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "flow-messages": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow-message"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetFlowFlowActionRelationshipListResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow-action"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "GetFlowTagRelationshipListResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "FlowTagResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/TagEnum"
- },
- "id": {
- "description": "The Tag ID",
- "type": "string",
- "example": "abcd1234-ef56-gh78-ij90-abcdef123456"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The Tag name",
- "type": "string",
- "example": "My Tag"
- }
- },
- "required": [
- "name"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- },
- "GetFlowTagResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/FlowTagResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "tag-group": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag-group"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "lists": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "list"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "segments": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "segment"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "campaigns": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "campaign"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "flows": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetFlowActionResponseCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "allOf": [
- {
- "$ref": "#/components/schemas/FlowActionResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "flows": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "flow-messages": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow-message"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- },
- "included": {
- "type": "array",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/FlowMessageResponseObjectResource"
- },
- {
- "$ref": "#/components/schemas/FlowResponseObjectResource"
- }
- ]
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "GetFlowResponse": {
- "type": "object",
- "properties": {
- "data": {
- "allOf": [
- {
- "$ref": "#/components/schemas/FlowResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "flow-actions": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow-action"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "tags": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "GetFlowActionFlowRelationshipResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "EmailMessageContent": {
- "type": "object",
- "properties": {
- "subject": {
- "type": "string"
- },
- "preview_text": {
- "type": "string"
- },
- "from_email": {
- "type": "string"
- },
- "from_name": {
- "type": "string"
- }
- },
- "required": [
- "subject",
- "preview_text",
- "from_email",
- "from_name"
- ]
- },
- "SMSMessageContent": {
- "type": "object",
- "properties": {
- "body": {
- "type": "string"
- },
- "media": {
- "type": "string"
- }
- },
- "required": [
- "body",
- "media"
- ]
- },
- "FlowMessageResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/FlowMessageEnum"
- },
- "id": {
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "channel": {
- "type": "string"
- },
- "content": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/EmailMessageContent"
- },
- {
- "$ref": "#/components/schemas/SMSMessageContent"
- }
- ]
- },
- "created": {
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated": {
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- }
- },
- "required": [
- "name",
- "channel",
- "content"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- },
- "GetFlowMessageResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/FlowMessageResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "flow-action": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow-action"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetFlowActionFlowMessageRelationshipResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow-message"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "GetFlowMessageResponseCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "allOf": [
- {
- "$ref": "#/components/schemas/FlowMessageResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "flow-action": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow-action"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- },
- "included": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/FlowActionResponseObjectResource"
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "GetFlowActionResponse": {
- "type": "object",
- "properties": {
- "data": {
- "allOf": [
- {
- "$ref": "#/components/schemas/FlowActionResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "flows": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "flow-messages": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow-message"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "GetFlowMessageFlowActionRelationshipResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow-action"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "AudiencesSubObject": {
- "type": "object",
- "properties": {
- "included": {
- "description": "A list of included audiences",
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": [
- "Y6nRLr"
- ]
- },
- "excluded": {
- "description": "An optional list of excluded audiences",
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": [
- "UTd5ui"
- ]
- }
- }
- },
- "SendOptionsSubObject": {
- "type": "object",
- "properties": {
- "use_smart_sending": {
- "description": "Use smart sending. Defaults to True",
- "type": "boolean"
- }
- }
- },
- "UTMParamsSubObject": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the UTM param",
- "type": "string",
- "example": "utm_medium"
- },
- "value": {
- "description": "Value of the UTM param. Can be templated data.",
- "type": "string",
- "example": "campaign"
- }
- },
- "required": [
- "name",
- "value"
- ]
- },
- "TrackingOptionsSubObject": {
- "type": "object",
- "properties": {
- "is_tracking_opens": {
- "description": "Whether the campaign is tracking open events. If not specified, uses company defaults.",
- "type": "boolean"
- },
- "is_tracking_clicks": {
- "description": "Whether the campaign is tracking click events. If not specified, uses company defaults.",
- "type": "boolean"
- },
- "is_add_utm": {
- "description": "Whether the campaign needs UTM parameters. If set to False, UTM params will not be used.",
- "type": "boolean"
- },
- "utm_params": {
- "description": "A list of UTM parameters. If an empty list is given and is_add_utm is True, uses company defaults.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/UTMParamsSubObject"
- }
- }
- }
- },
- "StaticScheduleOptions": {
- "type": "object",
- "properties": {
- "datetime": {
- "description": "The time to send at",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "is_local": {
- "description": "If the campaign should be sent with local recipient timezone send (requires UTC time) or statically sent at the given time. Defaults to False.",
- "type": "boolean"
- },
- "send_past_recipients_immediately": {
- "description": "Determines if we should send to local recipient timezone if the given time has passed. Only applicable to local sends. Defaults to False.",
- "type": "boolean"
- }
- },
- "required": [
- "datetime"
- ]
- },
- "ThrottledScheduleOptions": {
- "type": "object",
- "properties": {
- "datetime": {
- "description": "The time to send at",
- "type": "string",
- "format": "date-time"
- },
- "throttle_percentage": {
- "description": "The percentage of recipients per hour to send to. Allowed values: [10, 11, 13, 14, 17, 20, 25, 33, 50]",
- "type": "integer"
- }
- },
- "required": [
- "datetime",
- "throttle_percentage"
- ]
- },
- "STOScheduleOptions": {
- "type": "object",
- "properties": {
- "date": {
- "description": "The day to send on",
- "type": "string",
- "format": "date"
- }
- },
- "required": [
- "date"
- ]
- },
- "SendStrategySubObject": {
- "type": "object",
- "properties": {
- "method": {
- "description": "Describes the shape of the options object. Allowed values: ['static', 'throttled', 'immediate', 'smart_send_time']",
- "type": "string",
- "example": "static"
- },
- "options_static": {
- "description": "The send configuration options the campaign will send with. These define variables that alter the send strategy and must match the given method. Intended to be used with the 'static' method.",
- "$ref": "#/components/schemas/StaticScheduleOptions"
- },
- "options_throttled": {
- "description": "The send configuration options the campaign will send with. These define variables that alter the send strategy and must match the given method. Intended to be used with the 'throttled' method.",
- "$ref": "#/components/schemas/ThrottledScheduleOptions"
- },
- "options_sto": {
- "description": "The send configuration options the campaign will send with. These define variables that alter the send strategy and must match the given method. Intended to be used with the 'smart_send_time' method.",
- "$ref": "#/components/schemas/STOScheduleOptions"
- }
- },
- "required": [
- "method"
- ]
- },
- "CampaignResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CampaignEnum"
- },
- "id": {
- "description": "The campaign ID",
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The campaign name",
- "type": "string"
- },
- "status": {
- "description": "The current status of the campaign",
- "type": "string"
- },
- "archived": {
- "description": "Whether the campaign has been archived or not",
- "type": "boolean"
- },
- "channel": {
- "description": "The type of campaign",
- "type": "string"
- },
- "audiences": {
- "description": "The audiences to be included and/or excluded from the campaign",
- "$ref": "#/components/schemas/AudiencesSubObject"
- },
- "send_options": {
- "description": "Options to use when sending a campaign",
- "$ref": "#/components/schemas/SendOptionsSubObject"
- },
- "message": {
- "description": "The id of the message associated with the campaign",
- "type": "string"
- },
- "tracking_options": {
- "description": "The tracking options associated with the campaign",
- "$ref": "#/components/schemas/TrackingOptionsSubObject"
- },
- "send_strategy": {
- "description": "The send strategy the campaign will send with",
- "$ref": "#/components/schemas/SendStrategySubObject"
- },
- "created_at": {
- "description": "The datetime when the campaign was created",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "scheduled_at": {
- "description": "The datetime when the campaign was scheduled for future sending",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated_at": {
- "description": "The datetime when the campaign was last updated by a user or the system",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "send_time": {
- "description": "The datetime when the campaign will be / was sent or None if not yet scheduled by a send_job.",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- }
- },
- "required": [
- "name",
- "status",
- "archived",
- "channel",
- "audiences",
- "send_options",
- "message",
- "tracking_options",
- "send_strategy",
- "created_at",
- "scheduled_at",
- "updated_at",
- "send_time"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- },
- "GetCampaignResponseCollectionCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CampaignResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "tags": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- },
- "included": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TagResponseObjectResource"
- }
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetCampaignResponseCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CampaignResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "tags": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- },
- "included": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TagResponseObjectResource"
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "ContentSubObject": {
- "type": "object",
- "properties": {
- "subject": {
- "description": "The subject of the message",
- "type": "string",
- "example": "Buy our product!"
- },
- "preview_text": {
- "description": "Preview text associated with the message",
- "type": "string",
- "example": "My preview text"
- },
- "from_email": {
- "description": "The email the message should be sent from",
- "type": "string",
- "example": "store@my-company.com"
- },
- "from_label": {
- "description": "The label associated with the from_email",
- "type": "string",
- "example": "My Company"
- },
- "template_id": {
- "description": "The ID of the template associated to the message",
- "type": "string",
- "example": "RipRmi"
- },
- "template_name": {
- "description": "The name of the template associated to the message",
- "type": "string",
- "example": "My email template"
- }
- }
- },
- "SendTimeSubObject": {
- "type": "object",
- "properties": {
- "datetime": {
- "description": "The datetime that the message is to be sent",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "is_local": {
- "description": "Whether that datetime is to be a local datetime for the recipient",
- "type": "boolean"
- }
- },
- "required": [
- "datetime",
- "is_local"
- ]
- },
- "CampaignMessageResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CampaignMessageEnum"
- },
- "id": {
- "description": "The message ID",
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "label": {
- "description": "The label or name on the message",
- "type": "string"
- },
- "channel": {
- "description": "The channel the message is to be sent on",
- "type": "string"
- },
- "content": {
- "$ref": "#/components/schemas/ContentSubObject",
- "description": "Additional attributes relating to the content of the message"
- },
- "send_times": {
- "description": "The list of appropriate Send Time Sub-objects associated with the message",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/SendTimeSubObject"
- }
- },
- "created_at": {
- "description": "The datetime when the message was created",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated_at": {
- "description": "The datetime when the message was last updated",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "campaign_id": {
- "description": "The parent campaign id",
- "type": "string"
- }
- },
- "required": [
- "label",
- "channel",
- "content",
- "campaign_id"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- },
- "GetCampaignMessageResponse": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CampaignMessageResponseObjectResource"
- }
- },
- "required": [
- "data"
- ]
- },
- "GetCampaignTagRelationshipListResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "CampaignTagResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/TagEnum"
- },
- "id": {
- "description": "The Tag ID",
- "type": "string",
- "example": "abcd1234-ef56-gh78-ij90-abcdef123456"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The Tag name",
- "type": "string",
- "example": "My Tag"
- }
- },
- "required": [
- "name"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- },
- "GetCampaignTagResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CampaignTagResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "tag-group": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag-group"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "lists": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "list"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "segments": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "segment"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "campaigns": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "campaign"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "flows": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "CampaignSendJobResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CampaignSendJobEnum"
- },
- "id": {
- "description": "The ID of the campaign to send",
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "status": {
- "description": "The status of the send job",
- "type": "string",
- "enum": [
- "cancelled",
- "complete",
- "processing",
- "queued"
- ]
- }
- },
- "required": [
- "status"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- },
- "GetCampaignSendJobResponse": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CampaignSendJobResponseObjectResource"
- }
- },
- "required": [
- "data"
- ]
- },
- "CampaignRecipientEstimationJobResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CampaignRecipientEstimationJobEnum"
- },
- "id": {
- "description": "The ID of the campaign used for estimating recipients",
- "type": "string",
- "example": "01GMRWDSA0ARTAKE1SFX8JGXAY"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "status": {
- "description": "The status of the recipient estimation job",
- "type": "string",
- "enum": [
- "cancelled",
- "complete",
- "processing",
- "queued"
- ]
- }
- },
- "required": [
- "status"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- },
- "GetCampaignRecipientEstimationJobResponse": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CampaignRecipientEstimationJobResponseObjectResource"
- }
- },
- "required": [
- "data"
- ]
- },
- "CampaignRecipientEstimationResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CampaignRecipientEstimationEnum"
- },
- "id": {
- "description": "The ID of the campaign for which to get the estimated number of recipients",
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "estimated_recipient_count": {
- "description": "The estimated number of unique recipients the campaign will send to",
- "type": "integer"
- }
- },
- "required": [
- "estimated_recipient_count"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- },
- "GetCampaignRecipientEstimationResponse": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CampaignRecipientEstimationResponseObjectResource"
- }
- },
- "required": [
- "data"
- ]
- },
- "TemplateResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/TemplateEnum"
- },
- "id": {
- "description": "The ID of template",
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "company_id": {
- "description": "The ID of the company the template belongs to",
- "type": "string",
- "example": "COMPANY_ID"
- },
- "name": {
- "description": "The name of the template",
- "type": "string"
- },
- "editor_type": {
- "description": " `editor_type` has a fixed set of values:\n* SYSTEM_DRAGGABLE: indicates a drag-and-drop editor template\n* SIMPLE: A rich text editor template\n* CODE: A custom HTML template\n* USER_DRAGGABLE: A hybrid template, using custom HTML in the drag-and-drop editor\n",
- "type": "string"
- },
- "html": {
- "description": "The rendered HTML of the template",
- "type": "string"
- },
- "text": {
- "description": "The template plain_text",
- "type": "string"
- },
- "created": {
- "description": "The date the template was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated": {
- "description": "The date the template was updated in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- }
- },
- "required": [
- "company_id",
- "name",
- "editor_type",
- "html"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- },
- "GetTemplateResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TemplateResponseObjectResource"
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetTemplateResponse": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/TemplateResponseObjectResource"
- }
- },
- "required": [
- "data"
- ]
- },
- "ErrorSource": {
- "type": "object",
- "properties": {
- "pointer": {
- "description": "A pointer to the source of the error in the request payload.",
- "type": "string",
- "example": "/data",
- "default": "/data"
- }
- },
- "required": [
- "pointer"
- ]
- },
- "CatalogJobErrorPayload": {
- "type": "object",
- "properties": {
- "id": {
- "description": "Unique identifier for the error.",
- "type": "string",
- "example": "e4eebb08-b055-4a6f-bb13-c8cb69c9eb94"
- },
- "code": {
- "description": "A code for classifying the error type.",
- "type": "string",
- "example": "invalid"
- },
- "title": {
- "description": "A high-level message about the error.",
- "type": "string",
- "example": "Invalid input"
- },
- "detail": {
- "description": "Specific details about the error.",
- "type": "string",
- "example": "The payload provided in the request is invalid."
- },
- "source": {
- "description": "Additional information on the source of the error.",
- "$ref": "#/components/schemas/ErrorSource"
- }
- },
- "required": [
- "id",
- "code",
- "title",
- "detail",
- "source"
- ]
- },
- "CatalogItemCreateJobResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogItemBulkCreateJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "job_id": {
- "description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
- "type": "string"
- },
- "status": {
- "description": "Status of the asynchronous job.",
- "type": "string",
- "example": "processing",
- "enum": [
- "cancelled",
- "complete",
- "processing",
- "queued"
- ]
- },
- "created_at": {
- "description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "total_count": {
- "description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
- "type": "integer",
- "example": 10
- },
- "completed_count": {
- "description": "The total number of operations that have been completed by the job.",
- "type": "integer",
- "example": 9
- },
- "failed_count": {
- "description": "The total number of operations that have failed as part of the job.",
- "type": "integer",
- "example": 1
- },
- "completed_at": {
- "description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "expires_at": {
- "description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "errors": {
- "description": "Array of errors encountered during the processing of the job.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogJobErrorPayload"
- }
- }
- },
- "required": [
- "job_id",
- "status",
- "created_at",
- "total_count"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "attributes",
- "links"
- ]
- },
- "GetCatalogItemCreateJobResponseCollectionCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CatalogItemCreateJobResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "items": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-item"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- },
- "included": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogItemResponseObjectResource"
- }
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetCatalogItemCreateJobResponseCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CatalogItemCreateJobResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "items": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-item"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- },
- "included": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogItemResponseObjectResource"
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogItemUpdateJobResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogItemBulkUpdateJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "job_id": {
- "description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
- "type": "string"
- },
- "status": {
- "description": "Status of the asynchronous job.",
- "type": "string",
- "example": "processing",
- "enum": [
- "cancelled",
- "complete",
- "processing",
- "queued"
- ]
- },
- "created_at": {
- "description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "total_count": {
- "description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
- "type": "integer",
- "example": 10
- },
- "completed_count": {
- "description": "The total number of operations that have been completed by the job.",
- "type": "integer",
- "example": 9
- },
- "failed_count": {
- "description": "The total number of operations that have failed as part of the job.",
- "type": "integer",
- "example": 1
- },
- "completed_at": {
- "description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "expires_at": {
- "description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "errors": {
- "description": "Array of errors encountered during the processing of the job.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogJobErrorPayload"
- }
- }
- },
- "required": [
- "job_id",
- "status",
- "created_at",
- "total_count"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "attributes",
- "links"
- ]
- },
- "GetCatalogItemUpdateJobResponseCollectionCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CatalogItemUpdateJobResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "items": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-item"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- },
- "included": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogItemResponseObjectResource"
- }
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetCatalogItemUpdateJobResponseCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CatalogItemUpdateJobResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "items": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-item"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- },
- "included": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogItemResponseObjectResource"
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogItemDeleteJobResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogItemBulkDeleteJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "job_id": {
- "description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
- "type": "string"
- },
- "status": {
- "description": "Status of the asynchronous job.",
- "type": "string",
- "example": "processing",
- "enum": [
- "cancelled",
- "complete",
- "processing",
- "queued"
- ]
- },
- "created_at": {
- "description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "total_count": {
- "description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
- "type": "integer",
- "example": 10
- },
- "completed_count": {
- "description": "The total number of operations that have been completed by the job.",
- "type": "integer",
- "example": 9
- },
- "failed_count": {
- "description": "The total number of operations that have failed as part of the job.",
- "type": "integer",
- "example": 1
- },
- "completed_at": {
- "description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "expires_at": {
- "description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "errors": {
- "description": "Array of errors encountered during the processing of the job.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogJobErrorPayload"
- }
- }
- },
- "required": [
- "job_id",
- "status",
- "created_at",
- "total_count"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "attributes",
- "links"
- ]
- },
- "GetCatalogItemDeleteJobResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CatalogItemDeleteJobResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "items": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-item"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetCatalogItemDeleteJobResponse": {
- "type": "object",
- "properties": {
- "data": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CatalogItemDeleteJobResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "items": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-item"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogVariantCreateJobResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogVariantBulkCreateJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "job_id": {
- "description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
- "type": "string"
- },
- "status": {
- "description": "Status of the asynchronous job.",
- "type": "string",
- "example": "processing",
- "enum": [
- "cancelled",
- "complete",
- "processing",
- "queued"
- ]
- },
- "created_at": {
- "description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "total_count": {
- "description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
- "type": "integer",
- "example": 10
- },
- "completed_count": {
- "description": "The total number of operations that have been completed by the job.",
- "type": "integer",
- "example": 9
- },
- "failed_count": {
- "description": "The total number of operations that have failed as part of the job.",
- "type": "integer",
- "example": 1
- },
- "completed_at": {
- "description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "expires_at": {
- "description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "errors": {
- "description": "Array of errors encountered during the processing of the job.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogJobErrorPayload"
- }
- }
- },
- "required": [
- "job_id",
- "status",
- "created_at",
- "total_count"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "attributes",
- "links"
- ]
- },
- "GetCatalogVariantCreateJobResponseCollectionCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CatalogVariantCreateJobResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "variants": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-variant"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- },
- "included": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogVariantResponseObjectResource"
- }
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetCatalogVariantCreateJobResponseCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CatalogVariantCreateJobResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "variants": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-variant"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- },
- "included": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogVariantResponseObjectResource"
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogVariantUpdateJobResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogVariantBulkUpdateJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "job_id": {
- "description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
- "type": "string"
- },
- "status": {
- "description": "Status of the asynchronous job.",
- "type": "string",
- "example": "processing",
- "enum": [
- "cancelled",
- "complete",
- "processing",
- "queued"
- ]
- },
- "created_at": {
- "description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "total_count": {
- "description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
- "type": "integer",
- "example": 10
- },
- "completed_count": {
- "description": "The total number of operations that have been completed by the job.",
- "type": "integer",
- "example": 9
- },
- "failed_count": {
- "description": "The total number of operations that have failed as part of the job.",
- "type": "integer",
- "example": 1
- },
- "completed_at": {
- "description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "expires_at": {
- "description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "errors": {
- "description": "Array of errors encountered during the processing of the job.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogJobErrorPayload"
- }
- }
- },
- "required": [
- "job_id",
- "status",
- "created_at",
- "total_count"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "attributes",
- "links"
- ]
- },
- "GetCatalogVariantUpdateJobResponseCollectionCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CatalogVariantUpdateJobResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "variants": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-variant"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- },
- "included": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogVariantResponseObjectResource"
- }
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetCatalogVariantUpdateJobResponseCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CatalogVariantUpdateJobResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "variants": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-variant"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- },
- "included": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogVariantResponseObjectResource"
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogVariantDeleteJobResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogVariantBulkDeleteJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "job_id": {
- "description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
- "type": "string"
- },
- "status": {
- "description": "Status of the asynchronous job.",
- "type": "string",
- "example": "processing",
- "enum": [
- "cancelled",
- "complete",
- "processing",
- "queued"
- ]
- },
- "created_at": {
- "description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "total_count": {
- "description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
- "type": "integer",
- "example": 10
- },
- "completed_count": {
- "description": "The total number of operations that have been completed by the job.",
- "type": "integer",
- "example": 9
- },
- "failed_count": {
- "description": "The total number of operations that have failed as part of the job.",
- "type": "integer",
- "example": 1
- },
- "completed_at": {
- "description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "expires_at": {
- "description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "errors": {
- "description": "Array of errors encountered during the processing of the job.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogJobErrorPayload"
- }
- }
- },
- "required": [
- "job_id",
- "status",
- "created_at",
- "total_count"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "attributes",
- "links"
- ]
- },
- "GetCatalogVariantDeleteJobResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CatalogVariantDeleteJobResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "variants": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-variant"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetCatalogVariantDeleteJobResponse": {
- "type": "object",
- "properties": {
- "data": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CatalogVariantDeleteJobResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "variants": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-variant"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogCategoryCreateJobResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogCategoryBulkCreateJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "job_id": {
- "description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
- "type": "string"
- },
- "status": {
- "description": "Status of the asynchronous job.",
- "type": "string",
- "example": "processing",
- "enum": [
- "cancelled",
- "complete",
- "processing",
- "queued"
- ]
- },
- "created_at": {
- "description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "total_count": {
- "description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
- "type": "integer",
- "example": 10
- },
- "completed_count": {
- "description": "The total number of operations that have been completed by the job.",
- "type": "integer",
- "example": 9
- },
- "failed_count": {
- "description": "The total number of operations that have failed as part of the job.",
- "type": "integer",
- "example": 1
- },
- "completed_at": {
- "description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "expires_at": {
- "description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "errors": {
- "description": "Array of errors encountered during the processing of the job.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogJobErrorPayload"
- }
- }
- },
- "required": [
- "job_id",
- "status",
- "created_at",
- "total_count"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "attributes",
- "links"
- ]
- },
- "GetCatalogCategoryCreateJobResponseCollectionCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CatalogCategoryCreateJobResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "categories": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-category"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- },
- "included": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogCategoryResponseObjectResource"
- }
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetCatalogCategoryCreateJobResponseCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CatalogCategoryCreateJobResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "categories": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-category"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- },
- "included": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogCategoryResponseObjectResource"
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogCategoryUpdateJobResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogCategoryBulkUpdateJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "job_id": {
- "description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
- "type": "string"
- },
- "status": {
- "description": "Status of the asynchronous job.",
- "type": "string",
- "example": "processing",
- "enum": [
- "cancelled",
- "complete",
- "processing",
- "queued"
- ]
- },
- "created_at": {
- "description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "total_count": {
- "description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
- "type": "integer",
- "example": 10
- },
- "completed_count": {
- "description": "The total number of operations that have been completed by the job.",
- "type": "integer",
- "example": 9
- },
- "failed_count": {
- "description": "The total number of operations that have failed as part of the job.",
- "type": "integer",
- "example": 1
- },
- "completed_at": {
- "description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "expires_at": {
- "description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "errors": {
- "description": "Array of errors encountered during the processing of the job.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogJobErrorPayload"
- }
- }
- },
- "required": [
- "job_id",
- "status",
- "created_at",
- "total_count"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "attributes",
- "links"
- ]
- },
- "GetCatalogCategoryUpdateJobResponseCollectionCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CatalogCategoryUpdateJobResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "categories": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-category"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- },
- "included": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogCategoryResponseObjectResource"
- }
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetCatalogCategoryUpdateJobResponseCompoundDocument": {
- "type": "object",
- "properties": {
- "data": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CatalogCategoryUpdateJobResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "categories": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-category"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- },
- "included": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogCategoryResponseObjectResource"
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogCategoryDeleteJobResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogCategoryBulkDeleteJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "job_id": {
- "description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
- "type": "string"
- },
- "status": {
- "description": "Status of the asynchronous job.",
- "type": "string",
- "example": "processing",
- "enum": [
- "cancelled",
- "complete",
- "processing",
- "queued"
- ]
- },
- "created_at": {
- "description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "total_count": {
- "description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
- "type": "integer",
- "example": 10
- },
- "completed_count": {
- "description": "The total number of operations that have been completed by the job.",
- "type": "integer",
- "example": 9
- },
- "failed_count": {
- "description": "The total number of operations that have failed as part of the job.",
- "type": "integer",
- "example": 1
- },
- "completed_at": {
- "description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "expires_at": {
- "description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "errors": {
- "description": "Array of errors encountered during the processing of the job.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogJobErrorPayload"
- }
- }
- },
- "required": [
- "job_id",
- "status",
- "created_at",
- "total_count"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "attributes",
- "links"
- ]
- },
- "GetCatalogCategoryDeleteJobResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CatalogCategoryDeleteJobResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "categories": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-category"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetCatalogCategoryDeleteJobResponse": {
- "type": "object",
- "properties": {
- "data": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CatalogCategoryDeleteJobResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "categories": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-category"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "TagResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/TagEnum"
- },
- "id": {
- "description": "The Tag ID",
- "type": "string",
- "example": "abcd1234-ef56-gh78-ij90-abcdef123456"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The Tag name",
- "type": "string",
- "example": "My Tag"
- }
- },
- "required": [
- "name"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- },
- "GetTagResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/TagResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "tag-group": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag-group"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "lists": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "list"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "segments": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "segment"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "campaigns": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "campaign"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "flows": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetTagResponse": {
- "type": "object",
- "properties": {
- "data": {
- "allOf": [
- {
- "$ref": "#/components/schemas/TagResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "tag-group": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag-group"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "lists": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "list"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "segments": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "segment"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "campaigns": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "campaign"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "flows": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "TagGroupResponseObjectResource": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/TagGroupEnum"
- },
- "id": {
- "description": "The Tag Group ID",
- "type": "string",
- "example": "zyxw9876-vu54-ts32-rq10-zyxwvu654321"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The Tag Group name",
- "type": "string",
- "example": "My Tag Group"
- },
- "exclusive": {
- "description": "If a tag group is non-exclusive, any given related resource (campaign, flow, etc.) can be linked to multiple tags from that tag group. If a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.",
- "type": "boolean"
- },
- "default": {
- "description": "Every company automatically has one Default Tag Group. The Default Tag Group cannot be deleted, and no other Default Tag Groups can be created. This value is true for the Default Tag Group and false for all other Tag Groups.",
- "type": "boolean"
- }
- },
- "required": [
- "name",
- "exclusive",
- "default"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- },
- "GetTagGroupResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "allOf": [
- {
- "$ref": "#/components/schemas/TagGroupResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "tags": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "links": {
- "$ref": "#/components/schemas/CollectionLinks"
- }
- },
- "required": [
- "data",
- "links"
- ]
- },
- "GetTagGroupResponse": {
- "type": "object",
- "properties": {
- "data": {
- "allOf": [
- {
- "$ref": "#/components/schemas/TagGroupResponseObjectResource"
- },
- {
- "properties": {
- "relationships": {
- "type": "object",
- "properties": {
- "tags": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- }
- }
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "GetTagFlowRelationshipsResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "GetTagCampaignRelationshipsResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "campaign"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "GetTagListRelationshipsResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "list"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "GetTagSegmentRelationshipsResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "segment"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "GetTagTagGroupRelationshipsResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag-group"
- ]
- },
- "id": {
- "type": "string",
- "example": "zyxw9876-vu54-ts32-rq10-zyxwvu654321"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "GetTagGroupTagRelationshipsResponseCollection": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string",
- "example": [
- "abcd1234-ef56-gh78-ij90-abcdef123456",
- "klmn1234-op56-qr78-st90-klmnop123456"
- ]
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogItemCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogItemEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "external_id": {
- "description": "The ID of the catalog item in an external system.",
- "type": "string",
- "example": "SAMPLE-DATA-ITEM-1"
- },
- "integration_type": {
- "description": "The integration type. Currently only \"$custom\" is supported.",
- "type": "string",
- "enum": [
- "$custom"
- ]
- },
- "title": {
- "description": "The title of the catalog item.",
- "type": "string",
- "example": "Ocean Blue Shirt (Sample)"
- },
- "price": {
- "description": "This field can be used to set the price on the catalog item, which is what gets displayed for the item when included in emails. For most price-update use cases, you will also want to update the `price` on any child variants, using the [Update Catalog Variant Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_variant).",
- "type": "number",
- "example": 42
- },
- "catalog_type": {
- "description": "The type of catalog. Currently only \"$default\" is supported.",
- "type": "string",
- "example": "$default",
- "default": "$default"
- },
- "description": {
- "description": "A description of the catalog item.",
- "type": "string",
- "example": "Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns."
- },
- "url": {
- "description": "URL pointing to the location of the catalog item on your website.",
- "type": "string",
- "example": "https://via.placeholder.com/150"
- },
- "image_full_url": {
- "description": "URL pointing to the location of a full image of the catalog item.",
- "type": "string",
- "example": "https://via.placeholder.com/300"
- },
- "image_thumbnail_url": {
- "description": "URL pointing to the location of an image thumbnail of the catalog item",
- "type": "string",
- "example": "https://via.placeholder.com/150"
- },
- "images": {
- "description": "List of URLs pointing to the locations of images of the catalog item.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": [
- "https://via.placeholder.com/150"
- ]
- },
- "custom_metadata": {
- "description": "Flat JSON blob to provide custom metadata about the catalog item. May not exceed 100kb.",
- "type": "object",
- "example": {
- "Top Pick": true
- }
- },
- "published": {
- "description": "Boolean value indicating whether the catalog item is published.",
- "type": "boolean",
- "example": true,
- "default": true
- }
- },
- "required": [
- "external_id",
- "title",
- "description",
- "url"
- ]
- },
- "relationships": {
- "type": "object",
- "properties": {
- "categories": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-category"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "CatalogItemCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CatalogItemCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PostCatalogItemResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogItemEnum"
- },
- "id": {
- "description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "external_id": {
- "description": "The ID of the catalog item in an external system.",
- "type": "string",
- "example": "SAMPLE-DATA-ITEM-1"
- },
- "title": {
- "description": "The title of the catalog item.",
- "type": "string",
- "example": "Ocean Blue Shirt (Sample)"
- },
- "description": {
- "description": "A description of the catalog item.",
- "type": "string",
- "example": "Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns."
- },
- "price": {
- "description": "This field can be used to set the price on the catalog item, which is what gets displayed for the item when included in emails. For most price-update use cases, you will also want to update the `price` on any child variants, using the [Update Catalog Variant Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_variant).",
- "type": "number",
- "example": 42
- },
- "url": {
- "description": "URL pointing to the location of the catalog item on your website.",
- "type": "string",
- "example": "https://via.placeholder.com/150"
- },
- "image_full_url": {
- "description": "URL pointing to the location of a full image of the catalog item.",
- "type": "string",
- "example": "https://via.placeholder.com/300"
- },
- "image_thumbnail_url": {
- "description": "URL pointing to the location of an image thumbnail of the catalog item",
- "type": "string",
- "example": "https://via.placeholder.com/150"
- },
- "images": {
- "description": "List of URLs pointing to the locations of images of the catalog item.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": [
- "https://via.placeholder.com/150"
- ]
- },
- "custom_metadata": {
- "description": "Flat JSON blob to provide custom metadata about the catalog item. May not exceed 100kb.",
- "type": "object",
- "example": {
- "Top Pick": true
- }
- },
- "published": {
- "description": "Boolean value indicating whether the catalog item is published.",
- "type": "boolean",
- "example": true
- },
- "created": {
- "description": "Date and time when the catalog item was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated": {
- "description": "Date and time when the catalog item was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- }
- }
- },
- "relationships": {
- "type": "object",
- "properties": {
- "variants": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-variant"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogVariantCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogVariantEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "external_id": {
- "description": "The ID of the catalog item variant in an external system.",
- "type": "string",
- "example": "SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM"
- },
- "catalog_type": {
- "description": "The type of catalog. Currently only \"$default\" is supported.",
- "type": "string",
- "example": "$default",
- "default": "$default"
- },
- "integration_type": {
- "description": "The integration type. Currently only \"$custom\" is supported.",
- "type": "string",
- "enum": [
- "$custom"
- ]
- },
- "title": {
- "description": "The title of the catalog item variant.",
- "type": "string",
- "example": "Ocean Blue Shirt (Sample) Variant Medium"
- },
- "description": {
- "description": "A description of the catalog item variant.",
- "type": "string",
- "example": "Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns."
- },
- "sku": {
- "description": "The SKU of the catalog item variant.",
- "type": "string",
- "example": "OBS-MD"
- },
- "inventory_policy": {
- "description": "This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values:\n`1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock.\n`0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity.\n",
- "type": "integer",
- "example": 25,
- "enum": [
- 0,
- 1,
- 2
- ]
- },
- "inventory_quantity": {
- "description": "The quantity of the catalog item variant currently in stock.",
- "type": "number",
- "example": 25
- },
- "price": {
- "description": "This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the [Update Catalog Item Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_item).",
- "type": "number",
- "example": 42
- },
- "url": {
- "description": "URL pointing to the location of the catalog item variant on your website.",
- "type": "string",
- "example": "https://via.placeholder.com/150"
- },
- "image_full_url": {
- "description": "URL pointing to the location of a full image of the catalog item variant.",
- "type": "string",
- "example": "https://via.placeholder.com/300"
- },
- "image_thumbnail_url": {
- "description": "URL pointing to the location of an image thumbnail of the catalog item variant.",
- "type": "string",
- "example": "https://via.placeholder.com/150"
- },
- "images": {
- "description": "List of URLs pointing to the locations of images of the catalog item variant.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": [
- "https://via.placeholder.com/150"
- ]
- },
- "custom_metadata": {
- "description": "Flat JSON blob to provide custom metadata about the catalog item variant. May not exceed 100kb.",
- "type": "object",
- "example": {
- "Top Pick": true
- }
- },
- "published": {
- "description": "Boolean value indicating whether the catalog item variant is published.",
- "type": "boolean",
- "example": true,
- "default": true
- }
- },
- "required": [
- "external_id",
- "title",
- "description",
- "sku",
- "inventory_quantity",
- "price",
- "url"
- ]
- },
- "relationships": {
- "type": "object",
- "properties": {
- "items": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-item"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "CatalogVariantCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CatalogVariantCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PostCatalogVariantResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogVariantEnum"
- },
- "id": {
- "description": "The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "external_id": {
- "description": "The ID of the catalog item variant in an external system.",
- "type": "string",
- "example": "SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM"
- },
- "title": {
- "description": "The title of the catalog item variant.",
- "type": "string",
- "example": "Ocean Blue Shirt (Sample) Variant Medium"
- },
- "description": {
- "description": "A description of the catalog item variant.",
- "type": "string",
- "example": "Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns."
- },
- "sku": {
- "description": "The SKU of the catalog item variant.",
- "type": "string",
- "example": "OBS-MD"
- },
- "inventory_policy": {
- "description": "This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values:\n`1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock.\n`0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity.\n",
- "type": "integer",
- "example": 2,
- "enum": [
- 0,
- 1,
- 2
- ]
- },
- "inventory_quantity": {
- "description": "The quantity of the catalog item variant currently in stock.",
- "type": "number",
- "example": 25
- },
- "price": {
- "description": "This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the [Update Catalog Item Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_item).",
- "type": "number",
- "example": 42
- },
- "url": {
- "description": "URL pointing to the location of the catalog item variant on your website.",
- "type": "string",
- "example": "https://via.placeholder.com/150"
- },
- "image_full_url": {
- "description": "URL pointing to the location of a full image of the catalog item variant.",
- "type": "string",
- "example": "https://via.placeholder.com/300"
- },
- "image_thumbnail_url": {
- "description": "URL pointing to the location of an image thumbnail of the catalog item variant.",
- "type": "string",
- "example": "https://via.placeholder.com/150"
- },
- "images": {
- "description": "List of URLs pointing to the locations of images of the catalog item variant.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": [
- "https://via.placeholder.com/150"
- ]
- },
- "custom_metadata": {
- "description": "Flat JSON blob to provide custom metadata about the catalog item variant. May not exceed 100kb.",
- "type": "object",
- "example": {
- "Top Pick": true
- }
- },
- "published": {
- "description": "Boolean value indicating whether the catalog item variant is published.",
- "type": "boolean",
- "example": true
- },
- "created": {
- "description": "Date and time when the catalog item variant was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated": {
- "description": "Date and time when the catalog item variant was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- }
- }
- },
- "relationships": {
- "type": "object",
- "properties": {
- "items": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-item"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogCategoryCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogCategoryEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "external_id": {
- "description": "The ID of the catalog category in an external system.",
- "type": "string",
- "example": "SAMPLE-DATA-CATEGORY-APPAREL"
- },
- "name": {
- "description": "The name of the catalog category.",
- "type": "string",
- "example": "Sample Data Category Apparel"
- },
- "integration_type": {
- "description": "The integration type. Currently only \"$custom\" is supported.",
- "type": "string",
- "enum": [
- "$custom"
- ]
- },
- "catalog_type": {
- "description": "The type of catalog. Currently only \"$default\" is supported.",
- "type": "string",
- "example": "$default",
- "default": "$default"
- }
- },
- "required": [
- "external_id",
- "name"
- ]
- },
- "relationships": {
- "type": "object",
- "properties": {
- "items": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-item"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "CatalogCategoryCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CatalogCategoryCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PostCatalogCategoryResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogCategoryEnum"
- },
- "id": {
- "description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "external_id": {
- "description": "The ID of the catalog category in an external system.",
- "type": "string",
- "example": "SAMPLE-DATA-CATEGORY-APPAREL"
- },
- "name": {
- "description": "The name of the catalog category.",
- "type": "string",
- "example": "Sample Data Category Apparel"
- },
- "updated": {
- "description": "Date and time when the catalog category was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- }
- }
- },
- "relationships": {
- "type": "object",
- "properties": {
- "items": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-item"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogCategoryItemOp": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-item"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogItemCategoryOp": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-category"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "_MetricCreateQuery": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the event. Must be less than 128 characters.",
- "type": "string",
- "example": "Viewed Product"
- },
- "service": {
- "description": "This is for advanced usage. For api requests, this should use the default, which is set to api.",
- "type": "string"
- }
- },
- "required": [
- "name"
- ]
- },
- "EventCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/EventEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "profile": {
- "description": "\nProperties of the profile that triggered this event. The profile must contain an\nidentifier. The $email and/or $phone_number can be used as the identify the profile.\nOther key value pairs can be used to create segments. For example, to create a list of\npeople on trial plans, include a profile's plan type in the profile. The profile\nsupports special fields. The fields include: $email (string), $first_name (string),\n$last_name (string), $phone_number (string), $city (string), $region (string; state or\nother region), $country (string), $zip (string), $image (string; url to a photo of a\nperson), and $consent (list of strings; eg: ['sms', 'email', 'web', 'directmail',\n'mobile']).\n",
- "type": "object",
- "example": {
- "$email": "matt.kemp@klaviyo-demo.com"
- }
- },
- "metric": {
- "description": "The associated metric for the event. An account can have up to 200 unique metrics.",
- "example": {
- "name": "Viewed Product"
- },
- "$ref": "#/components/schemas/_MetricCreateQuery"
- },
- "properties": {
- "description": "\n Properties of this event. Any top level property (that are not objects) can be\nused to create segments. The $extra property is a special property. This records any\nnon-segmentable values that can be references later. For example, HTML templates are\nuseful on a segment, but itself is not used in creating a segment. There are limits\nplaced onto the size of the data present. This must not exceed 5 MB. This must not\nexceed 300 event properties. A single string cannot be larger than 100 KB. Each array\nmust not exceed 4000 elements. The properties cannot contain more than 10 nested levels.\n",
- "type": "object",
- "example": {
- "Brand": "Kids Book",
- "Categories": [
- "Fiction",
- "Children"
- ],
- "ProductID": 1111,
- "ProductName": "Winnie the Pooh",
- "$extra": {
- "URL": "http://www.example.com/path/to/product",
- "ImageURL": "http://www.example.com/path/to/product/image.png"
- }
- }
- },
- "time": {
- "description": "\nWhen this event occurred. By default, the time the request was received will be used.\nThe time is truncated to the second. The time must be after the year 2000 and can only\nbe up to 1 year in the future.\n",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "value": {
- "description": "A numeric value to associate with this event. For example, the dollar amount of a purchase.",
- "type": "number",
- "example": 9.99
- },
- "unique_id": {
- "description": "\nA unique identifier for an event. If the unique_id is repeated for the same\nprofile and metric, only the first processed event will be recorded. If this is not\npresent, this will use the time to the second. Using the default, this limits only one\nevent per profile per second.\n",
- "type": "string"
- }
- },
- "required": [
- "profile",
- "metric",
- "properties"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "EventCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/EventCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "MetricAggregateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/MetricAggregateEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "metric_id": {
- "description": "The metric ID used in the aggregation.",
- "type": "string",
- "example": "0rG4eQ"
- },
- "page_cursor": {
- "description": "Optional pagination cursor to iterate over large result sets",
- "type": "string"
- },
- "measurements": {
- "description": "Measurement key, e.g. `unique`, `sum_value`, `count`",
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "count",
- "sum_value",
- "unique"
- ],
- "description": "Supported measurements for aggregation"
- },
- "example": "count"
- },
- "interval": {
- "description": "Aggregation interval, e.g. \"hour\", \"day\", \"week\", \"month\"",
- "type": "string",
- "example": "day",
- "enum": [
- "day",
- "hour",
- "month",
- "week"
- ]
- },
- "page_size": {
- "description": "Alter the maximum number of returned rows in a single page of aggregation results",
- "type": "integer",
- "example": 500,
- "default": 500
- },
- "by": {
- "description": "Optional attribute(s) used for partitioning by the aggregation function",
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "$attributed_channel",
- "$attributed_flow",
- "$attributed_message",
- "$attributed_variation",
- "$campaign_channel",
- "$flow",
- "$flow_channel",
- "$message",
- "$message_send_cohort",
- "$variation",
- "$variation_send_cohort",
- "Bounce Type",
- "Campaign Name",
- "Client Canonical",
- "Client Name",
- "Client Type",
- "Email Domain",
- "Failure Source",
- "Failure Type",
- "From Number",
- "From Phone Region",
- "List",
- "Message Name",
- "Message Type",
- "Method",
- "Subject",
- "To Number",
- "To Phone Region",
- "URL",
- "form_id"
- ],
- "description": "Supported dimensions for grouping and filtering"
- },
- "example": "$message"
- },
- "return_fields": {
- "description": "Provide fields to limit the returned data",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "filter": {
- "description": "List of filters, must include time range using ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).\n These filters follow a similar format to those in `GET` requests, the primary difference is that this endpoint asks for a list.\n The time range can be filtered by providing a `greater-or-equal` and a `less-than` filter on the `datetime` field.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": [
- "greater-or-equal(datetime,2022-12-01T00:00:00)",
- "less-than(datetime,2022-12-08T00:00:00"
- ]
- },
- "timezone": {
- "description": "The timezone used for processing the query, e.g. `'America/New_York'`.\n This field is validated against a list of common timezones from the [IANA Time Zone Database](https://www.iana.org/time-zones).\n While most are supported, a few notable exceptions are `Factory`, `Europe/Kyiv` and `Pacific/Kanton`. This field is case-sensitive.",
- "type": "string",
- "example": "America/New_York",
- "default": "UTC"
- },
- "sort": {
- "description": "Provide a sort key (e.g. -$message)",
- "type": "string",
- "enum": [
- "$attributed_channel",
- "-$attributed_channel",
- "$attributed_flow",
- "-$attributed_flow",
- "$attributed_message",
- "-$attributed_message",
- "$attributed_variation",
- "-$attributed_variation",
- "$campaign_channel",
- "-$campaign_channel",
- "$flow",
- "-$flow",
- "$flow_channel",
- "-$flow_channel",
- "$message",
- "-$message",
- "$message_send_cohort",
- "-$message_send_cohort",
- "$variation",
- "-$variation",
- "$variation_send_cohort",
- "-$variation_send_cohort",
- "Bounce Type",
- "-Bounce Type",
- "Campaign Name",
- "-Campaign Name",
- "Client Canonical",
- "-Client Canonical",
- "Client Name",
- "-Client Name",
- "Client Type",
- "-Client Type",
- "Email Domain",
- "-Email Domain",
- "Failure Source",
- "-Failure Source",
- "Failure Type",
- "-Failure Type",
- "From Number",
- "-From Number",
- "From Phone Region",
- "-From Phone Region",
- "List",
- "-List",
- "Message Name",
- "-Message Name",
- "Message Type",
- "-Message Type",
- "Method",
- "-Method",
- "Subject",
- "-Subject",
- "To Number",
- "-To Number",
- "To Phone Region",
- "-To Phone Region",
- "URL",
- "-URL",
- "count",
- "-count",
- "form_id",
- "-form_id",
- "sum_value",
- "-sum_value",
- "unique",
- "-unique"
- ]
- }
- },
- "required": [
- "metric_id",
- "measurements",
- "interval",
- "filter"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "MetricAggregateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/MetricAggregateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "MetricAggregateRowDTO": {
- "type": "object",
- "properties": {
- "dimensions": {
- "description": "List of dimensions associated with this set of measurements",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "measurements": {
- "description": "Dictionary of measurement_key, values",
- "type": "object"
- }
- },
- "required": [
- "dimensions",
- "measurements"
- ]
- },
- "PostMetricAggregateResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/MetricAggregateEnum"
- },
- "id": {
- "description": "Ephemeral ID associated with the aggregation query",
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "dates": {
- "description": "The dates of the query range",
- "type": "array",
- "items": {
- "type": "string",
- "format": "date-time"
- }
- },
- "data": {
- "description": "Aggregation result data",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/MetricAggregateRowDTO"
- }
- }
- },
- "required": [
- "dates",
- "data"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "ListCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/ListEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "A helpful name to label the list",
- "type": "string",
- "example": "Newsletter"
- }
- },
- "required": [
- "name"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "ListCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/ListCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PostListResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/ListEnum"
- },
- "id": {
- "description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
- "type": "string",
- "example": "Y6nRLr"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "A helpful name to label the list",
- "type": "string",
- "example": "Newsletter"
- },
- "created": {
- "description": "Date and time when the list was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated": {
- "description": "Date and time when the list was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- }
- }
- },
- "relationships": {
- "type": "object",
- "properties": {
- "profiles": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "profile"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "tags": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "ListMembersAddQuery": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "profile"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "ProfileCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/ProfileEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "email": {
- "description": "Individual's email address",
- "type": "string",
- "example": "sarah.mason@klaviyo-demo.com"
- },
- "phone_number": {
- "description": "Individual's phone number in E.164 format",
- "type": "string",
- "example": "+15005550006"
- },
- "external_id": {
- "description": "A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.",
- "type": "string",
- "example": "63f64a2b-c6bf-40c7-b81f-bed08162edbe"
- },
- "first_name": {
- "description": "Individual's first name",
- "type": "string",
- "example": "Sarah"
- },
- "last_name": {
- "description": "Individual's last name",
- "type": "string",
- "example": "Mason"
- },
- "organization": {
- "description": "Name of the company or organization within the company for whom the individual works",
- "type": "string",
- "example": "Klaviyo"
- },
- "title": {
- "description": "Individual's job title",
- "type": "string",
- "example": "Engineer"
- },
- "image": {
- "description": "URL pointing to the location of a profile image",
- "type": "string",
- "example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg"
- },
- "location": {
- "$ref": "#/components/schemas/ProfileLocation"
- },
- "properties": {
- "description": "An object containing key/value pairs for any custom properties assigned to this profile",
- "type": "object",
- "example": {
- "pseudonym": "Dr. Octopus"
- }
- }
- }
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "ProfileCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/ProfileCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PostProfileResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/ProfileEnum"
- },
- "id": {
- "description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
- "type": "string",
- "example": "01GDDKASAP8TKDDA2GRZDSVP4H"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "email": {
- "description": "Individual's email address",
- "type": "string",
- "example": "sarah.mason@klaviyo-demo.com"
- },
- "phone_number": {
- "description": "Individual's phone number in E.164 format",
- "type": "string",
- "example": "+15005550006"
- },
- "external_id": {
- "description": "A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.",
- "type": "string",
- "example": "63f64a2b-c6bf-40c7-b81f-bed08162edbe"
- },
- "first_name": {
- "description": "Individual's first name",
- "type": "string",
- "example": "Sarah"
- },
- "last_name": {
- "description": "Individual's last name",
- "type": "string",
- "example": "Mason"
- },
- "organization": {
- "description": "Name of the company or organization within the company for whom the individual works",
- "type": "string",
- "example": "Klaviyo"
- },
- "title": {
- "description": "Individual's job title",
- "type": "string",
- "example": "Engineer"
- },
- "image": {
- "description": "URL pointing to the location of a profile image",
- "type": "string",
- "example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg"
- },
- "created": {
- "description": "Date and time when the profile was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated": {
- "description": "Date and time when the profile was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "last_event_date": {
- "description": "Date and time of the most recent event the triggered an update to the profile, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "location": {
- "$ref": "#/components/schemas/ProfileLocation"
- },
- "properties": {
- "description": "An object containing key/value pairs for any custom properties assigned to this profile",
- "type": "object",
- "example": {
- "pseudonym": "Dr. Octopus"
- }
- },
- "subscriptions": {
- "$ref": "#/components/schemas/Subscriptions"
- },
- "predictive_analytics": {
- "$ref": "#/components/schemas/PredictiveAnalytics"
- }
- }
- },
- "relationships": {
- "type": "object",
- "properties": {
- "lists": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "list"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "segments": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "segment"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "CampaignCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CampaignEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The campaign name",
- "type": "string",
- "example": "My new campaign"
- },
- "channel": {
- "description": "The type of campaign (email or sms, for example)",
- "type": "string",
- "example": "email"
- },
- "audiences": {
- "description": "The audiences to be included and/or excluded from the campaign",
- "$ref": "#/components/schemas/AudiencesSubObject"
- },
- "send_strategy": {
- "description": "The send strategy the campaign will send with. Defaults to 'Immediate' send strategy.",
- "$ref": "#/components/schemas/SendStrategySubObject"
- },
- "send_options": {
- "description": "Options to use when sending a campaign",
- "$ref": "#/components/schemas/SendOptionsSubObject"
- },
- "tracking_options": {
- "description": "The tracking options associated with the campaign",
- "$ref": "#/components/schemas/TrackingOptionsSubObject"
- }
- },
- "required": [
- "name",
- "channel",
- "audiences",
- "send_strategy",
- "send_options"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "CampaignCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CampaignCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PostCampaignResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CampaignEnum"
- },
- "id": {
- "description": "The campaign ID",
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The campaign name",
- "type": "string"
- },
- "status": {
- "description": "The current status of the campaign",
- "type": "string"
- },
- "archived": {
- "description": "Whether the campaign has been archived or not",
- "type": "boolean"
- },
- "channel": {
- "description": "The type of campaign",
- "type": "string"
- },
- "audiences": {
- "description": "The audiences to be included and/or excluded from the campaign",
- "$ref": "#/components/schemas/AudiencesSubObject"
- },
- "send_options": {
- "description": "Options to use when sending a campaign",
- "$ref": "#/components/schemas/SendOptionsSubObject"
- },
- "message": {
- "description": "The id of the message associated with the campaign",
- "type": "string"
- },
- "tracking_options": {
- "description": "The tracking options associated with the campaign",
- "$ref": "#/components/schemas/TrackingOptionsSubObject"
- },
- "send_strategy": {
- "description": "The send strategy the campaign will send with",
- "$ref": "#/components/schemas/SendStrategySubObject"
- },
- "created_at": {
- "description": "The datetime when the campaign was created",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "scheduled_at": {
- "description": "The datetime when the campaign was scheduled for future sending",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated_at": {
- "description": "The datetime when the campaign was last updated by a user or the system",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "send_time": {
- "description": "The datetime when the campaign will be / was sent or None if not yet scheduled by a send_job.",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- }
- },
- "required": [
- "name",
- "status",
- "archived",
- "channel",
- "audiences",
- "send_options",
- "message",
- "tracking_options",
- "send_strategy",
- "created_at",
- "scheduled_at",
- "updated_at",
- "send_time"
- ]
- },
- "relationships": {
- "type": "object",
- "properties": {
- "tags": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "CampaignCloneQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CampaignEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "id": {
- "description": "The campaign ID to be cloned",
- "type": "string"
- },
- "new_name": {
- "description": "The name for the new cloned campaign",
- "type": "string",
- "example": "My cloned campaign's new name"
- }
- },
- "required": [
- "id"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "CampaignCloneQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CampaignCloneQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "CampaignMessageAssignTemplateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CampaignMessageEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "id": {
- "description": "The message ID to be assigned to",
- "type": "string"
- },
- "template_id": {
- "description": "The template ID to assign",
- "type": "string",
- "example": "RipRmi"
- }
- },
- "required": [
- "id",
- "template_id"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "CampaignMessageAssignTemplateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CampaignMessageAssignTemplateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PostCampaignMessageResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CampaignMessageEnum"
- },
- "id": {
- "description": "The message ID",
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "label": {
- "description": "The label or name on the message",
- "type": "string"
- },
- "channel": {
- "description": "The channel the message is to be sent on",
- "type": "string"
- },
- "content": {
- "$ref": "#/components/schemas/ContentSubObject",
- "description": "Additional attributes relating to the content of the message"
- },
- "send_times": {
- "description": "The list of appropriate Send Time Sub-objects associated with the message",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/SendTimeSubObject"
- }
- },
- "created_at": {
- "description": "The datetime when the message was created",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated_at": {
- "description": "The datetime when the message was last updated",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "campaign_id": {
- "description": "The parent campaign id",
- "type": "string"
- }
- },
- "required": [
- "label",
- "channel",
- "content",
- "campaign_id"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "CampaignSendJobCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CampaignSendJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "id": {
- "description": "The ID of the campaign to send",
- "type": "string"
- }
- },
- "required": [
- "id"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "CampaignSendJobCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CampaignSendJobCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PostCampaignSendJobResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CampaignSendJobEnum"
- },
- "id": {
- "description": "The ID of the campaign to send",
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "status": {
- "description": "The status of the send job",
- "type": "string",
- "enum": [
- "cancelled",
- "complete",
- "processing",
- "queued"
- ]
- }
- },
- "required": [
- "status"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "CampaignRecipientEstimationJobCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CampaignRecipientEstimationJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "id": {
- "description": "The ID of the campaign to perform recipient estimation",
- "type": "string"
- }
- },
- "required": [
- "id"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "CampaignRecipientEstimationJobCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CampaignRecipientEstimationJobCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PostCampaignRecipientEstimationJobResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CampaignRecipientEstimationJobEnum"
- },
- "id": {
- "description": "The ID of the campaign used for estimating recipients",
- "type": "string",
- "example": "01GMRWDSA0ARTAKE1SFX8JGXAY"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "status": {
- "description": "The status of the recipient estimation job",
- "type": "string",
- "enum": [
- "cancelled",
- "complete",
- "processing",
- "queued"
- ]
- }
- },
- "required": [
- "status"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "TemplateCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/TemplateEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the template",
- "type": "string",
- "example": "Monthly Newsletter Template"
- },
- "editor_type": {
- "description": "Restricted to CODE",
- "type": "string"
- },
- "html": {
- "description": "The HTML contents of the template",
- "type": "string",
- "example": "\n \n \n hello world\n \n \n "
- },
- "text": {
- "description": "The plaintext version of the template",
- "type": "string",
- "example": "hello world"
- },
- "return_fields": {
- "description": "Provide fields to limit the returned data",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "required": [
- "name",
- "editor_type"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "TemplateCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/TemplateCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PostTemplateResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/TemplateEnum"
- },
- "id": {
- "description": "The ID of template",
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "company_id": {
- "description": "The ID of the company the template belongs to",
- "type": "string",
- "example": "COMPANY_ID"
- },
- "name": {
- "description": "The name of the template",
- "type": "string"
- },
- "editor_type": {
- "description": " `editor_type` has a fixed set of values:\n* SYSTEM_DRAGGABLE: indicates a drag-and-drop editor template\n* SIMPLE: A rich text editor template\n* CODE: A custom HTML template\n* USER_DRAGGABLE: A hybrid template, using custom HTML in the drag-and-drop editor\n",
- "type": "string"
- },
- "html": {
- "description": "The rendered HTML of the template",
- "type": "string"
- },
- "text": {
- "description": "The template plain_text",
- "type": "string"
- },
- "created": {
- "description": "The date the template was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated": {
- "description": "The date the template was updated in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- }
- },
- "required": [
- "company_id",
- "name",
- "editor_type",
- "html"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "TemplateRenderQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/TemplateEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "id": {
- "description": "The ID of template",
- "type": "string"
- },
- "context": {
- "description": "The context for the template render. This must be a JSON object which has values for any tags used in the template. See [this doc](https://help.klaviyo.com/hc/en-us/articles/115005084927-Template-tags-and-variable-syntax-reference-classic-editor-) for more details.",
- "type": "object",
- "example": {
- "first_name": "Jane",
- "last_name": "Smith"
- }
- },
- "return_fields": {
- "description": "Provide fields to limit the returned data",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "required": [
- "id",
- "context"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "TemplateRenderQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/TemplateRenderQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "TemplateCloneQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/TemplateEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "id": {
- "description": "The ID of template to be cloned",
- "type": "string"
- },
- "name": {
- "description": "The name of the template",
- "type": "string",
- "example": "Clone of Monthly Newsletter Template"
- },
- "return_fields": {
- "description": "Any subset of TemplateResponse fields",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "required": [
- "id"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "TemplateCloneQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/TemplateCloneQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogItemCreateJobCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogItemBulkCreateJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "items": {
- "description": "Array of catalog items to create.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogItemCreateQueryResourceObject"
- }
- }
- },
- "required": [
- "items"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "CatalogItemCreateJobCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CatalogItemCreateJobCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PostCatalogItemCreateJobResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogItemBulkCreateJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "job_id": {
- "description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
- "type": "string"
- },
- "status": {
- "description": "Status of the asynchronous job.",
- "type": "string",
- "example": "processing",
- "enum": [
- "cancelled",
- "complete",
- "processing",
- "queued"
- ]
- },
- "created_at": {
- "description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "total_count": {
- "description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
- "type": "integer",
- "example": 10
- },
- "completed_count": {
- "description": "The total number of operations that have been completed by the job.",
- "type": "integer",
- "example": 9
- },
- "failed_count": {
- "description": "The total number of operations that have failed as part of the job.",
- "type": "integer",
- "example": 1
- },
- "completed_at": {
- "description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "expires_at": {
- "description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "errors": {
- "description": "Array of errors encountered during the processing of the job.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogJobErrorPayload"
- }
- }
- },
- "required": [
- "job_id",
- "status",
- "created_at",
- "total_count"
- ]
- },
- "relationships": {
- "type": "object",
- "properties": {
- "items": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-item"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogItemUpdateJobCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogItemBulkUpdateJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "items": {
- "description": "Array of catalog items to update.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogItemUpdateQueryResourceObject"
- }
- }
- },
- "required": [
- "items"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "CatalogItemUpdateJobCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CatalogItemUpdateJobCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PostCatalogItemUpdateJobResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogItemBulkUpdateJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "job_id": {
- "description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
- "type": "string"
- },
- "status": {
- "description": "Status of the asynchronous job.",
- "type": "string",
- "example": "processing",
- "enum": [
- "cancelled",
- "complete",
- "processing",
- "queued"
- ]
- },
- "created_at": {
- "description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "total_count": {
- "description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
- "type": "integer",
- "example": 10
- },
- "completed_count": {
- "description": "The total number of operations that have been completed by the job.",
- "type": "integer",
- "example": 9
- },
- "failed_count": {
- "description": "The total number of operations that have failed as part of the job.",
- "type": "integer",
- "example": 1
- },
- "completed_at": {
- "description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "expires_at": {
- "description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "errors": {
- "description": "Array of errors encountered during the processing of the job.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogJobErrorPayload"
- }
- }
- },
- "required": [
- "job_id",
- "status",
- "created_at",
- "total_count"
- ]
- },
- "relationships": {
- "type": "object",
- "properties": {
- "items": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-item"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogItemDeleteJobCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogItemBulkDeleteJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "items": {
- "description": "Array of catalog items to delete.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogItemDeleteQueryResourceObject"
- }
- }
- },
- "required": [
- "items"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "CatalogItemDeleteJobCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CatalogItemDeleteJobCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PostCatalogItemDeleteJobResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogItemBulkDeleteJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "job_id": {
- "description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
- "type": "string"
- },
- "status": {
- "description": "Status of the asynchronous job.",
- "type": "string",
- "example": "processing",
- "enum": [
- "cancelled",
- "complete",
- "processing",
- "queued"
- ]
- },
- "created_at": {
- "description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "total_count": {
- "description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
- "type": "integer",
- "example": 10
- },
- "completed_count": {
- "description": "The total number of operations that have been completed by the job.",
- "type": "integer",
- "example": 9
- },
- "failed_count": {
- "description": "The total number of operations that have failed as part of the job.",
- "type": "integer",
- "example": 1
- },
- "completed_at": {
- "description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "expires_at": {
- "description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "errors": {
- "description": "Array of errors encountered during the processing of the job.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogJobErrorPayload"
- }
- }
- },
- "required": [
- "job_id",
- "status",
- "created_at",
- "total_count"
- ]
- },
- "relationships": {
- "type": "object",
- "properties": {
- "items": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-item"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogVariantCreateJobCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogVariantBulkCreateJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "variants": {
- "description": "Array of catalog variants to create.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogVariantCreateQueryResourceObject"
- }
- }
- },
- "required": [
- "variants"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "CatalogVariantCreateJobCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CatalogVariantCreateJobCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PostCatalogVariantCreateJobResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogVariantBulkCreateJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "job_id": {
- "description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
- "type": "string"
- },
- "status": {
- "description": "Status of the asynchronous job.",
- "type": "string",
- "example": "processing",
- "enum": [
- "cancelled",
- "complete",
- "processing",
- "queued"
- ]
- },
- "created_at": {
- "description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "total_count": {
- "description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
- "type": "integer",
- "example": 10
- },
- "completed_count": {
- "description": "The total number of operations that have been completed by the job.",
- "type": "integer",
- "example": 9
- },
- "failed_count": {
- "description": "The total number of operations that have failed as part of the job.",
- "type": "integer",
- "example": 1
- },
- "completed_at": {
- "description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "expires_at": {
- "description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "errors": {
- "description": "Array of errors encountered during the processing of the job.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogJobErrorPayload"
- }
- }
- },
- "required": [
- "job_id",
- "status",
- "created_at",
- "total_count"
- ]
- },
- "relationships": {
- "type": "object",
- "properties": {
- "variants": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-variant"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogVariantUpdateJobCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogVariantBulkUpdateJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "variants": {
- "description": "Array of catalog variants to update.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogVariantUpdateQueryResourceObject"
- }
- }
- },
- "required": [
- "variants"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "CatalogVariantUpdateJobCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CatalogVariantUpdateJobCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PostCatalogVariantUpdateJobResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogVariantBulkUpdateJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "job_id": {
- "description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
- "type": "string"
- },
- "status": {
- "description": "Status of the asynchronous job.",
- "type": "string",
- "example": "processing",
- "enum": [
- "cancelled",
- "complete",
- "processing",
- "queued"
- ]
- },
- "created_at": {
- "description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "total_count": {
- "description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
- "type": "integer",
- "example": 10
- },
- "completed_count": {
- "description": "The total number of operations that have been completed by the job.",
- "type": "integer",
- "example": 9
- },
- "failed_count": {
- "description": "The total number of operations that have failed as part of the job.",
- "type": "integer",
- "example": 1
- },
- "completed_at": {
- "description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "expires_at": {
- "description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "errors": {
- "description": "Array of errors encountered during the processing of the job.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogJobErrorPayload"
- }
- }
- },
- "required": [
- "job_id",
- "status",
- "created_at",
- "total_count"
- ]
- },
- "relationships": {
- "type": "object",
- "properties": {
- "variants": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-variant"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogVariantDeleteJobCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogVariantBulkDeleteJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "variants": {
- "description": "Array of catalog variants to delete.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogVariantDeleteQueryResourceObject"
- }
- }
- },
- "required": [
- "variants"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "CatalogVariantDeleteJobCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CatalogVariantDeleteJobCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PostCatalogVariantDeleteJobResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogVariantBulkDeleteJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "job_id": {
- "description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
- "type": "string"
- },
- "status": {
- "description": "Status of the asynchronous job.",
- "type": "string",
- "example": "processing",
- "enum": [
- "cancelled",
- "complete",
- "processing",
- "queued"
- ]
- },
- "created_at": {
- "description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "total_count": {
- "description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
- "type": "integer",
- "example": 10
- },
- "completed_count": {
- "description": "The total number of operations that have been completed by the job.",
- "type": "integer",
- "example": 9
- },
- "failed_count": {
- "description": "The total number of operations that have failed as part of the job.",
- "type": "integer",
- "example": 1
- },
- "completed_at": {
- "description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "expires_at": {
- "description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "errors": {
- "description": "Array of errors encountered during the processing of the job.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogJobErrorPayload"
- }
- }
- },
- "required": [
- "job_id",
- "status",
- "created_at",
- "total_count"
- ]
- },
- "relationships": {
- "type": "object",
- "properties": {
- "variants": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-variant"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogCategoryCreateJobCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogCategoryBulkCreateJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "categories": {
- "description": "Array of catalog categories to create.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogCategoryCreateQueryResourceObject"
- }
- }
- },
- "required": [
- "categories"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "CatalogCategoryCreateJobCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CatalogCategoryCreateJobCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PostCatalogCategoryCreateJobResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogCategoryBulkCreateJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "job_id": {
- "description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
- "type": "string"
- },
- "status": {
- "description": "Status of the asynchronous job.",
- "type": "string",
- "example": "processing",
- "enum": [
- "cancelled",
- "complete",
- "processing",
- "queued"
- ]
- },
- "created_at": {
- "description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "total_count": {
- "description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
- "type": "integer",
- "example": 10
- },
- "completed_count": {
- "description": "The total number of operations that have been completed by the job.",
- "type": "integer",
- "example": 9
- },
- "failed_count": {
- "description": "The total number of operations that have failed as part of the job.",
- "type": "integer",
- "example": 1
- },
- "completed_at": {
- "description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "expires_at": {
- "description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "errors": {
- "description": "Array of errors encountered during the processing of the job.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogJobErrorPayload"
- }
- }
- },
- "required": [
- "job_id",
- "status",
- "created_at",
- "total_count"
- ]
- },
- "relationships": {
- "type": "object",
- "properties": {
- "categories": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-category"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogCategoryUpdateJobCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogCategoryBulkUpdateJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "categories": {
- "description": "Array of catalog categories to update.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogCategoryUpdateQueryResourceObject"
- }
- }
- },
- "required": [
- "categories"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "CatalogCategoryUpdateJobCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CatalogCategoryUpdateJobCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PostCatalogCategoryUpdateJobResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogCategoryBulkUpdateJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "job_id": {
- "description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
- "type": "string"
- },
- "status": {
- "description": "Status of the asynchronous job.",
- "type": "string",
- "example": "processing",
- "enum": [
- "cancelled",
- "complete",
- "processing",
- "queued"
- ]
- },
- "created_at": {
- "description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "total_count": {
- "description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
- "type": "integer",
- "example": 10
- },
- "completed_count": {
- "description": "The total number of operations that have been completed by the job.",
- "type": "integer",
- "example": 9
- },
- "failed_count": {
- "description": "The total number of operations that have failed as part of the job.",
- "type": "integer",
- "example": 1
- },
- "completed_at": {
- "description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "expires_at": {
- "description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "errors": {
- "description": "Array of errors encountered during the processing of the job.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogJobErrorPayload"
- }
- }
- },
- "required": [
- "job_id",
- "status",
- "created_at",
- "total_count"
- ]
- },
- "relationships": {
- "type": "object",
- "properties": {
- "categories": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-category"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogCategoryDeleteJobCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogCategoryBulkDeleteJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "categories": {
- "description": "Array of catalog categories to delete.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogCategoryDeleteQueryResourceObject"
- }
- }
- },
- "required": [
- "categories"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "CatalogCategoryDeleteJobCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CatalogCategoryDeleteJobCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PostCatalogCategoryDeleteJobResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogCategoryBulkDeleteJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "job_id": {
- "description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
- "type": "string"
- },
- "status": {
- "description": "Status of the asynchronous job.",
- "type": "string",
- "example": "processing",
- "enum": [
- "cancelled",
- "complete",
- "processing",
- "queued"
- ]
- },
- "created_at": {
- "description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "total_count": {
- "description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
- "type": "integer",
- "example": 10
- },
- "completed_count": {
- "description": "The total number of operations that have been completed by the job.",
- "type": "integer",
- "example": 9
- },
- "failed_count": {
- "description": "The total number of operations that have failed as part of the job.",
- "type": "integer",
- "example": 1
- },
- "completed_at": {
- "description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "expires_at": {
- "description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "errors": {
- "description": "Array of errors encountered during the processing of the job.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CatalogJobErrorPayload"
- }
- }
- },
- "required": [
- "job_id",
- "status",
- "created_at",
- "total_count"
- ]
- },
- "relationships": {
- "type": "object",
- "properties": {
- "categories": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-category"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "TagCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/TagEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The Tag name",
- "type": "string",
- "example": "My Tag"
- },
- "tag_group_id": {
- "description": "The ID of the Tag Group to associate the Tag with. If this field is not specified, the Tag will be associated with the company's Default Tag Group.",
- "type": "string",
- "example": "zyxw9876-vu54-ts32-rq10-zyxwvu654321"
- }
- },
- "required": [
- "name"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "TagCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/TagCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PostTagResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/TagEnum"
- },
- "id": {
- "description": "The Tag ID",
- "type": "string",
- "example": "abcd1234-ef56-gh78-ij90-abcdef123456"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The Tag name",
- "type": "string",
- "example": "My Tag"
- }
- },
- "required": [
- "name"
- ]
- },
- "relationships": {
- "type": "object",
- "properties": {
- "tag-group": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag-group"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "lists": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "list"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "segments": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "segment"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "campaigns": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "campaign"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "flows": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "TagGroupCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/TagGroupEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The Tag Group name",
- "type": "string",
- "example": "My Tag Group"
- },
- "exclusive": {
- "type": "boolean"
- }
- },
- "required": [
- "name"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "TagGroupCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/TagGroupCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PostTagGroupResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/TagGroupEnum"
- },
- "id": {
- "description": "The Tag Group ID",
- "type": "string",
- "example": "zyxw9876-vu54-ts32-rq10-zyxwvu654321"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The Tag Group name",
- "type": "string",
- "example": "My Tag Group"
- },
- "exclusive": {
- "description": "If a tag group is non-exclusive, any given related resource (campaign, flow, etc.) can be linked to multiple tags from that tag group. If a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.",
- "type": "boolean"
- },
- "default": {
- "description": "Every company automatically has one Default Tag Group. The Default Tag Group cannot be deleted, and no other Default Tag Groups can be created. This value is true for the Default Tag Group and false for all other Tag Groups.",
- "type": "boolean"
- }
- },
- "required": [
- "name",
- "exclusive",
- "default"
- ]
- },
- "relationships": {
- "type": "object",
- "properties": {
- "tags": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "TagFlowOp": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "TagCampaignOp": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "campaign"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "TagListOp": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "list"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "TagSegmentOp": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "segment"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "Suppression": {
- "type": "object",
- "properties": {
- "email": {
- "description": "The email of the profile to suppress / unsuppress.",
- "type": "string",
- "example": "matt-kemp@klaviyo-demo.com"
- }
- },
- "required": [
- "email"
- ]
- },
- "SuppressionCreateJobCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/ProfileSuppressionBulkCreateJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "suppressions": {
- "description": "One or more suppressions to be created.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Suppression"
- }
- }
- },
- "required": [
- "suppressions"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "SuppressionCreateJobCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/SuppressionCreateJobCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "UnsuppressionCreateJobCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/ProfileUnsuppressionBulkCreateJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "suppressions": {
- "description": "One or more suppressions to be removed.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Suppression"
- }
- }
- },
- "required": [
- "suppressions"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "UnsuppressionCreateJobCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/UnsuppressionCreateJobCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "SubscriptionChannels": {
- "type": "object",
- "properties": {
- "email": {
- "description": "The communication types to subscribe to on the \"EMAIL\" Channel. Currently supports \"MARKETING\".",
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "MARKETING"
- ],
- "description": "The communication types supported by email subscriptions."
- },
- "example": [
- "MARKETING"
- ]
- },
- "sms": {
- "description": "The communication types to subscribe to on the \"SMS\" Channel. Currently supports \"MARKETING\".",
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "MARKETING"
- ],
- "description": "The communication types supported by SMS subscriptions."
- },
- "example": [
- "MARKETING"
- ]
- }
- }
- },
- "Subscription": {
- "type": "object",
- "properties": {
- "channels": {
- "description": "When provided, this will provide consent for the indicated message types on the specified channels. If omitted, we will subscribe the profile to all message types on the channels corresponding to the provided identifiers.",
- "$ref": "#/components/schemas/SubscriptionChannels"
- },
- "email": {
- "description": "The email address to subscribe or to set on the profile if `channels` is specified and the email channel is omitted.",
- "type": "string",
- "example": "matt-kemp@klaviyo-demo.com"
- },
- "phone_number": {
- "description": "The phone number to subscribe or to set on the profile if `channels` is specified and the SMS channel is omitted.",
- "type": "string",
- "example": "+15005550006"
- },
- "profile_id": {
- "description": "The ID of the profile to subscribe. If provided, this will be used to perform the lookup.",
- "type": "string",
- "example": "01GDDKASAP8TKDDA2GRZDSVP4H"
- }
- }
- },
- "SubscriptionCreateJobCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/ProfileSubscriptionBulkCreateJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "list_id": {
- "description": "The list to add the newly subscribed profiles to",
- "type": "string",
- "example": "Y6nRLr"
- },
- "custom_source": {
- "description": "A custom method detail or source to store on the consent records.",
- "type": "string",
- "example": "Marketing Event"
- },
- "subscriptions": {
- "description": "One or more subscriptions to be created.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Subscription"
- }
- }
- },
- "required": [
- "list_id",
- "subscriptions"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "SubscriptionCreateJobCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/SubscriptionCreateJobCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "UnsubscriptionCreateJobCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/ProfileUnsubscriptionBulkCreateJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "list_id": {
- "description": "Optional, the list to remove the profiles from",
- "type": "string",
- "example": "Y6nRLr"
- },
- "emails": {
- "description": "The emails to unsubscribe if any.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": "[\"matt-kemp@klaviyo-demo.com\", \"sarah.mason@klaviyo-demo.com\""
- },
- "phone_numbers": {
- "description": "The phone numbers to unsubscribe if any.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": "[\"+15005550006\",\"+15005550007\"]"
- }
- }
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "UnsubscriptionCreateJobCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/UnsubscriptionCreateJobCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "DataPrivacyCreateDeletionJobQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/DataPrivacyDeletionJobEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "profile_id": {
- "description": "The ID of the profile to delete. This is the `id` field on the profile object.",
- "type": "string",
- "example": "01F2VWQ645BES947MP1BPAKVMB"
- },
- "email": {
- "description": "The email address of the profile to delete.",
- "type": "string",
- "example": "matt.kemp@klaviyo-demo.com"
- },
- "phone_number": {
- "description": "The phone number of the profile to delete.",
- "type": "string",
- "example": "+15005550006"
- }
- }
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "DataPrivacyCreateDeletionJobQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/DataPrivacyCreateDeletionJobQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "OnsiteSubscriptionCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/SubscriptionEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "list_id": {
- "description": "The list ID to add the newly subscribed profile to.",
- "type": "string",
- "example": "Y6nRLr"
- },
- "custom_source": {
- "description": "A custom method detail or source to store on the consent records for this subscription.",
- "type": "string",
- "example": "Homepage footer signup form"
- },
- "email": {
- "description": "Email address to create subscription and email consent record for.",
- "type": "string",
- "example": "matt.kemp@klaviyo-demo.com"
- },
- "phone_number": {
- "description": "Phone number to create subscription and SMS consent record for, in E.164 format.",
- "type": "string",
- "example": "+15005550006"
- },
- "properties": {
- "description": "Profile properties to set on the newly subscribed profile.",
- "type": "object",
- "example": {
- "first_name": "Matt",
- "last_name": "Kemp",
- "favorite_color": "Blue"
- }
- }
- },
- "required": [
- "list_id"
- ]
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "OnsiteSubscriptionCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/OnsiteSubscriptionCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "_OnsiteProfileMetaIdentifiers": {
- "type": "object",
- "properties": {
- "id": {
- "description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
- "type": "string",
- "example": "01GDDKASAP8TKDDA2GRZDSVP4H"
- },
- "email": {
- "description": "Individual's email address",
- "type": "string",
- "example": "sarah.mason@klaviyo-demo.com"
- },
- "phone_number": {
- "description": "Individual's phone number in E.164 format",
- "type": "string",
- "example": "+15005550006"
- },
- "external_id": {
- "description": "A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.",
- "type": "string",
- "example": "63f64a2b-c6bf-40c7-b81f-bed08162edbe"
- },
- "anonymous_id": {
- "type": "string"
- },
- "_kx": {
- "description": "\nAlso known as the `exchange_id`, this is an encrypted identifier used for identifying a\nprofile by Klaviyo's web tracking.\n\nYou can use this field as a filter when retrieving profiles via the Get Profiles endpoint.\n",
- "type": "string",
- "example": "J8fjcn003Wy6b-3ILNlOyZXabW6dcFwTyeuxrowMers%3D.McN66"
- }
- }
- },
- "_OnsiteProfileMeta": {
- "type": "object",
- "properties": {
- "identifiers": {
- "$ref": "#/components/schemas/_OnsiteProfileMetaIdentifiers"
- }
- },
- "required": [
- "identifiers"
- ]
- },
- "OnsiteProfileCreateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/ProfileEnum"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "email": {
- "description": "Individual's email address",
- "type": "string",
- "example": "sarah.mason@klaviyo-demo.com"
- },
- "phone_number": {
- "description": "Individual's phone number in E.164 format",
- "type": "string",
- "example": "+15005550006"
- },
- "external_id": {
- "description": "A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.",
- "type": "string",
- "example": "63f64a2b-c6bf-40c7-b81f-bed08162edbe"
- },
- "anonymous_id": {
- "type": "string"
- },
- "first_name": {
- "description": "Individual's first name",
- "type": "string",
- "example": "Sarah"
- },
- "last_name": {
- "description": "Individual's last name",
- "type": "string",
- "example": "Mason"
- },
- "organization": {
- "description": "Name of the company or organization within the company for whom the individual works",
- "type": "string",
- "example": "Klaviyo"
- },
- "title": {
- "description": "Individual's job title",
- "type": "string",
- "example": "Engineer"
- },
- "image": {
- "description": "URL pointing to the location of a profile image",
- "type": "string",
- "example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg"
- },
- "location": {
- "$ref": "#/components/schemas/ProfileLocation"
- },
- "properties": {
- "description": "An object containing key/value pairs for any custom properties assigned to this profile",
- "type": "object",
- "example": {
- "pseudonym": "Dr. Octopus"
- }
- }
- }
- },
- "meta": {
- "$ref": "#/components/schemas/_OnsiteProfileMeta"
- }
- },
- "required": [
- "type",
- "attributes"
- ]
- },
- "OnsiteProfileCreateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/OnsiteProfileCreateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogItemUpdateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogItemEnum"
- },
- "id": {
- "description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "title": {
- "description": "The title of the catalog item.",
- "type": "string",
- "example": "Ocean Blue Shirt (Sample)"
- },
- "price": {
- "description": "This field can be used to set the price on the catalog item, which is what gets displayed for the item when included in emails. For most price-update use cases, you will also want to update the `price` on any child variants, using the [Update Catalog Variant Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_variant).",
- "type": "number",
- "example": 42
- },
- "description": {
- "description": "A description of the catalog item.",
- "type": "string",
- "example": "A description of the catalog item."
- },
- "url": {
- "description": "URL pointing to the location of the catalog item on your website.",
- "type": "string",
- "example": "https://via.placeholder.com/150"
- },
- "image_full_url": {
- "description": "URL pointing to the location of a full image of the catalog item.",
- "type": "string",
- "example": "https://via.placeholder.com/300"
- },
- "image_thumbnail_url": {
- "description": "URL pointing to the location of an image thumbnail of the catalog item",
- "type": "string",
- "example": "https://via.placeholder.com/150"
- },
- "images": {
- "description": "List of URLs pointing to the locations of images of the catalog item.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": [
- "https://via.placeholder.com/150"
- ]
- },
- "custom_metadata": {
- "description": "Flat JSON blob to provide custom metadata about the catalog item. May not exceed 100kb.",
- "type": "object",
- "example": {
- "Top Pick": true
- }
- },
- "published": {
- "description": "Boolean value indicating whether the catalog item is published.",
- "type": "boolean",
- "example": true
- }
- }
- },
- "relationships": {
- "type": "object",
- "properties": {
- "categories": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-category"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- },
- "required": [
- "type",
- "id",
- "attributes"
- ]
- },
- "CatalogItemUpdateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CatalogItemUpdateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PatchCatalogItemResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogItemEnum"
- },
- "id": {
- "description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "external_id": {
- "description": "The ID of the catalog item in an external system.",
- "type": "string",
- "example": "SAMPLE-DATA-ITEM-1"
- },
- "title": {
- "description": "The title of the catalog item.",
- "type": "string",
- "example": "Ocean Blue Shirt (Sample)"
- },
- "description": {
- "description": "A description of the catalog item.",
- "type": "string",
- "example": "Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns."
- },
- "price": {
- "description": "This field can be used to set the price on the catalog item, which is what gets displayed for the item when included in emails. For most price-update use cases, you will also want to update the `price` on any child variants, using the [Update Catalog Variant Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_variant).",
- "type": "number",
- "example": 42
- },
- "url": {
- "description": "URL pointing to the location of the catalog item on your website.",
- "type": "string",
- "example": "https://via.placeholder.com/150"
- },
- "image_full_url": {
- "description": "URL pointing to the location of a full image of the catalog item.",
- "type": "string",
- "example": "https://via.placeholder.com/300"
- },
- "image_thumbnail_url": {
- "description": "URL pointing to the location of an image thumbnail of the catalog item",
- "type": "string",
- "example": "https://via.placeholder.com/150"
- },
- "images": {
- "description": "List of URLs pointing to the locations of images of the catalog item.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": [
- "https://via.placeholder.com/150"
- ]
- },
- "custom_metadata": {
- "description": "Flat JSON blob to provide custom metadata about the catalog item. May not exceed 100kb.",
- "type": "object",
- "example": {
- "Top Pick": true
- }
- },
- "published": {
- "description": "Boolean value indicating whether the catalog item is published.",
- "type": "boolean",
- "example": true
- },
- "created": {
- "description": "Date and time when the catalog item was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated": {
- "description": "Date and time when the catalog item was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- }
- }
- },
- "relationships": {
- "type": "object",
- "properties": {
- "variants": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-variant"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogVariantUpdateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogVariantEnum"
- },
- "id": {
- "description": "The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "title": {
- "description": "The title of the catalog item variant.",
- "type": "string",
- "example": "Ocean Blue Shirt (Sample) Variant Medium"
- },
- "description": {
- "description": "A description of the catalog item variant.",
- "type": "string",
- "example": "Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns."
- },
- "sku": {
- "description": "The SKU of the catalog item variant.",
- "type": "string",
- "example": "OBS-MD"
- },
- "inventory_policy": {
- "description": "This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values:\n`1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock.\n`0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity.\n",
- "type": "integer",
- "example": 2,
- "enum": [
- 0,
- 1,
- 2
- ]
- },
- "inventory_quantity": {
- "description": "The quantity of the catalog item variant currently in stock.",
- "type": "number",
- "example": 25
- },
- "price": {
- "description": "This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the [Update Catalog Item Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_item).",
- "type": "number",
- "example": 42
- },
- "url": {
- "description": "URL pointing to the location of the catalog item variant on your website.",
- "type": "string",
- "example": "https://via.placeholder.com/150"
- },
- "image_full_url": {
- "description": "URL pointing to the location of a full image of the catalog item variant.",
- "type": "string",
- "example": "https://via.placeholder.com/300"
- },
- "image_thumbnail_url": {
- "description": "URL pointing to the location of an image thumbnail of the catalog item variant.",
- "type": "string",
- "example": "https://via.placeholder.com/150"
- },
- "images": {
- "description": "List of URLs pointing to the locations of images of the catalog item variant.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": [
- "https://via.placeholder.com/150"
- ]
- },
- "custom_metadata": {
- "description": "Flat JSON blob to provide custom metadata about the catalog item variant. May not exceed 100kb.",
- "type": "object",
- "example": {
- "Top Pick": true
- }
- },
- "published": {
- "description": "Boolean value indicating whether the catalog item variant is published.",
- "type": "boolean",
- "example": true
- }
- }
- }
- },
- "required": [
- "type",
- "id",
- "attributes"
- ]
- },
- "CatalogVariantUpdateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CatalogVariantUpdateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PatchCatalogVariantResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogVariantEnum"
- },
- "id": {
- "description": "The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "external_id": {
- "description": "The ID of the catalog item variant in an external system.",
- "type": "string",
- "example": "SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM"
- },
- "title": {
- "description": "The title of the catalog item variant.",
- "type": "string",
- "example": "Ocean Blue Shirt (Sample) Variant Medium"
- },
- "description": {
- "description": "A description of the catalog item variant.",
- "type": "string",
- "example": "Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns."
- },
- "sku": {
- "description": "The SKU of the catalog item variant.",
- "type": "string",
- "example": "OBS-MD"
- },
- "inventory_policy": {
- "description": "This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values:\n`1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock.\n`0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity.\n",
- "type": "integer",
- "example": 2,
- "enum": [
- 0,
- 1,
- 2
- ]
- },
- "inventory_quantity": {
- "description": "The quantity of the catalog item variant currently in stock.",
- "type": "number",
- "example": 25
- },
- "price": {
- "description": "This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the [Update Catalog Item Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_item).",
- "type": "number",
- "example": 42
- },
- "url": {
- "description": "URL pointing to the location of the catalog item variant on your website.",
- "type": "string",
- "example": "https://via.placeholder.com/150"
- },
- "image_full_url": {
- "description": "URL pointing to the location of a full image of the catalog item variant.",
- "type": "string",
- "example": "https://via.placeholder.com/300"
- },
- "image_thumbnail_url": {
- "description": "URL pointing to the location of an image thumbnail of the catalog item variant.",
- "type": "string",
- "example": "https://via.placeholder.com/150"
- },
- "images": {
- "description": "List of URLs pointing to the locations of images of the catalog item variant.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": [
- "https://via.placeholder.com/150"
- ]
- },
- "custom_metadata": {
- "description": "Flat JSON blob to provide custom metadata about the catalog item variant. May not exceed 100kb.",
- "type": "object",
- "example": {
- "Top Pick": true
- }
- },
- "published": {
- "description": "Boolean value indicating whether the catalog item variant is published.",
- "type": "boolean",
- "example": true
- },
- "created": {
- "description": "Date and time when the catalog item variant was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated": {
- "description": "Date and time when the catalog item variant was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- }
- }
- },
- "relationships": {
- "type": "object",
- "properties": {
- "items": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-item"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogCategoryUpdateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogCategoryEnum"
- },
- "id": {
- "description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the catalog category.",
- "type": "string",
- "example": "Sample Data Category Apparel"
- }
- }
- },
- "relationships": {
- "type": "object",
- "properties": {
- "items": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-item"
- ]
- },
- "id": {
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- }
- }
- }
- },
- "required": [
- "type",
- "id",
- "attributes"
- ]
- },
- "CatalogCategoryUpdateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CatalogCategoryUpdateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PatchCatalogCategoryResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogCategoryEnum"
- },
- "id": {
- "description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "external_id": {
- "description": "The ID of the catalog category in an external system.",
- "type": "string",
- "example": "SAMPLE-DATA-CATEGORY-APPAREL"
- },
- "name": {
- "description": "The name of the catalog category.",
- "type": "string",
- "example": "Sample Data Category Apparel"
- },
- "updated": {
- "description": "Date and time when the catalog category was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- }
- }
- },
- "relationships": {
- "type": "object",
- "properties": {
- "items": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "catalog-item"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "ListPartialUpdateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/ListEnum"
- },
- "id": {
- "description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
- "type": "string",
- "example": "Y6nRLr"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "A helpful name to label the list",
- "type": "string",
- "example": "Newsletter"
- }
- },
- "required": [
- "name"
- ]
- }
- },
- "required": [
- "type",
- "id",
- "attributes"
- ]
- },
- "ListPartialUpdateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/ListPartialUpdateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PatchListResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/ListEnum"
- },
- "id": {
- "description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
- "type": "string",
- "example": "Y6nRLr"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "A helpful name to label the list",
- "type": "string",
- "example": "Newsletter"
- },
- "created": {
- "description": "Date and time when the list was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated": {
- "description": "Date and time when the list was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- }
- }
- },
- "relationships": {
- "type": "object",
- "properties": {
- "profiles": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "profile"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "tags": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "SegmentPartialUpdateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/SegmentEnum"
- },
- "id": {
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- }
- },
- "required": [
- "name"
- ]
- }
- },
- "required": [
- "type",
- "id",
- "attributes"
- ]
- },
- "SegmentPartialUpdateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/SegmentPartialUpdateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PatchSegmentResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/SegmentEnum"
- },
- "id": {
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "A helpful name to label the segment ",
- "type": "string",
- "example": "Repeat Purchasers"
- },
- "created": {
- "description": "Date and time when the segment was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated": {
- "description": "Date and time when the segment was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- }
- }
- },
- "relationships": {
- "type": "object",
- "properties": {
- "profiles": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "profile"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "tags": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "ProfilePartialUpdateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/ProfileEnum"
- },
- "id": {
- "description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
- "type": "string",
- "example": "01GDDKASAP8TKDDA2GRZDSVP4H"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "email": {
- "description": "Individual's email address",
- "type": "string",
- "example": "sarah.mason@klaviyo-demo.com"
- },
- "phone_number": {
- "description": "Individual's phone number in E.164 format",
- "type": "string",
- "example": "+15005550006"
- },
- "external_id": {
- "description": "A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.",
- "type": "string",
- "example": "63f64a2b-c6bf-40c7-b81f-bed08162edbe"
- },
- "anonymous_id": {
- "type": "string"
- },
- "first_name": {
- "description": "Individual's first name",
- "type": "string",
- "example": "Sarah"
- },
- "last_name": {
- "description": "Individual's last name",
- "type": "string",
- "example": "Mason"
- },
- "organization": {
- "description": "Name of the company or organization within the company for whom the individual works",
- "type": "string",
- "example": "Klaviyo"
- },
- "title": {
- "description": "Individual's job title",
- "type": "string",
- "example": "Engineer"
- },
- "image": {
- "description": "URL pointing to the location of a profile image",
- "type": "string",
- "example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg"
- },
- "location": {
- "$ref": "#/components/schemas/ProfileLocation"
- },
- "properties": {
- "description": "An object containing key/value pairs for any custom properties assigned to this profile",
- "type": "object",
- "example": {
- "pseudonym": "Dr. Octopus"
- }
- }
- }
- }
- },
- "required": [
- "type",
- "id",
- "attributes"
- ]
- },
- "ProfilePartialUpdateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/ProfilePartialUpdateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PatchProfileResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/ProfileEnum"
- },
- "id": {
- "description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
- "type": "string",
- "example": "01GDDKASAP8TKDDA2GRZDSVP4H"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "email": {
- "description": "Individual's email address",
- "type": "string",
- "example": "sarah.mason@klaviyo-demo.com"
- },
- "phone_number": {
- "description": "Individual's phone number in E.164 format",
- "type": "string",
- "example": "+15005550006"
- },
- "external_id": {
- "description": "A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.",
- "type": "string",
- "example": "63f64a2b-c6bf-40c7-b81f-bed08162edbe"
- },
- "first_name": {
- "description": "Individual's first name",
- "type": "string",
- "example": "Sarah"
- },
- "last_name": {
- "description": "Individual's last name",
- "type": "string",
- "example": "Mason"
- },
- "organization": {
- "description": "Name of the company or organization within the company for whom the individual works",
- "type": "string",
- "example": "Klaviyo"
- },
- "title": {
- "description": "Individual's job title",
- "type": "string",
- "example": "Engineer"
- },
- "image": {
- "description": "URL pointing to the location of a profile image",
- "type": "string",
- "example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg"
- },
- "created": {
- "description": "Date and time when the profile was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated": {
- "description": "Date and time when the profile was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "last_event_date": {
- "description": "Date and time of the most recent event the triggered an update to the profile, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "location": {
- "$ref": "#/components/schemas/ProfileLocation"
- },
- "properties": {
- "description": "An object containing key/value pairs for any custom properties assigned to this profile",
- "type": "object",
- "example": {
- "pseudonym": "Dr. Octopus"
- }
- },
- "subscriptions": {
- "$ref": "#/components/schemas/Subscriptions"
- },
- "predictive_analytics": {
- "$ref": "#/components/schemas/PredictiveAnalytics"
- }
- }
- },
- "relationships": {
- "type": "object",
- "properties": {
- "lists": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "list"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "segments": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "segment"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "FlowUpdateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/FlowEnum"
- },
- "id": {
- "description": "ID of the Flow to update. Ex: XVTP5Q",
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "status": {
- "description": "Status you want to update the flow to. ['draft', 'manual', or 'live']",
- "type": "string"
- }
- },
- "required": [
- "status"
- ]
- }
- },
- "required": [
- "type",
- "id",
- "attributes"
- ]
- },
- "FlowUpdateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/FlowUpdateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PatchFlowResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/FlowEnum"
- },
- "id": {
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "status": {
- "type": "string"
- },
- "archived": {
- "type": "boolean"
- },
- "created": {
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated": {
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "trigger_type": {
- "type": "string"
- }
- }
- },
- "relationships": {
- "type": "object",
- "properties": {
- "flow-actions": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow-action"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "tags": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "CampaignPartialUpdateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CampaignEnum"
- },
- "id": {
- "description": "The campaign ID to be retrieved",
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The campaign name",
- "type": "string",
- "example": "My new campaign"
- },
- "audiences": {
- "description": "The audiences to be included and/or excluded from the campaign",
- "$ref": "#/components/schemas/AudiencesSubObject"
- },
- "send_options": {
- "description": "Options to use when sending a campaign",
- "$ref": "#/components/schemas/SendOptionsSubObject"
- },
- "tracking_options": {
- "description": "The tracking options associated with the campaign",
- "$ref": "#/components/schemas/TrackingOptionsSubObject"
- },
- "send_strategy": {
- "description": "The send strategy the campaign will send with",
- "$ref": "#/components/schemas/SendStrategySubObject"
- }
- }
- }
- },
- "required": [
- "type",
- "id",
- "attributes"
- ]
- },
- "CampaignPartialUpdateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CampaignPartialUpdateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PatchCampaignResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CampaignEnum"
- },
- "id": {
- "description": "The campaign ID",
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The campaign name",
- "type": "string"
- },
- "status": {
- "description": "The current status of the campaign",
- "type": "string"
- },
- "archived": {
- "description": "Whether the campaign has been archived or not",
- "type": "boolean"
- },
- "channel": {
- "description": "The type of campaign",
- "type": "string"
- },
- "audiences": {
- "description": "The audiences to be included and/or excluded from the campaign",
- "$ref": "#/components/schemas/AudiencesSubObject"
- },
- "send_options": {
- "description": "Options to use when sending a campaign",
- "$ref": "#/components/schemas/SendOptionsSubObject"
- },
- "message": {
- "description": "The id of the message associated with the campaign",
- "type": "string"
- },
- "tracking_options": {
- "description": "The tracking options associated with the campaign",
- "$ref": "#/components/schemas/TrackingOptionsSubObject"
- },
- "send_strategy": {
- "description": "The send strategy the campaign will send with",
- "$ref": "#/components/schemas/SendStrategySubObject"
- },
- "created_at": {
- "description": "The datetime when the campaign was created",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "scheduled_at": {
- "description": "The datetime when the campaign was scheduled for future sending",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated_at": {
- "description": "The datetime when the campaign was last updated by a user or the system",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "send_time": {
- "description": "The datetime when the campaign will be / was sent or None if not yet scheduled by a send_job.",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- }
- },
- "required": [
- "name",
- "status",
- "archived",
- "channel",
- "audiences",
- "send_options",
- "message",
- "tracking_options",
- "send_strategy",
- "created_at",
- "scheduled_at",
- "updated_at",
- "send_time"
- ]
- },
- "relationships": {
- "type": "object",
- "properties": {
- "tags": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "CampaignMessagePartialUpdateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CampaignMessageEnum"
- },
- "id": {
- "description": "The message ID to be retrieved",
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "label": {
- "description": "The label or name on the message",
- "type": "string",
- "example": "My message name"
- },
- "content": {
- "$ref": "#/components/schemas/ContentSubObject",
- "description": "Additional attributes relating to the content of the message"
- }
- }
- }
- },
- "required": [
- "type",
- "id",
- "attributes"
- ]
- },
- "CampaignMessagePartialUpdateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CampaignMessagePartialUpdateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PatchCampaignMessageResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CampaignMessageEnum"
- },
- "id": {
- "description": "The message ID",
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "label": {
- "description": "The label or name on the message",
- "type": "string"
- },
- "channel": {
- "description": "The channel the message is to be sent on",
- "type": "string"
- },
- "content": {
- "$ref": "#/components/schemas/ContentSubObject",
- "description": "Additional attributes relating to the content of the message"
- },
- "send_times": {
- "description": "The list of appropriate Send Time Sub-objects associated with the message",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/SendTimeSubObject"
- }
- },
- "created_at": {
- "description": "The datetime when the message was created",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated_at": {
- "description": "The datetime when the message was last updated",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "campaign_id": {
- "description": "The parent campaign id",
- "type": "string"
- }
- },
- "required": [
- "label",
- "channel",
- "content",
- "campaign_id"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "CampaignSendJobPartialUpdateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CampaignSendJobEnum"
- },
- "id": {
- "description": "The ID of the currently sending campaign to cancel or revert",
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "action": {
- "description": "The action you would like to take with this send job from among 'cancel' and 'revert'",
- "type": "string",
- "example": "cancel"
- }
- },
- "required": [
- "action"
- ]
- }
- },
- "required": [
- "type",
- "id",
- "attributes"
- ]
- },
- "CampaignSendJobPartialUpdateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/CampaignSendJobPartialUpdateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "TemplateUpdateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/TemplateEnum"
- },
- "id": {
- "description": "The ID of template",
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the template",
- "type": "string",
- "example": "Monthly Newsletter Template"
- },
- "html": {
- "description": "The HTML of the template",
- "type": "string",
- "example": "\n \n \n hello world\n \n \n "
- },
- "text": {
- "description": "The plaintext of the template",
- "type": "string",
- "example": "hello world"
- },
- "return_fields": {
- "description": "Provide fields to limit the returned data",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "type",
- "id",
- "attributes"
- ]
- },
- "TemplateUpdateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/TemplateUpdateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PatchTemplateResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/TemplateEnum"
- },
- "id": {
- "description": "The ID of template",
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "company_id": {
- "description": "The ID of the company the template belongs to",
- "type": "string",
- "example": "COMPANY_ID"
- },
- "name": {
- "description": "The name of the template",
- "type": "string"
- },
- "editor_type": {
- "description": " `editor_type` has a fixed set of values:\n* SYSTEM_DRAGGABLE: indicates a drag-and-drop editor template\n* SIMPLE: A rich text editor template\n* CODE: A custom HTML template\n* USER_DRAGGABLE: A hybrid template, using custom HTML in the drag-and-drop editor\n",
- "type": "string"
- },
- "html": {
- "description": "The rendered HTML of the template",
- "type": "string"
- },
- "text": {
- "description": "The template plain_text",
- "type": "string"
- },
- "created": {
- "description": "The date the template was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated": {
- "description": "The date the template was updated in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- }
- },
- "required": [
- "company_id",
- "name",
- "editor_type",
- "html"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "TagUpdateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/TagEnum"
- },
- "id": {
- "description": "The Tag ID",
- "type": "string",
- "example": "abcd1234-ef56-gh78-ij90-abcdef123456"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The Tag name",
- "type": "string",
- "example": "My Tag"
- }
- },
- "required": [
- "name"
- ]
- }
- },
- "required": [
- "type",
- "id",
- "attributes"
- ]
- },
- "TagUpdateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/TagUpdateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PatchTagResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/TagEnum"
- },
- "id": {
- "description": "The Tag ID",
- "type": "string",
- "example": "abcd1234-ef56-gh78-ij90-abcdef123456"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The Tag name",
- "type": "string",
- "example": "My Tag"
- }
- },
- "required": [
- "name"
- ]
- },
- "relationships": {
- "type": "object",
- "properties": {
- "tag-group": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag-group"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "lists": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "list"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "segments": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "segment"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "campaigns": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "campaign"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "flows": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "TagGroupUpdateQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/TagGroupEnum"
- },
- "id": {
- "description": "The Tag Group ID",
- "type": "string",
- "example": "zyxw9876-vu54-ts32-rq10-zyxwvu654321"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The Tag Group name",
- "type": "string",
- "example": "My Tag Group"
- },
- "return_fields": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "required": [
- "name"
- ]
- }
- },
- "required": [
- "type",
- "id",
- "attributes"
- ]
- },
- "TagGroupUpdateQuery": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/TagGroupUpdateQueryResourceObject"
- }
- },
- "required": [
- "data"
- ]
- },
- "PatchTagGroupResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/TagGroupEnum"
- },
- "id": {
- "description": "The Tag Group ID",
- "type": "string",
- "example": "zyxw9876-vu54-ts32-rq10-zyxwvu654321"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The Tag Group name",
- "type": "string",
- "example": "My Tag Group"
- },
- "exclusive": {
- "description": "If a tag group is non-exclusive, any given related resource (campaign, flow, etc.) can be linked to multiple tags from that tag group. If a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.",
- "type": "boolean"
- },
- "default": {
- "description": "Every company automatically has one Default Tag Group. The Default Tag Group cannot be deleted, and no other Default Tag Groups can be created. This value is true for the Default Tag Group and false for all other Tag Groups.",
- "type": "boolean"
- }
- },
- "required": [
- "name",
- "exclusive",
- "default"
- ]
- },
- "relationships": {
- "type": "object",
- "properties": {
- "tags": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "CatalogItemDeleteQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogItemEnum"
- },
- "id": {
- "description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
- }
- },
- "required": [
- "type",
- "id"
- ]
- },
- "CatalogVariantDeleteQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogVariantEnum"
- },
- "id": {
- "description": "The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM"
- }
- },
- "required": [
- "type",
- "id"
- ]
- },
- "CatalogCategoryDeleteQueryResourceObject": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/CatalogCategoryEnum"
- },
- "id": {
- "description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
- "type": "string",
- "example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
- }
- },
- "required": [
- "type",
- "id"
- ]
- },
- "ListMembersDeleteQuery": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "profile"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "data"
- ]
- },
- "DeleteTemplateResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/TemplateEnum"
- },
- "id": {
- "description": "The ID of template",
- "type": "string"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "company_id": {
- "description": "The ID of the company the template belongs to",
- "type": "string",
- "example": "COMPANY_ID"
- },
- "name": {
- "description": "The name of the template",
- "type": "string"
- },
- "editor_type": {
- "description": " `editor_type` has a fixed set of values:\n* SYSTEM_DRAGGABLE: indicates a drag-and-drop editor template\n* SIMPLE: A rich text editor template\n* CODE: A custom HTML template\n* USER_DRAGGABLE: A hybrid template, using custom HTML in the drag-and-drop editor\n",
- "type": "string"
- },
- "html": {
- "description": "The rendered HTML of the template",
- "type": "string"
- },
- "text": {
- "description": "The template plain_text",
- "type": "string"
- },
- "created": {
- "description": "The date the template was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- },
- "updated": {
- "description": "The date the template was updated in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
- "type": "string",
- "format": "date-time",
- "example": "2022-11-08T00:00:00"
- }
- },
- "required": [
- "company_id",
- "name",
- "editor_type",
- "html"
- ]
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "DeleteTagResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/TagEnum"
- },
- "id": {
- "description": "The Tag ID",
- "type": "string",
- "example": "abcd1234-ef56-gh78-ij90-abcdef123456"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The Tag name",
- "type": "string",
- "example": "My Tag"
- }
- },
- "required": [
- "name"
- ]
- },
- "relationships": {
- "type": "object",
- "properties": {
- "tag-group": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag-group"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "lists": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "list"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "segments": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "segment"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "campaigns": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "campaign"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- },
- "flows": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "flow"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "DeleteTagGroupResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/TagGroupEnum"
- },
- "id": {
- "description": "The Tag Group ID",
- "type": "string",
- "example": "zyxw9876-vu54-ts32-rq10-zyxwvu654321"
- },
- "attributes": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The Tag Group name",
- "type": "string",
- "example": "My Tag Group"
- },
- "exclusive": {
- "description": "If a tag group is non-exclusive, any given related resource (campaign, flow, etc.) can be linked to multiple tags from that tag group. If a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.",
- "type": "boolean"
- },
- "default": {
- "description": "Every company automatically has one Default Tag Group. The Default Tag Group cannot be deleted, and no other Default Tag Groups can be created. This value is true for the Default Tag Group and false for all other Tag Groups.",
- "type": "boolean"
- }
- },
- "required": [
- "name",
- "exclusive",
- "default"
- ]
- },
- "relationships": {
- "type": "object",
- "properties": {
- "tags": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type",
- "id"
- ],
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "id": {
- "type": "string"
- }
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/RelationshipLinks"
- }
- },
- "required": [
- "data"
- ]
- }
- }
- },
- "links": {
- "$ref": "#/components/schemas/ObjectLinks"
- }
- },
- "required": [
- "type",
- "id",
- "attributes",
- "links"
- ]
- }
- },
- "required": [
- "data"
- ]
- },
- "RelationshipLinks": {
- "type": "object",
- "properties": {
- "self": {
- "type": "string",
- "format": "uri"
- },
- "related": {
- "type": "string",
- "format": "uri"
- }
- },
- "required": [
- "self",
- "related"
- ]
- },
- "CollectionLinks": {
- "type": "object",
- "properties": {
- "self": {
- "type": "string",
- "format": "uri"
- },
- "first": {
- "type": "string",
- "format": "uri"
- },
- "last": {
- "type": "string",
- "format": "uri"
- },
- "prev": {
- "type": "string",
- "format": "uri"
- },
- "next": {
- "type": "string",
- "format": "uri"
- }
- },
- "required": [
- "self"
- ]
- },
- "ObjectLinks": {
- "type": "object",
- "properties": {
- "self": {
- "type": "string",
- "format": "uri"
- }
- },
- "required": [
- "self"
- ]
- },
- "CatalogItemEnum": {
- "type": "string",
- "enum": [
- "catalog-item"
- ]
- },
- "CatalogVariantEnum": {
- "type": "string",
- "enum": [
- "catalog-variant"
- ]
- },
- "CatalogCategoryEnum": {
- "type": "string",
- "enum": [
- "catalog-category"
- ]
- },
- "EventEnum": {
- "type": "string",
- "enum": [
- "event"
- ]
- },
- "MetricEnum": {
- "type": "string",
- "enum": [
- "metric"
- ]
- },
- "ProfileEnum": {
- "type": "string",
- "enum": [
- "profile"
- ]
- },
- "ListEnum": {
- "type": "string",
- "enum": [
- "list"
- ]
- },
- "TagEnum": {
- "type": "string",
- "enum": [
- "tag"
- ]
- },
- "SegmentEnum": {
- "type": "string",
- "enum": [
- "segment"
- ]
- },
- "FlowEnum": {
- "type": "string",
- "enum": [
- "flow"
- ]
- },
- "FlowActionEnum": {
- "type": "string",
- "enum": [
- "flow-action"
- ]
- },
- "FlowMessageEnum": {
- "type": "string",
- "enum": [
- "flow-message"
- ]
- },
- "CampaignEnum": {
- "type": "string",
- "enum": [
- "campaign"
- ]
- },
- "CampaignMessageEnum": {
- "type": "string",
- "enum": [
- "campaign-message"
- ]
- },
- "CampaignSendJobEnum": {
- "type": "string",
- "enum": [
- "campaign-send-job"
- ]
- },
- "CampaignRecipientEstimationJobEnum": {
- "type": "string",
- "enum": [
- "campaign-recipient-estimation-job"
- ]
- },
- "CampaignRecipientEstimationEnum": {
- "type": "string",
- "enum": [
- "campaign-recipient-estimation"
- ]
- },
- "TemplateEnum": {
- "type": "string",
- "enum": [
- "template"
- ]
- },
- "CatalogItemBulkCreateJobEnum": {
- "type": "string",
- "enum": [
- "catalog-item-bulk-create-job"
- ]
- },
- "CatalogItemBulkUpdateJobEnum": {
- "type": "string",
- "enum": [
- "catalog-item-bulk-update-job"
- ]
- },
- "CatalogItemBulkDeleteJobEnum": {
- "type": "string",
- "enum": [
- "catalog-item-bulk-delete-job"
- ]
- },
- "CatalogVariantBulkCreateJobEnum": {
- "type": "string",
- "enum": [
- "catalog-variant-bulk-create-job"
- ]
- },
- "CatalogVariantBulkUpdateJobEnum": {
- "type": "string",
- "enum": [
- "catalog-variant-bulk-update-job"
- ]
- },
- "CatalogVariantBulkDeleteJobEnum": {
- "type": "string",
- "enum": [
- "catalog-variant-bulk-delete-job"
- ]
- },
- "CatalogCategoryBulkCreateJobEnum": {
- "type": "string",
- "enum": [
- "catalog-category-bulk-create-job"
- ]
- },
- "CatalogCategoryBulkUpdateJobEnum": {
- "type": "string",
- "enum": [
- "catalog-category-bulk-update-job"
- ]
- },
- "CatalogCategoryBulkDeleteJobEnum": {
- "type": "string",
- "enum": [
- "catalog-category-bulk-delete-job"
- ]
- },
- "TagGroupEnum": {
- "type": "string",
- "enum": [
- "tag-group"
- ]
- },
- "MetricAggregateEnum": {
- "type": "string",
- "enum": [
- "metric-aggregate"
- ]
- },
- "ProfileSuppressionBulkCreateJobEnum": {
- "type": "string",
- "enum": [
- "profile-suppression-bulk-create-job"
- ]
- },
- "ProfileUnsuppressionBulkCreateJobEnum": {
- "type": "string",
- "enum": [
- "profile-unsuppression-bulk-create-job"
- ]
- },
- "ProfileSubscriptionBulkCreateJobEnum": {
- "type": "string",
- "enum": [
- "profile-subscription-bulk-create-job"
- ]
- },
- "ProfileUnsubscriptionBulkCreateJobEnum": {
- "type": "string",
- "enum": [
- "profile-unsubscription-bulk-create-job"
- ]
- },
- "DataPrivacyDeletionJobEnum": {
- "type": "string",
- "enum": [
- "data-privacy-deletion-job"
- ]
- },
- "SubscriptionEnum": {
- "type": "string",
- "enum": [
- "subscription"
- ]
- }
- },
- "responses": {
- "ClientError": {
- "description": "Client Error",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "id",
- "code",
- "title",
- "detail"
- ],
- "properties": {
- "id": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "title": {
- "type": "string"
- },
- "detail": {
- "type": "string"
- },
- "source": {
- "type": "object",
- "properties": {
- "pointer": {
- "type": "string"
- },
- "parameter": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "required": [
- "errors"
- ]
- }
- }
- }
- },
- "ServerError": {
- "description": "Server Error",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "id",
- "code",
- "title",
- "detail"
- ],
- "properties": {
- "id": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "title": {
- "type": "string"
- },
- "detail": {
- "type": "string"
- },
- "source": {
- "type": "object",
- "properties": {
- "pointer": {
- "type": "string"
- },
- "parameter": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "required": [
- "errors"
- ]
- }
- }
- }
- }
- },
- "securitySchemes": {
- "Klaviyo-API-Key": {
- "type": "apiKey",
- "in": "header",
- "name": "Authorization",
- "description": "Private key authentication for /api/ endpoints is performed by setting the `Authorization` header to `Klaviyo-API-Key your-private-api-key` For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#authentication",
- "x-default": "Klaviyo-API-Key your-private-api-key"
-
- }
- }
- },
- "tags": [
- {
- "name": "Campaigns",
- "description": "campaigns"
- },
- {
- "name": "Catalogs",
- "description": "catalogs"
- },
- {
- "name": "Data Privacy",
- "description": "data privacy"
- },
- {
- "name": "Events",
- "description": "events"
- },
- {
- "name": "Flows",
- "description": "flows"
- },
- {
- "name": "Lists",
- "description": "lists"
- },
- {
- "name": "Metrics",
- "description": "metrics"
- },
- {
- "name": "Profiles",
- "description": "profiles"
- },
- {
- "name": "Segments",
- "description": "segments"
- },
- {
- "name": "Tags",
- "description": "tags"
- },
- {
- "name": "Templates",
- "description": "templates"
- },
- {
- "name": "Tests",
- "description": "tests"
- },
- {
- "name": "Client",
- "description": "client"
- }
- ],
- "security": [
- {
- "Klaviyo-API-Key": []
- }
- ],
- "x-readme": {
- "explorer-enabled": false,
- "proxy-enabled": true,
- "samples-enabled": true
- }
- }
\ No newline at end of file