Klaviyo · Schema

ProfileIdentifierDTOResourceObject

MarketingEmailSMSCustomer DataEcommerceAutomation

Properties

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

JSON Schema

klaviyo-profileidentifierdtoresourceobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ProfileIdentifierDTOResourceObject",
  "title": "ProfileIdentifierDTOResourceObject",
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ProfileEnum"
    },
    "id": {
      "description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
      "type": "string",
      "example": "01GDDKASAP8TKDDA2GRZDSVP4H",
      "nullable": true
    },
    "attributes": {
      "type": "object",
      "properties": {
        "email": {
          "description": "Individual's email address",
          "type": "string",
          "example": "[email protected]",
          "nullable": true
        },
        "phone_number": {
          "description": "Individual's phone number in E.164 format",
          "type": "string",
          "example": "+15005550006",
          "nullable": true
        },
        "external_id": {
          "description": "A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.",
          "type": "string",
          "nullable": true
        }
      }
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}