Sign in

v1

latestOpenAPI 3.0.32026-07-26870417.2 KB
custom properties

Delete Custom Properties

This endpoint deletes one or more custom properties

Pass the ids or names of the properties to delete in ticket_properties and/or chat_properties. At least one of the two must be provided

Deleting a property is permanent. Any values set for it on tickets or chats are orphaned

Entries that do not match any property are reported with deleted: false and a reason, without failing the rest of the request

delete/properties

Request body

ticket_propertiesstring[]
  • The ids or names of the ticket properties to delete
chat_propertiesstring[]
  • The ids or names of the chat properties to delete

Example request

{
  "ticket_properties": [
    "Workspace",
    "property-a1b2c3"
  ],
  "chat_properties": [
    "Workspace"
  ]
}

Response

200 OK

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Custom properties deleted",
  "data": {
    "deleted_count": 2,
    "properties": [
      {
        "property_ref": "Workspace",
        "property_id": "property-a1b2c3",
        "deleted": true,
        "reason": "not_found"
      }
    ]
  }
}