Klaviyo · Schema

ListPartialUpdateQueryResourceObject

MarketingEmailSMSCustomer DataEcommerceAutomation

Properties

Name	Type	Description
type	object
id	string	Primary key that uniquely identifies this list. Generated by Klaviyo.
attributes	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ListPartialUpdateQueryResourceObject",
  "title": "ListPartialUpdateQueryResourceObject",
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ListEnum"
    },
    "id": {
      "description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
      "type": "string",
      "example": "Y6nRLr"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "name": {
          "description": "A helpful name to label the list",
          "type": "string",
          "example": "Newsletter",
          "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"
  ]
}