v1

latestOpenAPI 3.0.32026-07-26870417.2 KB

custom properties

Update Custom Property

This endpoint updates the name, section or mandatory flag of a custom property

Provide any combination of the three fields - at least one is required. If the section does not exist yet, it is created automatically

Options for dropdown and picklist properties are managed separately via the Update Property Options endpoint

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

If the same property name exists under both chat and ticket, pass the type query parameter to specify which one to update. Without it, the request is rejected as ambiguous

post/properties/{property_id}

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

namestring

The new name of the property
Must be unique within its type

sectionstring

The name of the section to move the property to
Created automatically if it does not exist

mandatoryboolean

Whether the property is mandatory
Supported only for ticket properties; rejected for chat properties

Example request

{
  "name": "Workspace ID",
  "section": "Issue Details",
  "mandatory": true
}

Response

200 OK

successboolean

messagestring

Example response

{
  "success": true,
  "message": "Custom property updated",
  "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"
  }
}