BatchPortalFlagStateResponseWithErrors

{
  "type": "object",
  "description": "Response for batch operations that had some failures",
  "properties": {
    "status": {
      "type": "string",
      "description": "The overall status of the batch operation",
      "example": "COMPLETE",
      "enum": [
        "COMPLETE",
        "PENDING"
      ]
    },
    "results": {
      "type": "array",
      "description": "List of portal flag states that were successfully affected",
      "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"
        ]
      }
    },
    "errors": {
      "type": "array",
      "description": "List of errors that occurred during the batch operation",
      "example": [
        {
          "status": "error",
          "category": "VALIDATION_ERROR",
          "message": "Invalid portal ID",
          "context": {
            "key": "value"
          }
        }
      ],
      "items": {
        "type": "object",
        "description": "Represents an error that occurred for a specific item in a batch operation",
        "properties": {
          "status": {
            "type": "string",
            "description": "Error status code",
            "example": "error"
          },
          "category": {
            "type": "string",
            "description": "Error category",
            "example": "VALIDATION_ERROR"
          },
          "message": {
            "type": "string",
            "description": "Human-readable error message",
            "example": "Invalid portal ID"
          },
          "context": {
            "type": "object",
            "description": "Additional context about the error",
            "example": {
              "key": "value"
            }
          }
        },
        "required": [
          "status",
          "category",
          "message"
        ]
      }
    },
    "startedAt": {
      "type": "string",
      "description": "Timestamp when the batch operation started",
      "format": "date-time",
      "example": "2025-03-15T14:30:00Z"
    },
    "completedAt": {
      "type": "string",
      "description": "Timestamp when the batch operation completed",
      "format": "date-time",
      "example": "2025-03-15T14:30:00Z"
    }
  },
  "required": [
    "status",
    "results"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "BatchPortalFlagStateResponseWithErrors"
}