Custom Fields

Update a workspace chat custom column

Applies a partial update to a workspace chat custom-column definition. When options is provided it replaces the full option set.

patch/v1/custom-columns/{column_id}

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/custom-columns/{column_id}
  • Auth: API key in header X-API-Key

Path parameters

column_idstring required

Workspace custom-column identifier.

Example:column_demo_123

Request body

defaultValueunknown
isRequiredboolean

Updated required flag.

namestring

Updated human-readable field label.

orderinteger

Updated display order.

typestring

Updated field input type.

Example request

{
  "isRequired": true,
  "name": "Account Segment",
  "options": [
    {
      "color": "#3b82f6",
      "label": "Qualified",
      "value": "qualified"
    }
  ],
  "order": 4,
  "type": "multiselect"
}

Response

OK

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.