v1

latestOpenAPI 3.1.02026-07-24111290748.0 KB
Tickets

Update ticket fields values

Replace the custom field values for a ticket.

Important — replace-all semantics: The request body must contain all custom field values you want the ticket to have. Any field that currently has a value on the ticket but is not included in the request body will be deleted.

Some system-managed fields (e.g. AI Agent Outcome, AI Intent) can only be deleted by Gorgias internal apps.

Safe pattern: fetch the current values with GET /api/tickets/{ticket_id}/custom-fields, merge your changes, and send the full list back.

put/api/tickets/{ticket_id}/custom-fields

Path parameters

ticket_idinteger required

The ID of the ticket.

Request body

idinteger required

ID of the custom field for which to set a value.

Example request

[
  {
    "id": 123
  }
]

Response

List of ticket's updated custom fields values.

idinteger
{"stackTrail":"components:schemas:TicketCustomFieldValue:properties:prediction","oasType":"schema","type":"unknown","title":"prediction"}
{"stackTrail":"components:schemas:TicketCustomFieldValue:properties:value","oasType":"schema","type":"unknown","title":"value"}