Sign in

v1

latestOpenAPI 3.0.32026-07-26870417.2 KB
custom properties

Create Custom Property

This endpoint creates a custom property in your workspace

For dropdown and picklist kinds, provide the initial option list in options - these kinds cannot be created without at least one option

The property name must be unique within its type. The same name can exist once as a chat property and once as a ticket property

mandatory is supported only for ticket properties. Passing mandatory: true for a chat property returns a validation error

The dependent_dropdown kind cannot be created via the API

post/properties/create

Request body

namestring required
  • The name of the property
  • Must be unique within its type (chat/ticket)
type'chat' | 'ticket' required
  • The type the property belongs to
kind'text' | 'date' | 'file' | 'dropdown' | 'picklist' required
  • The value kind of the property
  • dropdown is single-select, picklist is multi-select
sectionstring
  • The name of the section to place the property under
  • Created automatically if it does not exist
mandatoryboolean
  • Whether the property is mandatory
  • Supported only for ticket properties; rejected for chat properties
  • Defaults to false
optionsstring[]
  • The initial option labels
  • Required (at least one non-empty label) for dropdown and picklist kinds
  • Not allowed for other kinds

Example request

{
  "name": "Workspace",
  "type": "ticket",
  "kind": "dropdown",
  "section": "Issue Details",
  "options": [
    "Acme Corp",
    "Globex"
  ]
}

Response

200 OK

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Custom property created",
  "data": {
    "property_id": "property-a1b2c3",
    "property_name": "Workspace",
    "type": "ticket",
    "kind": "dropdown",
    "section_id": "3f8b6c1e-8f2a-4b6e-9c3d-2a1f0e9d8c7b",
    "section_name": "Issue Details",
    "options": [
      {
        "id": "1712345678901",
        "label": "Acme Corp"
      }
    ],
    "created_at": "2026-07-06T10:00:00.000Z"
  }
}