HubSpot · Schema

PortalFlagStateCollection

A paginated collection of portal flag states

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
portalFlagStates array List of portal flag states
paging object Pagination information for list responses
View JSON Schema on GitHub

JSON Schema

crm-feature-flags-api-portal-flag-state-collection-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-schema/crm-feature-flags-api-portal-flag-state-collection-schema.json",
  "title": "PortalFlagStateCollection",
  "description": "A paginated collection of portal flag states",
  "type": "object",
  "properties": {
    "portalFlagStates": {
      "type": "array",
      "description": "List of portal flag states",
      "items": {
        "type": "object",
        "description": "Represents the flag state override for a specific portal (account)",
        "required": [
          "appId",
          "flagName",
          "portalId",
          "flagState"
        ],
        "properties": {
          "appId": {
            "type": "integer",
            "format": "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"
          },
          "portalId": {
            "type": "integer",
            "format": "int64",
            "description": "The unique identifier for the HubSpot portal (account)",
            "example": 98765432
          },
          "flagState": {
            "$ref": "#/components/schemas/FlagState"
          }
        }
      },
      "example": [
        {
          "appId": 12345678,
          "flagName": "new-dashboard-feature",
          "portalId": 98765432,
          "flagState": {}
        }
      ]
    },
    "paging": {
      "type": "object",
      "description": "Pagination information for list responses",
      "properties": {
        "next": {
          "type": "object",
          "description": "Information for fetching the next page of results",
          "required": [
            "after"
          ],
          "properties": {
            "after": {
              "type": "string",
              "description": "Cursor for the next page",
              "example": "NTI1Cg%3D%3D"
            },
            "link": {
              "type": "string",
              "description": "Direct link to the next page",
              "example": "https://api.hubapi.com/feature-flags/v3/12345678/flags/new-dashboard-feature/portals?after=NTI1Cg%3D%3D"
            }
          }
        }
      }
    }
  },
  "required": [
    "portalFlagStates"
  ]
}