HubSpot · Schema

FieldOption

An option for an enumeration field

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
label string Display label for the option
value string The value of the option
displayOrder integer Order in which to display the option
View JSON Schema on GitHub

JSON Schema

custom-workflow-actions-api-field-option-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/custom-workflow-actions-api-field-option-schema.json",
  "title": "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": "integer",
      "description": "Order in which to display the option",
      "example": 100
    }
  },
  "required": [
    "label",
    "value"
  ]
}