HubSpot · JSON Structure

Crm Feature Flags Api Batch Portal Flag State Response Structure

Response for successful batch portal flag state operations

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

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

Properties

status results startedAt completedAt

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-batch-portal-flag-state-response-structure.json",
  "name": "BatchPortalFlagStateResponse",
  "description": "Response for successful batch portal flag state operations",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "The overall status of the batch operation",
      "enum": [
        "COMPLETE",
        "PENDING"
      ],
      "example": "COMPLETE"
    },
    "results": {
      "type": "array",
      "description": "List of portal flag states that were successfully affected",
      "items": {
        "type": "object",
        "description": "Represents the flag state override for a specific portal (account)",
        "required": [
          "appId",
          "flagName",
          "portalId",
          "flagState"
        ],
        "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"
          },
          "portalId": {
            "type": "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": {}
        }
      ]
    },
    "startedAt": {
      "type": "datetime",
      "description": "Timestamp when the batch operation started",
      "example": "2024-01-15T10:30:00Z"
    },
    "completedAt": {
      "type": "datetime",
      "description": "Timestamp when the batch operation completed",
      "example": "2024-01-15T10:30:01Z"
    }
  },
  "required": [
    "status",
    "results"
  ]
}