HubSpot · JSON Structure

Custom Workflow Actions Api Field Option Structure

An option for an enumeration field

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

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

Properties

label value displayOrder

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/custom-workflow-actions-api-field-option-structure.json",
  "name": "FieldOption",
  "description": "An option for an enumeration field",
  "type": "object",
  "properties": {
    "label": {
      "type": "string",
      "description": "Display label for the option",
      "example": "Example Record"
    },
    "value": {
      "type": "string",
      "description": "The value of the option",
      "example": "example-value"
    },
    "displayOrder": {
      "type": "int32",
      "description": "Order in which to display the option",
      "example": 100
    }
  },
  "required": [
    "label",
    "value"
  ]
}