Klaviyo · Schema

FormResponseObjectResource

MarketingEmailSMSCustomer DataE-CommerceAutomation

Properties

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

JSON Schema

klaviyo-formresponseobjectresource-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FormResponseObjectResource",
  "title": "FormResponseObjectResource",
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/FormEnum"
    },
    "id": {
      "description": "ID of the form. Generated by Klaviyo.",
      "type": "string",
      "example": "Y6nRLr"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "name": {
          "description": "Name of the form.",
          "type": "string",
          "example": "Cyber Monday Deals"
        },
        "status": {
          "description": "Status of the form. A live form with an in-progress draft is considered \"live\".",
          "type": "string",
          "enum": [
            "draft",
            "live"
          ]
        },
        "ab_test": {
          "description": "Whether the form has an A/B test configured, regardless of its status.",
          "type": "boolean"
        },
        "created_at": {
          "description": "ISO8601 timestamp when the form was created.",
          "type": "string",
          "format": "date-time",
          "example": "2024-03-04T00:00:00Z"
        },
        "updated_at": {
          "description": "ISO8601 timestamp when the form was last updated.",
          "type": "string",
          "format": "date-time",
          "example": "2024-03-04T00:00:00Z"
        }
      },
      "required": [
        "name",
        "status",
        "ab_test",
        "created_at",
        "updated_at"
      ]
    },
    "relationships": {
      "type": "object",
      "properties": {
        "form-versions": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/FormVersionEnum"
                  },
                  "id": {
                    "type": "string"
                  }
                }
              }
            },
            "links": {
              "$ref": "#/components/schemas/RelationshipLinks"
            }
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    }
  },
  "required": [
    "type",
    "id",
    "attributes",
    "links"
  ]
}