Klaviyo · Schema

AccountResponseObjectResource

MarketingEmailSMSCustomer DataEcommerceAutomation

Properties

Name Type Description
type object
id string
attributes object
links object
View JSON Schema on GitHub

JSON Schema

klaviyo-accountresponseobjectresource-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AccountResponseObjectResource",
  "title": "AccountResponseObjectResource",
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/AccountEnum"
    },
    "id": {
      "type": "string"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "test_account": {
          "description": "Indicates if the account is a test account. Test accounts are not a separate testing engineering environment. Test accounts use the same production environment as normal Klaviyo accounts. This feature is primarily UI based to reduce human errors",
          "type": "boolean"
        },
        "contact_information": {
          "description": "Contact information for the account. This is used in email footers by default to comply with the CAN-SPAM act.",
          "$ref": "#/components/schemas/ContactInformation"
        },
        "industry": {
          "description": "The kind of business and/or types of goods that the business sells. This is leveraged in Klaviyo analytics and guidance.",
          "type": "string",
          "example": "Software / SaaS",
          "nullable": true
        },
        "timezone": {
          "description": "The account's timezone is used when displaying dates and times. This is an IANA timezone. See [the full list here ](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).",
          "type": "string",
          "example": "US/Eastern"
        },
        "preferred_currency": {
          "description": "The preferred currency for the account. This is the currency used for currency-based metrics in dashboards, analytics, coupons, and templates.",
          "type": "string",
          "example": "USD"
        },
        "public_api_key": {
          "description": "The Public API Key can be used for client-side API calls. [More info here](https://developers.klaviyo.com/en/docs/retrieve_api_credentials).",
          "type": "string",
          "example": "AbC123"
        },
        "locale": {
          "description": "The account's locale is used to determine the region and language for the account.",
          "type": "string",
          "example": "en-US"
        }
      },
      "required": [
        "test_account",
        "contact_information",
        "timezone",
        "preferred_currency",
        "public_api_key",
        "locale"
      ]
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    }
  },
  "required": [
    "type",
    "id",
    "attributes",
    "links"
  ]
}