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 |
JSON Schema
{
"type": "object",
"description": "A paginated collection of portal flag states",
"properties": {
"portalFlagStates": {
"type": "array",
"description": "List of portal flag states",
"example": [
{
"appId": 12345678,
"flagName": "new-dashboard-feature",
"portalId": 98765432,
"flagState": {}
}
],
"items": {
"type": "object",
"description": "Represents the flag state override for a specific portal (account)",
"properties": {
"appId": {
"type": "integer",
"description": "The unique identifier for the HubSpot application",
"format": "int64",
"example": 12345678
},
"flagName": {
"type": "string",
"description": "The name of the feature flag",
"example": "new-dashboard-feature"
},
"portalId": {
"type": "integer",
"description": "The unique identifier for the HubSpot portal (account)",
"format": "int64",
"example": 98765432
},
"flagState": {
"type": "string",
"description": "The state of a feature flag",
"example": "ON",
"enum": [
"ON",
"OFF",
"ABSENT"
]
}
},
"required": [
"appId",
"flagName",
"portalId",
"flagState"
]
}
},
"paging": {
"type": "object",
"description": "Pagination information for list responses",
"properties": {
"next": {
"type": "object",
"description": "Information for fetching the next page of results",
"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": [
"after"
]
}
}
}
},
"required": [
"portalFlagStates"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "PortalFlagStateCollection"
}