Create or Update Ticket Field Option

POST {{baseUrl}}/api/v2/ticket_fields/:ticket_field_id/options

Creates or updates an option for the given drop-down ticket field.

To update an option, include the id of the option in the custom_field_option object. Example:

{"custom_field_option": {"id": 10002, "name": "Pineapples", ... }

If an option exists for the given ID, the option will be updated. Otherwise, a new option will be created.

Response

Returns one of the following status codes:

  • 200 with Location: /api/v2/ticket_fields/{ticket_field_id}/options.json if the ticket field option already exists in the database
  • 201 with Location: /api/v2/ticket_fields/{ticket_field_id}/options.json if the ticket field option is new

Allowed For

  • Admins

Rate Limit

You can make 100 requests every 1 minute using this endpoint. The rate limiting mechanism behaves as described in Monitoring your request activity in the API introduction.

Field Option Limits

  • 2000 options per ticket field

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: Created

{"custom_field_option":{"id":10002,"name":"Grapes","position":2,"raw_name":"Grapes","url":"http://{subdomain}.zendesk.com/api/v2/ticket_fields/1/options/10002.json","value":"grape"}}