Custom Fields

Create a workspace ticket custom column

Creates a workspace ticket custom-column definition. Ticket schema must be enabled for the workspace.

post/v1/ticket-custom-columns

Request

  • Base URL: https://api.entergram.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.entergram.com/v1/ticket-custom-columns
  • Auth: API key in header X-API-Key

Request body

defaultValueunknown
isRequiredboolean

Whether the field is required in the operator UI.

keystring

Optional stable key. When omitted it is slugified from the name.

namestring required

Human-readable field label.

orderinteger

Optional explicit display order.

typestring required

Field input type.

Example request

{
  "key": "relationship_stage",
  "name": "Relationship Stage",
  "options": [
    {
      "color": "#3b82f6",
      "label": "Qualified",
      "value": "qualified"
    }
  ],
  "order": 3,
  "type": "select"
}

Response

Created

Example response

{
  "data": {
    "id": "column_demo_123",
    "key": "relationship_stage",
    "name": "Relationship Stage",
    "options": [
      {
        "color": "#3b82f6",
        "id": "field_option_demo_123",
        "label": "Qualified",
        "value": "qualified"
      }
    ],
    "order": 3,
    "type": "select"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.