v1

latestOpenAPI 3.0.32026-07-26870417.2 KB

custom properties

Update Property Options

This endpoint adds or removes options on a dropdown or picklist custom property

To add options, pass the labels in options with operation: add. Adding is idempotent - re-adding an existing label is a no-op that returns its existing id, so you can safely keep the option list in sync with an external source of truth

To remove options, pass option ids or labels in options with operation: remove

Removing an option is permanent. Tickets or chats currently set to a removed option will no longer resolve it to a label

If the same property name exists under both chat and ticket, pass the type query parameter to specify which one to update

post/properties/{property_id}/options

Path parameters

property_idstring required

The property_id (e.g. property-xxxx) or the property_name of the custom property

Query parameters

type'chat' | 'ticket'

Specifies whether to resolve the chat or the ticket property when the same name exists under both

Request body

operation'add' | 'remove' required

Whether to add or remove the given options

optionsstring[] required

For add: the labels to add
For remove: the option ids or labels to remove

Example request

{
  "operation": "add",
  "options": [
    "Acme Corp",
    "Globex"
  ]
}

Response

200 OK

successboolean

messagestring

Example response

{
  "success": true,
  "message": "Options updated",
  "data": {
    "property_id": "property-a1b2c3",
    "operation": "add",
    "options": [
      {
        "id": "1712345678901",
        "label": "Acme Corp",
        "added": true,
        "removed": true
      }
    ]
  }
}