Klaviyo · Schema

ProfileSubscriptionCreateQueryResourceObject

MarketingEmailSMSCustomer DataEcommerceAutomation

Properties

Name Type Description
type object
id string The ID of the profile to subscribe. If provided, this will be used to perform the lookup.
attributes object
View JSON Schema on GitHub

JSON Schema

klaviyo-profilesubscriptioncreatequeryresourceobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ProfileSubscriptionCreateQueryResourceObject",
  "title": "ProfileSubscriptionCreateQueryResourceObject",
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ProfileEnum"
    },
    "id": {
      "description": "The ID of the profile to subscribe. If provided, this will be used to perform the lookup.",
      "type": "string",
      "example": "01GDDKASAP8TKDDA2GRZDSVP4H",
      "nullable": true
    },
    "attributes": {
      "type": "object",
      "properties": {
        "email": {
          "description": "The email address relating to the email subscription included in `subscriptions`. If the email channel is omitted from `subscriptions`, this will be set on the profile.",
          "type": "string",
          "example": "[email protected]",
          "nullable": true
        },
        "phone_number": {
          "description": "The phone number relating to the SMS subscription included in `subscriptions`. If the SMS channel is omitted from `subscriptions`, this will be set on the profile. This must be in E.164 format.",
          "type": "string",
          "example": "+15005550006",
          "nullable": true
        },
        "subscriptions": {
          "description": "Specifies the channel and message types that the profile will be consented to.",
          "$ref": "#/components/schemas/SubscriptionChannels"
        },
        "age_gated_date_of_birth": {
          "description": "The profile's date of birth. This field is required to update SMS consent for accounts using age-gating: https://help.klaviyo.com/hc/en-us/articles/17252552814875",
          "type": "string",
          "format": "date",
          "nullable": true
        }
      },
      "required": [
        "subscriptions"
      ]
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}