HubSpot · JSON Structure

Crm Feature Flags Api Feature Flag Structure

Represents a feature flag configuration for an application

Type: object Properties: 4 Required: 3
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

FeatureFlag is a JSON Structure definition published by HubSpot, describing 4 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

appId flagName defaultState overrideState

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-structure/crm-feature-flags-api-feature-flag-structure.json",
  "name": "FeatureFlag",
  "description": "Represents a feature flag configuration for an application",
  "type": "object",
  "properties": {
    "appId": {
      "type": "int64",
      "description": "The unique identifier for the HubSpot application",
      "example": 12345678
    },
    "flagName": {
      "type": "string",
      "description": "The name of the feature flag",
      "example": "new-dashboard-feature"
    },
    "defaultState": {
      "type": "string",
      "description": "The state of a feature flag",
      "enum": [
        "ON",
        "OFF",
        "ABSENT"
      ],
      "example": "ON"
    },
    "overrideState": {
      "type": "string",
      "description": "The state of a feature flag",
      "enum": [
        "ON",
        "OFF",
        "ABSENT"
      ],
      "example": "ON"
    }
  },
  "required": [
    "appId",
    "flagName",
    "defaultState"
  ]
}