Klaviyo · Schema

PushTokenDeviceMetadata

MarketingEmailSMSCustomer DataEcommerceAutomation

Properties

Name Type Description
device_id string Relatively stable ID for the device. Will update on app uninstall and reinstall
klaviyo_sdk string The name of the SDK used to create the push token.
sdk_version string The version of the SDK used to create the push token
device_model string The model of the device
os_name string The name of the operating system on the device.
os_version string The version of the operating system on the device
manufacturer string The manufacturer of the device
app_name string The name of the app that created the push token
app_version string The version of the app that created the push token
app_build string The build of the app that created the push token
app_id string The ID of the app that created the push token
environment string The environment in which the push token was created
View JSON Schema on GitHub

JSON Schema

klaviyo-pushtokendevicemetadata-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PushTokenDeviceMetadata",
  "title": "PushTokenDeviceMetadata",
  "type": "object",
  "properties": {
    "device_id": {
      "description": "Relatively stable ID for the device. Will update on app uninstall and reinstall",
      "type": "string",
      "example": "1234567890",
      "nullable": true
    },
    "klaviyo_sdk": {
      "description": "The name of the SDK used to create the push token.",
      "type": "string",
      "example": "swift",
      "enum": [
        "android",
        "flutter",
        "flutter_community",
        "react_native",
        "swift"
      ],
      "nullable": true
    },
    "sdk_version": {
      "description": "The version of the SDK used to create the push token",
      "type": "string",
      "example": "1.0.0",
      "nullable": true
    },
    "device_model": {
      "description": "The model of the device",
      "type": "string",
      "example": "iPhone12,1",
      "nullable": true
    },
    "os_name": {
      "description": "The name of the operating system on the device.",
      "type": "string",
      "example": "ios",
      "enum": [
        "android",
        "ios",
        "ipados",
        "macos",
        "tvos"
      ],
      "nullable": true
    },
    "os_version": {
      "description": "The version of the operating system on the device",
      "type": "string",
      "example": "14.0",
      "nullable": true
    },
    "manufacturer": {
      "description": "The manufacturer of the device",
      "type": "string",
      "example": "Apple",
      "nullable": true
    },
    "app_name": {
      "description": "The name of the app that created the push token",
      "type": "string",
      "example": "Klaviyo",
      "nullable": true
    },
    "app_version": {
      "description": "The version of the app that created the push token",
      "type": "string",
      "example": "1.0.0",
      "nullable": true
    },
    "app_build": {
      "description": "The build of the app that created the push token",
      "type": "string",
      "example": "1",
      "nullable": true
    },
    "app_id": {
      "description": "The ID of the app that created the push token",
      "type": "string",
      "example": "com.klaviyo.app",
      "nullable": true
    },
    "environment": {
      "description": "The environment in which the push token was created",
      "type": "string",
      "example": "release",
      "enum": [
        "debug",
        "release"
      ],
      "nullable": true
    }
  }
}