Klaviyo · Schema

ListResponseObjectResource

MarketingEmailSMSCustomer DataEcommerceAutomation

Properties

Name Type Description
type object
id string Primary key that uniquely identifies this list. Generated by Klaviyo.
attributes object
relationships object
links object
View JSON Schema on GitHub

JSON Schema

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