Klaviyo · Schema

FormVersionResponseObjectResource

MarketingEmailSMSCustomer DataEcommerceAutomation

Properties

Name Type Description
type object
id string ID of the form version. Generated by Klaviyo.
attributes object
links object
View JSON Schema on GitHub

JSON Schema

klaviyo-formversionresponseobjectresource-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FormVersionResponseObjectResource",
  "title": "FormVersionResponseObjectResource",
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/FormVersionEnum"
    },
    "id": {
      "description": "ID of the form version. Generated by Klaviyo.",
      "type": "string",
      "example": "1234567"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "form_type": {
          "description": "The type of form.",
          "type": "string",
          "enum": [
            "banner",
            "embed",
            "flyout",
            "full_page",
            "popup"
          ]
        },
        "variation_name": {
          "description": "The name of the form version.",
          "type": "string"
        },
        "ab_test": {
          "$ref": "#/components/schemas/FormVersionABTest",
          "nullable": true
        },
        "status": {
          "description": "Status of the form version. \"live\" means it's live on site.",
          "type": "string",
          "enum": [
            "draft",
            "live"
          ]
        },
        "created_at": {
          "description": "ISO8601 timestamp when the form version was created.",
          "type": "string",
          "format": "date-time",
          "example": "2024-03-04T00:00:00Z"
        },
        "updated_at": {
          "description": "ISO8601 timestamp when the form version was last updated.",
          "type": "string",
          "format": "date-time",
          "example": "2024-03-04T00:00:00Z"
        }
      },
      "required": [
        "form_type",
        "variation_name",
        "status",
        "created_at",
        "updated_at"
      ]
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    }
  },
  "required": [
    "type",
    "id",
    "attributes",
    "links"
  ]
}