Klaviyo API 2026-07-15 — persistent modeled service

Runtime

/api/purple-suite/{instanceId}/contracts/crm/klaviyo

[
  {
    "method": "get",
    "path": "/api/accounts",
    "operationId": "get_accounts"
  },
  {
    "method": "get",
    "path": "/api/accounts/:id",
    "operationId": "get_account"
  },
  {
    "method": "get",
    "path": "/api/lists",
    "operationId": "get_lists"
  },
  {
    "method": "post",
    "path": "/api/lists",
    "operationId": "create_list"
  },
  {
    "method": "get",
    "path": "/api/lists/:id",
    "operationId": "get_list"
  },
  {
    "method": "patch",
    "path": "/api/lists/:id",
    "operationId": "update_list"
  },
  {
    "method": "delete",
    "path": "/api/lists/:id",
    "operationId": "delete_list"
  },
  {
    "method": "get",
    "path": "/api/lists/:id/tags",
    "operationId": "get_tags_for_list"
  },
  {
    "method": "get",
    "path": "/api/lists/:id/relationships/tags",
    "operationId": "get_tag_ids_for_list"
  },
  {
    "method": "get",
    "path": "/api/lists/:id/profiles",
    "operationId": "get_profiles_for_list"
  },
  {
    "method": "get",
    "path": "/api/lists/:id/relationships/profiles",
    "operationId": "get_profile_ids_for_list"
  },
  {
    "method": "post",
    "path": "/api/lists/:id/relationships/profiles",
    "operationId": "add_profiles_to_list"
  },
  {
    "method": "delete",
    "path": "/api/lists/:id/relationships/profiles",
    "operationId": "remove_profiles_from_list"
  },
  {
    "method": "get",
    "path": "/api/lists/:id/flow-triggers",
    "operationId": "get_flows_triggered_by_list"
  },
  {
    "method": "get",
    "path": "/api/lists/:id/relationships/flow-triggers",
    "operationId": "get_ids_for_flows_triggered_by_list"
  },
  {
    "method": "get",
    "path": "/api/profiles",
    "operationId": "get_profiles"
  },
  {
    "method": "post",
    "path": "/api/profiles",
    "operationId": "create_profile"
  },
  {
    "method": "get",
    "path": "/api/profiles/:id",
    "operationId": "get_profile"
  },
  {
    "method": "patch",
    "path": "/api/profiles/:id",
    "operationId": "update_profile"
  },
  {
    "method": "get",
    "path": "/api/profile-bulk-import-jobs",
    "operationId": "get_bulk_import_profiles_jobs"
  },
  {
    "method": "post",
    "path": "/api/profile-bulk-import-jobs",
    "operationId": "bulk_import_profiles"
  },
  {
    "method": "get",
    "path": "/api/profile-bulk-import-jobs/:job_id",
    "operationId": "get_bulk_import_profiles_job"
  },
  {
    "method": "get",
    "path": "/api/profile-suppression-bulk-create-jobs",
    "operationId": "get_bulk_suppress_profiles_jobs"
  },
  {
    "method": "post",
    "path": "/api/profile-suppression-bulk-create-jobs",
    "operationId": "bulk_suppress_profiles"
  },
  {
    "method": "get",
    "path": "/api/profile-suppression-bulk-create-jobs/:job_id",
    "operationId": "get_bulk_suppress_profiles_job"
  },
  {
    "method": "get",
    "path": "/api/profile-suppression-bulk-delete-jobs",
    "operationId": "get_bulk_unsuppress_profiles_jobs"
  },
  {
    "method": "post",
    "path": "/api/profile-suppression-bulk-delete-jobs",
    "operationId": "bulk_unsuppress_profiles"
  },
  {
    "method": "get",
    "path": "/api/profile-suppression-bulk-delete-jobs/:job_id",
    "operationId": "get_bulk_unsuppress_profiles_job"
  },
  {
    "method": "get",
    "path": "/api/push-tokens",
    "operationId": "get_push_tokens"
  },
  {
    "method": "post",
    "path": "/api/push-tokens",
    "operationId": "create_push_token"
  },
  {
    "method": "get",
    "path": "/api/push-tokens/:id",
    "operationId": "get_push_token"
  },
  {
    "method": "delete",
    "path": "/api/push-tokens/:id",
    "operationId": "delete_push_token"
  },
  {
    "method": "post",
    "path": "/api/profile-import",
    "operationId": "create_or_update_profile"
  },
  {
    "method": "post",
    "path": "/api/profile-merge",
    "operationId": "merge_profiles"
  },
  {
    "method": "post",
    "path": "/api/profile-subscription-bulk-create-jobs",
    "operationId": "bulk_subscribe_profiles"
  },
  {
    "method": "post",
    "path": "/api/profile-subscription-bulk-delete-jobs",
    "operationId": "bulk_unsubscribe_profiles"
  },
  {
    "method": "get",
    "path": "/api/profiles/:id/push-tokens",
    "operationId": "get_push_tokens_for_profile"
  },
  {
    "method": "get",
    "path": "/api/profiles/:id/relationships/push-tokens",
    "operationId": "get_push_token_ids_for_profile"
  },
  {
    "method": "get",
    "path": "/api/profiles/:id/lists",
    "operationId": "get_lists_for_profile"
  },
  {
    "method": "get",
    "path": "/api/profiles/:id/relationships/lists",
    "operationId": "get_list_ids_for_profile"
  },
  {
    "method": "get",
    "path": "/api/profiles/:id/segments",
    "operationId": "get_segments_for_profile"
  },
  {
    "method": "get",
    "path": "/api/profiles/:id/relationships/segments",
    "operationId": "get_segment_ids_for_profile"
  },
  {
    "method": "get",
    "path": "/api/profiles/:id/conversation",
    "operationId": "get_conversation_for_profile"
  },
  {
    "method": "get",
    "path": "/api/profiles/:id/relationships/conversation",
    "operationId": "get_conversation_id_for_profile"
  },
  {
    "method": "get",
    "path": "/api/profiles/:id/conversations",
    "operationId": "get_conversations_for_profile"
  },
  {
    "method": "get",
    "path": "/api/profiles/:id/relationships/conversations",
    "operationId": "get_conversation_ids_for_profile"
  },
  {
    "method": "get",
    "path": "/api/profile-bulk-import-jobs/:id/lists",
    "operationId": "get_list_for_bulk_import_profiles_job"
  },
  {
    "method": "get",
    "path": "/api/profile-bulk-import-jobs/:id/relationships/lists",
    "operationId": "get_list_ids_for_bulk_import_profiles_job"
  },
  {
    "method": "get",
    "path": "/api/profile-bulk-import-jobs/:id/profiles",
    "operationId": "get_profiles_for_bulk_import_profiles_job"
  },
  {
    "method": "get",
    "path": "/api/profile-bulk-import-jobs/:id/relationships/profiles",
    "operationId": "get_profile_ids_for_bulk_import_profiles_job"
  },
  {
    "method": "get",
    "path": "/api/profile-bulk-import-jobs/:id/import-errors",
    "operationId": "get_errors_for_bulk_import_profiles_job"
  },
  {
    "method": "get",
    "path": "/api/push-tokens/:id/profile",
    "operationId": "get_profile_for_push_token"
  },
  {
    "method": "get",
    "path": "/api/push-tokens/:id/relationships/profile",
    "operationId": "get_profile_id_for_push_token"
  },
  {
    "method": "get",
    "path": "/api/segments",
    "operationId": "get_segments"
  },
  {
    "method": "post",
    "path": "/api/segments",
    "operationId": "create_segment"
  },
  {
    "method": "get",
    "path": "/api/segments/:id",
    "operationId": "get_segment"
  },
  {
    "method": "patch",
    "path": "/api/segments/:id",
    "operationId": "update_segment"
  },
  {
    "method": "delete",
    "path": "/api/segments/:id",
    "operationId": "delete_segment"
  },
  {
    "method": "get",
    "path": "/api/segments/:id/tags",
    "operationId": "get_tags_for_segment"
  },
  {
    "method": "get",
    "path": "/api/segments/:id/relationships/tags",
    "operationId": "get_tag_ids_for_segment"
  },
  {
    "method": "get",
    "path": "/api/segments/:id/profiles",
    "operationId": "get_profiles_for_segment"
  },
  {
    "method": "get",
    "path": "/api/segments/:id/relationships/profiles",
    "operationId": "get_profile_ids_for_segment"
  },
  {
    "method": "get",
    "path": "/api/segments/:id/flow-triggers",
    "operationId": "get_flows_triggered_by_segment"
  },
  {
    "method": "get",
    "path": "/api/segments/:id/relationships/flow-triggers",
    "operationId": "get_ids_for_flows_triggered_by_segment"
  }
]

Credentials

• Private API key — emulator compatibility: api-key

  Authorization: Klaviyo-API-Key <private-api-key>. This is Klaviyo's real and only transport for /api/ routes; PurpleSuite maps the private-key position to the selected instance key and adds no vendor-visible header.

  Credential model: instance-key

Coverage and limitations

{
  "documentScope": "bounded",
  "runtimeFidelity": "modeled",
  "counts": {
    "operations": 64
  },
  "notes": [
    "The published surface is 64 of Klaviyo's 345 official 2026-07-15 operations: every operation the vendor tags Accounts, Lists, Profiles, and Segments. All of them execute against persistent per-instance state.",
    "62 operations are fully modeled. create_segment and update_segment are modeled-core: the derived document narrows SegmentDefinition to the condition types this instance evaluates deterministically, and a request carrying a predictive-analytics, channel-affinity, postal-code-distance, metric, custom-object, or permissions condition is rejected with Klaviyo's 400 envelope rather than silently accepted.",
    "Segment membership is evaluated from each segment's definition on every read, matching Klaviyo's dynamic segments; it is never stored as a join table.",
    "The remaining 281 official operations (Catalogs, Custom Objects, Campaigns, Tags, Metrics, Flows, Coupons, Templates, Client, Forms, Events, Reporting, Webhooks, Images, Web Feeds, Reviews, Tracking Settings, Conversations, Data Privacy) are deliberately absent from this document and unmounted, so PurpleSuite makes no claim about them. They remain readable in the untouched pinned source, and COVERAGE_LEDGER.md classifies every one of the 345.",
    "The 12 Client operations additionally use a different transport — public-key `company_id` with `security: []` — and would require their own profile.",
    "predictive_analytics stays schema-visible and returns null: the vendor declares it nullable and the scores come from Klaviyo-hosted models."
  ]
}

Servers

[
  {
    "url": "/api/purple-suite/{instanceId}/contracts/crm/klaviyo",
    "description": "PurpleSuite instance-scoped Klaviyo emulation"
  }
]

Authentication schemes

{
  "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`<br>For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#authentication",
    "x-default": "Klaviyo-API-Key your-private-api-key"
  }
}

Each operation lists its security requirements. An empty security array permits an unauthenticated request. Use the scheme and headers declared for the selected contract.

Operations

• GET /api/accounts
• GET /api/accounts/{id}
• GET /api/lists
• POST /api/lists
• GET /api/lists/{id}
• PATCH /api/lists/{id}
• DELETE /api/lists/{id}
• GET /api/lists/{id}/tags
• GET /api/lists/{id}/relationships/tags
• GET /api/lists/{id}/profiles
• GET /api/lists/{id}/relationships/profiles
• POST /api/lists/{id}/relationships/profiles
• DELETE /api/lists/{id}/relationships/profiles
• GET /api/lists/{id}/flow-triggers
• GET /api/lists/{id}/relationships/flow-triggers
• GET /api/profiles
• POST /api/profiles
• GET /api/profiles/{id}
• PATCH /api/profiles/{id}
• GET /api/profile-bulk-import-jobs
• POST /api/profile-bulk-import-jobs
• GET /api/profile-bulk-import-jobs/{job_id}
• GET /api/profile-suppression-bulk-create-jobs
• POST /api/profile-suppression-bulk-create-jobs
• GET /api/profile-suppression-bulk-create-jobs/{job_id}
• GET /api/profile-suppression-bulk-delete-jobs
• POST /api/profile-suppression-bulk-delete-jobs
• GET /api/profile-suppression-bulk-delete-jobs/{job_id}
• GET /api/push-tokens
• POST /api/push-tokens
• GET /api/push-tokens/{id}
• DELETE /api/push-tokens/{id}
• POST /api/profile-import
• POST /api/profile-merge
• POST /api/profile-subscription-bulk-create-jobs
• POST /api/profile-subscription-bulk-delete-jobs
• GET /api/profiles/{id}/push-tokens
• GET /api/profiles/{id}/relationships/push-tokens
• GET /api/profiles/{id}/lists
• GET /api/profiles/{id}/relationships/lists
• GET /api/profiles/{id}/segments
• GET /api/profiles/{id}/relationships/segments
• GET /api/profiles/{id}/conversation
• GET /api/profiles/{id}/relationships/conversation
• GET /api/profiles/{id}/conversations
• GET /api/profiles/{id}/relationships/conversations
• GET /api/profile-bulk-import-jobs/{id}/lists
• GET /api/profile-bulk-import-jobs/{id}/relationships/lists
• GET /api/profile-bulk-import-jobs/{id}/profiles
• GET /api/profile-bulk-import-jobs/{id}/relationships/profiles
• GET /api/profile-bulk-import-jobs/{id}/import-errors
• GET /api/push-tokens/{id}/profile
• GET /api/push-tokens/{id}/relationships/profile
• GET /api/segments
• POST /api/segments
• GET /api/segments/{id}
• PATCH /api/segments/{id}
• DELETE /api/segments/{id}
• GET /api/segments/{id}/tags
• GET /api/segments/{id}/relationships/tags
• GET /api/segments/{id}/profiles
• GET /api/segments/{id}/relationships/profiles
• GET /api/segments/{id}/flow-triggers
• GET /api/segments/{id}/relationships/flow-triggers

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_accounts",
  "summary": "Get Accounts",
  "description": "Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array.\n\nYou can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`accounts:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_accounts.json)",
  "parameters": [
    {
      "name": "fields[account]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "contact_information",
            "contact_information.default_sender_email",
            "contact_information.default_sender_name",
            "contact_information.organization_name",
            "contact_information.street_address",
            "contact_information.street_address.address1",
            "contact_information.street_address.address2",
            "contact_information.street_address.city",
            "contact_information.street_address.country",
            "contact_information.street_address.region",
            "contact_information.street_address.zip",
            "contact_information.website_url",
            "id",
            "industry",
            "locale",
            "preferred_currency",
            "public_api_key",
            "test_account",
            "timezone"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetAccountResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Accounts"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "1/s",
    "steady": "15/m"
  },
  "x-klaviyo-scopes": [
    "accounts:read"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_account",
  "summary": "Get Account",
  "description": "Retrieve a single account object by its account ID. You can only request the account by which the private API key was generated.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`\n\n**Scopes:**\n`accounts:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_account.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "The ID of the account",
      "required": true,
      "schema": {
        "description": "The ID of the account",
        "type": "string",
        "example": "AbC123"
      }
    },
    {
      "name": "fields[account]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "contact_information",
            "contact_information.default_sender_email",
            "contact_information.default_sender_name",
            "contact_information.organization_name",
            "contact_information.street_address",
            "contact_information.street_address.address1",
            "contact_information.street_address.address2",
            "contact_information.street_address.city",
            "contact_information.street_address.country",
            "contact_information.street_address.region",
            "contact_information.street_address.zip",
            "contact_information.website_url",
            "id",
            "industry",
            "locale",
            "preferred_currency",
            "public_api_key",
            "test_account",
            "timezone"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetAccountResponse"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Accounts"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "1/s",
    "steady": "15/m"
  },
  "x-klaviyo-scopes": [
    "accounts:read"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_lists",
  "summary": "Get Lists",
  "description": "Get all lists in an account.\n\nFilter to request a subset of all lists. Lists can be filtered by `id`, `name`, `created`, and `updated` fields.\n\nReturns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`lists:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_lists.json)",
  "parameters": [
    {
      "name": "fields[flow]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "archived",
            "created",
            "id",
            "name",
            "status",
            "trigger_type",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[list]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "created",
            "id",
            "name",
            "opt_in_process",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[tag]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "id",
            "name"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "filter",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals` (string)<br>`id`: `any`, `equals` (string)<br>`created`: `greater-than` (date-time)<br>`updated`: `greater-than` (date-time)",
      "schema": {
        "type": "string",
        "example": "equals(name,['example'])"
      }
    },
    {
      "name": "include",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships",
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "flow-triggers",
            "tags"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "page[cursor]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "page[size]",
      "in": "query",
      "description": "Default: 10. Min: 1. Max: 10.",
      "required": false,
      "schema": {
        "type": "integer",
        "default": 10,
        "maximum": 10,
        "minimum": 1
      }
    },
    {
      "name": "sort",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting",
      "schema": {
        "type": "string",
        "enum": [
          "created",
          "-created",
          "id",
          "-id",
          "name",
          "-name",
          "updated",
          "-updated"
        ]
      }
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetListListResponseCollectionCompoundDocument"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Lists"
  ],
  "x-klaviyo-filters": {
    "name": {
      "operators": {
        "list": [
          "any",
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "id": {
      "operators": {
        "list": [
          "any",
          "equals"
        ],
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "created": {
      "operators": {
        "single": [
          "greater-than"
        ]
      },
      "value": {
        "type": "string",
        "format": "date-time"
      }
    },
    "updated": {
      "operators": {
        "single": [
          "greater-than"
        ]
      },
      "value": {
        "type": "string",
        "format": "date-time"
      }
    }
  },
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "75/s",
    "steady": "750/m"
  },
  "x-klaviyo-scopes": [
    "lists:read"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "create_list",
  "summary": "Create List",
  "description": "Create a new list.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`<br>Daily: `150/d`\n\n**Scopes:**\n`lists:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_list.json)",
  "parameters": [
    {
      "name": "fields[list]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "created",
            "id",
            "name",
            "opt_in_process",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/vnd.api+json": {
        "schema": {
          "$ref": "#/components/schemas/ListCreateQuery"
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/PostListCreateResponse"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Lists"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "10/s",
    "steady": "150/m",
    "daily": "150/d"
  },
  "x-klaviyo-scopes": [
    "lists:write"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_list",
  "summary": "Get List",
  "description": "Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `additional-fields[list]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-07-15/docs/rate_limits_and_error_handling) guide.\n\n**Scopes:**\n`lists:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
      "required": true,
      "schema": {
        "description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
        "type": "string",
        "example": "Y6nRLr"
      }
    },
    {
      "name": "additional-fields[list]",
      "in": "query",
      "description": "Request additional fields not included by default in the response. Supported values: 'profile_count'",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "profile_count"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[flow]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "archived",
            "created",
            "id",
            "name",
            "status",
            "trigger_type",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[list]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "created",
            "id",
            "name",
            "opt_in_process",
            "profile_count",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[tag]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "id",
            "name"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "include",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships",
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "flow-triggers",
            "tags"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetListRetrieveResponseCompoundDocument"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Lists"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "75/s",
    "steady": "750/m"
  },
  "x-klaviyo-scopes": [
    "lists:read"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "update_list",
  "summary": "Update List",
  "description": "Update the name of a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_list.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
      "required": true,
      "schema": {
        "description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
        "type": "string",
        "example": "Y6nRLr"
      }
    },
    {
      "name": "fields[list]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "created",
            "id",
            "name",
            "opt_in_process",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/vnd.api+json": {
        "schema": {
          "$ref": "#/components/schemas/ListPartialUpdateQuery"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/PatchListPartialUpdateResponse"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Lists"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "10/s",
    "steady": "150/m"
  },
  "x-klaviyo-scopes": [
    "lists:write"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "delete_list",
  "summary": "Delete List",
  "description": "Delete a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_list.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
      "required": true,
      "schema": {
        "description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
        "type": "string",
        "example": "Y6nRLr"
      }
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "204": {
      "description": "Success"
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Lists"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "10/s",
    "steady": "150/m"
  },
  "x-klaviyo-scopes": [
    "lists:write"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_tags_for_list",
  "summary": "Get Tags for List",
  "description": "Return all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`lists:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_list.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
      "required": true,
      "schema": {
        "description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
        "type": "string",
        "example": "Y6nRLr"
      }
    },
    {
      "name": "fields[tag]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "id",
            "name"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetTagResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Lists"
  ],
  "x-klaviyo-operation-aliases": [
    "get_list_tags"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "3/s",
    "steady": "60/m"
  },
  "x-klaviyo-scopes": [
    "lists:read",
    "tags:read"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_tag_ids_for_list",
  "summary": "Get Tag IDs for List",
  "description": "Return all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`lists:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_list.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
      "required": true,
      "schema": {
        "description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
        "type": "string",
        "example": "Y6nRLr"
      }
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetListTagsRelationshipsResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Lists"
  ],
  "x-klaviyo-operation-aliases": [
    "get_list_relationships_tags"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "3/s",
    "steady": "60/m"
  },
  "x-klaviyo-scopes": [
    "lists:read",
    "tags:read"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_profiles_for_list",
  "summary": "Get Profiles for List",
  "description": "Get all profiles within a list with the given list ID.\n\nFilter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-07-15/docs/rate_limits_and_error_handling) guide.\n\n**Scopes:**\n`lists:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles_for_list.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
      "required": true,
      "schema": {
        "description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
        "type": "string",
        "example": "Y6nRLr"
      }
    },
    {
      "name": "additional-fields[profile]",
      "in": "query",
      "description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "subscriptions",
            "predictive_analytics"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[profile]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "created",
            "email",
            "external_id",
            "first_name",
            "id",
            "image",
            "joined_group_at",
            "last_event_date",
            "last_name",
            "locale",
            "location",
            "location.address1",
            "location.address2",
            "location.city",
            "location.country",
            "location.ip",
            "location.latitude",
            "location.longitude",
            "location.region",
            "location.timezone",
            "location.zip",
            "organization",
            "phone_number",
            "predictive_analytics",
            "predictive_analytics.average_days_between_orders",
            "predictive_analytics.average_order_value",
            "predictive_analytics.churn_probability",
            "predictive_analytics.expected_date_of_next_order",
            "predictive_analytics.historic_clv",
            "predictive_analytics.historic_number_of_orders",
            "predictive_analytics.predicted_clv",
            "predictive_analytics.predicted_number_of_orders",
            "predictive_analytics.ranked_channel_affinity",
            "predictive_analytics.total_clv",
            "properties",
            "subscriptions",
            "subscriptions.email",
            "subscriptions.email.click_tracking",
            "subscriptions.email.click_tracking.can_receive",
            "subscriptions.email.click_tracking.consent",
            "subscriptions.email.click_tracking.consent_timestamp",
            "subscriptions.email.click_tracking.created_timestamp",
            "subscriptions.email.click_tracking.last_updated",
            "subscriptions.email.click_tracking.metadata",
            "subscriptions.email.click_tracking.valid_until",
            "subscriptions.email.marketing",
            "subscriptions.email.marketing.can_receive_email_marketing",
            "subscriptions.email.marketing.consent",
            "subscriptions.email.marketing.consent_timestamp",
            "subscriptions.email.marketing.custom_method_detail",
            "subscriptions.email.marketing.double_optin",
            "subscriptions.email.marketing.last_updated",
            "subscriptions.email.marketing.list_suppressions",
            "subscriptions.email.marketing.method",
            "subscriptions.email.marketing.method_detail",
            "subscriptions.email.marketing.suppression",
            "subscriptions.email.open_tracking",
            "subscriptions.email.open_tracking.can_receive",
            "subscriptions.email.open_tracking.consent",
            "subscriptions.email.open_tracking.consent_timestamp",
            "subscriptions.email.open_tracking.created_timestamp",
            "subscriptions.email.open_tracking.last_updated",
            "subscriptions.email.open_tracking.metadata",
            "subscriptions.email.open_tracking.valid_until",
            "subscriptions.mobile_push",
            "subscriptions.mobile_push.marketing",
            "subscriptions.mobile_push.marketing.can_receive_push_marketing",
            "subscriptions.mobile_push.marketing.consent",
            "subscriptions.mobile_push.marketing.consent_timestamp",
            "subscriptions.sms",
            "subscriptions.sms.marketing",
            "subscriptions.sms.marketing.can_receive_sms_marketing",
            "subscriptions.sms.marketing.consent",
            "subscriptions.sms.marketing.consent_timestamp",
            "subscriptions.sms.marketing.last_updated",
            "subscriptions.sms.marketing.method",
            "subscriptions.sms.marketing.method_detail",
            "subscriptions.sms.transactional",
            "subscriptions.sms.transactional.can_receive_sms_transactional",
            "subscriptions.sms.transactional.consent",
            "subscriptions.sms.transactional.consent_timestamp",
            "subscriptions.sms.transactional.last_updated",
            "subscriptions.sms.transactional.method",
            "subscriptions.sms.transactional.method_detail",
            "subscriptions.whatsapp",
            "subscriptions.whatsapp.conversational",
            "subscriptions.whatsapp.conversational.can_receive",
            "subscriptions.whatsapp.conversational.consent",
            "subscriptions.whatsapp.conversational.consent_timestamp",
            "subscriptions.whatsapp.conversational.created_timestamp",
            "subscriptions.whatsapp.conversational.last_updated",
            "subscriptions.whatsapp.conversational.metadata",
            "subscriptions.whatsapp.conversational.phone_number",
            "subscriptions.whatsapp.conversational.valid_until",
            "subscriptions.whatsapp.marketing",
            "subscriptions.whatsapp.marketing.can_receive",
            "subscriptions.whatsapp.marketing.consent",
            "subscriptions.whatsapp.marketing.consent_timestamp",
            "subscriptions.whatsapp.marketing.created_timestamp",
            "subscriptions.whatsapp.marketing.last_updated",
            "subscriptions.whatsapp.marketing.metadata",
            "subscriptions.whatsapp.marketing.phone_number",
            "subscriptions.whatsapp.marketing.valid_until",
            "subscriptions.whatsapp.transactional",
            "subscriptions.whatsapp.transactional.can_receive",
            "subscriptions.whatsapp.transactional.consent",
            "subscriptions.whatsapp.transactional.consent_timestamp",
            "subscriptions.whatsapp.transactional.created_timestamp",
            "subscriptions.whatsapp.transactional.last_updated",
            "subscriptions.whatsapp.transactional.metadata",
            "subscriptions.whatsapp.transactional.phone_number",
            "subscriptions.whatsapp.transactional.valid_until",
            "title",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "filter",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals` (string)<br>`phone_number`: `any`, `equals` (string)<br>`push_token`: `any`, `equals` (string)<br>`_kx`: `equals` (string)<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)",
      "schema": {
        "type": "string",
        "example": "equals(email,['example'])"
      }
    },
    {
      "name": "page[cursor]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "page[size]",
      "in": "query",
      "description": "Default: 20. Min: 1. Max: 100.",
      "required": false,
      "schema": {
        "type": "integer",
        "default": 20,
        "maximum": 100,
        "minimum": 1
      }
    },
    {
      "name": "sort",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting",
      "schema": {
        "type": "string",
        "enum": [
          "joined_group_at",
          "-joined_group_at"
        ]
      }
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetListMemberResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Lists"
  ],
  "x-klaviyo-filters": {
    "email": {
      "operators": {
        "list": [
          "any",
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "phone_number": {
      "operators": {
        "list": [
          "any",
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "push_token": {
      "operators": {
        "list": [
          "any",
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "_kx": {
      "operators": {
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "joined_group_at": {
      "operators": {
        "single": [
          "greater-or-equal",
          "greater-than",
          "less-or-equal",
          "less-than"
        ]
      },
      "value": {
        "type": "string",
        "format": "date-time"
      }
    }
  },
  "x-klaviyo-operation-aliases": [
    "get_list_profiles"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "75/s",
    "steady": "750/m"
  },
  "x-klaviyo-scopes": [
    "lists:read",
    "profiles:read"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_profile_ids_for_list",
  "summary": "Get Profile IDs for List",
  "description": "Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-07-15/docs/rate_limits_and_error_handling) guide.\n\n**Scopes:**\n`lists:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_ids_for_list.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
      "required": true,
      "schema": {
        "description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
        "type": "string",
        "example": "Y6nRLr"
      }
    },
    {
      "name": "filter",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals` (string)<br>`phone_number`: `any`, `equals` (string)<br>`push_token`: `any`, `equals` (string)<br>`_kx`: `equals` (string)<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)",
      "schema": {
        "type": "string",
        "example": "equals(email,['example'])"
      }
    },
    {
      "name": "page[cursor]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "page[size]",
      "in": "query",
      "description": "Default: 20. Min: 1. Max: 100.",
      "required": false,
      "schema": {
        "type": "integer",
        "default": 20,
        "maximum": 100,
        "minimum": 1
      }
    },
    {
      "name": "sort",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting",
      "schema": {
        "type": "string",
        "enum": [
          "joined_group_at",
          "-joined_group_at"
        ]
      }
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetListProfilesRelationshipsResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Lists"
  ],
  "x-klaviyo-filters": {
    "email": {
      "operators": {
        "list": [
          "any",
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "phone_number": {
      "operators": {
        "list": [
          "any",
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "push_token": {
      "operators": {
        "list": [
          "any",
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "_kx": {
      "operators": {
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "joined_group_at": {
      "operators": {
        "single": [
          "greater-or-equal",
          "greater-than",
          "less-or-equal",
          "less-than"
        ]
      },
      "value": {
        "type": "string",
        "format": "date-time"
      }
    }
  },
  "x-klaviyo-operation-aliases": [
    "get_list_relationships_profiles"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "75/s",
    "steady": "750/m"
  },
  "x-klaviyo-scopes": [
    "lists:read",
    "profiles:read"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "add_profiles_to_list",
  "summary": "Add Profiles to List",
  "description": "Add a profile to a list with the given list ID.\n\nIt is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you're trying to give a profile [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api) to receive email marketing, SMS marketing, or both.\n\nThis endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:write`\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/add_profiles_to_list.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "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": "2026-07-15"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/vnd.api+json": {
        "schema": {
          "$ref": "#/components/schemas/ListMembersAddQuery"
        }
      }
    }
  },
  "responses": {
    "204": {
      "description": "Success"
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Lists"
  ],
  "x-klaviyo-operation-aliases": [
    "create_list_relationships",
    "create_list_relationships_profile",
    "create_list_relationships_profiles"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "10/s",
    "steady": "150/m"
  },
  "x-klaviyo-scopes": [
    "lists:write",
    "profiles:write"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "remove_profiles_from_list",
  "summary": "Remove Profiles from List",
  "description": "Remove a profile from a list with the given list ID.\n\nThe provided profile will no longer receive marketing from this particular list once removed.\n\nRemoving a profile from a list will not impact the profile's [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api) status or subscription status in general.\nTo update a profile's subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles).\n\nThis endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:write`\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_profiles_from_list.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "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": "2026-07-15"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/vnd.api+json": {
        "schema": {
          "$ref": "#/components/schemas/ListMembersDeleteQuery"
        }
      }
    }
  },
  "responses": {
    "204": {
      "description": "Success"
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Lists"
  ],
  "x-klaviyo-operation-aliases": [
    "delete_list_relationships",
    "delete_list_relationships_profiles"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "10/s",
    "steady": "150/m"
  },
  "x-klaviyo-scopes": [
    "lists:write",
    "profiles:write"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_flows_triggered_by_list",
  "summary": "Get Flows Triggered by List",
  "description": "Get all flows where the given list ID is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n`lists:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flows_triggered_by_list.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
      "required": true,
      "schema": {
        "description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
        "type": "string",
        "example": "Y6nRLr"
      }
    },
    {
      "name": "fields[flow]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "archived",
            "created",
            "id",
            "name",
            "status",
            "trigger_type",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetFlowResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Lists"
  ],
  "x-klaviyo-operation-aliases": [
    "get_flow_triggers_for_list",
    "get_list_flow_triggers"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "3/s",
    "steady": "60/m"
  },
  "x-klaviyo-scopes": [
    "flows:read",
    "lists:read"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_ids_for_flows_triggered_by_list",
  "summary": "Get IDs for Flows Triggered by List",
  "description": "Get the IDs of all flows where the given list is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n`lists:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_ids_for_flows_triggered_by_list.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
      "required": true,
      "schema": {
        "description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
        "type": "string",
        "example": "Y6nRLr"
      }
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetListFlowTriggersRelationshipsResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Lists"
  ],
  "x-klaviyo-operation-aliases": [
    "get_flow_trigger_ids_for_list",
    "get_list_relationships_flow_triggers"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "3/s",
    "steady": "60/m"
  },
  "x-klaviyo-scopes": [
    "flows:read",
    "lists:read"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_profiles",
  "summary": "Get Profiles",
  "description": "Get all profiles in an account.\n\nProfiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp`\n\nUse the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-07-15/docs/rate_limits_and_error_handling) guide.\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles.json)",
  "parameters": [
    {
      "name": "additional-fields[profile]",
      "in": "query",
      "description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "subscriptions",
            "predictive_analytics"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[conversation]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "channel",
            "id"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[profile]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "created",
            "email",
            "external_id",
            "first_name",
            "id",
            "image",
            "last_event_date",
            "last_name",
            "locale",
            "location",
            "location.address1",
            "location.address2",
            "location.city",
            "location.country",
            "location.ip",
            "location.latitude",
            "location.longitude",
            "location.region",
            "location.timezone",
            "location.zip",
            "organization",
            "phone_number",
            "predictive_analytics",
            "predictive_analytics.average_days_between_orders",
            "predictive_analytics.average_order_value",
            "predictive_analytics.churn_probability",
            "predictive_analytics.expected_date_of_next_order",
            "predictive_analytics.historic_clv",
            "predictive_analytics.historic_number_of_orders",
            "predictive_analytics.predicted_clv",
            "predictive_analytics.predicted_number_of_orders",
            "predictive_analytics.ranked_channel_affinity",
            "predictive_analytics.total_clv",
            "properties",
            "subscriptions",
            "subscriptions.email",
            "subscriptions.email.click_tracking",
            "subscriptions.email.click_tracking.can_receive",
            "subscriptions.email.click_tracking.consent",
            "subscriptions.email.click_tracking.consent_timestamp",
            "subscriptions.email.click_tracking.created_timestamp",
            "subscriptions.email.click_tracking.last_updated",
            "subscriptions.email.click_tracking.metadata",
            "subscriptions.email.click_tracking.valid_until",
            "subscriptions.email.marketing",
            "subscriptions.email.marketing.can_receive_email_marketing",
            "subscriptions.email.marketing.consent",
            "subscriptions.email.marketing.consent_timestamp",
            "subscriptions.email.marketing.custom_method_detail",
            "subscriptions.email.marketing.double_optin",
            "subscriptions.email.marketing.last_updated",
            "subscriptions.email.marketing.list_suppressions",
            "subscriptions.email.marketing.method",
            "subscriptions.email.marketing.method_detail",
            "subscriptions.email.marketing.suppression",
            "subscriptions.email.open_tracking",
            "subscriptions.email.open_tracking.can_receive",
            "subscriptions.email.open_tracking.consent",
            "subscriptions.email.open_tracking.consent_timestamp",
            "subscriptions.email.open_tracking.created_timestamp",
            "subscriptions.email.open_tracking.last_updated",
            "subscriptions.email.open_tracking.metadata",
            "subscriptions.email.open_tracking.valid_until",
            "subscriptions.mobile_push",
            "subscriptions.mobile_push.marketing",
            "subscriptions.mobile_push.marketing.can_receive_push_marketing",
            "subscriptions.mobile_push.marketing.consent",
            "subscriptions.mobile_push.marketing.consent_timestamp",
            "subscriptions.sms",
            "subscriptions.sms.marketing",
            "subscriptions.sms.marketing.can_receive_sms_marketing",
            "subscriptions.sms.marketing.consent",
            "subscriptions.sms.marketing.consent_timestamp",
            "subscriptions.sms.marketing.last_updated",
            "subscriptions.sms.marketing.method",
            "subscriptions.sms.marketing.method_detail",
            "subscriptions.sms.transactional",
            "subscriptions.sms.transactional.can_receive_sms_transactional",
            "subscriptions.sms.transactional.consent",
            "subscriptions.sms.transactional.consent_timestamp",
            "subscriptions.sms.transactional.last_updated",
            "subscriptions.sms.transactional.method",
            "subscriptions.sms.transactional.method_detail",
            "subscriptions.whatsapp",
            "subscriptions.whatsapp.conversational",
            "subscriptions.whatsapp.conversational.can_receive",
            "subscriptions.whatsapp.conversational.consent",
            "subscriptions.whatsapp.conversational.consent_timestamp",
            "subscriptions.whatsapp.conversational.created_timestamp",
            "subscriptions.whatsapp.conversational.last_updated",
            "subscriptions.whatsapp.conversational.metadata",
            "subscriptions.whatsapp.conversational.phone_number",
            "subscriptions.whatsapp.conversational.valid_until",
            "subscriptions.whatsapp.marketing",
            "subscriptions.whatsapp.marketing.can_receive",
            "subscriptions.whatsapp.marketing.consent",
            "subscriptions.whatsapp.marketing.consent_timestamp",
            "subscriptions.whatsapp.marketing.created_timestamp",
            "subscriptions.whatsapp.marketing.last_updated",
            "subscriptions.whatsapp.marketing.metadata",
            "subscriptions.whatsapp.marketing.phone_number",
            "subscriptions.whatsapp.marketing.valid_until",
            "subscriptions.whatsapp.transactional",
            "subscriptions.whatsapp.transactional.can_receive",
            "subscriptions.whatsapp.transactional.consent",
            "subscriptions.whatsapp.transactional.consent_timestamp",
            "subscriptions.whatsapp.transactional.created_timestamp",
            "subscriptions.whatsapp.transactional.last_updated",
            "subscriptions.whatsapp.transactional.metadata",
            "subscriptions.whatsapp.transactional.phone_number",
            "subscriptions.whatsapp.transactional.valid_until",
            "title",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[push-token]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "background",
            "created",
            "enablement_status",
            "id",
            "metadata",
            "metadata.app_build",
            "metadata.app_id",
            "metadata.app_name",
            "metadata.app_version",
            "metadata.device_id",
            "metadata.device_model",
            "metadata.environment",
            "metadata.klaviyo_sdk",
            "metadata.manufacturer",
            "metadata.os_name",
            "metadata.os_version",
            "metadata.sdk_version",
            "platform",
            "recorded_date",
            "token",
            "vendor"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "filter",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals` (string)<br>`email`: `any`, `equals` (string)<br>`phone_number`: `any`, `equals` (string)<br>`external_id`: `any`, `equals` (string)<br>`_kx`: `equals` (string)<br>`created`: `greater-than`, `less-than` (date-time)<br>`updated`: `greater-than`, `less-than` (date-time)<br>`subscriptions.email.marketing.list_suppressions.reason`: `equals` (string)<br>`subscriptions.email.marketing.list_suppressions.timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`subscriptions.email.marketing.list_suppressions.list_id`: `equals` (string)<br>`subscriptions.email.marketing.suppression.reason`: `equals` (string)<br>`subscriptions.email.marketing.suppression.timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)",
      "schema": {
        "type": "string",
        "example": "equals(id,'example')"
      }
    },
    {
      "name": "include",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships",
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "conversations",
            "push-tokens"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "page[cursor]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "page[size]",
      "in": "query",
      "description": "Default: 20. Min: 1. Max: 100.",
      "required": false,
      "schema": {
        "type": "integer",
        "default": 20,
        "maximum": 100,
        "minimum": 1
      }
    },
    {
      "name": "sort",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting",
      "schema": {
        "type": "string",
        "enum": [
          "created",
          "-created",
          "email",
          "-email",
          "id",
          "-id",
          "subscriptions.email.marketing.list_suppressions.timestamp",
          "-subscriptions.email.marketing.list_suppressions.timestamp",
          "subscriptions.email.marketing.suppression.timestamp",
          "-subscriptions.email.marketing.suppression.timestamp",
          "updated",
          "-updated"
        ]
      }
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetProfileResponsePluralConversationsCollectionCompoundDocument"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-filters": {
    "id": {
      "operators": {
        "list": [
          "any",
          "equals"
        ],
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "email": {
      "operators": {
        "list": [
          "any",
          "equals"
        ],
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "phone_number": {
      "operators": {
        "list": [
          "any",
          "equals"
        ],
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "external_id": {
      "operators": {
        "list": [
          "any",
          "equals"
        ],
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "_kx": {
      "operators": {
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "created": {
      "operators": {
        "single": [
          "greater-than",
          "less-than"
        ]
      },
      "value": {
        "type": "string",
        "format": "date-time"
      }
    },
    "updated": {
      "operators": {
        "single": [
          "greater-than",
          "less-than"
        ]
      },
      "value": {
        "type": "string",
        "format": "date-time"
      }
    },
    "subscriptions.email.marketing.list_suppressions.reason": {
      "operators": {
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "subscriptions.email.marketing.list_suppressions.timestamp": {
      "operators": {
        "single": [
          "greater-or-equal",
          "greater-than",
          "less-or-equal",
          "less-than"
        ]
      },
      "value": {
        "type": "string",
        "format": "date-time"
      }
    },
    "subscriptions.email.marketing.list_suppressions.list_id": {
      "operators": {
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "subscriptions.email.marketing.suppression.reason": {
      "operators": {
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "subscriptions.email.marketing.suppression.timestamp": {
      "operators": {
        "single": [
          "greater-or-equal",
          "greater-than",
          "less-or-equal",
          "less-than"
        ]
      },
      "value": {
        "type": "string",
        "format": "date-time"
      }
    }
  },
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "75/s",
    "steady": "750/m"
  },
  "x-klaviyo-scopes": [
    "profiles:read"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "create_profile",
  "summary": "Create Profile",
  "description": "Create a new profile.\n\nUse the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.\n\nThe maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_profile.json)",
  "parameters": [
    {
      "name": "additional-fields[profile]",
      "in": "query",
      "description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "subscriptions",
            "predictive_analytics"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[profile]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "created",
            "email",
            "external_id",
            "first_name",
            "id",
            "image",
            "last_event_date",
            "last_name",
            "locale",
            "location",
            "location.address1",
            "location.address2",
            "location.city",
            "location.country",
            "location.ip",
            "location.latitude",
            "location.longitude",
            "location.region",
            "location.timezone",
            "location.zip",
            "organization",
            "phone_number",
            "predictive_analytics",
            "predictive_analytics.average_days_between_orders",
            "predictive_analytics.average_order_value",
            "predictive_analytics.churn_probability",
            "predictive_analytics.expected_date_of_next_order",
            "predictive_analytics.historic_clv",
            "predictive_analytics.historic_number_of_orders",
            "predictive_analytics.predicted_clv",
            "predictive_analytics.predicted_number_of_orders",
            "predictive_analytics.ranked_channel_affinity",
            "predictive_analytics.total_clv",
            "properties",
            "subscriptions",
            "subscriptions.email",
            "subscriptions.email.click_tracking",
            "subscriptions.email.click_tracking.can_receive",
            "subscriptions.email.click_tracking.consent",
            "subscriptions.email.click_tracking.consent_timestamp",
            "subscriptions.email.click_tracking.created_timestamp",
            "subscriptions.email.click_tracking.last_updated",
            "subscriptions.email.click_tracking.metadata",
            "subscriptions.email.click_tracking.valid_until",
            "subscriptions.email.marketing",
            "subscriptions.email.marketing.can_receive_email_marketing",
            "subscriptions.email.marketing.consent",
            "subscriptions.email.marketing.consent_timestamp",
            "subscriptions.email.marketing.custom_method_detail",
            "subscriptions.email.marketing.double_optin",
            "subscriptions.email.marketing.last_updated",
            "subscriptions.email.marketing.list_suppressions",
            "subscriptions.email.marketing.method",
            "subscriptions.email.marketing.method_detail",
            "subscriptions.email.marketing.suppression",
            "subscriptions.email.open_tracking",
            "subscriptions.email.open_tracking.can_receive",
            "subscriptions.email.open_tracking.consent",
            "subscriptions.email.open_tracking.consent_timestamp",
            "subscriptions.email.open_tracking.created_timestamp",
            "subscriptions.email.open_tracking.last_updated",
            "subscriptions.email.open_tracking.metadata",
            "subscriptions.email.open_tracking.valid_until",
            "subscriptions.mobile_push",
            "subscriptions.mobile_push.marketing",
            "subscriptions.mobile_push.marketing.can_receive_push_marketing",
            "subscriptions.mobile_push.marketing.consent",
            "subscriptions.mobile_push.marketing.consent_timestamp",
            "subscriptions.sms",
            "subscriptions.sms.marketing",
            "subscriptions.sms.marketing.can_receive_sms_marketing",
            "subscriptions.sms.marketing.consent",
            "subscriptions.sms.marketing.consent_timestamp",
            "subscriptions.sms.marketing.last_updated",
            "subscriptions.sms.marketing.method",
            "subscriptions.sms.marketing.method_detail",
            "subscriptions.sms.transactional",
            "subscriptions.sms.transactional.can_receive_sms_transactional",
            "subscriptions.sms.transactional.consent",
            "subscriptions.sms.transactional.consent_timestamp",
            "subscriptions.sms.transactional.last_updated",
            "subscriptions.sms.transactional.method",
            "subscriptions.sms.transactional.method_detail",
            "subscriptions.whatsapp",
            "subscriptions.whatsapp.conversational",
            "subscriptions.whatsapp.conversational.can_receive",
            "subscriptions.whatsapp.conversational.consent",
            "subscriptions.whatsapp.conversational.consent_timestamp",
            "subscriptions.whatsapp.conversational.created_timestamp",
            "subscriptions.whatsapp.conversational.last_updated",
            "subscriptions.whatsapp.conversational.metadata",
            "subscriptions.whatsapp.conversational.phone_number",
            "subscriptions.whatsapp.conversational.valid_until",
            "subscriptions.whatsapp.marketing",
            "subscriptions.whatsapp.marketing.can_receive",
            "subscriptions.whatsapp.marketing.consent",
            "subscriptions.whatsapp.marketing.consent_timestamp",
            "subscriptions.whatsapp.marketing.created_timestamp",
            "subscriptions.whatsapp.marketing.last_updated",
            "subscriptions.whatsapp.marketing.metadata",
            "subscriptions.whatsapp.marketing.phone_number",
            "subscriptions.whatsapp.marketing.valid_until",
            "subscriptions.whatsapp.transactional",
            "subscriptions.whatsapp.transactional.can_receive",
            "subscriptions.whatsapp.transactional.consent",
            "subscriptions.whatsapp.transactional.consent_timestamp",
            "subscriptions.whatsapp.transactional.created_timestamp",
            "subscriptions.whatsapp.transactional.last_updated",
            "subscriptions.whatsapp.transactional.metadata",
            "subscriptions.whatsapp.transactional.phone_number",
            "subscriptions.whatsapp.transactional.valid_until",
            "title",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/vnd.api+json": {
        "schema": {
          "$ref": "#/components/schemas/ProfileCreateQuery"
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/PostProfileResponse"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "75/s",
    "steady": "750/m"
  },
  "x-klaviyo-scopes": [
    "profiles:write"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_profile",
  "summary": "Get Profile",
  "description": "Get the profile with the given profile ID.\n\nUse the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `include=list` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>Rate limits when using the `include=segment` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `include` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-07-15/docs/rate_limits_and_error_handling) guide.\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "additional-fields[profile]",
      "in": "query",
      "description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "subscriptions",
            "predictive_analytics"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[conversation]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "channel",
            "id"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[list]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "created",
            "id",
            "name",
            "opt_in_process",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[profile]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "created",
            "email",
            "external_id",
            "first_name",
            "id",
            "image",
            "last_event_date",
            "last_name",
            "locale",
            "location",
            "location.address1",
            "location.address2",
            "location.city",
            "location.country",
            "location.ip",
            "location.latitude",
            "location.longitude",
            "location.region",
            "location.timezone",
            "location.zip",
            "organization",
            "phone_number",
            "predictive_analytics",
            "predictive_analytics.average_days_between_orders",
            "predictive_analytics.average_order_value",
            "predictive_analytics.churn_probability",
            "predictive_analytics.expected_date_of_next_order",
            "predictive_analytics.historic_clv",
            "predictive_analytics.historic_number_of_orders",
            "predictive_analytics.predicted_clv",
            "predictive_analytics.predicted_number_of_orders",
            "predictive_analytics.ranked_channel_affinity",
            "predictive_analytics.total_clv",
            "properties",
            "subscriptions",
            "subscriptions.email",
            "subscriptions.email.click_tracking",
            "subscriptions.email.click_tracking.can_receive",
            "subscriptions.email.click_tracking.consent",
            "subscriptions.email.click_tracking.consent_timestamp",
            "subscriptions.email.click_tracking.created_timestamp",
            "subscriptions.email.click_tracking.last_updated",
            "subscriptions.email.click_tracking.metadata",
            "subscriptions.email.click_tracking.valid_until",
            "subscriptions.email.marketing",
            "subscriptions.email.marketing.can_receive_email_marketing",
            "subscriptions.email.marketing.consent",
            "subscriptions.email.marketing.consent_timestamp",
            "subscriptions.email.marketing.custom_method_detail",
            "subscriptions.email.marketing.double_optin",
            "subscriptions.email.marketing.last_updated",
            "subscriptions.email.marketing.list_suppressions",
            "subscriptions.email.marketing.method",
            "subscriptions.email.marketing.method_detail",
            "subscriptions.email.marketing.suppression",
            "subscriptions.email.open_tracking",
            "subscriptions.email.open_tracking.can_receive",
            "subscriptions.email.open_tracking.consent",
            "subscriptions.email.open_tracking.consent_timestamp",
            "subscriptions.email.open_tracking.created_timestamp",
            "subscriptions.email.open_tracking.last_updated",
            "subscriptions.email.open_tracking.metadata",
            "subscriptions.email.open_tracking.valid_until",
            "subscriptions.mobile_push",
            "subscriptions.mobile_push.marketing",
            "subscriptions.mobile_push.marketing.can_receive_push_marketing",
            "subscriptions.mobile_push.marketing.consent",
            "subscriptions.mobile_push.marketing.consent_timestamp",
            "subscriptions.sms",
            "subscriptions.sms.marketing",
            "subscriptions.sms.marketing.can_receive_sms_marketing",
            "subscriptions.sms.marketing.consent",
            "subscriptions.sms.marketing.consent_timestamp",
            "subscriptions.sms.marketing.last_updated",
            "subscriptions.sms.marketing.method",
            "subscriptions.sms.marketing.method_detail",
            "subscriptions.sms.transactional",
            "subscriptions.sms.transactional.can_receive_sms_transactional",
            "subscriptions.sms.transactional.consent",
            "subscriptions.sms.transactional.consent_timestamp",
            "subscriptions.sms.transactional.last_updated",
            "subscriptions.sms.transactional.method",
            "subscriptions.sms.transactional.method_detail",
            "subscriptions.whatsapp",
            "subscriptions.whatsapp.conversational",
            "subscriptions.whatsapp.conversational.can_receive",
            "subscriptions.whatsapp.conversational.consent",
            "subscriptions.whatsapp.conversational.consent_timestamp",
            "subscriptions.whatsapp.conversational.created_timestamp",
            "subscriptions.whatsapp.conversational.last_updated",
            "subscriptions.whatsapp.conversational.metadata",
            "subscriptions.whatsapp.conversational.phone_number",
            "subscriptions.whatsapp.conversational.valid_until",
            "subscriptions.whatsapp.marketing",
            "subscriptions.whatsapp.marketing.can_receive",
            "subscriptions.whatsapp.marketing.consent",
            "subscriptions.whatsapp.marketing.consent_timestamp",
            "subscriptions.whatsapp.marketing.created_timestamp",
            "subscriptions.whatsapp.marketing.last_updated",
            "subscriptions.whatsapp.marketing.metadata",
            "subscriptions.whatsapp.marketing.phone_number",
            "subscriptions.whatsapp.marketing.valid_until",
            "subscriptions.whatsapp.transactional",
            "subscriptions.whatsapp.transactional.can_receive",
            "subscriptions.whatsapp.transactional.consent",
            "subscriptions.whatsapp.transactional.consent_timestamp",
            "subscriptions.whatsapp.transactional.created_timestamp",
            "subscriptions.whatsapp.transactional.last_updated",
            "subscriptions.whatsapp.transactional.metadata",
            "subscriptions.whatsapp.transactional.phone_number",
            "subscriptions.whatsapp.transactional.valid_until",
            "title",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[push-token]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "background",
            "created",
            "enablement_status",
            "id",
            "metadata",
            "metadata.app_build",
            "metadata.app_id",
            "metadata.app_name",
            "metadata.app_version",
            "metadata.device_id",
            "metadata.device_model",
            "metadata.environment",
            "metadata.klaviyo_sdk",
            "metadata.manufacturer",
            "metadata.os_name",
            "metadata.os_version",
            "metadata.sdk_version",
            "platform",
            "recorded_date",
            "token",
            "vendor"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[segment]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "created",
            "definition",
            "definition.condition_groups",
            "id",
            "is_active",
            "is_processing",
            "is_starred",
            "name",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "include",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships",
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "conversations",
            "lists",
            "push-tokens",
            "segments"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetProfileResponsePluralConversationsCompoundDocument"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "75/s",
    "steady": "750/m"
  },
  "x-klaviyo-scopes": [
    "profiles:read"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "update_profile",
  "summary": "Update Profile",
  "description": "Update the profile with the given profile ID.\n\nUse the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.\n\nNote that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged.\n\nThe maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_profile.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
      "required": true,
      "schema": {
        "description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
        "type": "string",
        "example": "01GDDKASAP8TKDDA2GRZDSVP4H"
      }
    },
    {
      "name": "additional-fields[profile]",
      "in": "query",
      "description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "subscriptions",
            "predictive_analytics"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[profile]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "created",
            "email",
            "external_id",
            "first_name",
            "id",
            "image",
            "last_event_date",
            "last_name",
            "locale",
            "location",
            "location.address1",
            "location.address2",
            "location.city",
            "location.country",
            "location.ip",
            "location.latitude",
            "location.longitude",
            "location.region",
            "location.timezone",
            "location.zip",
            "organization",
            "phone_number",
            "predictive_analytics",
            "predictive_analytics.average_days_between_orders",
            "predictive_analytics.average_order_value",
            "predictive_analytics.churn_probability",
            "predictive_analytics.expected_date_of_next_order",
            "predictive_analytics.historic_clv",
            "predictive_analytics.historic_number_of_orders",
            "predictive_analytics.predicted_clv",
            "predictive_analytics.predicted_number_of_orders",
            "predictive_analytics.ranked_channel_affinity",
            "predictive_analytics.total_clv",
            "properties",
            "subscriptions",
            "subscriptions.email",
            "subscriptions.email.click_tracking",
            "subscriptions.email.click_tracking.can_receive",
            "subscriptions.email.click_tracking.consent",
            "subscriptions.email.click_tracking.consent_timestamp",
            "subscriptions.email.click_tracking.created_timestamp",
            "subscriptions.email.click_tracking.last_updated",
            "subscriptions.email.click_tracking.metadata",
            "subscriptions.email.click_tracking.valid_until",
            "subscriptions.email.marketing",
            "subscriptions.email.marketing.can_receive_email_marketing",
            "subscriptions.email.marketing.consent",
            "subscriptions.email.marketing.consent_timestamp",
            "subscriptions.email.marketing.custom_method_detail",
            "subscriptions.email.marketing.double_optin",
            "subscriptions.email.marketing.last_updated",
            "subscriptions.email.marketing.list_suppressions",
            "subscriptions.email.marketing.method",
            "subscriptions.email.marketing.method_detail",
            "subscriptions.email.marketing.suppression",
            "subscriptions.email.open_tracking",
            "subscriptions.email.open_tracking.can_receive",
            "subscriptions.email.open_tracking.consent",
            "subscriptions.email.open_tracking.consent_timestamp",
            "subscriptions.email.open_tracking.created_timestamp",
            "subscriptions.email.open_tracking.last_updated",
            "subscriptions.email.open_tracking.metadata",
            "subscriptions.email.open_tracking.valid_until",
            "subscriptions.mobile_push",
            "subscriptions.mobile_push.marketing",
            "subscriptions.mobile_push.marketing.can_receive_push_marketing",
            "subscriptions.mobile_push.marketing.consent",
            "subscriptions.mobile_push.marketing.consent_timestamp",
            "subscriptions.sms",
            "subscriptions.sms.marketing",
            "subscriptions.sms.marketing.can_receive_sms_marketing",
            "subscriptions.sms.marketing.consent",
            "subscriptions.sms.marketing.consent_timestamp",
            "subscriptions.sms.marketing.last_updated",
            "subscriptions.sms.marketing.method",
            "subscriptions.sms.marketing.method_detail",
            "subscriptions.sms.transactional",
            "subscriptions.sms.transactional.can_receive_sms_transactional",
            "subscriptions.sms.transactional.consent",
            "subscriptions.sms.transactional.consent_timestamp",
            "subscriptions.sms.transactional.last_updated",
            "subscriptions.sms.transactional.method",
            "subscriptions.sms.transactional.method_detail",
            "subscriptions.whatsapp",
            "subscriptions.whatsapp.conversational",
            "subscriptions.whatsapp.conversational.can_receive",
            "subscriptions.whatsapp.conversational.consent",
            "subscriptions.whatsapp.conversational.consent_timestamp",
            "subscriptions.whatsapp.conversational.created_timestamp",
            "subscriptions.whatsapp.conversational.last_updated",
            "subscriptions.whatsapp.conversational.metadata",
            "subscriptions.whatsapp.conversational.phone_number",
            "subscriptions.whatsapp.conversational.valid_until",
            "subscriptions.whatsapp.marketing",
            "subscriptions.whatsapp.marketing.can_receive",
            "subscriptions.whatsapp.marketing.consent",
            "subscriptions.whatsapp.marketing.consent_timestamp",
            "subscriptions.whatsapp.marketing.created_timestamp",
            "subscriptions.whatsapp.marketing.last_updated",
            "subscriptions.whatsapp.marketing.metadata",
            "subscriptions.whatsapp.marketing.phone_number",
            "subscriptions.whatsapp.marketing.valid_until",
            "subscriptions.whatsapp.transactional",
            "subscriptions.whatsapp.transactional.can_receive",
            "subscriptions.whatsapp.transactional.consent",
            "subscriptions.whatsapp.transactional.consent_timestamp",
            "subscriptions.whatsapp.transactional.created_timestamp",
            "subscriptions.whatsapp.transactional.last_updated",
            "subscriptions.whatsapp.transactional.metadata",
            "subscriptions.whatsapp.transactional.phone_number",
            "subscriptions.whatsapp.transactional.valid_until",
            "title",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/vnd.api+json": {
        "schema": {
          "$ref": "#/components/schemas/ProfilePartialUpdateQuery"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/PatchProfileResponse"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "75/s",
    "steady": "750/m"
  },
  "x-klaviyo-scopes": [
    "profiles:write"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_bulk_import_profiles_jobs",
  "summary": "Get Bulk Import Profiles Jobs",
  "description": "Get all bulk profile import jobs.\n\nReturns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_import_profiles_jobs.json)",
  "parameters": [
    {
      "name": "fields[profile-bulk-import-job]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "completed_at",
            "completed_count",
            "created_at",
            "expires_at",
            "failed_count",
            "id",
            "started_at",
            "status",
            "total_count"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "filter",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals` (allowed values: `'queued'`, `'processing'`, `'complete'`)",
      "schema": {
        "type": "string",
        "example": "equals(status,'queued')"
      }
    },
    {
      "name": "page[cursor]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "page[size]",
      "in": "query",
      "description": "Default: 20. Min: 1. Max: 100.",
      "required": false,
      "schema": {
        "type": "integer",
        "default": 20,
        "maximum": 100,
        "minimum": 1
      }
    },
    {
      "name": "sort",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting",
      "schema": {
        "type": "string",
        "enum": [
          "created_at",
          "-created_at"
        ]
      }
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetProfileImportJobResponseCollectionCompoundDocument"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-filters": {
    "status": {
      "operators": {
        "list": [
          "any",
          "equals"
        ],
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "string",
        "enum": [
          "queued",
          "processing",
          "complete"
        ]
      }
    }
  },
  "x-klaviyo-operation-aliases": [
    "get_bulk_profile_import_jobs",
    "get_profile_bulk_import_jobs"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "10/s",
    "steady": "150/m"
  },
  "x-klaviyo-scopes": [
    "lists:read",
    "profiles:read"
  ],
  "x-klaviyo-subtag": "Bulk Import Profiles"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "bulk_import_profiles",
  "summary": "Bulk Import Profiles",
  "description": "Create a bulk profile import job to create or update a batch of profiles.\n\nAccepts up to 10,000 profiles per request. The maximum allowed payload size is 5MB. The maximum allowed payload size per-profile is 100KB.\n\nTo learn more, see our [Bulk Profile Import API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_bulk_profile_import_api).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:write`\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_import_profiles.json)",
  "parameters": [
    {
      "name": "fields[profile-bulk-import-job]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "completed_at",
            "completed_count",
            "created_at",
            "expires_at",
            "failed_count",
            "id",
            "started_at",
            "status",
            "total_count"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/vnd.api+json": {
        "schema": {
          "$ref": "#/components/schemas/ProfileImportJobCreateQuery"
        }
      }
    }
  },
  "responses": {
    "202": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/PostProfileImportJobResponse"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "spawn_bulk_profile_import_job",
    "create_profile_bulk_import_job"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "10/s",
    "steady": "150/m"
  },
  "x-klaviyo-scopes": [
    "lists:write",
    "profiles:write"
  ],
  "x-klaviyo-subtag": "Bulk Import Profiles"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_bulk_import_profiles_job",
  "summary": "Get Bulk Import Profiles Job",
  "description": "Get a bulk profile import job with the given job ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_import_profiles_job.json)",
  "parameters": [
    {
      "name": "job_id",
      "in": "path",
      "description": "ID of the job to retrieve.",
      "required": true,
      "schema": {
        "description": "ID of the job to retrieve.",
        "type": "string",
        "example": "01GSQPBF74KQ5YTDEPP41T1BZH"
      }
    },
    {
      "name": "fields[list]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "created",
            "id",
            "name",
            "opt_in_process",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[profile-bulk-import-job]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "completed_at",
            "completed_count",
            "created_at",
            "expires_at",
            "failed_count",
            "id",
            "started_at",
            "status",
            "total_count"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "include",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships",
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "lists"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetProfileImportJobResponseCompoundDocument"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "get_bulk_profile_import_job",
    "get_profile_bulk_import_job"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "10/s",
    "steady": "150/m"
  },
  "x-klaviyo-scopes": [
    "lists:read",
    "profiles:read"
  ],
  "x-klaviyo-subtag": "Bulk Import Profiles"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_bulk_suppress_profiles_jobs",
  "summary": "Get Bulk Suppress Profiles Jobs",
  "description": "Get the status of all bulk profile suppression jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`subscriptions:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_suppress_profiles_jobs.json)",
  "parameters": [
    {
      "name": "fields[profile-suppression-bulk-create-job]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "completed_at",
            "completed_count",
            "created_at",
            "id",
            "skipped_count",
            "status",
            "total_count"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "filter",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` (allowed values: `'queued'`, `'processing'`, `'complete'`, `'cancelled'`)<br>`list_id`: `equals` (string)<br>`segment_id`: `equals` (string)",
      "schema": {
        "type": "string",
        "example": "equals(status,'processing')"
      }
    },
    {
      "name": "page[cursor]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "sort",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/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": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetBulkProfileSuppressionsCreateJobResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-filters": {
    "status": {
      "operators": {
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "string",
        "enum": [
          "queued",
          "processing",
          "complete",
          "cancelled"
        ]
      }
    },
    "list_id": {
      "operators": {
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "segment_id": {
      "operators": {
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    }
  },
  "x-klaviyo-operation-aliases": [
    "get_profile_suppression_bulk_create_jobs"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "75/s",
    "steady": "750/m"
  },
  "x-klaviyo-scopes": [
    "subscriptions:read"
  ],
  "x-klaviyo-subtag": "Consent"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "bulk_suppress_profiles",
  "summary": "Bulk Suppress Profiles",
  "description": "Manually suppress profiles by email address or specify a segment/list ID to suppress all current members of a segment/list.\n\nSuppressed profiles cannot receive email marketing, independent of their consent status. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).\n\nEmail address per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`profiles:write`\n`subscriptions:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_suppress_profiles.json)",
  "parameters": [
    {
      "name": "fields[profile-suppression-bulk-create-job]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "completed_at",
            "completed_count",
            "created_at",
            "id",
            "skipped_count",
            "status",
            "total_count"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "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/vnd.api+json": {
        "schema": {
          "$ref": "#/components/schemas/SuppressionCreateJobCreateQuery"
        }
      }
    }
  },
  "responses": {
    "202": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/PostBulkProfileSuppressionsCreateJobResponse"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "suppress_profiles",
    "create_profile_suppression_bulk_create_job"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "75/s",
    "steady": "750/m"
  },
  "x-klaviyo-scopes": [
    "profiles:write",
    "subscriptions:write"
  ],
  "x-klaviyo-subtag": "Consent"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_bulk_suppress_profiles_job",
  "summary": "Get Bulk Suppress Profiles Job",
  "description": "Get the bulk suppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`subscriptions:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_suppress_profiles_job.json)",
  "parameters": [
    {
      "name": "job_id",
      "in": "path",
      "description": "ID of the job to retrieve.",
      "required": true,
      "schema": {
        "description": "ID of the job to retrieve.",
        "type": "string",
        "example": "01GSQPBF74KQ5YTDEPP41T1BZH"
      }
    },
    {
      "name": "fields[profile-suppression-bulk-create-job]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "completed_at",
            "completed_count",
            "created_at",
            "id",
            "skipped_count",
            "status",
            "total_count"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetBulkProfileSuppressionsCreateJobResponse"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "get_profile_suppression_bulk_create_job"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "75/s",
    "steady": "750/m"
  },
  "x-klaviyo-scopes": [
    "subscriptions:read"
  ],
  "x-klaviyo-subtag": "Consent"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_bulk_unsuppress_profiles_jobs",
  "summary": "Get Bulk Unsuppress Profiles Jobs",
  "description": "Get all bulk unsuppress profiles jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`subscriptions:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_unsuppress_profiles_jobs.json)",
  "parameters": [
    {
      "name": "fields[profile-suppression-bulk-delete-job]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "completed_at",
            "completed_count",
            "created_at",
            "id",
            "skipped_count",
            "status",
            "total_count"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "filter",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` (allowed values: `'queued'`, `'processing'`, `'complete'`, `'cancelled'`)<br>`list_id`: `equals` (string)<br>`segment_id`: `equals` (string)",
      "schema": {
        "type": "string",
        "example": "equals(status,'processing')"
      }
    },
    {
      "name": "page[cursor]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "sort",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/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": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetBulkProfileSuppressionsRemoveJobResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-filters": {
    "status": {
      "operators": {
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "string",
        "enum": [
          "queued",
          "processing",
          "complete",
          "cancelled"
        ]
      }
    },
    "list_id": {
      "operators": {
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "segment_id": {
      "operators": {
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    }
  },
  "x-klaviyo-operation-aliases": [
    "get_profile_suppression_bulk_delete_jobs"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "75/s",
    "steady": "750/m"
  },
  "x-klaviyo-scopes": [
    "subscriptions:read"
  ],
  "x-klaviyo-subtag": "Consent"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "bulk_unsuppress_profiles",
  "summary": "Bulk Unsuppress Profiles",
  "description": "Manually unsuppress profiles by email address or specify a segment/list ID to unsuppress all current members of a segment/list.\n\nThis only removes suppressions with reason USER_SUPPRESSED ; unsubscribed profiles and suppressed profiles with reason INVALID_EMAIL or HARD_BOUNCE remain unchanged. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).\n\nEmail address per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`subscriptions:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_unsuppress_profiles.json)",
  "parameters": [
    {
      "name": "fields[profile-suppression-bulk-delete-job]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "completed_at",
            "completed_count",
            "created_at",
            "id",
            "skipped_count",
            "status",
            "total_count"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "requestBody": {
    "description": "Unsuppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not\nfound with the given email, no action will be taken.",
    "required": true,
    "content": {
      "application/vnd.api+json": {
        "schema": {
          "$ref": "#/components/schemas/SuppressionDeleteJobCreateQuery"
        }
      }
    }
  },
  "responses": {
    "202": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/PostBulkProfileSuppressionsRemoveJobResponse"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "unsuppress_profiles",
    "create_profile_suppression_bulk_delete_job"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "75/s",
    "steady": "750/m"
  },
  "x-klaviyo-scopes": [
    "subscriptions:write"
  ],
  "x-klaviyo-subtag": "Consent"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_bulk_unsuppress_profiles_job",
  "summary": "Get Bulk Unsuppress Profiles Job",
  "description": "Get the bulk unsuppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`subscriptions:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_unsuppress_profiles_job.json)",
  "parameters": [
    {
      "name": "job_id",
      "in": "path",
      "description": "ID of the job to retrieve.",
      "required": true,
      "schema": {
        "description": "ID of the job to retrieve.",
        "type": "string",
        "example": "01GSQPBF74KQ5YTDEPP41T1BZH"
      }
    },
    {
      "name": "fields[profile-suppression-bulk-delete-job]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "completed_at",
            "completed_count",
            "created_at",
            "id",
            "skipped_count",
            "status",
            "total_count"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetBulkProfileSuppressionsRemoveJobResponse"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "get_profile_suppression_bulk_delete_job"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "75/s",
    "steady": "750/m"
  },
  "x-klaviyo-scopes": [
    "subscriptions:read"
  ],
  "x-klaviyo-subtag": "Consent"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_push_tokens",
  "summary": "Get Push Tokens",
  "description": "Return push tokens associated with company.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n`push-tokens:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_tokens.json)",
  "parameters": [
    {
      "name": "fields[profile]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "created",
            "email",
            "external_id",
            "first_name",
            "id",
            "image",
            "last_event_date",
            "last_name",
            "locale",
            "location",
            "location.address1",
            "location.address2",
            "location.city",
            "location.country",
            "location.ip",
            "location.latitude",
            "location.longitude",
            "location.region",
            "location.timezone",
            "location.zip",
            "organization",
            "phone_number",
            "properties",
            "title",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[push-token]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "background",
            "created",
            "enablement_status",
            "id",
            "metadata",
            "metadata.app_build",
            "metadata.app_id",
            "metadata.app_name",
            "metadata.app_version",
            "metadata.device_id",
            "metadata.device_model",
            "metadata.environment",
            "metadata.klaviyo_sdk",
            "metadata.manufacturer",
            "metadata.os_name",
            "metadata.os_version",
            "metadata.sdk_version",
            "platform",
            "recorded_date",
            "token",
            "vendor"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "filter",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `equals` (string)<br>`profile.id`: `equals` (string)<br>`enablement_status`: `equals` (allowed values: `'AUTHORIZED'`, `'UNAUTHORIZED'`, `'DENIED'`, `'PROVISIONAL'`, `'NOT_DETERMINED'`)<br>`platform`: `equals` (allowed values: `'ios'`, `'android'`)",
      "schema": {
        "type": "string",
        "example": "equals(id,'example')"
      }
    },
    {
      "name": "include",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships",
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "profile"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "page[cursor]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "page[size]",
      "in": "query",
      "description": "Default: 20. Min: 1. Max: 100.",
      "required": false,
      "schema": {
        "type": "integer",
        "default": 20,
        "maximum": 100,
        "minimum": 1
      }
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetPushTokenResponseCollectionCompoundDocument"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-filters": {
    "id": {
      "operators": {
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "profile.id": {
      "operators": {
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "enablement_status": {
      "operators": {
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "string",
        "enum": [
          "AUTHORIZED",
          "UNAUTHORIZED",
          "DENIED",
          "PROVISIONAL",
          "NOT_DETERMINED"
        ]
      }
    },
    "platform": {
      "operators": {
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "string",
        "enum": [
          "ios",
          "android"
        ]
      }
    }
  },
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "10/s",
    "steady": "150/m"
  },
  "x-klaviyo-scopes": [
    "profiles:read",
    "push-tokens:read"
  ],
  "x-klaviyo-subtag": "Push Tokens"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "create_push_token",
  "summary": "Create or Update Push Token",
  "description": "Create or update a push token.\n\nThis endpoint can be used to migrate push tokens from another platform to Klaviyo. Please use our mobile SDKs ([iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk)) to create push tokens from users' devices.\n\nThe maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`profiles:write`\n`push-tokens:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_push_token.json)",
  "parameters": [
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/vnd.api+json": {
        "schema": {
          "$ref": "#/components/schemas/PushTokenCreateQuery"
        }
      }
    }
  },
  "responses": {
    "202": {
      "description": "Success"
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "75/s",
    "steady": "750/m"
  },
  "x-klaviyo-scopes": [
    "profiles:write",
    "push-tokens:write"
  ],
  "x-klaviyo-subtag": "Push Tokens"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_push_token",
  "summary": "Get Push Token",
  "description": "Return a specific push token based on its ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n`push-tokens:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_token.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "The value of the push token",
      "required": true,
      "schema": {
        "description": "The value of the push token",
        "type": "string"
      }
    },
    {
      "name": "fields[profile]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "created",
            "email",
            "external_id",
            "first_name",
            "id",
            "image",
            "last_event_date",
            "last_name",
            "locale",
            "location",
            "location.address1",
            "location.address2",
            "location.city",
            "location.country",
            "location.ip",
            "location.latitude",
            "location.longitude",
            "location.region",
            "location.timezone",
            "location.zip",
            "organization",
            "phone_number",
            "properties",
            "title",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[push-token]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "background",
            "created",
            "enablement_status",
            "id",
            "metadata",
            "metadata.app_build",
            "metadata.app_id",
            "metadata.app_name",
            "metadata.app_version",
            "metadata.device_id",
            "metadata.device_model",
            "metadata.environment",
            "metadata.klaviyo_sdk",
            "metadata.manufacturer",
            "metadata.os_name",
            "metadata.os_version",
            "metadata.sdk_version",
            "platform",
            "recorded_date",
            "token",
            "vendor"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "include",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships",
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "profile"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetPushTokenResponseCompoundDocument"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "10/s",
    "steady": "150/m"
  },
  "x-klaviyo-scopes": [
    "profiles:read",
    "push-tokens:read"
  ],
  "x-klaviyo-subtag": "Push Tokens"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "delete_push_token",
  "summary": "Delete Push Token",
  "description": "Delete a specific push token based on its ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`push-tokens:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_push_token.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "The value of the push token to delete",
      "required": true,
      "schema": {
        "description": "The value of the push token to delete",
        "type": "string",
        "example": "925e385b52fb405715f3616c337cc65c"
      }
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "204": {
      "description": "Success"
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "3/s",
    "steady": "60/m"
  },
  "x-klaviyo-scopes": [
    "push-tokens:write"
  ],
  "x-klaviyo-subtag": "Push Tokens"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "create_or_update_profile",
  "summary": "Create or Update Profile",
  "description": "Given a set of profile attributes and optionally an ID, create or update a profile.\n\nReturns 201 if a new profile was created, 200 if an existing profile was updated.\n\nUse the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.\n\nNote that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged.\n\nThe maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_or_update_profile.json)",
  "parameters": [
    {
      "name": "additional-fields[profile]",
      "in": "query",
      "description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "subscriptions",
            "predictive_analytics"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[profile]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "created",
            "email",
            "external_id",
            "first_name",
            "id",
            "image",
            "last_event_date",
            "last_name",
            "locale",
            "location",
            "location.address1",
            "location.address2",
            "location.city",
            "location.country",
            "location.ip",
            "location.latitude",
            "location.longitude",
            "location.region",
            "location.timezone",
            "location.zip",
            "organization",
            "phone_number",
            "predictive_analytics",
            "predictive_analytics.average_days_between_orders",
            "predictive_analytics.average_order_value",
            "predictive_analytics.churn_probability",
            "predictive_analytics.expected_date_of_next_order",
            "predictive_analytics.historic_clv",
            "predictive_analytics.historic_number_of_orders",
            "predictive_analytics.predicted_clv",
            "predictive_analytics.predicted_number_of_orders",
            "predictive_analytics.ranked_channel_affinity",
            "predictive_analytics.total_clv",
            "properties",
            "subscriptions",
            "subscriptions.email",
            "subscriptions.email.click_tracking",
            "subscriptions.email.click_tracking.can_receive",
            "subscriptions.email.click_tracking.consent",
            "subscriptions.email.click_tracking.consent_timestamp",
            "subscriptions.email.click_tracking.created_timestamp",
            "subscriptions.email.click_tracking.last_updated",
            "subscriptions.email.click_tracking.metadata",
            "subscriptions.email.click_tracking.valid_until",
            "subscriptions.email.marketing",
            "subscriptions.email.marketing.can_receive_email_marketing",
            "subscriptions.email.marketing.consent",
            "subscriptions.email.marketing.consent_timestamp",
            "subscriptions.email.marketing.custom_method_detail",
            "subscriptions.email.marketing.double_optin",
            "subscriptions.email.marketing.last_updated",
            "subscriptions.email.marketing.list_suppressions",
            "subscriptions.email.marketing.method",
            "subscriptions.email.marketing.method_detail",
            "subscriptions.email.marketing.suppression",
            "subscriptions.email.open_tracking",
            "subscriptions.email.open_tracking.can_receive",
            "subscriptions.email.open_tracking.consent",
            "subscriptions.email.open_tracking.consent_timestamp",
            "subscriptions.email.open_tracking.created_timestamp",
            "subscriptions.email.open_tracking.last_updated",
            "subscriptions.email.open_tracking.metadata",
            "subscriptions.email.open_tracking.valid_until",
            "subscriptions.mobile_push",
            "subscriptions.mobile_push.marketing",
            "subscriptions.mobile_push.marketing.can_receive_push_marketing",
            "subscriptions.mobile_push.marketing.consent",
            "subscriptions.mobile_push.marketing.consent_timestamp",
            "subscriptions.sms",
            "subscriptions.sms.marketing",
            "subscriptions.sms.marketing.can_receive_sms_marketing",
            "subscriptions.sms.marketing.consent",
            "subscriptions.sms.marketing.consent_timestamp",
            "subscriptions.sms.marketing.last_updated",
            "subscriptions.sms.marketing.method",
            "subscriptions.sms.marketing.method_detail",
            "subscriptions.sms.transactional",
            "subscriptions.sms.transactional.can_receive_sms_transactional",
            "subscriptions.sms.transactional.consent",
            "subscriptions.sms.transactional.consent_timestamp",
            "subscriptions.sms.transactional.last_updated",
            "subscriptions.sms.transactional.method",
            "subscriptions.sms.transactional.method_detail",
            "subscriptions.whatsapp",
            "subscriptions.whatsapp.conversational",
            "subscriptions.whatsapp.conversational.can_receive",
            "subscriptions.whatsapp.conversational.consent",
            "subscriptions.whatsapp.conversational.consent_timestamp",
            "subscriptions.whatsapp.conversational.created_timestamp",
            "subscriptions.whatsapp.conversational.last_updated",
            "subscriptions.whatsapp.conversational.metadata",
            "subscriptions.whatsapp.conversational.phone_number",
            "subscriptions.whatsapp.conversational.valid_until",
            "subscriptions.whatsapp.marketing",
            "subscriptions.whatsapp.marketing.can_receive",
            "subscriptions.whatsapp.marketing.consent",
            "subscriptions.whatsapp.marketing.consent_timestamp",
            "subscriptions.whatsapp.marketing.created_timestamp",
            "subscriptions.whatsapp.marketing.last_updated",
            "subscriptions.whatsapp.marketing.metadata",
            "subscriptions.whatsapp.marketing.phone_number",
            "subscriptions.whatsapp.marketing.valid_until",
            "subscriptions.whatsapp.transactional",
            "subscriptions.whatsapp.transactional.can_receive",
            "subscriptions.whatsapp.transactional.consent",
            "subscriptions.whatsapp.transactional.consent_timestamp",
            "subscriptions.whatsapp.transactional.created_timestamp",
            "subscriptions.whatsapp.transactional.last_updated",
            "subscriptions.whatsapp.transactional.metadata",
            "subscriptions.whatsapp.transactional.phone_number",
            "subscriptions.whatsapp.transactional.valid_until",
            "title",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/vnd.api+json": {
        "schema": {
          "$ref": "#/components/schemas/ProfileUpsertQuery"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Profile Updated Successfully",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/PostProfileResponse"
          }
        }
      }
    },
    "201": {
      "description": "Profile Created Successfully",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/PostProfileResponse"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "create_profile_import"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "75/s",
    "steady": "750/m"
  },
  "x-klaviyo-scopes": [
    "profiles:write"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "merge_profiles",
  "summary": "Merge Profiles",
  "description": "Merge a given related profile into a profile with the given profile ID.\n\nThe profile provided under `relationships` (the \"source\" profile) will be merged into the profile provided by the ID in the base data object (the \"destination\" profile).\nThis endpoint queues an asynchronous task which will merge data from the source profile into the destination profile, deleting the source profile in the process. This endpoint accepts only one source profile.\n\nTo learn more about how profile data is preserved or overwritten during a merge, please [visit our Help Center](https://help.klaviyo.com/hc/en-us/articles/115005073847#merge-2-profiles3).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/merge_profiles.json)",
  "parameters": [
    {
      "name": "fields[profile]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "id"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/vnd.api+json": {
        "schema": {
          "$ref": "#/components/schemas/ProfileMergeQuery"
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/PostProfileMergeResponse"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "create_profile_merge"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "10/s",
    "steady": "150/m"
  },
  "x-klaviyo-scopes": [
    "profiles:write"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "bulk_subscribe_profiles",
  "summary": "Bulk Subscribe Profiles",
  "description": "Subscribe one or more profiles to email marketing, SMS marketing, WhatsApp, or push. If the provided 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.\nLearn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).\n\nIf a list is not provided, the opt-in process used will be determined by the [account-level default opt-in setting](https://www.klaviyo.com/settings/account/api-keys).\n\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).\n\nThis API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about [suppressed profiles](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1).\n\nMaximum number of profiles can be submitted for subscription: 1000\n\nThis endpoint now supports a `historical_import` flag. If this flag is set `true`, profiles being subscribed will bypass double opt-in emails and be subscribed immediately. They will also bypass any associated \"Added to list\" flows. This is useful for importing historical data where you have already collected consent. If `historical_import` is set to true, the `consented_at` field is required and must be in the past.\n\nPush tokens provided in `push_tokens` will be registered for each profile as long as push subscriptions are consented to.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`lists:write`\n`profiles:write`\n`subscriptions:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_subscribe_profiles.json)",
  "parameters": [
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "requestBody": {
    "description": "Subscribes one or more profiles to marketing, with support for push channel and push tokens.\nAll profiles will be added to the provided list. Either email or phone number is required.\nBoth may be specified to subscribe to both channels. If a profile cannot be found matching\nthe given identifier(s), a new profile will be created and then subscribed.",
    "required": true,
    "content": {
      "application/vnd.api+json": {
        "schema": {
          "$ref": "#/components/schemas/SubscriptionCreateJobCreateQuery"
        }
      }
    }
  },
  "responses": {
    "202": {
      "description": "Success"
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "subscribe_profiles",
    "create_profile_subscription_bulk_create_job"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "75/s",
    "steady": "750/m"
  },
  "x-klaviyo-scopes": [
    "lists:write",
    "profiles:write",
    "subscriptions:write"
  ],
  "x-klaviyo-subtag": "Consent"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "bulk_unsubscribe_profiles",
  "summary": "Bulk Unsubscribe Profiles",
  "description": "> 🚧\n>\n> Profiles not in the specified list will be globally unsubscribed. Always verify profile list membership before calling this endpoint to avoid unintended global unsubscribes.\n\nUnsubscribe one or more profiles from email marketing, SMS marketing, push marketing, or a combination. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).\n\nPush tokens provided in `subscriptions.push.tokens` will be removed for the specified profiles.\n\nTo remove someone from a list without changing their subscription status, use [Remove Profiles from List](https://developers.klaviyo.com/en/reference/remove_profiles_from_list).\n\nMaximum number of profiles per call: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`lists:write`\n`profiles:write`\n`subscriptions:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_unsubscribe_profiles.json)",
  "parameters": [
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "requestBody": {
    "description": "Unsubscribes one or more profiles from marketing. Supports email, SMS, WhatsApp, and push channels. All profiles will be removed from the provided list.\nEither email or phone number is required for email/SMS/WhatsApp channels. Push tokens can be removed by providing token strings directly.\nIf a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed.",
    "required": true,
    "content": {
      "application/vnd.api+json": {
        "schema": {
          "$ref": "#/components/schemas/SubscriptionDeleteJobCreateQuery"
        }
      }
    }
  },
  "responses": {
    "202": {
      "description": "Success"
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "unsubscribe_profiles",
    "create_profile_subscription_bulk_delete_job"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "75/s",
    "steady": "750/m"
  },
  "x-klaviyo-scopes": [
    "lists:write",
    "profiles:write",
    "subscriptions:write"
  ],
  "x-klaviyo-subtag": "Consent"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_push_tokens_for_profile",
  "summary": "Get Push Tokens for Profile",
  "description": "Return all push tokens that belong to the given profile.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_tokens_for_profile.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "fields[push-token]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "background",
            "created",
            "enablement_status",
            "id",
            "metadata",
            "metadata.app_build",
            "metadata.app_id",
            "metadata.app_name",
            "metadata.app_version",
            "metadata.device_id",
            "metadata.device_model",
            "metadata.environment",
            "metadata.klaviyo_sdk",
            "metadata.manufacturer",
            "metadata.os_name",
            "metadata.os_version",
            "metadata.sdk_version",
            "platform",
            "recorded_date",
            "token",
            "vendor"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetPushTokenResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "get_profile_push_tokens"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "10/s",
    "steady": "150/m"
  },
  "x-klaviyo-scopes": [
    "profiles:read"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_push_token_ids_for_profile",
  "summary": "Get Push Token IDs for Profile",
  "description": "Return the IDs of all push tokens associated with the given profile.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_token_ids_for_profile.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "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": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetProfilePushTokensRelationshipsResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "get_profile_relationships_push_tokens"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "10/s",
    "steady": "150/m"
  },
  "x-klaviyo-scopes": [
    "profiles:read"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_lists_for_profile",
  "summary": "Get Lists for Profile",
  "description": "Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`lists:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_lists_for_profile.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "fields[list]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "created",
            "id",
            "name",
            "opt_in_process",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetListResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "get_profile_lists"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "3/s",
    "steady": "60/m"
  },
  "x-klaviyo-scopes": [
    "lists:read",
    "profiles:read"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_list_ids_for_profile",
  "summary": "Get List IDs for Profile",
  "description": "Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`lists:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_ids_for_profile.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "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": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetProfileListsRelationshipsResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "get_profile_relationships_lists"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "3/s",
    "steady": "60/m"
  },
  "x-klaviyo-scopes": [
    "lists:read",
    "profiles:read"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_segments_for_profile",
  "summary": "Get Segments for Profile",
  "description": "Get segment memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`profiles:read`\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segments_for_profile.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "fields[segment]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "created",
            "definition",
            "definition.condition_groups",
            "id",
            "is_active",
            "is_processing",
            "is_starred",
            "name",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetSegmentResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "get_profile_segments"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "3/s",
    "steady": "60/m"
  },
  "x-klaviyo-scopes": [
    "profiles:read",
    "segments:read"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_segment_ids_for_profile",
  "summary": "Get Segment IDs for Profile",
  "description": "Get segment membership relationships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`profiles:read`\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segment_ids_for_profile.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "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": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetProfileSegmentsRelationshipsResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "get_profile_relationships_segments"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "3/s",
    "steady": "60/m"
  },
  "x-klaviyo-scopes": [
    "profiles:read",
    "segments:read"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_conversation_for_profile",
  "summary": "Get Conversation for Profile",
  "description": "Get the conversation for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`conversations:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_conversation_for_profile.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "fields[conversation]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "channel",
            "id"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetConversationResponse"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "get_profile_conversation"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "3/s",
    "steady": "60/m"
  },
  "x-klaviyo-scopes": [
    "conversations:read",
    "profiles:read"
  ],
  "x-klaviyo-subtag": "Conversations"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_conversation_id_for_profile",
  "summary": "Get Conversation ID for Profile",
  "description": "Get the conversation relationship for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`conversations:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_conversation_id_for_profile.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "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": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetProfileConversationRelationshipResponse"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "get_profile_relationships_conversation"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "3/s",
    "steady": "60/m"
  },
  "x-klaviyo-scopes": [
    "conversations:read",
    "profiles:read"
  ],
  "x-klaviyo-subtag": "Conversations"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_conversations_for_profile",
  "summary": "Get Conversations for Profile",
  "description": "Get all conversations for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`conversations:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_conversations_for_profile.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "fields[conversation]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "channel",
            "id"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetConversationResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "get_profile_conversations"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "3/s",
    "steady": "60/m"
  },
  "x-klaviyo-scopes": [
    "conversations:read",
    "profiles:read"
  ],
  "x-klaviyo-subtag": "Conversations"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_conversation_ids_for_profile",
  "summary": "Get Conversation IDs for Profile",
  "description": "Get the IDs of all conversations for a profile across all channels.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`conversations:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_conversation_ids_for_profile.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "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": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetProfileConversationsRelationshipsResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "get_profile_relationships_conversations"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "3/s",
    "steady": "60/m"
  },
  "x-klaviyo-scopes": [
    "conversations:read",
    "profiles:read"
  ],
  "x-klaviyo-subtag": "Conversations"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_list_for_bulk_import_profiles_job",
  "summary": "Get List for Bulk Import Profiles Job",
  "description": "Get list for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_for_bulk_import_profiles_job.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "fields[list]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "created",
            "id",
            "name",
            "opt_in_process",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetListResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "get_bulk_profile_import_job_lists",
    "get_lists_for_profile_bulk_import_job",
    "get_profile_bulk_import_job_lists"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "10/s",
    "steady": "150/m"
  },
  "x-klaviyo-scopes": [
    "lists:read"
  ],
  "x-klaviyo-subtag": "Bulk Import Profiles"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_list_ids_for_bulk_import_profiles_job",
  "summary": "Get List IDs for Bulk Import Profiles Job",
  "description": "Get list relationship for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`lists:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_ids_for_bulk_import_profiles_job.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "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": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetProfileBulkImportJobListsRelationshipsResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "get_bulk_profile_import_job_relationships_lists",
    "get_list_ids_for_profile_bulk_import_job",
    "get_profile_bulk_import_job_relationships_lists"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "10/s",
    "steady": "150/m"
  },
  "x-klaviyo-scopes": [
    "lists:read"
  ],
  "x-klaviyo-subtag": "Bulk Import Profiles"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_profiles_for_bulk_import_profiles_job",
  "summary": "Get Profiles for Bulk Import Profiles Job",
  "description": "Get profiles for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles_for_bulk_import_profiles_job.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "additional-fields[profile]",
      "in": "query",
      "description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "subscriptions",
            "predictive_analytics"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[profile]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "created",
            "email",
            "external_id",
            "first_name",
            "id",
            "image",
            "last_event_date",
            "last_name",
            "locale",
            "location",
            "location.address1",
            "location.address2",
            "location.city",
            "location.country",
            "location.ip",
            "location.latitude",
            "location.longitude",
            "location.region",
            "location.timezone",
            "location.zip",
            "organization",
            "phone_number",
            "predictive_analytics",
            "predictive_analytics.average_days_between_orders",
            "predictive_analytics.average_order_value",
            "predictive_analytics.churn_probability",
            "predictive_analytics.expected_date_of_next_order",
            "predictive_analytics.historic_clv",
            "predictive_analytics.historic_number_of_orders",
            "predictive_analytics.predicted_clv",
            "predictive_analytics.predicted_number_of_orders",
            "predictive_analytics.ranked_channel_affinity",
            "predictive_analytics.total_clv",
            "properties",
            "subscriptions",
            "subscriptions.email",
            "subscriptions.email.click_tracking",
            "subscriptions.email.click_tracking.can_receive",
            "subscriptions.email.click_tracking.consent",
            "subscriptions.email.click_tracking.consent_timestamp",
            "subscriptions.email.click_tracking.created_timestamp",
            "subscriptions.email.click_tracking.last_updated",
            "subscriptions.email.click_tracking.metadata",
            "subscriptions.email.click_tracking.valid_until",
            "subscriptions.email.marketing",
            "subscriptions.email.marketing.can_receive_email_marketing",
            "subscriptions.email.marketing.consent",
            "subscriptions.email.marketing.consent_timestamp",
            "subscriptions.email.marketing.custom_method_detail",
            "subscriptions.email.marketing.double_optin",
            "subscriptions.email.marketing.last_updated",
            "subscriptions.email.marketing.list_suppressions",
            "subscriptions.email.marketing.method",
            "subscriptions.email.marketing.method_detail",
            "subscriptions.email.marketing.suppression",
            "subscriptions.email.open_tracking",
            "subscriptions.email.open_tracking.can_receive",
            "subscriptions.email.open_tracking.consent",
            "subscriptions.email.open_tracking.consent_timestamp",
            "subscriptions.email.open_tracking.created_timestamp",
            "subscriptions.email.open_tracking.last_updated",
            "subscriptions.email.open_tracking.metadata",
            "subscriptions.email.open_tracking.valid_until",
            "subscriptions.mobile_push",
            "subscriptions.mobile_push.marketing",
            "subscriptions.mobile_push.marketing.can_receive_push_marketing",
            "subscriptions.mobile_push.marketing.consent",
            "subscriptions.mobile_push.marketing.consent_timestamp",
            "subscriptions.sms",
            "subscriptions.sms.marketing",
            "subscriptions.sms.marketing.can_receive_sms_marketing",
            "subscriptions.sms.marketing.consent",
            "subscriptions.sms.marketing.consent_timestamp",
            "subscriptions.sms.marketing.last_updated",
            "subscriptions.sms.marketing.method",
            "subscriptions.sms.marketing.method_detail",
            "subscriptions.sms.transactional",
            "subscriptions.sms.transactional.can_receive_sms_transactional",
            "subscriptions.sms.transactional.consent",
            "subscriptions.sms.transactional.consent_timestamp",
            "subscriptions.sms.transactional.last_updated",
            "subscriptions.sms.transactional.method",
            "subscriptions.sms.transactional.method_detail",
            "subscriptions.whatsapp",
            "subscriptions.whatsapp.conversational",
            "subscriptions.whatsapp.conversational.can_receive",
            "subscriptions.whatsapp.conversational.consent",
            "subscriptions.whatsapp.conversational.consent_timestamp",
            "subscriptions.whatsapp.conversational.created_timestamp",
            "subscriptions.whatsapp.conversational.last_updated",
            "subscriptions.whatsapp.conversational.metadata",
            "subscriptions.whatsapp.conversational.phone_number",
            "subscriptions.whatsapp.conversational.valid_until",
            "subscriptions.whatsapp.marketing",
            "subscriptions.whatsapp.marketing.can_receive",
            "subscriptions.whatsapp.marketing.consent",
            "subscriptions.whatsapp.marketing.consent_timestamp",
            "subscriptions.whatsapp.marketing.created_timestamp",
            "subscriptions.whatsapp.marketing.last_updated",
            "subscriptions.whatsapp.marketing.metadata",
            "subscriptions.whatsapp.marketing.phone_number",
            "subscriptions.whatsapp.marketing.valid_until",
            "subscriptions.whatsapp.transactional",
            "subscriptions.whatsapp.transactional.can_receive",
            "subscriptions.whatsapp.transactional.consent",
            "subscriptions.whatsapp.transactional.consent_timestamp",
            "subscriptions.whatsapp.transactional.created_timestamp",
            "subscriptions.whatsapp.transactional.last_updated",
            "subscriptions.whatsapp.transactional.metadata",
            "subscriptions.whatsapp.transactional.phone_number",
            "subscriptions.whatsapp.transactional.valid_until",
            "title",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "page[cursor]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "page[size]",
      "in": "query",
      "description": "Default: 20. Min: 1. Max: 100.",
      "required": false,
      "schema": {
        "type": "integer",
        "default": 20,
        "maximum": 100,
        "minimum": 1
      }
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetProfileResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "get_bulk_profile_import_job_profiles",
    "get_profile_bulk_import_job_profiles",
    "get_profiles_for_profile_bulk_import_job"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "10/s",
    "steady": "150/m"
  },
  "x-klaviyo-scopes": [
    "profiles:read"
  ],
  "x-klaviyo-subtag": "Bulk Import Profiles"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_profile_ids_for_bulk_import_profiles_job",
  "summary": "Get Profile IDs for Bulk Import Profiles Job",
  "description": "Get profile relationships for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_ids_for_bulk_import_profiles_job.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "page[cursor]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "page[size]",
      "in": "query",
      "description": "Default: 20. Min: 1. Max: 100.",
      "required": false,
      "schema": {
        "type": "integer",
        "default": 20,
        "maximum": 100,
        "minimum": 1
      }
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetProfileBulkImportJobProfilesRelationshipsResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "get_bulk_profile_import_job_relationships_profiles",
    "get_profile_bulk_import_job_relationships_profiles",
    "get_profile_ids_for_profile_bulk_import_job"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "10/s",
    "steady": "150/m"
  },
  "x-klaviyo-scopes": [
    "profiles:read"
  ],
  "x-klaviyo-subtag": "Bulk Import Profiles"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_errors_for_bulk_import_profiles_job",
  "summary": "Get Errors for Bulk Import Profiles Job",
  "description": "Get import errors for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_errors_for_bulk_import_profiles_job.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "fields[import-error]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "code",
            "detail",
            "id",
            "original_payload",
            "source",
            "source.pointer",
            "title"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "page[cursor]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "page[size]",
      "in": "query",
      "description": "Default: 20. Min: 1. Max: 100.",
      "required": false,
      "schema": {
        "type": "integer",
        "default": 20,
        "maximum": 100,
        "minimum": 1
      }
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetImportErrorResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "get_bulk_profile_import_job_import_errors",
    "get_import_errors_for_profile_bulk_import_job",
    "get_profile_bulk_import_job_import_errors"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "10/s",
    "steady": "150/m"
  },
  "x-klaviyo-scopes": [
    "profiles:read"
  ],
  "x-klaviyo-subtag": "Bulk Import Profiles"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_profile_for_push_token",
  "summary": "Get Profile for Push Token",
  "description": "Return the profile associated with the given push token.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n`push-tokens:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_for_push_token.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "The value of the push token",
      "required": true,
      "schema": {
        "description": "The value of the push token",
        "type": "string"
      }
    },
    {
      "name": "additional-fields[profile]",
      "in": "query",
      "description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "subscriptions",
            "predictive_analytics"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[profile]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "created",
            "email",
            "external_id",
            "first_name",
            "id",
            "image",
            "last_event_date",
            "last_name",
            "locale",
            "location",
            "location.address1",
            "location.address2",
            "location.city",
            "location.country",
            "location.ip",
            "location.latitude",
            "location.longitude",
            "location.region",
            "location.timezone",
            "location.zip",
            "organization",
            "phone_number",
            "predictive_analytics",
            "predictive_analytics.average_days_between_orders",
            "predictive_analytics.average_order_value",
            "predictive_analytics.churn_probability",
            "predictive_analytics.expected_date_of_next_order",
            "predictive_analytics.historic_clv",
            "predictive_analytics.historic_number_of_orders",
            "predictive_analytics.predicted_clv",
            "predictive_analytics.predicted_number_of_orders",
            "predictive_analytics.ranked_channel_affinity",
            "predictive_analytics.total_clv",
            "properties",
            "subscriptions",
            "subscriptions.email",
            "subscriptions.email.click_tracking",
            "subscriptions.email.click_tracking.can_receive",
            "subscriptions.email.click_tracking.consent",
            "subscriptions.email.click_tracking.consent_timestamp",
            "subscriptions.email.click_tracking.created_timestamp",
            "subscriptions.email.click_tracking.last_updated",
            "subscriptions.email.click_tracking.metadata",
            "subscriptions.email.click_tracking.valid_until",
            "subscriptions.email.marketing",
            "subscriptions.email.marketing.can_receive_email_marketing",
            "subscriptions.email.marketing.consent",
            "subscriptions.email.marketing.consent_timestamp",
            "subscriptions.email.marketing.custom_method_detail",
            "subscriptions.email.marketing.double_optin",
            "subscriptions.email.marketing.last_updated",
            "subscriptions.email.marketing.list_suppressions",
            "subscriptions.email.marketing.method",
            "subscriptions.email.marketing.method_detail",
            "subscriptions.email.marketing.suppression",
            "subscriptions.email.open_tracking",
            "subscriptions.email.open_tracking.can_receive",
            "subscriptions.email.open_tracking.consent",
            "subscriptions.email.open_tracking.consent_timestamp",
            "subscriptions.email.open_tracking.created_timestamp",
            "subscriptions.email.open_tracking.last_updated",
            "subscriptions.email.open_tracking.metadata",
            "subscriptions.email.open_tracking.valid_until",
            "subscriptions.mobile_push",
            "subscriptions.mobile_push.marketing",
            "subscriptions.mobile_push.marketing.can_receive_push_marketing",
            "subscriptions.mobile_push.marketing.consent",
            "subscriptions.mobile_push.marketing.consent_timestamp",
            "subscriptions.sms",
            "subscriptions.sms.marketing",
            "subscriptions.sms.marketing.can_receive_sms_marketing",
            "subscriptions.sms.marketing.consent",
            "subscriptions.sms.marketing.consent_timestamp",
            "subscriptions.sms.marketing.last_updated",
            "subscriptions.sms.marketing.method",
            "subscriptions.sms.marketing.method_detail",
            "subscriptions.sms.transactional",
            "subscriptions.sms.transactional.can_receive_sms_transactional",
            "subscriptions.sms.transactional.consent",
            "subscriptions.sms.transactional.consent_timestamp",
            "subscriptions.sms.transactional.last_updated",
            "subscriptions.sms.transactional.method",
            "subscriptions.sms.transactional.method_detail",
            "subscriptions.whatsapp",
            "subscriptions.whatsapp.conversational",
            "subscriptions.whatsapp.conversational.can_receive",
            "subscriptions.whatsapp.conversational.consent",
            "subscriptions.whatsapp.conversational.consent_timestamp",
            "subscriptions.whatsapp.conversational.created_timestamp",
            "subscriptions.whatsapp.conversational.last_updated",
            "subscriptions.whatsapp.conversational.metadata",
            "subscriptions.whatsapp.conversational.phone_number",
            "subscriptions.whatsapp.conversational.valid_until",
            "subscriptions.whatsapp.marketing",
            "subscriptions.whatsapp.marketing.can_receive",
            "subscriptions.whatsapp.marketing.consent",
            "subscriptions.whatsapp.marketing.consent_timestamp",
            "subscriptions.whatsapp.marketing.created_timestamp",
            "subscriptions.whatsapp.marketing.last_updated",
            "subscriptions.whatsapp.marketing.metadata",
            "subscriptions.whatsapp.marketing.phone_number",
            "subscriptions.whatsapp.marketing.valid_until",
            "subscriptions.whatsapp.transactional",
            "subscriptions.whatsapp.transactional.can_receive",
            "subscriptions.whatsapp.transactional.consent",
            "subscriptions.whatsapp.transactional.consent_timestamp",
            "subscriptions.whatsapp.transactional.created_timestamp",
            "subscriptions.whatsapp.transactional.last_updated",
            "subscriptions.whatsapp.transactional.metadata",
            "subscriptions.whatsapp.transactional.phone_number",
            "subscriptions.whatsapp.transactional.valid_until",
            "title",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetProfileResponse"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "get_push_token_profile"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "10/s",
    "steady": "150/m"
  },
  "x-klaviyo-scopes": [
    "profiles:read",
    "push-tokens:read"
  ],
  "x-klaviyo-subtag": "Push Tokens"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_profile_id_for_push_token",
  "summary": "Get Profile ID for Push Token",
  "description": "Return the ID of the profile associated with the given push token.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n`push-tokens:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_id_for_push_token.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "The value of the push token",
      "required": true,
      "schema": {
        "description": "The value of the push token",
        "type": "string"
      }
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetPushTokenProfileRelationshipResponse"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Profiles"
  ],
  "x-klaviyo-operation-aliases": [
    "get_push_token_relationships_profile"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "10/s",
    "steady": "150/m"
  },
  "x-klaviyo-scopes": [
    "profiles:read",
    "push-tokens:read"
  ],
  "x-klaviyo-subtag": "Push Tokens"
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_segments",
  "summary": "Get Segments",
  "description": "Get all segments in an account.\n\nFilter to request a subset of all segments. Segments can be filtered by `name`, `created`, and `updated` fields.\n\nReturns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segments.json)",
  "parameters": [
    {
      "name": "fields[flow]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "archived",
            "created",
            "id",
            "name",
            "status",
            "trigger_type",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[segment]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "created",
            "definition",
            "definition.condition_groups",
            "id",
            "is_active",
            "is_processing",
            "is_starred",
            "name",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[tag]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "id",
            "name"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "filter",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals` (string)<br>`id`: `any`, `equals` (string)<br>`created`: `greater-than` (date-time)<br>`updated`: `greater-than` (date-time)<br>`is_active`: `any`, `equals` (boolean)<br>`is_starred`: `equals` (boolean)",
      "schema": {
        "type": "string",
        "example": "equals(name,['example'])"
      }
    },
    {
      "name": "include",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships",
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "flow-triggers",
            "tags"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "page[cursor]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "page[size]",
      "in": "query",
      "description": "Default: 10. Min: 1. Max: 10.",
      "required": false,
      "schema": {
        "type": "integer",
        "default": 10,
        "maximum": 10,
        "minimum": 1
      }
    },
    {
      "name": "sort",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting",
      "schema": {
        "type": "string",
        "enum": [
          "created",
          "-created",
          "id",
          "-id",
          "name",
          "-name",
          "updated",
          "-updated"
        ]
      }
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetSegmentListResponseCollectionCompoundDocument"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Segments"
  ],
  "x-klaviyo-filters": {
    "name": {
      "operators": {
        "list": [
          "any",
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "id": {
      "operators": {
        "list": [
          "any",
          "equals"
        ],
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "created": {
      "operators": {
        "single": [
          "greater-than"
        ]
      },
      "value": {
        "type": "string",
        "format": "date-time"
      }
    },
    "updated": {
      "operators": {
        "single": [
          "greater-than"
        ]
      },
      "value": {
        "type": "string",
        "format": "date-time"
      }
    },
    "is_active": {
      "operators": {
        "list": [
          "any",
          "equals"
        ],
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "boolean"
      }
    },
    "is_starred": {
      "operators": {
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "boolean"
      }
    }
  },
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "75/s",
    "steady": "750/m"
  },
  "x-klaviyo-scopes": [
    "segments:read"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "create_segment",
  "summary": "Create Segment",
  "description": "Create a segment.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d`\n\n**Scopes:**\n`segments:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_segment.json)",
  "parameters": [
    {
      "name": "fields[segment]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "created",
            "definition",
            "definition.condition_groups",
            "id",
            "is_active",
            "is_processing",
            "is_starred",
            "name",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/vnd.api+json": {
        "schema": {
          "$ref": "#/components/schemas/SegmentCreateQuery"
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/PostSegmentCreateResponse"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Segments"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "1/s",
    "steady": "15/m",
    "daily": "100/d"
  },
  "x-klaviyo-scopes": [
    "segments:write"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_segment",
  "summary": "Get Segment",
  "description": "Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-07-15/docs/rate_limits_and_error_handling) guide.\n\n**Scopes:**\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segment.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "additional-fields[segment]",
      "in": "query",
      "description": "Request additional fields not included by default in the response. Supported values: 'profile_count'",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "profile_count"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[flow]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "archived",
            "created",
            "id",
            "name",
            "status",
            "trigger_type",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[segment]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "created",
            "definition",
            "definition.condition_groups",
            "id",
            "is_active",
            "is_processing",
            "is_starred",
            "name",
            "profile_count",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[tag]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "id",
            "name"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "include",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships",
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "flow-triggers",
            "tags"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetSegmentRetrieveResponseCompoundDocument"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Segments"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "75/s",
    "steady": "750/m"
  },
  "x-klaviyo-scopes": [
    "segments:read"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "update_segment",
  "summary": "Update Segment",
  "description": "Update a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d`\n\n**Scopes:**\n`segments:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_segment.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "fields[segment]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "created",
            "definition",
            "definition.condition_groups",
            "id",
            "is_active",
            "is_processing",
            "is_starred",
            "name",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/vnd.api+json": {
        "schema": {
          "$ref": "#/components/schemas/SegmentPartialUpdateQuery"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/PatchSegmentPartialUpdateResponse"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Segments"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "1/s",
    "steady": "15/m",
    "daily": "100/d"
  },
  "x-klaviyo-scopes": [
    "segments:write"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "delete_segment",
  "summary": "Delete Segment",
  "description": "Delete a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`segments:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_segment.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "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": "2026-07-15"
      }
    }
  ],
  "responses": {
    "204": {
      "description": "Success"
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Segments"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "3/s",
    "steady": "60/m"
  },
  "x-klaviyo-scopes": [
    "segments:write"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_tags_for_segment",
  "summary": "Get Tags for Segment",
  "description": "Return all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`segments:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_segment.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "fields[tag]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "id",
            "name"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetTagResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Segments"
  ],
  "x-klaviyo-operation-aliases": [
    "get_segment_tags"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "3/s",
    "steady": "60/m"
  },
  "x-klaviyo-scopes": [
    "segments:read",
    "tags:read"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_tag_ids_for_segment",
  "summary": "Get Tag IDs for Segment",
  "description": "If `related_resource` is `tags`, returns the tag IDs of all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`segments:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_segment.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "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": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetSegmentTagsRelationshipsResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Segments"
  ],
  "x-klaviyo-operation-aliases": [
    "get_segment_relationships_tags"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "3/s",
    "steady": "60/m"
  },
  "x-klaviyo-scopes": [
    "segments:read",
    "tags:read"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_profiles_for_segment",
  "summary": "Get Profiles for Segment",
  "description": "Get all profiles within a segment with the given segment ID.\n\nFilter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`profiles:read`\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles_for_segment.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "Primary key that uniquely identifies this segment. Generated by Klaviyo.",
      "required": true,
      "schema": {
        "description": "Primary key that uniquely identifies this segment. Generated by Klaviyo.",
        "type": "string",
        "example": "Y6nRLr"
      }
    },
    {
      "name": "additional-fields[profile]",
      "in": "query",
      "description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "subscriptions",
            "predictive_analytics"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "fields[profile]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "created",
            "email",
            "external_id",
            "first_name",
            "id",
            "image",
            "joined_group_at",
            "last_event_date",
            "last_name",
            "locale",
            "location",
            "location.address1",
            "location.address2",
            "location.city",
            "location.country",
            "location.ip",
            "location.latitude",
            "location.longitude",
            "location.region",
            "location.timezone",
            "location.zip",
            "organization",
            "phone_number",
            "predictive_analytics",
            "predictive_analytics.average_days_between_orders",
            "predictive_analytics.average_order_value",
            "predictive_analytics.churn_probability",
            "predictive_analytics.expected_date_of_next_order",
            "predictive_analytics.historic_clv",
            "predictive_analytics.historic_number_of_orders",
            "predictive_analytics.predicted_clv",
            "predictive_analytics.predicted_number_of_orders",
            "predictive_analytics.ranked_channel_affinity",
            "predictive_analytics.total_clv",
            "properties",
            "subscriptions",
            "subscriptions.email",
            "subscriptions.email.click_tracking",
            "subscriptions.email.click_tracking.can_receive",
            "subscriptions.email.click_tracking.consent",
            "subscriptions.email.click_tracking.consent_timestamp",
            "subscriptions.email.click_tracking.created_timestamp",
            "subscriptions.email.click_tracking.last_updated",
            "subscriptions.email.click_tracking.metadata",
            "subscriptions.email.click_tracking.valid_until",
            "subscriptions.email.marketing",
            "subscriptions.email.marketing.can_receive_email_marketing",
            "subscriptions.email.marketing.consent",
            "subscriptions.email.marketing.consent_timestamp",
            "subscriptions.email.marketing.custom_method_detail",
            "subscriptions.email.marketing.double_optin",
            "subscriptions.email.marketing.last_updated",
            "subscriptions.email.marketing.list_suppressions",
            "subscriptions.email.marketing.method",
            "subscriptions.email.marketing.method_detail",
            "subscriptions.email.marketing.suppression",
            "subscriptions.email.open_tracking",
            "subscriptions.email.open_tracking.can_receive",
            "subscriptions.email.open_tracking.consent",
            "subscriptions.email.open_tracking.consent_timestamp",
            "subscriptions.email.open_tracking.created_timestamp",
            "subscriptions.email.open_tracking.last_updated",
            "subscriptions.email.open_tracking.metadata",
            "subscriptions.email.open_tracking.valid_until",
            "subscriptions.mobile_push",
            "subscriptions.mobile_push.marketing",
            "subscriptions.mobile_push.marketing.can_receive_push_marketing",
            "subscriptions.mobile_push.marketing.consent",
            "subscriptions.mobile_push.marketing.consent_timestamp",
            "subscriptions.sms",
            "subscriptions.sms.marketing",
            "subscriptions.sms.marketing.can_receive_sms_marketing",
            "subscriptions.sms.marketing.consent",
            "subscriptions.sms.marketing.consent_timestamp",
            "subscriptions.sms.marketing.last_updated",
            "subscriptions.sms.marketing.method",
            "subscriptions.sms.marketing.method_detail",
            "subscriptions.sms.transactional",
            "subscriptions.sms.transactional.can_receive_sms_transactional",
            "subscriptions.sms.transactional.consent",
            "subscriptions.sms.transactional.consent_timestamp",
            "subscriptions.sms.transactional.last_updated",
            "subscriptions.sms.transactional.method",
            "subscriptions.sms.transactional.method_detail",
            "subscriptions.whatsapp",
            "subscriptions.whatsapp.conversational",
            "subscriptions.whatsapp.conversational.can_receive",
            "subscriptions.whatsapp.conversational.consent",
            "subscriptions.whatsapp.conversational.consent_timestamp",
            "subscriptions.whatsapp.conversational.created_timestamp",
            "subscriptions.whatsapp.conversational.last_updated",
            "subscriptions.whatsapp.conversational.metadata",
            "subscriptions.whatsapp.conversational.phone_number",
            "subscriptions.whatsapp.conversational.valid_until",
            "subscriptions.whatsapp.marketing",
            "subscriptions.whatsapp.marketing.can_receive",
            "subscriptions.whatsapp.marketing.consent",
            "subscriptions.whatsapp.marketing.consent_timestamp",
            "subscriptions.whatsapp.marketing.created_timestamp",
            "subscriptions.whatsapp.marketing.last_updated",
            "subscriptions.whatsapp.marketing.metadata",
            "subscriptions.whatsapp.marketing.phone_number",
            "subscriptions.whatsapp.marketing.valid_until",
            "subscriptions.whatsapp.transactional",
            "subscriptions.whatsapp.transactional.can_receive",
            "subscriptions.whatsapp.transactional.consent",
            "subscriptions.whatsapp.transactional.consent_timestamp",
            "subscriptions.whatsapp.transactional.created_timestamp",
            "subscriptions.whatsapp.transactional.last_updated",
            "subscriptions.whatsapp.transactional.metadata",
            "subscriptions.whatsapp.transactional.phone_number",
            "subscriptions.whatsapp.transactional.valid_until",
            "title",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "filter",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`profile_id`: `any`, `equals` (string)<br>`email`: `any`, `equals` (string)<br>`phone_number`: `any`, `equals` (string)<br>`push_token`: `any`, `equals` (string)<br>`_kx`: `equals` (string)<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)",
      "schema": {
        "type": "string",
        "example": "equals(profile_id,['example'])"
      }
    },
    {
      "name": "page[cursor]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "page[size]",
      "in": "query",
      "description": "Default: 20. Min: 1. Max: 100.",
      "required": false,
      "schema": {
        "type": "integer",
        "default": 20,
        "maximum": 100,
        "minimum": 1
      }
    },
    {
      "name": "sort",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting",
      "schema": {
        "type": "string",
        "enum": [
          "joined_group_at",
          "-joined_group_at"
        ]
      }
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetSegmentMemberResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Segments"
  ],
  "x-klaviyo-filters": {
    "profile_id": {
      "operators": {
        "list": [
          "any",
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "email": {
      "operators": {
        "list": [
          "any",
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "phone_number": {
      "operators": {
        "list": [
          "any",
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "push_token": {
      "operators": {
        "list": [
          "any",
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "_kx": {
      "operators": {
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "joined_group_at": {
      "operators": {
        "single": [
          "greater-or-equal",
          "greater-than",
          "less-or-equal",
          "less-than"
        ]
      },
      "value": {
        "type": "string",
        "format": "date-time"
      }
    }
  },
  "x-klaviyo-operation-aliases": [
    "get_segment_profiles"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "75/s",
    "steady": "750/m"
  },
  "x-klaviyo-scopes": [
    "profiles:read",
    "segments:read"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_profile_ids_for_segment",
  "summary": "Get Profile IDs for Segment",
  "description": "Get all profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`profiles:read`\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_ids_for_segment.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "Primary key that uniquely identifies this segment. Generated by Klaviyo.",
      "required": true,
      "schema": {
        "description": "Primary key that uniquely identifies this segment. Generated by Klaviyo.",
        "type": "string",
        "example": "Y6nRLr"
      }
    },
    {
      "name": "filter",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`profile_id`: `any`, `equals` (string)<br>`email`: `any`, `equals` (string)<br>`phone_number`: `any`, `equals` (string)<br>`push_token`: `any`, `equals` (string)<br>`_kx`: `equals` (string)<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)",
      "schema": {
        "type": "string",
        "example": "equals(profile_id,['example'])"
      }
    },
    {
      "name": "page[cursor]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "page[size]",
      "in": "query",
      "description": "Default: 20. Min: 1. Max: 100.",
      "required": false,
      "schema": {
        "type": "integer",
        "default": 20,
        "maximum": 100,
        "minimum": 1
      }
    },
    {
      "name": "sort",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting",
      "schema": {
        "type": "string",
        "enum": [
          "joined_group_at",
          "-joined_group_at"
        ]
      }
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetSegmentProfilesRelationshipsResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Segments"
  ],
  "x-klaviyo-filters": {
    "profile_id": {
      "operators": {
        "list": [
          "any",
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "email": {
      "operators": {
        "list": [
          "any",
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "phone_number": {
      "operators": {
        "list": [
          "any",
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "push_token": {
      "operators": {
        "list": [
          "any",
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "_kx": {
      "operators": {
        "single": [
          "equals"
        ]
      },
      "value": {
        "type": "string"
      }
    },
    "joined_group_at": {
      "operators": {
        "single": [
          "greater-or-equal",
          "greater-than",
          "less-or-equal",
          "less-than"
        ]
      },
      "value": {
        "type": "string",
        "format": "date-time"
      }
    }
  },
  "x-klaviyo-operation-aliases": [
    "get_segment_relationships_profiles"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "75/s",
    "steady": "750/m"
  },
  "x-klaviyo-scopes": [
    "profiles:read",
    "segments:read"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_flows_triggered_by_segment",
  "summary": "Get Flows Triggered by Segment",
  "description": "Get all flows where the given segment ID is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flows_triggered_by_segment.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "Primary key that uniquely identifies this segment. Generated by Klaviyo.",
      "required": true,
      "schema": {
        "description": "Primary key that uniquely identifies this segment. Generated by Klaviyo.",
        "type": "string",
        "example": "Y6nRLr"
      }
    },
    {
      "name": "fields[flow]",
      "in": "query",
      "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets",
      "required": false,
      "schema": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "archived",
            "created",
            "id",
            "name",
            "status",
            "trigger_type",
            "updated"
          ]
        }
      },
      "explode": false
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetFlowResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Segments"
  ],
  "x-klaviyo-operation-aliases": [
    "get_flow_triggers_for_segment",
    "get_segment_flow_triggers"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "3/s",
    "steady": "60/m"
  },
  "x-klaviyo-scopes": [
    "flows:read",
    "segments:read"
  ]
}

[
  {
    "Klaviyo-API-Key": []
  }
]

{
  "operationId": "get_ids_for_flows_triggered_by_segment",
  "summary": "Get IDs for Flows Triggered by Segment",
  "description": "Get the IDs of all flows where the given segment is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_ids_for_flows_triggered_by_segment.json)",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "Primary key that uniquely identifies this segment. Generated by Klaviyo.",
      "required": true,
      "schema": {
        "description": "Primary key that uniquely identifies this segment. Generated by Klaviyo.",
        "type": "string",
        "example": "Y6nRLr"
      }
    },
    {
      "name": "revision",
      "in": "header",
      "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
      "required": true,
      "schema": {
        "type": "string",
        "default": "2026-07-15"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/vnd.api+json": {
          "schema": {
            "$ref": "#/components/schemas/GetSegmentFlowTriggersRelationshipsResponseCollection"
          }
        }
      }
    },
    "4XX": {
      "$ref": "#/components/responses/ClientError"
    },
    "5XX": {
      "$ref": "#/components/responses/ServerError"
    }
  },
  "tags": [
    "Segments"
  ],
  "x-klaviyo-operation-aliases": [
    "get_flow_trigger_ids_for_segment",
    "get_segment_relationships_flow_triggers"
  ],
  "x-klaviyo-pre-release": "None",
  "x-klaviyo-ratelimit": {
    "burst": "3/s",
    "steady": "60/m"
  },
  "x-klaviyo-scopes": [
    "flows:read",
    "segments:read"
  ]
}

Schemas and reusable components

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "method"
      ]
    },
    "method": {
      "type": "string",
      "enum": [
        "api"
      ]
    },
    "filter": {
      "description": "Optional filter on a specific list of API keys (using last 4 digits of the key)",
      "$ref": "#/components/schemas/InStringArrayFilter",
      "nullable": true
    }
  },
  "required": [
    "field",
    "method"
  ]
}

{
  "type": "string",
  "enum": [
    "account"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/AccountEnum"
    },
    "id": {
      "type": "string"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "test_account": {
          "description": "Indicates if the account is a test account. Test accounts are not a separate testing engineering environment. Test accounts use the same production environment as normal Klaviyo accounts. This feature is primarily UI based to reduce human errors",
          "type": "boolean"
        },
        "contact_information": {
          "description": "Contact information for the account. This is used in email footers by default to comply with the CAN-SPAM act.",
          "$ref": "#/components/schemas/ContactInformation"
        },
        "industry": {
          "description": "The kind of business and/or types of goods that the business sells. This is leveraged in Klaviyo analytics and guidance.",
          "type": "string",
          "example": "Software / SaaS",
          "nullable": true
        },
        "timezone": {
          "description": "The account's timezone is used when displaying dates and times. This is an IANA timezone. See [the full list here ](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).",
          "type": "string",
          "example": "US/Eastern"
        },
        "preferred_currency": {
          "description": "The preferred currency for the account. This is the currency used for currency-based metrics in dashboards, analytics, coupons, and templates.",
          "type": "string",
          "example": "USD"
        },
        "public_api_key": {
          "description": "The Public API Key can be used for client-side API calls. [More info here](https://developers.klaviyo.com/en/docs/retrieve_api_credentials).",
          "type": "string",
          "example": "AbC123"
        },
        "locale": {
          "description": "The account's locale is used to determine the region and language for the account.",
          "type": "string",
          "example": "en-US"
        }
      },
      "required": [
        "test_account",
        "contact_information",
        "timezone",
        "preferred_currency",
        "public_api_key",
        "locale"
      ]
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    }
  },
  "required": [
    "type",
    "id",
    "attributes",
    "links"
  ]
}

{
  "description": "Optional hints emitted by the API for agent callers",
  "type": "object",
  "properties": {
    "next_steps": {
      "description": "Suggested follow-up actions for agents to take after this response",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "date"
      ]
    },
    "operator": {
      "description": "Operators for anniversary date filters.",
      "type": "string",
      "enum": [
        "anniversary",
        "anniversary-month"
      ]
    }
  },
  "required": [
    "type",
    "operator"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "method"
      ]
    },
    "method": {
      "type": "string",
      "enum": [
        "back_in_stock"
      ]
    }
  },
  "required": [
    "field",
    "method"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "boolean"
      ]
    },
    "operator": {
      "description": "Operators for boolean filters.",
      "type": "string",
      "enum": [
        "equals"
      ]
    },
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "type",
    "operator",
    "value"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "bounce_date"
      ]
    },
    "filter": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/StaticDateFilter"
        },
        {
          "$ref": "#/components/schemas/StaticDateRangeFilter"
        },
        {
          "$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
        },
        {
          "$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
        },
        {
          "$ref": "#/components/schemas/RelativeDateRangeFilter"
        },
        {
          "$ref": "#/components/schemas/CalendarDateFilter"
        },
        {
          "$ref": "#/components/schemas/AnniversaryDateFilter"
        },
        {
          "$ref": "#/components/schemas/IsSetExistenceFilter"
        }
      ]
    }
  },
  "required": [
    "field",
    "filter"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ProfileSuppressionBulkCreateJobEnum"
    },
    "id": {
      "description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
      "type": "string"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "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+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,
          "default": 0,
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "skipped_count": {
          "description": "The total number of profiles that have been skipped as part of the job.",
          "type": "integer",
          "example": 1,
          "default": 0,
          "nullable": true
        }
      },
      "required": [
        "status",
        "created_at",
        "total_count"
      ]
    },
    "relationships": {
      "type": "object",
      "properties": {
        "lists": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/ListEnum"
                  },
                  "id": {
                    "description": "Suppress/Unsuppress all profiles in this list",
                    "type": "string",
                    "example": "Y6nRLr"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "segments": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/SegmentEnum"
                  },
                  "id": {
                    "description": "Suppress/Unsuppress all profiles in this segment",
                    "type": "string",
                    "example": "Y6nRLr"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    }
  },
  "required": [
    "type",
    "id",
    "attributes",
    "links"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ProfileSuppressionBulkDeleteJobEnum"
    },
    "id": {
      "description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
      "type": "string"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "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+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,
          "default": 0,
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "skipped_count": {
          "description": "The total number of profiles that have been skipped as part of the job.",
          "type": "integer",
          "example": 1,
          "default": 0,
          "nullable": true
        }
      },
      "required": [
        "status",
        "created_at",
        "total_count"
      ]
    },
    "relationships": {
      "type": "object",
      "properties": {
        "lists": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/ListEnum"
                  },
                  "id": {
                    "description": "Suppress/Unsuppress all profiles in this list",
                    "type": "string",
                    "example": "Y6nRLr"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "segments": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/SegmentEnum"
                  },
                  "id": {
                    "description": "Suppress/Unsuppress all profiles in this segment",
                    "type": "string",
                    "example": "Y6nRLr"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    }
  },
  "required": [
    "type",
    "id",
    "attributes",
    "links"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "method"
      ]
    },
    "method": {
      "type": "string",
      "enum": [
        "bulk_remove"
      ]
    }
  },
  "required": [
    "field",
    "method"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "date"
      ]
    },
    "operator": {
      "description": "Operators for calendar date filters.",
      "type": "string",
      "enum": [
        "calendar-month"
      ]
    },
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "type",
    "operator",
    "value"
  ]
}

{
  "type": "string",
  "enum": [
    "campaign"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "method"
      ]
    },
    "method": {
      "type": "string",
      "enum": [
        "carrier_deactivation"
      ]
    }
  },
  "required": [
    "field",
    "method"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "method"
      ]
    },
    "method": {
      "type": "string",
      "enum": [
        "checkout"
      ]
    }
  },
  "required": [
    "field",
    "method"
  ]
}

{
  "type": "object",
  "properties": {
    "consent": {
      "description": "The consent status for the channel.",
      "type": "string",
      "example": "SUBSCRIBED"
    },
    "consent_timestamp": {
      "description": "The timestamp when consent was recorded or updated for the channel, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
      "type": "string",
      "format": "date-time",
      "example": "2023-02-21T20:07:38+00:00",
      "nullable": true
    },
    "last_updated": {
      "description": "The timestamp when the channel was last modified, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
      "type": "string",
      "format": "date-time",
      "example": "2023-02-21T20:07:38+00:00",
      "nullable": true
    },
    "created_timestamp": {
      "description": "The timestamp when the channel was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
      "type": "string",
      "format": "date-time",
      "example": "2023-02-21T20:07:38+00:00",
      "nullable": true
    },
    "metadata": {
      "description": "Channel-specific metadata containing additional information about the permission.",
      "type": "object",
      "nullable": true
    },
    "can_receive": {
      "description": "Whether the profile can receive messages on this channel.",
      "type": "boolean"
    },
    "valid_until": {
      "description": "Optional expiration date for the permission, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
      "type": "string",
      "format": "date-time",
      "example": "2024-02-21T20:07:38+00:00",
      "nullable": true
    }
  },
  "required": [
    "consent",
    "can_receive"
  ]
}

{
  "type": "object",
  "properties": {
    "consent": {
      "description": "The click-tracking consent to grant. Currently supports \"SUBSCRIBED\".",
      "type": "string",
      "example": "SUBSCRIBED",
      "enum": [
        "SUBSCRIBED"
      ]
    }
  },
  "required": [
    "consent"
  ]
}

{
  "type": "object",
  "properties": {
    "consent": {
      "description": "The click-tracking consent to revoke. Currently supports \"UNSUBSCRIBED\".",
      "type": "string",
      "example": "UNSUBSCRIBED",
      "enum": [
        "UNSUBSCRIBED"
      ]
    }
  },
  "required": [
    "consent"
  ]
}

{
  "type": "object",
  "properties": {
    "self": {
      "type": "string",
      "format": "uri"
    },
    "prev": {
      "type": "string",
      "format": "uri"
    },
    "next": {
      "type": "string",
      "format": "uri"
    }
  },
  "required": [
    "self"
  ]
}

{
  "type": "object",
  "properties": {
    "conditions": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/ProfileHasGroupMembershipCondition"
          },
          {
            "$ref": "#/components/schemas/ProfileNoGroupMembershipCondition"
          },
          {
            "$ref": "#/components/schemas/ProfileMarketingConsentCondition"
          },
          {
            "$ref": "#/components/schemas/ProfilePropertyCondition"
          },
          {
            "$ref": "#/components/schemas/ProfileRegionCondition"
          }
        ],
        "x-purplesuite-narrowed": "Narrowed to the condition types this contract evaluates deterministically. Predictive analytics, channel affinity, postal-code distance, metric, custom-object, and permissions conditions require Klaviyo-hosted services and are rejected with a 400 rather than silently accepted."
      }
    }
  },
  "required": [
    "conditions"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "string"
      ]
    },
    "operator": {
      "type": "string",
      "enum": [
        "in"
      ]
    },
    "value": {
      "type": "array",
      "items": {
        "enum": [
          "constant_contact"
        ],
        "type": "string"
      }
    }
  },
  "required": [
    "type",
    "operator",
    "value"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "method"
      ]
    },
    "method": {
      "type": "string",
      "enum": [
        "integration"
      ]
    },
    "filter": {
      "$ref": "#/components/schemas/ConstantContactIntegrationFilter"
    }
  },
  "required": [
    "field",
    "method",
    "filter"
  ]
}

{
  "type": "object",
  "properties": {
    "default_sender_name": {
      "description": "This field is used to auto-populate the default sender name on flow and campaign emails.",
      "type": "string",
      "example": "Klaviyo Demo"
    },
    "default_sender_email": {
      "description": "This field is used to auto-populate the default sender email address on flow and campaign emails.",
      "type": "string",
      "example": "contact@klaviyo-demo.com"
    },
    "website_url": {
      "type": "string",
      "example": "https://www.klaviyo.com",
      "nullable": true
    },
    "organization_name": {
      "type": "string",
      "example": "Klaviyo Demo"
    },
    "street_address": {
      "description": "Street address for your organization.",
      "$ref": "#/components/schemas/StreetAddress"
    }
  },
  "required": [
    "default_sender_name",
    "default_sender_email",
    "organization_name",
    "street_address"
  ]
}

{
  "type": "string",
  "enum": [
    "conversation"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ConversationEnum"
    },
    "id": {
      "type": "string"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "channel": {
          "description": "The messaging channel of the conversation.",
          "type": "string",
          "enum": [
            "instagram",
            "sms",
            "whatsapp"
          ]
        }
      },
      "required": [
        "channel"
      ]
    },
    "relationships": {
      "type": "object",
      "properties": {
        "profile": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "type": {
                  "$ref": "#/components/schemas/ProfileEnum"
                },
                "id": {
                  "type": "string"
                }
              },
              "required": [
                "type",
                "id"
              ]
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    }
  },
  "required": [
    "type",
    "id",
    "attributes",
    "links"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "custom_source"
      ]
    },
    "filter": {
      "$ref": "#/components/schemas/EqualsStringFilter"
    }
  },
  "required": [
    "field",
    "filter"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "method"
      ]
    },
    "method": {
      "type": "string",
      "enum": [
        "data_warehouse_import"
      ]
    }
  },
  "required": [
    "field",
    "method"
  ]
}

{
  "type": "object",
  "properties": {
    "device_id": {
      "description": "Relatively stable ID for the device. Will update on app uninstall and reinstall",
      "type": "string",
      "example": "1234567890",
      "nullable": true
    },
    "klaviyo_sdk": {
      "description": "The name of the SDK used to create the push token.",
      "type": "string",
      "example": "swift",
      "enum": [
        "android",
        "flutter",
        "flutter_community",
        "react_native",
        "swift"
      ],
      "nullable": true
    },
    "sdk_version": {
      "description": "The version of the SDK used to create the push token",
      "type": "string",
      "example": "1.0.0",
      "nullable": true
    },
    "device_model": {
      "description": "The model of the device",
      "type": "string",
      "example": "iPhone12,1",
      "nullable": true
    },
    "os_name": {
      "description": "The name of the operating system on the device.",
      "type": "string",
      "example": "ios",
      "enum": [
        "android",
        "ios",
        "ipados",
        "macos",
        "tvos"
      ],
      "nullable": true
    },
    "os_version": {
      "description": "The version of the operating system on the device",
      "type": "string",
      "example": "14.0",
      "nullable": true
    },
    "manufacturer": {
      "description": "The manufacturer of the device",
      "type": "string",
      "example": "Apple",
      "nullable": true
    },
    "app_name": {
      "description": "The name of the app that created the push token",
      "type": "string",
      "example": "Klaviyo",
      "nullable": true
    },
    "app_version": {
      "description": "The version of the app that created the push token",
      "type": "string",
      "example": "1.0.0",
      "nullable": true
    },
    "app_build": {
      "description": "The build of the app that created the push token",
      "type": "string",
      "example": "1",
      "nullable": true
    },
    "app_id": {
      "description": "The ID of the app that created the push token",
      "type": "string",
      "example": "com.klaviyo.app",
      "nullable": true
    },
    "environment": {
      "description": "The environment in which the push token was created",
      "type": "string",
      "example": "release",
      "enum": [
        "debug",
        "release"
      ],
      "nullable": true
    }
  }
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "is_double_opt_in"
      ]
    },
    "filter": {
      "$ref": "#/components/schemas/BooleanFilter"
    }
  },
  "required": [
    "field",
    "filter"
  ]
}

{
  "type": "object",
  "properties": {
    "marketing": {
      "description": "The email marketing subscription.",
      "$ref": "#/components/schemas/EmailMarketing",
      "nullable": true
    },
    "open_tracking": {
      "description": "The email open tracking consent.",
      "$ref": "#/components/schemas/OpenTrackingConsent",
      "nullable": true
    },
    "click_tracking": {
      "description": "The email click tracking consent.",
      "$ref": "#/components/schemas/ClickTrackingConsent",
      "nullable": true
    }
  }
}

{
  "type": "object",
  "properties": {
    "can_receive_email_marketing": {
      "description": "Whether or not this profile has implicit consent to receive email marketing. True if it does profile does not have any global suppressions.",
      "type": "boolean"
    },
    "consent": {
      "description": "The consent status for email marketing.",
      "type": "string",
      "example": "SUBSCRIBED"
    },
    "consent_timestamp": {
      "description": "The timestamp when consent was recorded 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",
      "nullable": true
    },
    "last_updated": {
      "description": "The timestamp when a field on the email marketing object was last modified.",
      "type": "string",
      "format": "date-time",
      "example": "2023-02-21T20:07:38+00:00",
      "nullable": true
    },
    "method": {
      "description": "The method by which the profile was subscribed to email marketing.",
      "type": "string",
      "example": "PREFERENCE_PAGE",
      "nullable": true
    },
    "method_detail": {
      "description": "Additional details about the method by which the profile was subscribed to email marketing. This may be empty if no details were provided.",
      "type": "string",
      "example": "mydomain.com/signup",
      "default": "",
      "nullable": true
    },
    "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",
      "nullable": true
    },
    "double_optin": {
      "description": "Whether the profile was subscribed to email marketing using a double opt-in.",
      "type": "boolean",
      "example": true,
      "nullable": true
    },
    "suppression": {
      "description": "The global email marketing suppression for this profile.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EmailMarketingSuppression"
      },
      "nullable": true
    },
    "list_suppressions": {
      "description": "The list suppressions for this profile.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EmailMarketingListSuppression"
      },
      "nullable": true
    }
  },
  "required": [
    "can_receive_email_marketing",
    "consent"
  ]
}

{
  "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"
  ]
}

{
  "type": "object",
  "properties": {
    "reason": {
      "description": "The reason the profile was suppressed.",
      "type": "string",
      "example": "HARD_BOUNCE",
      "enum": [
        "HARD_BOUNCE",
        "INVALID_EMAIL",
        "SPAM_COMPLAINT",
        "UNSUBSCRIBE",
        "USER_SUPPRESSED"
      ]
    },
    "timestamp": {
      "description": "The timestamp when the profile was suppressed, 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"
  ]
}

{
  "type": "object",
  "properties": {
    "marketing": {
      "description": "The parameters to subscribe to on the \"EMAIL\" Channel. Currently supports \"MARKETING\".",
      "$ref": "#/components/schemas/SubscriptionParameters",
      "nullable": true
    },
    "open_tracking": {
      "description": "The open-tracking consent to grant on the \"EMAIL\" channel. Open-tracking consent is recorded on the profile only; it does not by itself add the profile to a list specified in the request.",
      "$ref": "#/components/schemas/OpenTrackingSubscriptionParameters",
      "nullable": true
    },
    "click_tracking": {
      "description": "The click-tracking consent to grant on the \"EMAIL\" channel. Click-tracking consent is recorded on the profile only; it does not by itself add the profile to a list specified in the request.",
      "$ref": "#/components/schemas/ClickTrackingSubscriptionParameters",
      "nullable": true
    }
  }
}

{
  "type": "object",
  "properties": {
    "marketing": {
      "description": "The parameters to unsubscribe from marketing on the \"EMAIL\" channel.",
      "$ref": "#/components/schemas/UnsubscriptionParameters",
      "nullable": true
    },
    "open_tracking": {
      "description": "The open-tracking consent to revoke on the \"EMAIL\" channel.",
      "$ref": "#/components/schemas/OpenTrackingUnsubscriptionParameters",
      "nullable": true
    },
    "click_tracking": {
      "description": "The click-tracking consent to revoke on the \"EMAIL\" channel.",
      "$ref": "#/components/schemas/ClickTrackingUnsubscriptionParameters",
      "nullable": true
    }
  }
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "string"
      ]
    },
    "operator": {
      "type": "string",
      "enum": [
        "equals"
      ]
    },
    "value": {
      "type": "string",
      "nullable": true
    }
  },
  "required": [
    "type",
    "operator",
    "value"
  ]
}

{
  "type": "object",
  "properties": {
    "pointer": {
      "description": "A pointer to the source of the error in the request payload.",
      "type": "string",
      "example": "/data",
      "default": "/data",
      "nullable": true
    }
  }
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "existence"
      ]
    },
    "operator": {
      "description": "Operators for existence filters.",
      "type": "string",
      "enum": [
        "is-set",
        "not-set"
      ]
    }
  },
  "required": [
    "type",
    "operator"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "method"
      ]
    },
    "method": {
      "type": "string",
      "enum": [
        "failed_age_gate"
      ]
    }
  },
  "required": [
    "field",
    "method"
  ]
}

{
  "type": "string",
  "enum": [
    "flow-action"
  ]
}

{
  "type": "string",
  "enum": [
    "flow"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/FlowEnum"
    },
    "id": {
      "type": "string"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "nullable": true
        },
        "status": {
          "type": "string",
          "nullable": true
        },
        "archived": {
          "type": "boolean",
          "nullable": true
        },
        "created": {
          "type": "string",
          "format": "date-time",
          "example": "2022-11-08T00:00:00+00:00",
          "nullable": true
        },
        "updated": {
          "type": "string",
          "format": "date-time",
          "example": "2022-11-08T00:00:00+00:00",
          "nullable": true
        },
        "trigger_type": {
          "description": "Corresponds to the object which triggered the flow.",
          "type": "string",
          "enum": [
            "Added to List",
            "Date Based",
            "Low Inventory",
            "Metric",
            "Price Drop",
            "Unconfigured"
          ],
          "nullable": true
        }
      }
    },
    "relationships": {
      "type": "object",
      "properties": {
        "flow-actions": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/FlowActionEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "tags": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/TagEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    }
  },
  "required": [
    "type",
    "id",
    "attributes",
    "links"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "method"
      ]
    },
    "method": {
      "type": "string",
      "enum": [
        "form"
      ]
    },
    "filter": {
      "description": "Optional filter on a specific list of form ids",
      "$ref": "#/components/schemas/InStringArrayFilter",
      "nullable": true
    }
  },
  "required": [
    "field",
    "method"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/AccountResponseObjectResource"
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AccountResponseObjectResource"
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/BulkProfileSuppressionsCreateJobResponseObjectResource"
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BulkProfileSuppressionsCreateJobResponseObjectResource"
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/BulkProfileSuppressionsRemoveJobResponseObjectResource"
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BulkProfileSuppressionsRemoveJobResponseObjectResource"
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ConversationResponseObjectResource"
        }
      ],
      "nullable": true
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ConversationResponseObjectResource"
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/FlowResponseObjectResource"
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ImportErrorResponseObjectResource"
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "type",
          "id"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/FlowEnum"
          },
          "id": {
            "type": "string"
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ListListResponseObjectResource"
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    },
    "included": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/TagResponseObjectResource"
          },
          {
            "$ref": "#/components/schemas/FlowResponseObjectResource"
          }
        ]
      }
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "properties": {
              "type": {
                "$ref": "#/components/schemas/ProfileEnum"
              },
              "attributes": {
                "properties": {
                  "subscriptions": {
                    "$ref": "#/components/schemas/Subscriptions",
                    "nullable": true
                  },
                  "predictive_analytics": {
                    "$ref": "#/components/schemas/PredictiveAnalytics",
                    "nullable": true
                  }
                }
              }
            }
          },
          {
            "$ref": "#/components/schemas/ListMemberResponseObjectResource"
          }
        ]
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "type",
          "id"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/ProfileEnum"
          },
          "id": {
            "description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
            "type": "string",
            "example": "01GDDKASAP8TKDDA2GRZDSVP4H"
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ListResponseObjectResource"
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "allOf": [
        {
          "properties": {
            "type": {
              "$ref": "#/components/schemas/ListEnum"
            },
            "attributes": {
              "properties": {
                "profile_count": {
                  "type": "integer",
                  "nullable": true
                }
              }
            }
          }
        },
        {
          "$ref": "#/components/schemas/ListRetrieveResponseObjectResource"
        }
      ]
    },
    "included": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/TagResponseObjectResource"
          },
          {
            "$ref": "#/components/schemas/FlowResponseObjectResource"
          }
        ]
      }
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "type",
          "id"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/TagEnum"
          },
          "id": {
            "description": "The Tag ID",
            "type": "string",
            "example": "abcd1234-ef56-gh78-ij90-abcdef123456"
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "type",
          "id"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/ListEnum"
          },
          "id": {
            "description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
            "type": "string",
            "example": "Y6nRLr"
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "type",
          "id"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/ProfileEnum"
          },
          "id": {
            "description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
            "type": "string",
            "example": "01GDDKASAP8TKDDA2GRZDSVP4H"
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "nullable": true,
      "properties": {
        "type": {
          "$ref": "#/components/schemas/ConversationEnum"
        },
        "id": {
          "type": "string"
        }
      },
      "required": [
        "type",
        "id"
      ]
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "type",
          "id"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/ConversationEnum"
          },
          "id": {
            "type": "string"
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ProfileImportJobResponseObjectResource"
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/ProfileImportJobResponseObjectResource"
    },
    "included": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ListResponseObjectResource"
      }
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "type",
          "id"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/ListEnum"
          },
          "id": {
            "description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
            "type": "string",
            "example": "Y6nRLr"
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "type",
          "id"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/PushTokenEnum"
          },
          "id": {
            "description": "ID of push token",
            "type": "string"
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "allOf": [
        {
          "properties": {
            "type": {
              "$ref": "#/components/schemas/ProfileEnum"
            },
            "attributes": {
              "properties": {
                "subscriptions": {
                  "$ref": "#/components/schemas/Subscriptions",
                  "nullable": true
                },
                "predictive_analytics": {
                  "$ref": "#/components/schemas/PredictiveAnalytics",
                  "nullable": true
                }
              }
            }
          }
        },
        {
          "$ref": "#/components/schemas/ProfileResponseObjectResource"
        }
      ],
      "nullable": true
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "properties": {
              "type": {
                "$ref": "#/components/schemas/ProfileEnum"
              },
              "attributes": {
                "properties": {
                  "subscriptions": {
                    "$ref": "#/components/schemas/Subscriptions",
                    "nullable": true
                  },
                  "predictive_analytics": {
                    "$ref": "#/components/schemas/PredictiveAnalytics",
                    "nullable": true
                  }
                }
              }
            }
          },
          {
            "$ref": "#/components/schemas/ProfileResponseObjectResource"
          }
        ]
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "properties": {
              "type": {
                "$ref": "#/components/schemas/ProfileEnum"
              },
              "attributes": {
                "properties": {
                  "subscriptions": {
                    "$ref": "#/components/schemas/Subscriptions",
                    "nullable": true
                  },
                  "predictive_analytics": {
                    "$ref": "#/components/schemas/PredictiveAnalytics",
                    "nullable": true
                  }
                }
              }
            }
          },
          {
            "$ref": "#/components/schemas/ProfileResponsePluralConversationsObjectResource"
          }
        ]
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    },
    "included": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/ConversationResponseObjectResource"
          },
          {
            "$ref": "#/components/schemas/PushTokenResponseObjectResource"
          }
        ]
      }
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "allOf": [
        {
          "properties": {
            "type": {
              "$ref": "#/components/schemas/ProfileEnum"
            },
            "attributes": {
              "properties": {
                "subscriptions": {
                  "$ref": "#/components/schemas/Subscriptions",
                  "nullable": true
                },
                "predictive_analytics": {
                  "$ref": "#/components/schemas/PredictiveAnalytics",
                  "nullable": true
                }
              }
            }
          }
        },
        {
          "$ref": "#/components/schemas/ProfileResponsePluralConversationsObjectResource"
        }
      ]
    },
    "included": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/ListResponseObjectResource"
          },
          {
            "$ref": "#/components/schemas/SegmentResponseObjectResource"
          },
          {
            "$ref": "#/components/schemas/ConversationResponseObjectResource"
          },
          {
            "$ref": "#/components/schemas/PushTokenResponseObjectResource"
          }
        ]
      }
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "type",
          "id"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/SegmentEnum"
          },
          "id": {
            "type": "string"
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "nullable": true,
      "properties": {
        "type": {
          "$ref": "#/components/schemas/ProfileEnum"
        },
        "id": {
          "description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
          "type": "string",
          "example": "01GDDKASAP8TKDDA2GRZDSVP4H"
        }
      },
      "required": [
        "type",
        "id"
      ]
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PushTokenResponseObjectResource"
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PushTokenResponseObjectResource"
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    },
    "included": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ProfileResponseObjectResource"
      }
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/PushTokenResponseObjectResource"
    },
    "included": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ProfileResponseObjectResource"
      }
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "type",
          "id"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/FlowEnum"
          },
          "id": {
            "type": "string"
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SegmentListResponseObjectResource"
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    },
    "included": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/TagResponseObjectResource"
          },
          {
            "$ref": "#/components/schemas/FlowResponseObjectResource"
          }
        ]
      }
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "properties": {
              "type": {
                "$ref": "#/components/schemas/ProfileEnum"
              },
              "attributes": {
                "properties": {
                  "subscriptions": {
                    "$ref": "#/components/schemas/Subscriptions",
                    "nullable": true
                  },
                  "predictive_analytics": {
                    "$ref": "#/components/schemas/PredictiveAnalytics",
                    "nullable": true
                  }
                }
              }
            }
          },
          {
            "$ref": "#/components/schemas/SegmentMemberResponseObjectResource"
          }
        ]
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "type",
          "id"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/ProfileEnum"
          },
          "id": {
            "description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
            "type": "string",
            "example": "01GDDKASAP8TKDDA2GRZDSVP4H"
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SegmentResponseObjectResource"
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "allOf": [
        {
          "properties": {
            "type": {
              "$ref": "#/components/schemas/SegmentEnum"
            },
            "attributes": {
              "properties": {
                "profile_count": {
                  "type": "integer",
                  "nullable": true
                }
              }
            }
          }
        },
        {
          "$ref": "#/components/schemas/SegmentRetrieveResponseObjectResource"
        }
      ]
    },
    "included": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/TagResponseObjectResource"
          },
          {
            "$ref": "#/components/schemas/FlowResponseObjectResource"
          }
        ]
      }
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "type",
          "id"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/TagEnum"
          },
          "id": {
            "description": "The Tag ID",
            "type": "string",
            "example": "abcd1234-ef56-gh78-ij90-abcdef123456"
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TagResponseObjectResource"
      }
    },
    "links": {
      "$ref": "#/components/schemas/CollectionLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "subscription": {
      "type": "string",
      "enum": [
        "any"
      ]
    },
    "filters": {
      "nullable": true
    }
  },
  "required": [
    "subscription"
  ]
}

{
  "type": "object",
  "properties": {
    "channel": {
      "type": "string",
      "enum": [
        "email"
      ]
    },
    "can_receive_marketing": {
      "type": "boolean",
      "enum": [
        true
      ]
    },
    "consent_status": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/HasEmailMarketing"
        },
        {
          "$ref": "#/components/schemas/HasEmailMarketingSubscribed"
        },
        {
          "$ref": "#/components/schemas/HasEmailMarketingNeverSubscribed"
        }
      ]
    }
  },
  "required": [
    "channel",
    "can_receive_marketing",
    "consent_status"
  ]
}

{
  "type": "object",
  "properties": {
    "subscription": {
      "type": "string",
      "enum": [
        "never_subscribed"
      ]
    },
    "filters": {
      "nullable": true
    }
  },
  "required": [
    "subscription"
  ]
}

{
  "type": "object",
  "properties": {
    "subscription": {
      "type": "string",
      "enum": [
        "subscribed"
      ]
    },
    "filters": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/DoubleOptinFilter"
          },
          {
            "$ref": "#/components/schemas/StatusDateFilter"
          },
          {
            "$ref": "#/components/schemas/CustomSourceFilter"
          },
          {
            "$ref": "#/components/schemas/FormMethodFilter"
          },
          {
            "$ref": "#/components/schemas/PreferencePageFilter"
          },
          {
            "$ref": "#/components/schemas/APIMethodFilter"
          },
          {
            "$ref": "#/components/schemas/InboundMessageMethodFilter"
          },
          {
            "$ref": "#/components/schemas/BackInStockMethodFilter"
          },
          {
            "$ref": "#/components/schemas/SftpMethodFilter"
          },
          {
            "$ref": "#/components/schemas/ManualImportManualMethodFilter"
          },
          {
            "$ref": "#/components/schemas/ManualAddManualMethodFilter"
          },
          {
            "$ref": "#/components/schemas/ShopifyIntegrationMethodFilter"
          }
        ]
      },
      "nullable": true
    }
  },
  "required": [
    "subscription"
  ]
}

{
  "type": "object",
  "properties": {
    "subscription": {
      "type": "string",
      "enum": [
        "any"
      ]
    },
    "filters": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StatusDateFilter"
      },
      "nullable": true
    }
  },
  "required": [
    "subscription"
  ]
}

{
  "type": "object",
  "properties": {
    "channel": {
      "type": "string",
      "enum": [
        "push"
      ]
    },
    "can_receive_marketing": {
      "type": "boolean",
      "enum": [
        true
      ]
    },
    "consent_status": {
      "$ref": "#/components/schemas/HasPushMarketing"
    }
  },
  "required": [
    "channel",
    "can_receive_marketing",
    "consent_status"
  ]
}

{
  "type": "object",
  "properties": {
    "channel": {
      "type": "string",
      "enum": [
        "sms"
      ]
    },
    "can_receive_marketing": {
      "type": "boolean",
      "enum": [
        true
      ]
    },
    "consent_status": {
      "$ref": "#/components/schemas/HasSMSMarketingSubscribed"
    }
  },
  "required": [
    "channel",
    "can_receive_marketing",
    "consent_status"
  ]
}

{
  "type": "object",
  "properties": {
    "subscription": {
      "type": "string",
      "enum": [
        "subscribed"
      ]
    },
    "filters": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/StatusDateFilter"
          },
          {
            "$ref": "#/components/schemas/FormMethodFilter"
          },
          {
            "$ref": "#/components/schemas/ManualImportManualMethodFilter"
          },
          {
            "$ref": "#/components/schemas/ManualAddManualMethodFilter"
          },
          {
            "$ref": "#/components/schemas/CheckoutMethodFilter"
          },
          {
            "$ref": "#/components/schemas/InboundMessageMethodFilter"
          },
          {
            "$ref": "#/components/schemas/PreferencePageMethodFilter"
          },
          {
            "$ref": "#/components/schemas/SftpMethodFilter"
          },
          {
            "$ref": "#/components/schemas/ShopifyIntegrationMethodFilter"
          },
          {
            "$ref": "#/components/schemas/SubscribedSMSIsRcsCapableFilter"
          }
        ]
      },
      "nullable": true
    }
  },
  "required": [
    "subscription"
  ]
}

{
  "type": "string",
  "enum": [
    "import-error"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ImportErrorEnum"
    },
    "id": {
      "description": "Unique identifier for the error.",
      "type": "string",
      "example": "e4eebb08-b055-4a6f-bb13-c8cb69c9eb94"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "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"
        },
        "original_payload": {
          "type": "object",
          "nullable": true
        }
      },
      "required": [
        "code",
        "title",
        "detail",
        "source"
      ]
    }
  },
  "required": [
    "type",
    "id",
    "attributes"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "string"
      ]
    },
    "operator": {
      "type": "string",
      "enum": [
        "in"
      ]
    },
    "value": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "type",
    "operator",
    "value"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "method"
      ]
    },
    "method": {
      "type": "string",
      "enum": [
        "inbound_message"
      ]
    }
  },
  "required": [
    "field",
    "method"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "invalid_email_date"
      ]
    },
    "filter": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/StaticDateFilter"
        },
        {
          "$ref": "#/components/schemas/StaticDateRangeFilter"
        },
        {
          "$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
        },
        {
          "$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
        },
        {
          "$ref": "#/components/schemas/RelativeDateRangeFilter"
        },
        {
          "$ref": "#/components/schemas/CalendarDateFilter"
        },
        {
          "$ref": "#/components/schemas/AnniversaryDateFilter"
        },
        {
          "$ref": "#/components/schemas/IsSetExistenceFilter"
        }
      ]
    }
  },
  "required": [
    "field",
    "filter"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "existence"
      ]
    },
    "operator": {
      "type": "string",
      "enum": [
        "is-set"
      ]
    }
  },
  "required": [
    "type",
    "operator"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/ListCreateQueryResourceObject"
    }
  },
  "required": [
    "data"
  ]
}

{
  "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"
        },
        "opt_in_process": {
          "description": "The opt-in process for this list. Valid values: 'double_opt_in', 'single_opt_in'. If not provided, uses account default.",
          "type": "string",
          "example": "double_opt_in",
          "enum": [
            "double_opt_in",
            "single_opt_in"
          ],
          "nullable": true
        }
      },
      "required": [
        "name"
      ]
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}

{
  "type": "string",
  "enum": [
    "list"
  ]
}

{
  "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",
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "opt_in_process": {
          "description": "The opt-in process for this list. Valid values: 'double_opt_in', 'single_opt_in'.",
          "type": "string",
          "example": "double_opt_in",
          "enum": [
            "double_opt_in",
            "single_opt_in"
          ],
          "nullable": true
        }
      }
    },
    "relationships": {
      "type": "object",
      "properties": {
        "profiles": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/ProfileEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "tags": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/TagEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "flow-triggers": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/FlowEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    }
  },
  "required": [
    "type",
    "id",
    "attributes",
    "links"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ProfileEnum"
    },
    "id": {
      "description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
      "type": "string",
      "example": "01GDDKASAP8TKDDA2GRZDSVP4H",
      "nullable": true
    },
    "attributes": {
      "type": "object",
      "properties": {
        "email": {
          "description": "Individual's email address",
          "type": "string",
          "example": "sarah.mason@klaviyo-demo.com",
          "nullable": true
        },
        "phone_number": {
          "description": "Individual's phone number in E.164 format",
          "type": "string",
          "example": "+15005550006",
          "nullable": true
        },
        "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",
          "nullable": true
        },
        "first_name": {
          "description": "Individual's first name",
          "type": "string",
          "example": "Sarah",
          "nullable": true
        },
        "last_name": {
          "description": "Individual's last name",
          "type": "string",
          "example": "Mason",
          "nullable": true
        },
        "organization": {
          "description": "Name of the company or organization within the company for whom the individual works",
          "type": "string",
          "example": "Example Corporation",
          "nullable": true
        },
        "locale": {
          "description": "The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)",
          "type": "string",
          "example": "en-US",
          "nullable": true
        },
        "title": {
          "description": "Individual's job title",
          "type": "string",
          "example": "Regional Manager",
          "nullable": true
        },
        "image": {
          "description": "URL pointing to the location of a profile image",
          "type": "string",
          "example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "location": {
          "$ref": "#/components/schemas/ProfileLocation",
          "nullable": true
        },
        "properties": {
          "description": "An object containing key/value pairs for any custom properties assigned to this profile",
          "type": "object",
          "example": {
            "pseudonym": "Dr. Octopus"
          },
          "nullable": true
        },
        "joined_group_at": {
          "description": "The datetime when this profile most recently joined the list.",
          "type": "string",
          "format": "date-time",
          "example": "2022-11-08T00:00:00+00:00"
        }
      },
      "required": [
        "joined_group_at"
      ]
    },
    "relationships": {
      "type": "object",
      "properties": {
        "lists": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/ListEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "segments": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/SegmentEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "push-tokens": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/PushTokenEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    }
  },
  "required": [
    "type",
    "attributes",
    "links"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "type",
          "id"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/ProfileEnum"
          },
          "id": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "type",
          "id"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/ProfileEnum"
          },
          "id": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/ListPartialUpdateQueryResourceObject"
    }
  },
  "required": [
    "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",
          "nullable": true
        },
        "opt_in_process": {
          "description": "The opt-in process for this list. Valid values: 'double_opt_in', 'single_opt_in'.",
          "type": "string",
          "example": "double_opt_in",
          "enum": [
            "double_opt_in",
            "single_opt_in"
          ],
          "nullable": true
        }
      }
    }
  },
  "required": [
    "type",
    "id",
    "attributes"
  ]
}

{
  "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",
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "opt_in_process": {
          "description": "The opt-in process for this list. Valid values: 'double_opt_in', 'single_opt_in'.",
          "type": "string",
          "example": "double_opt_in",
          "enum": [
            "double_opt_in",
            "single_opt_in"
          ],
          "nullable": true
        }
      }
    },
    "relationships": {
      "type": "object",
      "properties": {
        "profiles": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/ProfileEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "tags": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/TagEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "flow-triggers": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/FlowEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    }
  },
  "required": [
    "type",
    "id",
    "attributes",
    "links"
  ]
}

{
  "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",
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "opt_in_process": {
          "description": "The opt-in process for this list. Valid values: 'double_opt_in', 'single_opt_in'.",
          "type": "string",
          "example": "double_opt_in",
          "enum": [
            "double_opt_in",
            "single_opt_in"
          ],
          "nullable": true
        }
      }
    },
    "relationships": {
      "type": "object",
      "properties": {
        "profiles": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/ProfileEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "tags": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/TagEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "flow-triggers": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/FlowEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    }
  },
  "required": [
    "type",
    "id",
    "attributes",
    "links"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "method"
      ]
    },
    "method": {
      "type": "string",
      "enum": [
        "mailbox_provider"
      ]
    }
  },
  "required": [
    "field",
    "method"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "method"
      ]
    },
    "method": {
      "type": "string",
      "enum": [
        "manual_add"
      ]
    },
    "filter": {
      "description": "Optional filter on a specific list of user email addresses who initiated the manual action",
      "$ref": "#/components/schemas/InStringArrayFilter",
      "nullable": true
    }
  },
  "required": [
    "field",
    "method"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "method"
      ]
    },
    "method": {
      "type": "string",
      "enum": [
        "manual_import"
      ]
    },
    "filter": {
      "description": "Optional filter on a specific list of user email addresses who initiated the manual action",
      "$ref": "#/components/schemas/InStringArrayFilter",
      "nullable": true
    }
  },
  "required": [
    "field",
    "method"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "method"
      ]
    },
    "method": {
      "type": "string",
      "enum": [
        "manual_import"
      ]
    }
  },
  "required": [
    "field",
    "method"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "method"
      ]
    },
    "method": {
      "type": "string",
      "enum": [
        "manual_remove"
      ]
    }
  },
  "required": [
    "field",
    "method"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "manual_suppression_date"
      ]
    },
    "filter": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/StaticDateFilter"
        },
        {
          "$ref": "#/components/schemas/StaticDateRangeFilter"
        },
        {
          "$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
        },
        {
          "$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
        },
        {
          "$ref": "#/components/schemas/RelativeDateRangeFilter"
        },
        {
          "$ref": "#/components/schemas/CalendarDateFilter"
        },
        {
          "$ref": "#/components/schemas/AnniversaryDateFilter"
        },
        {
          "$ref": "#/components/schemas/IsSetExistenceFilter"
        }
      ]
    }
  },
  "required": [
    "field",
    "filter"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "method"
      ]
    },
    "method": {
      "type": "string",
      "enum": [
        "message_blocked"
      ]
    }
  },
  "required": [
    "field",
    "method"
  ]
}

{
  "type": "object",
  "properties": {
    "subscription": {
      "type": "string",
      "enum": [
        "any"
      ]
    },
    "filters": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/BounceDateFilter"
          },
          {
            "$ref": "#/components/schemas/ManualSuppressionDateFilter"
          },
          {
            "$ref": "#/components/schemas/InvalidEmailDateFilter"
          }
        ]
      },
      "nullable": true
    }
  },
  "required": [
    "subscription"
  ]
}

{
  "type": "object",
  "properties": {
    "channel": {
      "type": "string",
      "enum": [
        "email"
      ]
    },
    "can_receive_marketing": {
      "type": "boolean",
      "enum": [
        false
      ]
    },
    "consent_status": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/NoEmailMarketing"
        },
        {
          "$ref": "#/components/schemas/NoEmailMarketingUnsubscribed"
        },
        {
          "$ref": "#/components/schemas/NoEmailMarketingNeverSubscribed"
        },
        {
          "$ref": "#/components/schemas/NoEmailMarketingSubscribed"
        }
      ]
    }
  },
  "required": [
    "channel",
    "can_receive_marketing",
    "consent_status"
  ]
}

{
  "type": "object",
  "properties": {
    "subscription": {
      "type": "string",
      "enum": [
        "never_subscribed"
      ]
    },
    "filters": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/BounceDateFilter"
          },
          {
            "$ref": "#/components/schemas/ManualSuppressionDateFilter"
          },
          {
            "$ref": "#/components/schemas/InvalidEmailDateFilter"
          }
        ]
      }
    }
  },
  "required": [
    "subscription",
    "filters"
  ]
}

{
  "type": "object",
  "properties": {
    "subscription": {
      "type": "string",
      "enum": [
        "subscribed"
      ]
    },
    "filters": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/BounceDateFilter"
          },
          {
            "$ref": "#/components/schemas/ManualSuppressionDateFilter"
          },
          {
            "$ref": "#/components/schemas/InvalidEmailDateFilter"
          }
        ]
      }
    }
  },
  "required": [
    "subscription",
    "filters"
  ]
}

{
  "type": "object",
  "properties": {
    "subscription": {
      "type": "string",
      "enum": [
        "unsubscribed"
      ]
    },
    "filters": {
      "nullable": true,
      "oneOf": [
        {
          "type": "array",
          "items": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/StatusDateFilter"
              },
              {
                "$ref": "#/components/schemas/APIMethodFilter"
              },
              {
                "$ref": "#/components/schemas/InboundMessageMethodFilter"
              },
              {
                "$ref": "#/components/schemas/PreferencePageMethodFilter"
              },
              {
                "$ref": "#/components/schemas/ManualRemoveMethodFilter"
              },
              {
                "$ref": "#/components/schemas/SpamComplaintMethodFilter"
              },
              {
                "$ref": "#/components/schemas/MailboxProviderMethodFilter"
              },
              {
                "$ref": "#/components/schemas/OneClickUnsubscribeMethodFilter"
              },
              {
                "$ref": "#/components/schemas/ManualImportMethodFilter"
              },
              {
                "$ref": "#/components/schemas/SftpMethodFilter"
              },
              {
                "$ref": "#/components/schemas/DataWarehouseImportMethodFilter"
              },
              {
                "$ref": "#/components/schemas/ProfileModificationMethodFilter"
              },
              {
                "$ref": "#/components/schemas/ConstantContactIntegrationMethodFilter"
              }
            ]
          }
        },
        {
          "type": "array",
          "items": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/BounceDateFilter"
              },
              {
                "$ref": "#/components/schemas/ManualSuppressionDateFilter"
              },
              {
                "$ref": "#/components/schemas/InvalidEmailDateFilter"
              }
            ]
          }
        }
      ]
    }
  },
  "required": [
    "subscription"
  ]
}

{
  "type": "object",
  "properties": {
    "subscription": {
      "type": "string",
      "enum": [
        "any"
      ]
    }
  },
  "required": [
    "subscription"
  ]
}

{
  "type": "object",
  "properties": {
    "channel": {
      "type": "string",
      "enum": [
        "push"
      ]
    },
    "can_receive_marketing": {
      "type": "boolean",
      "enum": [
        false
      ]
    },
    "consent_status": {
      "$ref": "#/components/schemas/NoPushMarketing"
    }
  },
  "required": [
    "channel",
    "can_receive_marketing",
    "consent_status"
  ]
}

{
  "type": "object",
  "properties": {
    "subscription": {
      "type": "string",
      "enum": [
        "any"
      ]
    }
  },
  "required": [
    "subscription"
  ]
}

{
  "type": "object",
  "properties": {
    "channel": {
      "type": "string",
      "enum": [
        "sms"
      ]
    },
    "can_receive_marketing": {
      "type": "boolean",
      "enum": [
        false
      ]
    },
    "consent_status": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/NoSMSMarketing"
        },
        {
          "$ref": "#/components/schemas/NoSMSMarketingUnsubscribed"
        },
        {
          "$ref": "#/components/schemas/NoSMSMarketingNeverSubscribed"
        }
      ]
    }
  },
  "required": [
    "channel",
    "can_receive_marketing",
    "consent_status"
  ]
}

{
  "type": "object",
  "properties": {
    "subscription": {
      "type": "string",
      "enum": [
        "never_subscribed"
      ]
    }
  },
  "required": [
    "subscription"
  ]
}

{
  "type": "object",
  "properties": {
    "subscription": {
      "type": "string",
      "enum": [
        "unsubscribed"
      ]
    },
    "filters": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/StatusDateFilter"
          },
          {
            "$ref": "#/components/schemas/FormMethodFilter"
          },
          {
            "$ref": "#/components/schemas/ManualImportManualMethodFilter"
          },
          {
            "$ref": "#/components/schemas/ManualAddManualMethodFilter"
          },
          {
            "$ref": "#/components/schemas/ManualRemoveMethodFilter"
          },
          {
            "$ref": "#/components/schemas/BulkRemoveMethodFilter"
          },
          {
            "$ref": "#/components/schemas/CheckoutMethodFilter"
          },
          {
            "$ref": "#/components/schemas/InboundMessageMethodFilter"
          },
          {
            "$ref": "#/components/schemas/PreferencePageMethodFilter"
          },
          {
            "$ref": "#/components/schemas/SftpMethodFilter"
          },
          {
            "$ref": "#/components/schemas/CarrierDeactivationMethodFilter"
          },
          {
            "$ref": "#/components/schemas/ProvidedLandlineMethodFilter"
          },
          {
            "$ref": "#/components/schemas/MessageBlockedMethodFilter"
          },
          {
            "$ref": "#/components/schemas/ProvidedNoAgeMethodFilter"
          },
          {
            "$ref": "#/components/schemas/FailedAgeGateMethodFilter"
          },
          {
            "$ref": "#/components/schemas/ShopifyIntegrationMethodFilter"
          }
        ]
      },
      "nullable": true
    }
  },
  "required": [
    "subscription"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "numeric"
      ]
    },
    "operator": {
      "description": "Operators for numeric filters.",
      "type": "string",
      "enum": [
        "equals",
        "greater-than",
        "greater-than-or-equal",
        "less-than",
        "less-than-or-equal",
        "not-equals"
      ]
    },
    "value": {
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "number"
        }
      ]
    }
  },
  "required": [
    "type",
    "operator",
    "value"
  ]
}

{
  "type": "object",
  "properties": {
    "self": {
      "type": "string",
      "format": "uri"
    }
  },
  "required": [
    "self"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "method"
      ]
    },
    "method": {
      "type": "string",
      "enum": [
        "one_click_unsubscribe"
      ]
    }
  },
  "required": [
    "field",
    "method"
  ]
}

{
  "type": "object",
  "properties": {
    "related": {
      "type": "string",
      "format": "uri"
    }
  },
  "required": [
    "related"
  ]
}

{
  "type": "object",
  "properties": {
    "consent": {
      "description": "The consent status for the channel.",
      "type": "string",
      "example": "SUBSCRIBED"
    },
    "consent_timestamp": {
      "description": "The timestamp when consent was recorded or updated for the channel, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
      "type": "string",
      "format": "date-time",
      "example": "2023-02-21T20:07:38+00:00",
      "nullable": true
    },
    "last_updated": {
      "description": "The timestamp when the channel was last modified, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
      "type": "string",
      "format": "date-time",
      "example": "2023-02-21T20:07:38+00:00",
      "nullable": true
    },
    "created_timestamp": {
      "description": "The timestamp when the channel was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
      "type": "string",
      "format": "date-time",
      "example": "2023-02-21T20:07:38+00:00",
      "nullable": true
    },
    "metadata": {
      "description": "Channel-specific metadata containing additional information about the permission.",
      "type": "object",
      "nullable": true
    },
    "can_receive": {
      "description": "Whether the profile can receive messages on this channel.",
      "type": "boolean"
    },
    "valid_until": {
      "description": "Optional expiration date for the permission, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
      "type": "string",
      "format": "date-time",
      "example": "2024-02-21T20:07:38+00:00",
      "nullable": true
    }
  },
  "required": [
    "consent",
    "can_receive"
  ]
}

{
  "type": "object",
  "properties": {
    "consent": {
      "description": "The open-tracking consent to grant. Currently supports \"SUBSCRIBED\".",
      "type": "string",
      "example": "SUBSCRIBED",
      "enum": [
        "SUBSCRIBED"
      ]
    }
  },
  "required": [
    "consent"
  ]
}

{
  "type": "object",
  "properties": {
    "consent": {
      "description": "The open-tracking consent to revoke. Currently supports \"UNSUBSCRIBED\".",
      "type": "string",
      "example": "UNSUBSCRIBED",
      "enum": [
        "UNSUBSCRIBED"
      ]
    }
  },
  "required": [
    "consent"
  ]
}

{
  "type": "object",
  "properties": {
    "append": {
      "type": "object"
    },
    "unappend": {
      "type": "object"
    }
  }
}

{
  "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",
              "nullable": true
            },
            "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+00:00",
              "nullable": true
            },
            "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+00:00",
              "nullable": true
            },
            "opt_in_process": {
              "description": "The opt-in process for this list. Valid values: 'double_opt_in', 'single_opt_in'.",
              "type": "string",
              "example": "double_opt_in",
              "enum": [
                "double_opt_in",
                "single_opt_in"
              ],
              "nullable": true
            }
          }
        },
        "relationships": {
          "type": "object",
          "properties": {
            "profiles": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/ProfileEnum"
                      },
                      "id": {
                        "type": "string"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/RelationshipLinks"
                }
              }
            },
            "tags": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/TagEnum"
                      },
                      "id": {
                        "type": "string"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/RelationshipLinks"
                }
              }
            },
            "flow-triggers": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/FlowEnum"
                      },
                      "id": {
                        "type": "string"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/RelationshipLinks"
                }
              }
            }
          }
        },
        "links": {
          "$ref": "#/components/schemas/ObjectLinks"
        }
      },
      "required": [
        "type",
        "id",
        "attributes",
        "links"
      ]
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "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",
          "nullable": true
        },
        "attributes": {
          "type": "object",
          "properties": {
            "email": {
              "description": "Individual's email address",
              "type": "string",
              "example": "sarah.mason@klaviyo-demo.com",
              "nullable": true
            },
            "phone_number": {
              "description": "Individual's phone number in E.164 format",
              "type": "string",
              "example": "+15005550006",
              "nullable": true
            },
            "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",
              "nullable": true
            },
            "first_name": {
              "description": "Individual's first name",
              "type": "string",
              "example": "Sarah",
              "nullable": true
            },
            "last_name": {
              "description": "Individual's last name",
              "type": "string",
              "example": "Mason",
              "nullable": true
            },
            "organization": {
              "description": "Name of the company or organization within the company for whom the individual works",
              "type": "string",
              "example": "Example Corporation",
              "nullable": true
            },
            "locale": {
              "description": "The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)",
              "type": "string",
              "example": "en-US",
              "nullable": true
            },
            "title": {
              "description": "Individual's job title",
              "type": "string",
              "example": "Regional Manager",
              "nullable": true
            },
            "image": {
              "description": "URL pointing to the location of a profile image",
              "type": "string",
              "example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
              "nullable": true
            },
            "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+00:00",
              "nullable": true
            },
            "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+00:00",
              "nullable": true
            },
            "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+00:00",
              "nullable": true
            },
            "location": {
              "$ref": "#/components/schemas/ProfileLocation",
              "nullable": true
            },
            "properties": {
              "description": "An object containing key/value pairs for any custom properties assigned to this profile",
              "type": "object",
              "example": {
                "pseudonym": "Dr. Octopus"
              },
              "nullable": true
            },
            "subscriptions": {
              "$ref": "#/components/schemas/Subscriptions",
              "nullable": true
            },
            "predictive_analytics": {
              "$ref": "#/components/schemas/PredictiveAnalytics",
              "nullable": true
            }
          }
        },
        "relationships": {
          "type": "object",
          "properties": {
            "lists": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/ListEnum"
                      },
                      "id": {
                        "type": "string"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/RelationshipLinks"
                }
              }
            },
            "segments": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/SegmentEnum"
                      },
                      "id": {
                        "type": "string"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/RelationshipLinks"
                }
              }
            },
            "push-tokens": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/PushTokenEnum"
                      },
                      "id": {
                        "type": "string"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/RelationshipLinks"
                }
              }
            }
          }
        },
        "links": {
          "$ref": "#/components/schemas/ObjectLinks"
        }
      },
      "required": [
        "type",
        "attributes",
        "links"
      ]
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "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",
              "nullable": true
            },
            "definition": {
              "$ref": "#/components/schemas/SegmentDefinition",
              "nullable": true
            },
            "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+00:00",
              "nullable": true
            },
            "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+00:00",
              "nullable": true
            },
            "is_active": {
              "description": "Whether the segment is active. Inactive segments are not processed and their membership does not update.",
              "type": "boolean"
            },
            "is_processing": {
              "type": "boolean"
            },
            "is_starred": {
              "type": "boolean"
            }
          },
          "required": [
            "is_active",
            "is_processing",
            "is_starred"
          ]
        },
        "relationships": {
          "type": "object",
          "properties": {
            "profiles": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/ProfileEnum"
                      },
                      "id": {
                        "type": "string"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/RelationshipLinks"
                }
              }
            },
            "tags": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/TagEnum"
                      },
                      "id": {
                        "type": "string"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/RelationshipLinks"
                }
              }
            },
            "flow-triggers": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/FlowEnum"
                      },
                      "id": {
                        "type": "string"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/RelationshipLinks"
                }
              }
            }
          }
        },
        "links": {
          "$ref": "#/components/schemas/ObjectLinks"
        }
      },
      "required": [
        "type",
        "id",
        "attributes",
        "links"
      ]
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/components/schemas/ProfileSuppressionBulkCreateJobEnum"
        },
        "id": {
          "description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
          "type": "string"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "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+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,
              "default": 0,
              "nullable": true
            },
            "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+00:00",
              "nullable": true
            },
            "skipped_count": {
              "description": "The total number of profiles that have been skipped as part of the job.",
              "type": "integer",
              "example": 1,
              "default": 0,
              "nullable": true
            }
          },
          "required": [
            "status",
            "created_at",
            "total_count"
          ]
        },
        "relationships": {
          "type": "object",
          "properties": {
            "lists": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/ListEnum"
                      },
                      "id": {
                        "description": "Suppress/Unsuppress all profiles in this list",
                        "type": "string",
                        "example": "Y6nRLr"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/RelationshipLinks"
                }
              }
            },
            "segments": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/SegmentEnum"
                      },
                      "id": {
                        "description": "Suppress/Unsuppress all profiles in this segment",
                        "type": "string",
                        "example": "Y6nRLr"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/RelationshipLinks"
                }
              }
            }
          }
        },
        "links": {
          "$ref": "#/components/schemas/ObjectLinks"
        }
      },
      "required": [
        "type",
        "id",
        "attributes",
        "links"
      ]
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/components/schemas/ProfileSuppressionBulkDeleteJobEnum"
        },
        "id": {
          "description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
          "type": "string"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "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+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,
              "default": 0,
              "nullable": true
            },
            "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+00:00",
              "nullable": true
            },
            "skipped_count": {
              "description": "The total number of profiles that have been skipped as part of the job.",
              "type": "integer",
              "example": 1,
              "default": 0,
              "nullable": true
            }
          },
          "required": [
            "status",
            "created_at",
            "total_count"
          ]
        },
        "relationships": {
          "type": "object",
          "properties": {
            "lists": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/ListEnum"
                      },
                      "id": {
                        "description": "Suppress/Unsuppress all profiles in this list",
                        "type": "string",
                        "example": "Y6nRLr"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/RelationshipLinks"
                }
              }
            },
            "segments": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/SegmentEnum"
                      },
                      "id": {
                        "description": "Suppress/Unsuppress all profiles in this segment",
                        "type": "string",
                        "example": "Y6nRLr"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/RelationshipLinks"
                }
              }
            }
          }
        },
        "links": {
          "$ref": "#/components/schemas/ObjectLinks"
        }
      },
      "required": [
        "type",
        "id",
        "attributes",
        "links"
      ]
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "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",
              "nullable": true
            },
            "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+00:00",
              "nullable": true
            },
            "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+00:00",
              "nullable": true
            },
            "opt_in_process": {
              "description": "The opt-in process for this list. Valid values: 'double_opt_in', 'single_opt_in'.",
              "type": "string",
              "example": "double_opt_in",
              "enum": [
                "double_opt_in",
                "single_opt_in"
              ],
              "nullable": true
            }
          }
        },
        "relationships": {
          "type": "object",
          "properties": {
            "profiles": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/ProfileEnum"
                      },
                      "id": {
                        "type": "string"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/RelationshipLinks"
                }
              }
            },
            "tags": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/TagEnum"
                      },
                      "id": {
                        "type": "string"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/RelationshipLinks"
                }
              }
            },
            "flow-triggers": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/FlowEnum"
                      },
                      "id": {
                        "type": "string"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/RelationshipLinks"
                }
              }
            }
          }
        },
        "links": {
          "$ref": "#/components/schemas/ObjectLinks"
        }
      },
      "required": [
        "type",
        "id",
        "attributes",
        "links"
      ]
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/components/schemas/ProfileBulkImportJobEnum"
        },
        "id": {
          "description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
          "type": "string"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "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+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,
              "default": 0,
              "nullable": true
            },
            "failed_count": {
              "description": "The total number of operations that have failed as part of the job.",
              "type": "integer",
              "example": 1,
              "default": 0,
              "nullable": true
            },
            "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+00:00",
              "nullable": true
            },
            "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+00:00",
              "nullable": true
            },
            "started_at": {
              "description": "Date and time the job started processing in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
              "type": "string",
              "format": "date-time",
              "example": "2022-11-08T00:00:00+00:00",
              "nullable": true
            }
          },
          "required": [
            "status",
            "created_at",
            "total_count"
          ]
        },
        "relationships": {
          "type": "object",
          "properties": {
            "lists": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/ListEnum"
                      },
                      "id": {
                        "description": "List to add the profiles to",
                        "type": "string"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/RelationshipLinks"
                }
              }
            },
            "profiles": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/ProfileEnum"
                      },
                      "id": {
                        "description": "IDs of the created/updated profiles",
                        "type": "string"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/RelationshipLinks"
                }
              }
            },
            "import-errors": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/ImportErrorEnum"
                      },
                      "id": {
                        "description": "Errors encountering during import",
                        "type": "string"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/OnlyRelatedLinks"
                }
              }
            }
          }
        },
        "links": {
          "$ref": "#/components/schemas/ObjectLinks"
        }
      },
      "required": [
        "type",
        "id",
        "attributes",
        "links"
      ]
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/components/schemas/ProfileEnum"
        },
        "id": {
          "description": "The ID of the destination profile that was merged into",
          "type": "string",
          "example": "01GDDKASAP8TKDDA2GRZDSVP4H"
        },
        "links": {
          "$ref": "#/components/schemas/ObjectLinks"
        }
      },
      "required": [
        "type",
        "id",
        "links"
      ]
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "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",
          "nullable": true
        },
        "attributes": {
          "type": "object",
          "properties": {
            "email": {
              "description": "Individual's email address",
              "type": "string",
              "example": "sarah.mason@klaviyo-demo.com",
              "nullable": true
            },
            "phone_number": {
              "description": "Individual's phone number in E.164 format",
              "type": "string",
              "example": "+15005550006",
              "nullable": true
            },
            "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",
              "nullable": true
            },
            "first_name": {
              "description": "Individual's first name",
              "type": "string",
              "example": "Sarah",
              "nullable": true
            },
            "last_name": {
              "description": "Individual's last name",
              "type": "string",
              "example": "Mason",
              "nullable": true
            },
            "organization": {
              "description": "Name of the company or organization within the company for whom the individual works",
              "type": "string",
              "example": "Example Corporation",
              "nullable": true
            },
            "locale": {
              "description": "The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)",
              "type": "string",
              "example": "en-US",
              "nullable": true
            },
            "title": {
              "description": "Individual's job title",
              "type": "string",
              "example": "Regional Manager",
              "nullable": true
            },
            "image": {
              "description": "URL pointing to the location of a profile image",
              "type": "string",
              "example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
              "nullable": true
            },
            "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+00:00",
              "nullable": true
            },
            "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+00:00",
              "nullable": true
            },
            "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+00:00",
              "nullable": true
            },
            "location": {
              "$ref": "#/components/schemas/ProfileLocation",
              "nullable": true
            },
            "properties": {
              "description": "An object containing key/value pairs for any custom properties assigned to this profile",
              "type": "object",
              "example": {
                "pseudonym": "Dr. Octopus"
              },
              "nullable": true
            },
            "subscriptions": {
              "$ref": "#/components/schemas/Subscriptions",
              "nullable": true
            },
            "predictive_analytics": {
              "$ref": "#/components/schemas/PredictiveAnalytics",
              "nullable": true
            }
          }
        },
        "relationships": {
          "type": "object",
          "properties": {
            "lists": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/ListEnum"
                      },
                      "id": {
                        "type": "string"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/RelationshipLinks"
                }
              }
            },
            "segments": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/SegmentEnum"
                      },
                      "id": {
                        "type": "string"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/RelationshipLinks"
                }
              }
            },
            "push-tokens": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/PushTokenEnum"
                      },
                      "id": {
                        "type": "string"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/RelationshipLinks"
                }
              }
            }
          }
        },
        "links": {
          "$ref": "#/components/schemas/ObjectLinks"
        }
      },
      "required": [
        "type",
        "attributes",
        "links"
      ]
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "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",
              "nullable": true
            },
            "definition": {
              "$ref": "#/components/schemas/SegmentDefinition",
              "nullable": true
            },
            "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+00:00",
              "nullable": true
            },
            "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+00:00",
              "nullable": true
            },
            "is_active": {
              "description": "Whether the segment is active. Inactive segments are not processed and their membership does not update.",
              "type": "boolean"
            },
            "is_processing": {
              "type": "boolean"
            },
            "is_starred": {
              "type": "boolean"
            }
          },
          "required": [
            "is_active",
            "is_processing",
            "is_starred"
          ]
        },
        "relationships": {
          "type": "object",
          "properties": {
            "profiles": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/ProfileEnum"
                      },
                      "id": {
                        "type": "string"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/RelationshipLinks"
                }
              }
            },
            "tags": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/TagEnum"
                      },
                      "id": {
                        "type": "string"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/RelationshipLinks"
                }
              }
            },
            "flow-triggers": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/FlowEnum"
                      },
                      "id": {
                        "type": "string"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/RelationshipLinks"
                }
              }
            }
          }
        },
        "links": {
          "$ref": "#/components/schemas/ObjectLinks"
        }
      },
      "required": [
        "type",
        "id",
        "attributes",
        "links"
      ]
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    },
    "meta": {
      "$ref": "#/components/schemas/ResponseMeta"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "historic_clv": {
      "description": "Total value of all historically placed orders",
      "type": "number",
      "example": 93.87,
      "nullable": true
    },
    "predicted_clv": {
      "description": "Predicted value of all placed orders in the next 365 days",
      "type": "number",
      "example": 27.24,
      "nullable": true
    },
    "total_clv": {
      "description": "Sum of historic and predicted CLV",
      "type": "number",
      "example": 121.11,
      "nullable": true
    },
    "historic_number_of_orders": {
      "description": "Number of already placed orders",
      "type": "number",
      "example": 2,
      "nullable": true
    },
    "predicted_number_of_orders": {
      "description": "Predicted number of placed orders in the next 365 days",
      "type": "number",
      "example": 0.54,
      "nullable": true
    },
    "average_days_between_orders": {
      "description": "Average number of days between orders (None if only one order has been placed)",
      "type": "number",
      "example": 189,
      "nullable": true
    },
    "average_order_value": {
      "description": "Average value of placed orders",
      "type": "number",
      "example": 46.94,
      "nullable": true
    },
    "churn_probability": {
      "description": "Probability the customer has churned",
      "type": "number",
      "example": 0.89,
      "nullable": true
    },
    "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+00:00",
      "nullable": true
    },
    "ranked_channel_affinity": {
      "description": "List of channels ranked by their predicted effectiveness for this profile, with the best channel being listed first at index 0",
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "email",
          "push",
          "sms",
          "whatsapp"
        ],
        "description": "Enum for channel name return values used in the V3 API for channel affinity for the field `ranked_channel_affinity`."
      },
      "example": [
        "sms",
        "email",
        "push"
      ],
      "nullable": true
    }
  }
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "method"
      ]
    },
    "method": {
      "type": "string",
      "enum": [
        "preference_page"
      ]
    },
    "filter": {
      "description": "Optional filter on a specific subscribe page url",
      "$ref": "#/components/schemas/EqualsStringFilter",
      "nullable": true
    }
  },
  "required": [
    "field",
    "method"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "method"
      ]
    },
    "method": {
      "type": "string",
      "enum": [
        "preference_page"
      ]
    }
  },
  "required": [
    "field",
    "method"
  ]
}

{
  "type": "string",
  "enum": [
    "profile-bulk-import-job"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/ProfileCreateQueryResourceObject"
    }
  },
  "required": [
    "data"
  ]
}

{
  "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",
          "nullable": true
        },
        "phone_number": {
          "description": "Individual's phone number in E.164 format",
          "type": "string",
          "example": "+15005550006",
          "nullable": true
        },
        "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",
          "nullable": true
        },
        "first_name": {
          "description": "Individual's first name",
          "type": "string",
          "example": "Sarah",
          "nullable": true
        },
        "last_name": {
          "description": "Individual's last name",
          "type": "string",
          "example": "Mason",
          "nullable": true
        },
        "organization": {
          "description": "Name of the company or organization within the company for whom the individual works",
          "type": "string",
          "example": "Example Corporation",
          "nullable": true
        },
        "locale": {
          "description": "The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)",
          "type": "string",
          "example": "en-US",
          "nullable": true
        },
        "title": {
          "description": "Individual's job title",
          "type": "string",
          "example": "Regional Manager",
          "nullable": true
        },
        "image": {
          "description": "URL pointing to the location of a profile image",
          "type": "string",
          "example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
          "nullable": true
        },
        "location": {
          "$ref": "#/components/schemas/ProfileLocation",
          "nullable": true
        },
        "properties": {
          "description": "An object containing key/value pairs for any custom properties assigned to this profile",
          "type": "object",
          "example": {
            "pseudonym": "Dr. Octopus"
          },
          "nullable": true
        }
      }
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}

{
  "type": "string",
  "enum": [
    "profile"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "profile-group-membership"
      ]
    },
    "is_member": {
      "type": "boolean",
      "enum": [
        true
      ]
    },
    "group_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "timeframe_filter": {
      "nullable": true,
      "oneOf": [
        {
          "$ref": "#/components/schemas/StaticDateFilter"
        },
        {
          "$ref": "#/components/schemas/StaticDateRangeFilter"
        },
        {
          "$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
        },
        {
          "$ref": "#/components/schemas/RelativeDateRangeFilter"
        }
      ]
    }
  },
  "required": [
    "type",
    "is_member",
    "group_ids"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/ProfileImportJobCreateQueryResourceObject"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ProfileBulkImportJobEnum"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "profiles": {
          "description": "Array of profiles to create or update",
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/ProfileUpsertQueryResourceObject"
              }
            }
          },
          "required": [
            "data"
          ]
        }
      },
      "required": [
        "profiles"
      ]
    },
    "relationships": {
      "type": "object",
      "properties": {
        "lists": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/ListEnum"
                  },
                  "id": {
                    "description": "Optional list to add the profiles to",
                    "type": "string",
                    "example": "VRgFBd"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ProfileBulkImportJobEnum"
    },
    "id": {
      "description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
      "type": "string"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "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+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,
          "default": 0,
          "nullable": true
        },
        "failed_count": {
          "description": "The total number of operations that have failed as part of the job.",
          "type": "integer",
          "example": 1,
          "default": 0,
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "started_at": {
          "description": "Date and time the job started processing in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
          "type": "string",
          "format": "date-time",
          "example": "2022-11-08T00:00:00+00:00",
          "nullable": true
        }
      },
      "required": [
        "status",
        "created_at",
        "total_count"
      ]
    },
    "relationships": {
      "type": "object",
      "properties": {
        "lists": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/ListEnum"
                  },
                  "id": {
                    "description": "List to add the profiles to",
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "profiles": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/ProfileEnum"
                  },
                  "id": {
                    "description": "IDs of the created/updated profiles",
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "import-errors": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/ImportErrorEnum"
                  },
                  "id": {
                    "description": "Errors encountering during import",
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/OnlyRelatedLinks"
            }
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    }
  },
  "required": [
    "type",
    "id",
    "attributes",
    "links"
  ]
}

{
  "type": "object",
  "properties": {
    "address1": {
      "description": "First line of street address",
      "type": "string",
      "example": "89 E 42nd St",
      "nullable": true
    },
    "address2": {
      "description": "Second line of street address",
      "type": "string",
      "example": "1st floor",
      "nullable": true
    },
    "city": {
      "description": "City name",
      "type": "string",
      "example": "New York",
      "nullable": true
    },
    "country": {
      "description": "Country name",
      "type": "string",
      "example": "United States",
      "nullable": true
    },
    "latitude": {
      "description": "Latitude coordinate. We recommend providing a precision of four decimal places.",
      "example": "40.7128",
      "nullable": true,
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "longitude": {
      "description": "Longitude coordinate. We recommend providing a precision of four decimal places.",
      "example": "74.0060",
      "nullable": true,
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "region": {
      "description": "Region within a country, such as state or province",
      "type": "string",
      "example": "NY",
      "nullable": true
    },
    "zip": {
      "description": "Zip code",
      "type": "string",
      "example": "10017",
      "nullable": true
    },
    "timezone": {
      "description": "Time zone name. We recommend using time zones from the IANA Time Zone Database.",
      "type": "string",
      "example": "America/New_York",
      "nullable": true
    },
    "ip": {
      "description": "IP Address",
      "type": "string",
      "example": "127.0.0.1",
      "nullable": true
    }
  }
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "profile-marketing-consent"
      ]
    },
    "consent": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/HasEmailMarketingConsent"
        },
        {
          "$ref": "#/components/schemas/NoEmailMarketingConsent"
        },
        {
          "$ref": "#/components/schemas/HasSMSMarketingConsent"
        },
        {
          "$ref": "#/components/schemas/NoSMSMarketingConsent"
        },
        {
          "$ref": "#/components/schemas/HasPushMarketingConsent"
        },
        {
          "$ref": "#/components/schemas/NoPushMarketingConsent"
        }
      ]
    }
  },
  "required": [
    "type",
    "consent"
  ]
}

{
  "type": "string",
  "enum": [
    "profile-merge"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/ProfileMergeQueryResourceObject"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ProfileMergeEnum"
    },
    "id": {
      "description": "The ID of the destination profile to merge into",
      "type": "string",
      "example": "01GDDKASAP8TKDDA2GRZDSVP4H"
    },
    "relationships": {
      "type": "object",
      "properties": {
        "profiles": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/ProfileEnum"
                  },
                  "id": {
                    "description": "The ID of a source profile to merge into the destination profile",
                    "type": "string",
                    "example": "01GDDKASAP8TKDDA2GRZDSVP4I"
                  }
                }
              }
            }
          }
        }
      },
      "required": [
        "profiles"
      ]
    }
  },
  "required": [
    "type",
    "id",
    "relationships"
  ]
}

{
  "type": "object",
  "properties": {
    "patch_properties": {
      "description": "Specify one or more patch operations to apply to existing property data",
      "example": {
        "append": {
          "skus": "92538"
        }
      },
      "$ref": "#/components/schemas/ProfileMetaPatchProperties",
      "nullable": true
    },
    "patch_identifiers": {
      "description": "Specify one or more patch operations to apply to existing identifier data. Currently only `email` is supported, and it is used to add or remove secondary email addresses on a profile.",
      "example": {
        "append": {
          "email": [
            "example@test.com",
            "another@example.com"
          ]
        }
      },
      "$ref": "#/components/schemas/PatchIdentifiers",
      "nullable": true
    }
  }
}

{
  "type": "object",
  "properties": {
    "append": {
      "description": "Append a simple value or values to this property array",
      "type": "object",
      "example": {
        "skus": "92538"
      },
      "nullable": true
    },
    "unappend": {
      "description": "Remove a simple value or values from this property array",
      "type": "object",
      "example": {
        "skus": "40571"
      },
      "nullable": true
    },
    "unset": {
      "description": "Remove a key or keys (and their values) completely from properties",
      "example": "skus",
      "nullable": true,
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ]
    }
  }
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "method"
      ]
    },
    "method": {
      "type": "string",
      "enum": [
        "profile_modification"
      ]
    }
  },
  "required": [
    "field",
    "method"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "profile-group-membership"
      ]
    },
    "is_member": {
      "type": "boolean",
      "enum": [
        false
      ]
    },
    "group_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "type",
    "is_member",
    "group_ids"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/ProfilePartialUpdateQueryResourceObject"
    }
  },
  "required": [
    "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",
          "nullable": true
        },
        "phone_number": {
          "description": "Individual's phone number in E.164 format",
          "type": "string",
          "example": "+15005550006",
          "nullable": true
        },
        "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",
          "nullable": true
        },
        "first_name": {
          "description": "Individual's first name",
          "type": "string",
          "example": "Sarah",
          "nullable": true
        },
        "last_name": {
          "description": "Individual's last name",
          "type": "string",
          "example": "Mason",
          "nullable": true
        },
        "organization": {
          "description": "Name of the company or organization within the company for whom the individual works",
          "type": "string",
          "example": "Example Corporation",
          "nullable": true
        },
        "locale": {
          "description": "The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)",
          "type": "string",
          "example": "en-US",
          "nullable": true
        },
        "title": {
          "description": "Individual's job title",
          "type": "string",
          "example": "Regional Manager",
          "nullable": true
        },
        "image": {
          "description": "URL pointing to the location of a profile image",
          "type": "string",
          "example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
          "nullable": true
        },
        "location": {
          "$ref": "#/components/schemas/ProfileLocation",
          "nullable": true
        },
        "properties": {
          "description": "An object containing key/value pairs for any custom properties assigned to this profile",
          "type": "object",
          "example": {
            "pseudonym": "Dr. Octopus"
          },
          "nullable": true
        }
      }
    },
    "meta": {
      "$ref": "#/components/schemas/ProfileMeta",
      "nullable": true
    }
  },
  "required": [
    "type",
    "id",
    "attributes"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "profile-property"
      ]
    },
    "property": {
      "description": "The profile property to check. Use one of the well-known property names (e.g. `email`, `first_name`) or, for custom profile properties, the form `properties['property name']`.",
      "type": "string",
      "example": "properties['Favorite Color']"
    },
    "filter": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/StringOperatorStringFilter"
        },
        {
          "$ref": "#/components/schemas/StringArrayOperatorStringArrayFilter"
        },
        {
          "$ref": "#/components/schemas/StringPhoneOperatorStringArrayFilter"
        },
        {
          "$ref": "#/components/schemas/NumericOperatorNumericFilter"
        },
        {
          "$ref": "#/components/schemas/BooleanFilter"
        },
        {
          "$ref": "#/components/schemas/ExistenceOperatorExistenceFilter"
        }
      ],
      "x-purplesuite-narrowed": "Narrowed to string, numeric, boolean, and existence filters. Date, relative-date, and list filters are rejected with a 400."
    }
  },
  "required": [
    "type",
    "property",
    "filter"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "profile-region"
      ]
    },
    "in_region": {
      "type": "boolean"
    },
    "region": {
      "description": "Regions for profile region conditions.",
      "type": "string",
      "enum": [
        "european_union",
        "united_states"
      ]
    }
  },
  "required": [
    "type",
    "in_region",
    "region"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ProfileEnum"
    },
    "id": {
      "description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
      "type": "string",
      "example": "01GDDKASAP8TKDDA2GRZDSVP4H",
      "nullable": true
    },
    "attributes": {
      "type": "object",
      "properties": {
        "email": {
          "description": "Individual's email address",
          "type": "string",
          "example": "sarah.mason@klaviyo-demo.com",
          "nullable": true
        },
        "phone_number": {
          "description": "Individual's phone number in E.164 format",
          "type": "string",
          "example": "+15005550006",
          "nullable": true
        },
        "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",
          "nullable": true
        },
        "first_name": {
          "description": "Individual's first name",
          "type": "string",
          "example": "Sarah",
          "nullable": true
        },
        "last_name": {
          "description": "Individual's last name",
          "type": "string",
          "example": "Mason",
          "nullable": true
        },
        "organization": {
          "description": "Name of the company or organization within the company for whom the individual works",
          "type": "string",
          "example": "Example Corporation",
          "nullable": true
        },
        "locale": {
          "description": "The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)",
          "type": "string",
          "example": "en-US",
          "nullable": true
        },
        "title": {
          "description": "Individual's job title",
          "type": "string",
          "example": "Regional Manager",
          "nullable": true
        },
        "image": {
          "description": "URL pointing to the location of a profile image",
          "type": "string",
          "example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "location": {
          "$ref": "#/components/schemas/ProfileLocation",
          "nullable": true
        },
        "properties": {
          "description": "An object containing key/value pairs for any custom properties assigned to this profile",
          "type": "object",
          "example": {
            "pseudonym": "Dr. Octopus"
          },
          "nullable": true
        }
      }
    },
    "relationships": {
      "type": "object",
      "properties": {
        "lists": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/ListEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "segments": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/SegmentEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "push-tokens": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/PushTokenEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    }
  },
  "required": [
    "type",
    "attributes",
    "links"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ProfileEnum"
    },
    "id": {
      "description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
      "type": "string",
      "example": "01GDDKASAP8TKDDA2GRZDSVP4H",
      "nullable": true
    },
    "attributes": {
      "type": "object",
      "properties": {
        "email": {
          "description": "Individual's email address",
          "type": "string",
          "example": "sarah.mason@klaviyo-demo.com",
          "nullable": true
        },
        "phone_number": {
          "description": "Individual's phone number in E.164 format",
          "type": "string",
          "example": "+15005550006",
          "nullable": true
        },
        "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",
          "nullable": true
        },
        "first_name": {
          "description": "Individual's first name",
          "type": "string",
          "example": "Sarah",
          "nullable": true
        },
        "last_name": {
          "description": "Individual's last name",
          "type": "string",
          "example": "Mason",
          "nullable": true
        },
        "organization": {
          "description": "Name of the company or organization within the company for whom the individual works",
          "type": "string",
          "example": "Example Corporation",
          "nullable": true
        },
        "locale": {
          "description": "The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)",
          "type": "string",
          "example": "en-US",
          "nullable": true
        },
        "title": {
          "description": "Individual's job title",
          "type": "string",
          "example": "Regional Manager",
          "nullable": true
        },
        "image": {
          "description": "URL pointing to the location of a profile image",
          "type": "string",
          "example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "location": {
          "$ref": "#/components/schemas/ProfileLocation",
          "nullable": true
        },
        "properties": {
          "description": "An object containing key/value pairs for any custom properties assigned to this profile",
          "type": "object",
          "example": {
            "pseudonym": "Dr. Octopus"
          },
          "nullable": true
        }
      }
    },
    "relationships": {
      "type": "object",
      "properties": {
        "lists": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/ListEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "segments": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/SegmentEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "push-tokens": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/PushTokenEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "conversations": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/ConversationEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    }
  },
  "required": [
    "type",
    "attributes",
    "links"
  ]
}

{
  "type": "string",
  "enum": [
    "profile-subscription-bulk-create-job"
  ]
}

{
  "type": "string",
  "enum": [
    "profile-subscription-bulk-delete-job"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ProfileEnum"
    },
    "id": {
      "description": "The ID of the profile to subscribe. If provided, this will be used to perform the lookup.",
      "type": "string",
      "example": "01GDDKASAP8TKDDA2GRZDSVP4H",
      "nullable": true
    },
    "attributes": {
      "type": "object",
      "properties": {
        "email": {
          "description": "The email address relating to the email subscription included in `subscriptions`. If the email channel is omitted from `subscriptions`, this will be set on the profile.",
          "type": "string",
          "example": "matt-kemp@klaviyo-demo.com",
          "nullable": true
        },
        "phone_number": {
          "description": "The phone number relating to the SMS subscription included in `subscriptions`. If the SMS channel is omitted from `subscriptions`, this will be set on the profile. This must be in E.164 format.",
          "type": "string",
          "example": "+15005550006",
          "nullable": true
        },
        "subscriptions": {
          "description": "Specifies the channel and message types that the profile will be consented to.",
          "$ref": "#/components/schemas/SubscriptionChannels"
        },
        "age_gated_date_of_birth": {
          "description": "The profile's date of birth. This field is required to update SMS consent for accounts using age-gating: https://help.klaviyo.com/hc/en-us/articles/17252552814875",
          "type": "string",
          "format": "date",
          "nullable": true
        }
      },
      "required": [
        "subscriptions"
      ]
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ProfileEnum"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "email": {
          "description": "The email address to unsubscribe.",
          "type": "string",
          "example": "matt-kemp@klaviyo-demo.com",
          "nullable": true
        },
        "phone_number": {
          "description": "The phone number to unsubscribe. This must be in E.164 format.",
          "type": "string",
          "example": "+15005550006",
          "nullable": true
        },
        "subscriptions": {
          "description": "Specifies the channel and message types that the profile will have consent revoked from.",
          "$ref": "#/components/schemas/UnsubscriptionChannels"
        }
      },
      "required": [
        "subscriptions"
      ]
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}

{
  "type": "string",
  "enum": [
    "profile-suppression-bulk-create-job"
  ]
}

{
  "type": "string",
  "enum": [
    "profile-suppression-bulk-delete-job"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ProfileEnum"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "email": {
          "description": "The email of the profile to suppress.",
          "type": "string",
          "example": "matt-kemp@klaviyo-demo.com"
        }
      },
      "required": [
        "email"
      ]
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ProfileEnum"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "email": {
          "description": "The email of the profile to unsuppress.",
          "type": "string",
          "example": "matt-kemp@klaviyo-demo.com"
        }
      },
      "required": [
        "email"
      ]
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/ProfileUpsertQueryResourceObject"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ProfileEnum"
    },
    "id": {
      "description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
      "type": "string",
      "nullable": true
    },
    "attributes": {
      "type": "object",
      "properties": {
        "email": {
          "description": "Individual's email address",
          "type": "string",
          "example": "sarah.mason@klaviyo-demo.com",
          "nullable": true
        },
        "phone_number": {
          "description": "Individual's phone number in E.164 format",
          "type": "string",
          "example": "+15005550006",
          "nullable": true
        },
        "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",
          "nullable": true
        },
        "_kx": {
          "description": "Also 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.",
          "type": "string",
          "nullable": true
        },
        "first_name": {
          "description": "Individual's first name",
          "type": "string",
          "example": "Sarah",
          "nullable": true
        },
        "last_name": {
          "description": "Individual's last name",
          "type": "string",
          "example": "Mason",
          "nullable": true
        },
        "organization": {
          "description": "Name of the company or organization within the company for whom the individual works",
          "type": "string",
          "example": "Example Corporation",
          "nullable": true
        },
        "locale": {
          "description": "The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)",
          "type": "string",
          "example": "en-US",
          "nullable": true
        },
        "title": {
          "description": "Individual's job title",
          "type": "string",
          "example": "Regional Manager",
          "nullable": true
        },
        "image": {
          "description": "URL pointing to the location of a profile image",
          "type": "string",
          "example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
          "nullable": true
        },
        "location": {
          "$ref": "#/components/schemas/ProfileLocation",
          "nullable": true
        },
        "properties": {
          "description": "An object containing key/value pairs for any custom properties assigned to this profile",
          "type": "object",
          "example": {
            "pseudonym": "Dr. Octopus"
          },
          "nullable": true
        }
      }
    },
    "meta": {
      "$ref": "#/components/schemas/ProfileMeta",
      "nullable": true
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "method"
      ]
    },
    "method": {
      "type": "string",
      "enum": [
        "provided_landline"
      ]
    }
  },
  "required": [
    "field",
    "method"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "method"
      ]
    },
    "method": {
      "type": "string",
      "enum": [
        "provided_no_age"
      ]
    }
  },
  "required": [
    "field",
    "method"
  ]
}

{
  "type": "object",
  "properties": {
    "marketing": {
      "description": "The mobile push marketing subscription.",
      "$ref": "#/components/schemas/PushMarketing",
      "nullable": true
    }
  }
}

{
  "type": "object",
  "properties": {
    "can_receive_push_marketing": {
      "description": "Whether or not this profile is subscribed to receive mobile push.",
      "type": "boolean"
    },
    "consent": {
      "description": "The consent status for mobile push marketing.",
      "type": "string",
      "example": "SUBSCRIBED"
    },
    "consent_timestamp": {
      "description": "The timestamp when the consent was last changed, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
      "type": "string",
      "format": "date-time",
      "example": "2023-02-21T20:07:38+00:00",
      "nullable": true
    }
  },
  "required": [
    "can_receive_push_marketing",
    "consent"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ProfileEnum"
    },
    "id": {
      "description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
      "type": "string",
      "nullable": true
    },
    "attributes": {
      "type": "object",
      "properties": {
        "phone_number": {
          "description": "Individual's phone number in E.164 format",
          "type": "string",
          "example": "+15005550006",
          "nullable": true
        },
        "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",
          "nullable": true
        },
        "_kx": {
          "description": "Also 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.",
          "type": "string",
          "nullable": true
        },
        "first_name": {
          "description": "Individual's first name",
          "type": "string",
          "example": "Sarah",
          "nullable": true
        },
        "last_name": {
          "description": "Individual's last name",
          "type": "string",
          "example": "Mason",
          "nullable": true
        },
        "organization": {
          "description": "Name of the company or organization within the company for whom the individual works",
          "type": "string",
          "example": "Example Corporation",
          "nullable": true
        },
        "locale": {
          "description": "The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)",
          "type": "string",
          "example": "en-US",
          "nullable": true
        },
        "title": {
          "description": "Individual's job title",
          "type": "string",
          "example": "Regional Manager",
          "nullable": true
        },
        "image": {
          "description": "URL pointing to the location of a profile image",
          "type": "string",
          "example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
          "nullable": true
        },
        "location": {
          "$ref": "#/components/schemas/ProfileLocation",
          "nullable": true
        },
        "properties": {
          "description": "An object containing key/value pairs for any custom properties assigned to this profile",
          "type": "object",
          "example": {
            "pseudonym": "Dr. Octopus"
          },
          "nullable": true
        },
        "email": {
          "description": "Individual's email address",
          "type": "string",
          "example": "sarah.mason@klaviyo-demo.com",
          "nullable": true
        }
      }
    },
    "meta": {
      "$ref": "#/components/schemas/ProfileMeta",
      "nullable": true
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}

{
  "type": "object",
  "properties": {
    "marketing": {
      "description": "The parameters to subscribe to marketing on the \"Push\" channel.",
      "$ref": "#/components/schemas/SubscriptionParameters"
    },
    "tokens": {
      "description": "A list of push tokens to register for this profile.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PushTokenEntry"
      },
      "nullable": true
    },
    "anonymous_id": {
      "description": "An anonymous identifier for push-only profiles with no email/phone.",
      "type": "string",
      "nullable": true
    }
  },
  "required": [
    "marketing"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/PushTokenCreateQueryResourceObject"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/PushTokenEnum"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "token": {
          "description": "A push token from APNS or FCM.",
          "type": "string",
          "example": "1234567890"
        },
        "platform": {
          "description": "The platform on which the push token was created.",
          "type": "string",
          "enum": [
            "android",
            "ios"
          ]
        },
        "enablement_status": {
          "description": "This is the enablement status for the individual push token.",
          "type": "string",
          "example": "AUTHORIZED",
          "default": "AUTHORIZED",
          "enum": [
            "AUTHORIZED",
            "DENIED",
            "NOT_DETERMINED",
            "PROVISIONAL",
            "UNAUTHORIZED"
          ],
          "nullable": true
        },
        "vendor": {
          "description": "The vendor of the push token.",
          "type": "string",
          "example": "apns",
          "enum": [
            "apns",
            "fcm"
          ]
        },
        "background": {
          "description": "The background state of the push token.",
          "type": "string",
          "example": "AVAILABLE",
          "default": "AVAILABLE",
          "enum": [
            "AVAILABLE",
            "DENIED",
            "RESTRICTED"
          ],
          "nullable": true
        },
        "device_metadata": {
          "description": "Metadata about the device that created the push token",
          "$ref": "#/components/schemas/DeviceMetadata",
          "nullable": true
        },
        "profile": {
          "description": "The profile associated with the push token to create/update",
          "type": "object",
          "properties": {
            "data": {
              "$ref": "#/components/schemas/PushProfileUpsertQueryResourceObject"
            }
          },
          "required": [
            "data"
          ]
        }
      },
      "required": [
        "token",
        "platform",
        "vendor",
        "profile"
      ]
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}

{
  "type": "object",
  "properties": {
    "device_id": {
      "description": "Relatively stable ID for the device. Will update on app uninstall and reinstall",
      "type": "string",
      "example": "1234567890",
      "nullable": true
    },
    "klaviyo_sdk": {
      "description": "The name of the SDK used to create the push token.",
      "type": "string",
      "example": "swift",
      "enum": [
        "android",
        "flutter",
        "flutter_community",
        "react_native",
        "swift"
      ],
      "nullable": true
    },
    "sdk_version": {
      "description": "The version of the SDK used to create the push token",
      "type": "string",
      "example": "1.0.0",
      "nullable": true
    },
    "device_model": {
      "description": "The model of the device",
      "type": "string",
      "example": "iPhone12,1",
      "nullable": true
    },
    "os_name": {
      "description": "The name of the operating system on the device.",
      "type": "string",
      "example": "ios",
      "enum": [
        "android",
        "ios",
        "ipados",
        "macos",
        "tvos"
      ],
      "nullable": true
    },
    "os_version": {
      "description": "The version of the operating system on the device",
      "type": "string",
      "example": "14.0",
      "nullable": true
    },
    "manufacturer": {
      "description": "The manufacturer of the device",
      "type": "string",
      "example": "Apple",
      "nullable": true
    },
    "app_name": {
      "description": "The name of the app that created the push token",
      "type": "string",
      "example": "Klaviyo",
      "nullable": true
    },
    "app_version": {
      "description": "The version of the app that created the push token",
      "type": "string",
      "example": "1.0.0",
      "nullable": true
    },
    "app_build": {
      "description": "The build of the app that created the push token",
      "type": "string",
      "example": "1",
      "nullable": true
    },
    "app_id": {
      "description": "The ID of the app that created the push token",
      "type": "string",
      "example": "com.klaviyo.app",
      "nullable": true
    },
    "environment": {
      "description": "The environment in which the push token was created",
      "type": "string",
      "example": "release",
      "enum": [
        "debug",
        "release"
      ],
      "nullable": true
    }
  }
}

{
  "type": "object",
  "properties": {
    "token": {
      "description": "A push token from APNS or FCM.",
      "type": "string",
      "example": "1234567890abcdef"
    },
    "platform": {
      "description": "The platform on which the push token was created. Either \"ios\" or \"android\".",
      "type": "string",
      "enum": [
        "android",
        "ios"
      ]
    },
    "vendor": {
      "description": "The vendor of the push token. Either \"apns\" or \"fcm\".",
      "type": "string",
      "example": "apns",
      "enum": [
        "apns",
        "fcm"
      ]
    },
    "enablement_status": {
      "description": "The enablement status for the push token.",
      "type": "string",
      "example": "AUTHORIZED",
      "enum": [
        "AUTHORIZED",
        "DENIED",
        "NOT_DETERMINED",
        "PROVISIONAL",
        "UNAUTHORIZED"
      ],
      "nullable": true
    },
    "background": {
      "description": "The background state of the push token.",
      "type": "string",
      "example": "AVAILABLE",
      "enum": [
        "AVAILABLE",
        "DENIED",
        "RESTRICTED"
      ],
      "nullable": true
    },
    "device_metadata": {
      "description": "Metadata about the device that created the push token.",
      "$ref": "#/components/schemas/PushTokenDeviceMetadata",
      "nullable": true
    }
  },
  "required": [
    "token",
    "platform",
    "vendor"
  ]
}

{
  "type": "string",
  "enum": [
    "push-token"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/PushTokenEnum"
    },
    "id": {
      "description": "ID of push token",
      "type": "string"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "created": {
          "description": "The time at which the token was created",
          "type": "string",
          "format": "date-time",
          "example": "2022-11-08T00:00:00+00:00"
        },
        "token": {
          "description": "The push token",
          "type": "string"
        },
        "enablement_status": {
          "description": "The enablement status of the push token",
          "type": "string",
          "enum": [
            "AUTHORIZED",
            "DENIED",
            "NOT_DETERMINED",
            "PROVISIONAL",
            "UNAUTHORIZED"
          ]
        },
        "platform": {
          "description": "The platform of the push token('ios', 'android')",
          "type": "string",
          "enum": [
            "android",
            "ios"
          ]
        },
        "vendor": {
          "description": "The vendor of the push token('APNs', 'FCM')",
          "type": "string"
        },
        "background": {
          "description": "The background state of the push token",
          "type": "string"
        },
        "recorded_date": {
          "description": "The date the push token was recorded",
          "type": "string"
        },
        "metadata": {
          "description": "Metadata of device",
          "$ref": "#/components/schemas/DeviceMetadata",
          "nullable": true
        }
      },
      "required": [
        "created",
        "token",
        "enablement_status",
        "platform",
        "vendor",
        "background",
        "recorded_date"
      ]
    },
    "relationships": {
      "type": "object",
      "properties": {
        "profile": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "type": {
                  "$ref": "#/components/schemas/ProfileEnum"
                },
                "id": {
                  "description": "The profile associated with the push token",
                  "type": "string"
                }
              },
              "required": [
                "type",
                "id"
              ]
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    }
  },
  "required": [
    "type",
    "id",
    "attributes",
    "links"
  ]
}

{
  "type": "object",
  "properties": {
    "marketing": {
      "description": "The parameters to unsubscribe from marketing on the \"Push\" channel.",
      "$ref": "#/components/schemas/UnsubscriptionParameters"
    },
    "tokens": {
      "description": "A list of push tokens to unsubscribe/remove.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PushTokenEntry"
      }
    }
  },
  "required": [
    "marketing",
    "tokens"
  ]
}

{
  "type": "object",
  "properties": {
    "self": {
      "type": "string",
      "format": "uri"
    },
    "related": {
      "type": "string",
      "format": "uri"
    }
  },
  "required": [
    "self",
    "related"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "date"
      ]
    },
    "operator": {
      "description": "Operators for relative date filters.\n\ne.g. \"anniversary in the last 10 days\"",
      "type": "string",
      "enum": [
        "anniversary-last",
        "anniversary-next"
      ]
    },
    "unit": {
      "description": "Units for relative date filters.",
      "type": "string",
      "enum": [
        "day",
        "hour",
        "week"
      ]
    },
    "quantity": {
      "type": "integer"
    }
  },
  "required": [
    "type",
    "operator",
    "unit",
    "quantity"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "date"
      ]
    },
    "operator": {
      "description": "Operators for relative date filters.\n\ne.g. \"in the last 10 days\"",
      "type": "string",
      "enum": [
        "at-least",
        "in-the-last",
        "in-the-next"
      ]
    },
    "unit": {
      "description": "Units for relative date filters.",
      "type": "string",
      "enum": [
        "day",
        "hour",
        "week"
      ]
    },
    "quantity": {
      "type": "integer"
    }
  },
  "required": [
    "type",
    "operator",
    "unit",
    "quantity"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "date"
      ]
    },
    "operator": {
      "description": "Operators for relative date range filters.\n\ne.g. \"between 10 and 20 days ago\"",
      "type": "string",
      "enum": [
        "between"
      ]
    },
    "start": {
      "type": "integer"
    },
    "end": {
      "type": "integer"
    },
    "unit": {
      "description": "Units for relative date filters.",
      "type": "string",
      "enum": [
        "day",
        "hour",
        "week"
      ]
    }
  },
  "required": [
    "type",
    "operator",
    "start",
    "end",
    "unit"
  ]
}

{
  "description": "Response-level metadata",
  "type": "object",
  "properties": {
    "agent_hints": {
      "$ref": "#/components/schemas/AgentHints"
    }
  }
}

{
  "type": "object",
  "properties": {
    "marketing": {
      "description": "The SMS marketing subscription.",
      "$ref": "#/components/schemas/SMSMarketing",
      "nullable": true
    },
    "transactional": {
      "description": "The SMS transactional subscription.",
      "$ref": "#/components/schemas/SMSTransactional",
      "nullable": true
    }
  }
}

{
  "type": "object",
  "properties": {
    "can_receive_sms_marketing": {
      "description": "Whether or not this profile is subscribed to receive SMS marketing.",
      "type": "boolean"
    },
    "consent": {
      "description": "The consent status for SMS marketing.",
      "type": "string",
      "example": "SUBSCRIBED"
    },
    "consent_timestamp": {
      "description": "The timestamp when consent was recorded 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",
      "nullable": true
    },
    "method": {
      "description": "The method by which the profile was subscribed to SMS marketing.",
      "type": "string",
      "example": "TEXT",
      "nullable": true
    },
    "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",
      "default": "",
      "nullable": true
    },
    "last_updated": {
      "description": "The timestamp when the SMS consent record was last modified, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
      "type": "string",
      "format": "date-time",
      "example": "2023-02-21T20:07:38+00:00",
      "nullable": true
    }
  },
  "required": [
    "can_receive_sms_marketing",
    "consent"
  ]
}

{
  "type": "object",
  "properties": {
    "marketing": {
      "description": "The parameters to subscribe to marketing on the \"SMS\" Channel.",
      "$ref": "#/components/schemas/SubscriptionParameters",
      "nullable": true
    },
    "transactional": {
      "description": "The parameters to subscribe to transactional messaging on the \"SMS\" Channel.",
      "$ref": "#/components/schemas/SubscriptionParameters",
      "nullable": true
    }
  }
}

{
  "type": "object",
  "properties": {
    "can_receive_sms_transactional": {
      "description": "Whether or not this profile is subscribed to receive transactional SMS.",
      "type": "boolean"
    },
    "consent": {
      "description": "The consent status for SMS Transactional.",
      "type": "string",
      "example": "SUBSCRIBED"
    },
    "consent_timestamp": {
      "description": "The timestamp when consent was recorded or updated for Transactional SMS messaging , in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
      "type": "string",
      "format": "date-time",
      "example": "2023-02-21T20:07:38+00:00",
      "nullable": true
    },
    "method": {
      "description": "The method by which the profile was subscribed to Transactional SMS messaging .",
      "type": "string",
      "example": "TEXT",
      "nullable": true
    },
    "method_detail": {
      "description": "Additional details about the method which the profile was subscribed to Transactional SMS messaging. This may be empty if no details were provided.",
      "type": "string",
      "example": "JOIN",
      "default": "",
      "nullable": true
    },
    "last_updated": {
      "description": "The timestamp when the SMS consent record was last modified, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
      "type": "string",
      "format": "date-time",
      "example": "2023-02-21T20:07:38+00:00",
      "nullable": true
    }
  },
  "required": [
    "can_receive_sms_transactional",
    "consent"
  ]
}

{
  "type": "object",
  "properties": {
    "marketing": {
      "description": "The parameters to unsubscribe from marketing on the \"SMS\" channel.",
      "$ref": "#/components/schemas/UnsubscriptionParameters",
      "nullable": true
    },
    "transactional": {
      "description": "The parameters to unsubscribe from transactional messaging on the \"SMS\" channel.",
      "$ref": "#/components/schemas/UnsubscriptionParameters",
      "nullable": true
    }
  }
}

{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/SegmentCreateQueryResourceObject"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/SegmentEnum"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "definition": {
          "$ref": "#/components/schemas/SegmentDefinition"
        },
        "is_starred": {
          "type": "boolean",
          "default": false,
          "nullable": true
        }
      },
      "required": [
        "name",
        "definition"
      ]
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}

{
  "type": "object",
  "properties": {
    "condition_groups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ConditionGroup"
      }
    }
  },
  "required": [
    "condition_groups"
  ]
}

{
  "type": "string",
  "enum": [
    "segment"
  ]
}

{
  "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",
          "nullable": true
        },
        "definition": {
          "$ref": "#/components/schemas/SegmentDefinition",
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "is_active": {
          "description": "Whether the segment is active. Inactive segments are not processed and their membership does not update.",
          "type": "boolean"
        },
        "is_processing": {
          "type": "boolean"
        },
        "is_starred": {
          "type": "boolean"
        }
      },
      "required": [
        "is_active",
        "is_processing",
        "is_starred"
      ]
    },
    "relationships": {
      "type": "object",
      "properties": {
        "profiles": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/ProfileEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "tags": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/TagEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "flow-triggers": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/FlowEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    }
  },
  "required": [
    "type",
    "id",
    "attributes",
    "links"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ProfileEnum"
    },
    "id": {
      "description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
      "type": "string",
      "example": "01GDDKASAP8TKDDA2GRZDSVP4H",
      "nullable": true
    },
    "attributes": {
      "type": "object",
      "properties": {
        "email": {
          "description": "Individual's email address",
          "type": "string",
          "example": "sarah.mason@klaviyo-demo.com",
          "nullable": true
        },
        "phone_number": {
          "description": "Individual's phone number in E.164 format",
          "type": "string",
          "example": "+15005550006",
          "nullable": true
        },
        "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",
          "nullable": true
        },
        "first_name": {
          "description": "Individual's first name",
          "type": "string",
          "example": "Sarah",
          "nullable": true
        },
        "last_name": {
          "description": "Individual's last name",
          "type": "string",
          "example": "Mason",
          "nullable": true
        },
        "organization": {
          "description": "Name of the company or organization within the company for whom the individual works",
          "type": "string",
          "example": "Example Corporation",
          "nullable": true
        },
        "locale": {
          "description": "The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)",
          "type": "string",
          "example": "en-US",
          "nullable": true
        },
        "title": {
          "description": "Individual's job title",
          "type": "string",
          "example": "Regional Manager",
          "nullable": true
        },
        "image": {
          "description": "URL pointing to the location of a profile image",
          "type": "string",
          "example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "location": {
          "$ref": "#/components/schemas/ProfileLocation",
          "nullable": true
        },
        "properties": {
          "description": "An object containing key/value pairs for any custom properties assigned to this profile",
          "type": "object",
          "example": {
            "pseudonym": "Dr. Octopus"
          },
          "nullable": true
        },
        "joined_group_at": {
          "description": "The datetime when this profile most recently joined the segment.",
          "type": "string",
          "format": "date-time",
          "example": "2022-11-08T00:00:00+00:00"
        }
      },
      "required": [
        "joined_group_at"
      ]
    },
    "relationships": {
      "type": "object",
      "properties": {
        "lists": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/ListEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "segments": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/SegmentEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "push-tokens": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/PushTokenEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    }
  },
  "required": [
    "type",
    "attributes",
    "links"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/SegmentPartialUpdateQueryResourceObject"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/SegmentEnum"
    },
    "id": {
      "type": "string"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "definition": {
          "$ref": "#/components/schemas/SegmentDefinition",
          "nullable": true
        },
        "name": {
          "type": "string",
          "nullable": true
        },
        "is_starred": {
          "type": "boolean",
          "nullable": true
        },
        "is_active": {
          "description": "Set to false to deactivate the segment. When deactivating, this must be the only attribute in the request body. Deactivation cannot be combined with other updates. Marking a segment inactive will impact campaigns, flows, ad syncs, forms, helpdesk routing, and other features that reference this segment. Set to true to reactivate a deactivated segment.",
          "type": "boolean",
          "nullable": true
        }
      }
    }
  },
  "required": [
    "type",
    "id",
    "attributes"
  ]
}

{
  "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",
          "nullable": true
        },
        "definition": {
          "$ref": "#/components/schemas/SegmentDefinition",
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "is_active": {
          "description": "Whether the segment is active. Inactive segments are not processed and their membership does not update.",
          "type": "boolean"
        },
        "is_processing": {
          "type": "boolean"
        },
        "is_starred": {
          "type": "boolean"
        }
      },
      "required": [
        "is_active",
        "is_processing",
        "is_starred"
      ]
    },
    "relationships": {
      "type": "object",
      "properties": {
        "profiles": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/ProfileEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "tags": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/TagEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "flow-triggers": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/FlowEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    }
  },
  "required": [
    "type",
    "id",
    "attributes",
    "links"
  ]
}

{
  "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",
          "nullable": true
        },
        "definition": {
          "$ref": "#/components/schemas/SegmentDefinition",
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "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+00:00",
          "nullable": true
        },
        "is_active": {
          "description": "Whether the segment is active. Inactive segments are not processed and their membership does not update.",
          "type": "boolean"
        },
        "is_processing": {
          "type": "boolean"
        },
        "is_starred": {
          "type": "boolean"
        }
      },
      "required": [
        "is_active",
        "is_processing",
        "is_starred"
      ]
    },
    "relationships": {
      "type": "object",
      "properties": {
        "profiles": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/ProfileEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "tags": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/TagEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "flow-triggers": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/FlowEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    }
  },
  "required": [
    "type",
    "id",
    "attributes",
    "links"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "method"
      ]
    },
    "method": {
      "type": "string",
      "enum": [
        "sftp"
      ]
    }
  },
  "required": [
    "field",
    "method"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "string"
      ]
    },
    "operator": {
      "type": "string",
      "enum": [
        "in"
      ]
    },
    "value": {
      "type": "array",
      "items": {
        "enum": [
          "shopify"
        ],
        "type": "string"
      }
    }
  },
  "required": [
    "type",
    "operator",
    "value"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "method"
      ]
    },
    "method": {
      "type": "string",
      "enum": [
        "integration"
      ]
    },
    "filter": {
      "$ref": "#/components/schemas/ShopifyIntegrationFilter"
    }
  },
  "required": [
    "field",
    "method",
    "filter"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "method"
      ]
    },
    "method": {
      "type": "string",
      "enum": [
        "spam_complaint"
      ]
    }
  },
  "required": [
    "field",
    "method"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "date"
      ]
    },
    "operator": {
      "description": "Operators for static date filters.\n\nE.g. \"before 2023-01-01\"",
      "type": "string",
      "enum": [
        "after",
        "before"
      ]
    },
    "date": {
      "type": "string",
      "format": "date-time",
      "example": "2022-11-08T00:00:00+00:00"
    }
  },
  "required": [
    "type",
    "operator",
    "date"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "date"
      ]
    },
    "operator": {
      "description": "Operators for static date range filters.\n\nE.g. \"between 2023-01-01 and 2023-02-01\"",
      "type": "string",
      "enum": [
        "between-static"
      ]
    },
    "start": {
      "type": "string",
      "format": "date-time",
      "example": "2022-11-08T00:00:00+00:00"
    },
    "end": {
      "type": "string",
      "format": "date-time",
      "example": "2022-11-08T00:00:00+00:00"
    }
  },
  "required": [
    "type",
    "operator",
    "start",
    "end"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "status_date"
      ]
    },
    "filter": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/StaticDateFilter"
        },
        {
          "$ref": "#/components/schemas/StaticDateRangeFilter"
        },
        {
          "$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
        },
        {
          "$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
        },
        {
          "$ref": "#/components/schemas/RelativeDateRangeFilter"
        },
        {
          "$ref": "#/components/schemas/CalendarDateFilter"
        },
        {
          "$ref": "#/components/schemas/AnniversaryDateFilter"
        }
      ]
    }
  },
  "required": [
    "field",
    "filter"
  ]
}

{
  "type": "object",
  "properties": {
    "address1": {
      "type": "string",
      "example": "125 Summer Street",
      "nullable": true
    },
    "address2": {
      "type": "string",
      "example": "5th Floor",
      "nullable": true
    },
    "city": {
      "type": "string",
      "example": "Boston",
      "nullable": true
    },
    "region": {
      "description": "State, province, or region.",
      "type": "string",
      "example": "MA",
      "nullable": true
    },
    "country": {
      "description": "Two-letter [ISO country code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)",
      "type": "string",
      "example": "US",
      "nullable": true
    },
    "zip": {
      "type": "string",
      "example": "04323",
      "nullable": true
    }
  }
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "string"
      ]
    },
    "operator": {
      "description": "Operators for string-in-array filters.",
      "type": "string",
      "enum": [
        "in",
        "not-in"
      ]
    },
    "value": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "type",
    "operator",
    "value"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "string"
      ]
    },
    "operator": {
      "description": "Operators for string filters.",
      "type": "string",
      "enum": [
        "contains",
        "ends-with",
        "equals",
        "not-contains",
        "not-ends-with",
        "not-equals",
        "not-starts-with",
        "nregex",
        "regex",
        "starts-with"
      ]
    },
    "value": {
      "type": "string",
      "nullable": true
    }
  },
  "required": [
    "type",
    "operator",
    "value"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "string"
      ]
    },
    "operator": {
      "description": "Operators for phone string array filters.\n\nExample condition using this filter:\n        {\n            \"type\": \"profile-property\",\n            \"field\": \"phone\",\n            \"filter\": {\n                \"type\": \"string\",\n                \"operator\": \"phone-country-code-in\",\n                \"value\": [\"US\", \"GB\"]\n            }\n        }",
      "type": "string",
      "enum": [
        "phone-country-code-in",
        "phone-country-code-not-in"
      ]
    },
    "value": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "type",
    "operator",
    "value"
  ]
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "enum": [
        "is_rcs_capable"
      ]
    },
    "filter": {
      "$ref": "#/components/schemas/BooleanFilter"
    }
  },
  "required": [
    "field",
    "filter"
  ]
}

{
  "type": "object",
  "properties": {
    "email": {
      "description": "The subscription parameters to subscribe to on the \"EMAIL\" Channel.",
      "$ref": "#/components/schemas/EmailSubscriptionParameters",
      "nullable": true
    },
    "sms": {
      "description": "The subscription parameters to subscribe to on the \"SMS\" Channel.",
      "$ref": "#/components/schemas/SMSSubscriptionParameters",
      "nullable": true
    },
    "whatsapp": {
      "description": "The subscription parameters to subscribe to on the \"WhatsApp\" Channel.",
      "$ref": "#/components/schemas/WhatsAppSubscriptionParameters",
      "nullable": true
    },
    "push": {
      "description": "The subscription parameters to subscribe to on the \"Push\" Channel.",
      "$ref": "#/components/schemas/PushSubscriptionParameters",
      "nullable": true
    }
  }
}

{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/SubscriptionCreateJobCreateQueryResourceObject"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ProfileSubscriptionBulkCreateJobEnum"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "custom_source": {
          "description": "A custom method detail or source to store on the consent records.",
          "type": "string",
          "example": "Marketing Event",
          "nullable": true
        },
        "profiles": {
          "description": "The profile(s) to subscribe",
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/ProfileSubscriptionCreateQueryResourceObject"
              }
            }
          },
          "required": [
            "data"
          ]
        },
        "historical_import": {
          "description": "Whether this subscription is part of a historical import. If true, the consented_at field must be provided for each profile.",
          "type": "boolean",
          "default": false,
          "nullable": true
        }
      },
      "required": [
        "profiles"
      ]
    },
    "relationships": {
      "type": "object",
      "properties": {
        "list": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "type": {
                  "$ref": "#/components/schemas/ListEnum"
                },
                "id": {
                  "description": "The list to add the newly subscribed profiles to",
                  "type": "string",
                  "example": "Y6nRLr"
                }
              },
              "required": [
                "type",
                "id"
              ]
            }
          }
        }
      }
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/SubscriptionDeleteJobCreateQueryResourceObject"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ProfileSubscriptionBulkDeleteJobEnum"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "profiles": {
          "description": "The profile(s) to unsubscribe",
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/ProfileSubscriptionDeleteQueryResourceObject"
              }
            }
          },
          "required": [
            "data"
          ]
        }
      },
      "required": [
        "profiles"
      ]
    },
    "relationships": {
      "type": "object",
      "properties": {
        "list": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "type": {
                  "$ref": "#/components/schemas/ListEnum"
                },
                "id": {
                  "description": "The list to remove the profiles from",
                  "type": "string",
                  "example": "Y6nRLr"
                }
              },
              "required": [
                "type",
                "id"
              ]
            }
          }
        }
      }
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}

{
  "type": "object",
  "properties": {
    "consent": {
      "description": "The Consent status to be set as part of the subscribe call. Currently supports \"SUBSCRIBED\".",
      "type": "string",
      "example": "SUBSCRIBED",
      "enum": [
        "SUBSCRIBED"
      ]
    },
    "consented_at": {
      "description": "The timestamp of when the profile's consent was gathered. This should only be used when syncing over historical consent info to Klaviyo; if the `historical_import` flag is not included, providing any value for this field will raise an error.",
      "type": "string",
      "format": "date-time",
      "nullable": true
    }
  },
  "required": [
    "consent"
  ]
}

{
  "type": "object",
  "properties": {
    "email": {
      "description": "The email channel subscription.",
      "$ref": "#/components/schemas/EmailChannel",
      "nullable": true
    },
    "sms": {
      "description": "The SMS channel subscription.",
      "$ref": "#/components/schemas/SMSChannel",
      "nullable": true
    },
    "mobile_push": {
      "description": "The mobile push channel subscription.",
      "$ref": "#/components/schemas/PushChannel",
      "nullable": true
    },
    "whatsapp": {
      "description": "The whatsapp channel subscription.",
      "$ref": "#/components/schemas/WhatsappChannel",
      "nullable": true
    }
  }
}

{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/SuppressionCreateJobCreateQueryResourceObject"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ProfileSuppressionBulkCreateJobEnum"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "profiles": {
          "description": "The profile(s) to create suppressions for.",
          "type": "object",
          "nullable": true,
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/ProfileSuppressionCreateQueryResourceObject"
              }
            }
          },
          "required": [
            "data"
          ]
        }
      }
    },
    "relationships": {
      "type": "object",
      "properties": {
        "list": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "type": {
                  "$ref": "#/components/schemas/ListEnum"
                },
                "id": {
                  "description": "Suppress all profiles in this list",
                  "type": "string",
                  "example": "Y6nRLr"
                }
              },
              "required": [
                "type",
                "id"
              ]
            }
          }
        },
        "segment": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "type": {
                  "$ref": "#/components/schemas/SegmentEnum"
                },
                "id": {
                  "description": "Suppress all profiles in this segment",
                  "type": "string",
                  "example": "Y6nRLr"
                }
              },
              "required": [
                "type",
                "id"
              ]
            }
          }
        }
      }
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/SuppressionDeleteJobCreateQueryResourceObject"
    }
  },
  "required": [
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ProfileSuppressionBulkDeleteJobEnum"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "profiles": {
          "description": "The profile(s) to remove suppressions for.",
          "type": "object",
          "nullable": true,
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/ProfileSuppressionDeleteQueryResourceObject"
              }
            }
          },
          "required": [
            "data"
          ]
        }
      }
    },
    "relationships": {
      "type": "object",
      "properties": {
        "list": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "type": {
                  "$ref": "#/components/schemas/ListEnum"
                },
                "id": {
                  "description": "The list to pull the profiles to remove suppressions from",
                  "type": "string",
                  "example": "Y6nRLr"
                }
              },
              "required": [
                "type",
                "id"
              ]
            }
          }
        },
        "segment": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "type": {
                  "$ref": "#/components/schemas/SegmentEnum"
                },
                "id": {
                  "description": "The segment to pull the profiles to remove suppressions from",
                  "type": "string",
                  "example": "Y6nRLr"
                }
              },
              "required": [
                "type",
                "id"
              ]
            }
          }
        }
      }
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}

{
  "type": "string",
  "enum": [
    "tag"
  ]
}

{
  "type": "string",
  "enum": [
    "tag-group"
  ]
}

{
  "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": "object",
              "properties": {
                "type": {
                  "$ref": "#/components/schemas/TagGroupEnum"
                },
                "id": {
                  "type": "string"
                }
              },
              "required": [
                "type",
                "id"
              ]
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "lists": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/ListEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "segments": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/SegmentEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "campaigns": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/CampaignEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        },
        "flows": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/FlowEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    }
  },
  "required": [
    "type",
    "id",
    "attributes",
    "links"
  ]
}

{
  "type": "object",
  "properties": {
    "email": {
      "description": "The subscription parameters to unsubscribe from the \"EMAIL\" Channel.",
      "$ref": "#/components/schemas/EmailUnsubscriptionParameters",
      "nullable": true
    },
    "sms": {
      "description": "The subscription parameters to unsubscribe from the \"SMS\" Channel.",
      "$ref": "#/components/schemas/SMSUnsubscriptionParameters",
      "nullable": true
    },
    "whatsapp": {
      "description": "The subscription parameters to unsubscribe from the \"WhatsApp\" Channel.",
      "$ref": "#/components/schemas/WhatsAppUnsubscriptionParameters",
      "nullable": true
    },
    "push": {
      "description": "The subscription parameters to unsubscribe from the \"Push\" Channel.",
      "$ref": "#/components/schemas/PushUnsubscriptionParameters",
      "nullable": true
    }
  }
}

{
  "type": "object",
  "properties": {
    "consent": {
      "description": "The Consent status to be set as part of the unsubscribe call. Currently supports \"UNSUBSCRIBED\".",
      "type": "string",
      "example": "UNSUBSCRIBED",
      "enum": [
        "UNSUBSCRIBED"
      ]
    }
  },
  "required": [
    "consent"
  ]
}

{
  "type": "object",
  "properties": {
    "marketing": {
      "description": "The parameters to subscribe to marketing on the \"WhatsApp\" Channel.",
      "$ref": "#/components/schemas/SubscriptionParameters",
      "nullable": true
    },
    "transactional": {
      "description": "The parameters to subscribe to transactional messaging on the \"WhatsApp\" Channel.",
      "$ref": "#/components/schemas/SubscriptionParameters",
      "nullable": true
    }
  }
}

{
  "type": "object",
  "properties": {
    "marketing": {
      "description": "The parameters to unsubscribe from marketing on the \"WhatsApp\" channel.",
      "$ref": "#/components/schemas/UnsubscriptionParameters",
      "nullable": true
    },
    "transactional": {
      "description": "The parameters to unsubscribe from transactional messaging on the \"WhatsApp\" channel.",
      "$ref": "#/components/schemas/UnsubscriptionParameters",
      "nullable": true
    },
    "conversational": {
      "description": "The parameters to unsubscribe from conversational messaging on the \"WhatsApp\" channel.",
      "$ref": "#/components/schemas/UnsubscriptionParameters",
      "nullable": true
    }
  }
}

{
  "type": "object",
  "properties": {
    "marketing": {
      "description": "The Whatsapp marketing subscription.",
      "$ref": "#/components/schemas/WhatsappMarketingChannel",
      "nullable": true
    },
    "transactional": {
      "description": "The Whatsapp transactional subscription.",
      "$ref": "#/components/schemas/WhatsappTransactionalChannel",
      "nullable": true
    },
    "conversational": {
      "description": "The Whatsapp conversational subscription.",
      "$ref": "#/components/schemas/WhatsappConversationalChannel",
      "nullable": true
    }
  }
}

{
  "type": "object",
  "properties": {
    "consent": {
      "description": "The consent status for the channel.",
      "type": "string",
      "example": "SUBSCRIBED"
    },
    "consent_timestamp": {
      "description": "The timestamp when consent was recorded or updated for the channel, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
      "type": "string",
      "format": "date-time",
      "example": "2023-02-21T20:07:38+00:00",
      "nullable": true
    },
    "last_updated": {
      "description": "The timestamp when the channel was last modified, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
      "type": "string",
      "format": "date-time",
      "example": "2023-02-21T20:07:38+00:00",
      "nullable": true
    },
    "created_timestamp": {
      "description": "The timestamp when the channel was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
      "type": "string",
      "format": "date-time",
      "example": "2023-02-21T20:07:38+00:00",
      "nullable": true
    },
    "metadata": {
      "description": "Channel-specific metadata containing additional information about the permission.",
      "type": "object",
      "nullable": true
    },
    "can_receive": {
      "description": "Whether the profile can receive messages on this channel.",
      "type": "boolean"
    },
    "valid_until": {
      "description": "Optional expiration date for the permission, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
      "type": "string",
      "format": "date-time",
      "example": "2024-02-21T20:07:38+00:00",
      "nullable": true
    },
    "phone_number": {
      "description": "Phone number to which the consent was granted for.",
      "type": "string",
      "nullable": true
    }
  },
  "required": [
    "consent",
    "can_receive"
  ]
}

{
  "type": "object",
  "properties": {
    "consent": {
      "description": "The consent status for the channel.",
      "type": "string",
      "example": "SUBSCRIBED"
    },
    "consent_timestamp": {
      "description": "The timestamp when consent was recorded or updated for the channel, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
      "type": "string",
      "format": "date-time",
      "example": "2023-02-21T20:07:38+00:00",
      "nullable": true
    },
    "last_updated": {
      "description": "The timestamp when the channel was last modified, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
      "type": "string",
      "format": "date-time",
      "example": "2023-02-21T20:07:38+00:00",
      "nullable": true
    },
    "created_timestamp": {
      "description": "The timestamp when the channel was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
      "type": "string",
      "format": "date-time",
      "example": "2023-02-21T20:07:38+00:00",
      "nullable": true
    },
    "metadata": {
      "description": "Channel-specific metadata containing additional information about the permission.",
      "type": "object",
      "nullable": true
    },
    "can_receive": {
      "description": "Whether the profile can receive messages on this channel.",
      "type": "boolean"
    },
    "valid_until": {
      "description": "Optional expiration date for the permission, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
      "type": "string",
      "format": "date-time",
      "example": "2024-02-21T20:07:38+00:00",
      "nullable": true
    },
    "phone_number": {
      "description": "Phone number to which the consent was granted for.",
      "type": "string",
      "nullable": true
    }
  },
  "required": [
    "consent",
    "can_receive"
  ]
}

{
  "type": "object",
  "properties": {
    "consent": {
      "description": "The consent status for the channel.",
      "type": "string",
      "example": "SUBSCRIBED"
    },
    "consent_timestamp": {
      "description": "The timestamp when consent was recorded or updated for the channel, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
      "type": "string",
      "format": "date-time",
      "example": "2023-02-21T20:07:38+00:00",
      "nullable": true
    },
    "last_updated": {
      "description": "The timestamp when the channel was last modified, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
      "type": "string",
      "format": "date-time",
      "example": "2023-02-21T20:07:38+00:00",
      "nullable": true
    },
    "created_timestamp": {
      "description": "The timestamp when the channel was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
      "type": "string",
      "format": "date-time",
      "example": "2023-02-21T20:07:38+00:00",
      "nullable": true
    },
    "metadata": {
      "description": "Channel-specific metadata containing additional information about the permission.",
      "type": "object",
      "nullable": true
    },
    "can_receive": {
      "description": "Whether the profile can receive messages on this channel.",
      "type": "boolean"
    },
    "valid_until": {
      "description": "Optional expiration date for the permission, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
      "type": "string",
      "format": "date-time",
      "example": "2024-02-21T20:07:38+00:00",
      "nullable": true
    },
    "phone_number": {
      "description": "Phone number to which the consent was granted for.",
      "type": "string",
      "nullable": true
    }
  },
  "required": [
    "consent",
    "can_receive"
  ]
}

{
  "description": "Client Error",
  "content": {
    "application/vnd.api+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"
        ]
      }
    }
  }
}

{
  "description": "Server Error",
  "content": {
    "application/vnd.api+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"
        ]
      }
    }
  }
}

{
  "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`<br>For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#authentication",
  "x-default": "Klaviyo-API-Key your-private-api-key"
}

Document metadata and extensions

{
  "openapi": "3.0.2",
  "info": {
    "title": "Klaviyo API",
    "version": "2026-07-15",
    "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"
    },
    "x-purplesuite-contract": {
      "system": "crm",
      "paint": "klaviyo",
      "revision": "2026-07-15",
      "documentScope": "bounded",
      "publishedOperations": 64,
      "vendorOperations": 345,
      "note": "A PurpleSuite emulation of the Klaviyo API. The published surface is the Accounts, Lists, Profiles, and Segments operations, which execute against persistent per-instance state. The remaining official operations are not published here; see COVERAGE_LEDGER.md."
    }
  },
  "tags": [
    {
      "name": "Accounts",
      "description": "accounts"
    },
    {
      "name": "Lists",
      "description": "lists"
    },
    {
      "name": "Profiles",
      "description": "profiles"
    },
    {
      "name": "Segments",
      "description": "segments"
    }
  ],
  "security": [
    {
      "Klaviyo-API-Key": []
    }
  ],
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": true,
    "samples-enabled": true
  }
}