Klaviyo · Schema

PhoneNumberProperties

MarketingEmailSMSCustomer DataEcommerceAutomation

Properties

Name Type Description
display_device array
classname string
label string
show_label boolean
placeholder string
required boolean
error_messages object
property_name string
sms_consent_type array
channel_settings object
View JSON Schema on GitHub

JSON Schema

klaviyo-phonenumberproperties-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PhoneNumberProperties",
  "title": "PhoneNumberProperties",
  "type": "object",
  "properties": {
    "display_device": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "both",
          "desktop",
          "mobile"
        ],
        "description": "Enumeration for mobile and desktop."
      }
    },
    "classname": {
      "type": "string",
      "nullable": true
    },
    "label": {
      "type": "string",
      "nullable": true
    },
    "show_label": {
      "type": "boolean",
      "default": false
    },
    "placeholder": {
      "type": "string",
      "nullable": true
    },
    "required": {
      "type": "boolean",
      "default": false,
      "nullable": true
    },
    "error_messages": {
      "$ref": "#/components/schemas/ErrorMessages",
      "nullable": true
    },
    "property_name": {
      "type": "string",
      "example": "$phone_number",
      "default": "$phone_number"
    },
    "sms_consent_type": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "phone_number_only",
          "promotional",
          "transactional"
        ],
        "description": "Consent Type Enum."
      },
      "nullable": true
    },
    "channel_settings": {
      "$ref": "#/components/schemas/ChannelSettings",
      "nullable": true
    }
  }
}