Kajabi · Schema

Contacts

Schema for Kajabi contacts

Creator EconomyOnline CoursesMembershipsE-CommerceDigital ProductsContactsWebhooksPayments

Properties

Name Type Description
name string
email string
phone_number stringnull
business_number stringnull
subscribed boolean
address_line_1 stringnull
address_line_2 stringnull
address_city stringnull
address_state stringnull
address_country stringnull
external_user_id string Supported once contact is granted an offer or makes a purchase
address_zip stringnull
custom_1 string Support depends on custom fields of a site
custom_2 string Support depends on custom fields of a site
custom_3 string Support depends on custom fields of a site
created_at string ISO 8601 date-time, read only
updated_at string ISO 8601 date-time, read only
View JSON Schema on GitHub

JSON Schema

contacts_attributes.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/kajabi/main/json-schema/contacts_attributes.json",
  "title": "Contacts",
  "description": "Schema for Kajabi contacts",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "phone_number": {
      "type": [
        "string",
        "null"
      ]
    },
    "business_number": {
      "type": [
        "string",
        "null"
      ]
    },
    "subscribed": {
      "type": "boolean"
    },
    "address_line_1": {
      "type": [
        "string",
        "null"
      ]
    },
    "address_line_2": {
      "type": [
        "string",
        "null"
      ]
    },
    "address_city": {
      "type": [
        "string",
        "null"
      ]
    },
    "address_state": {
      "type": [
        "string",
        "null"
      ]
    },
    "address_country": {
      "type": [
        "string",
        "null"
      ]
    },
    "external_user_id": {
      "type": "string",
      "nullable": true,
      "description": "Supported once contact is granted an offer or makes a purchase"
    },
    "address_zip": {
      "type": [
        "string",
        "null"
      ]
    },
    "custom_1": {
      "type": "string",
      "nullable": true,
      "description": "Support depends on custom fields of a site"
    },
    "custom_2": {
      "type": "string",
      "nullable": true,
      "description": "Support depends on custom fields of a site"
    },
    "custom_3": {
      "type": "string",
      "nullable": true,
      "description": "Support depends on custom fields of a site"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "ISO 8601 date-time, read only"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "ISO 8601 date-time, read only"
    }
  }
}