Create Ticket Field
POST {{baseUrl}}/api/v2/ticket_fields
Creates any of the following custom field types:
| Custom field type | Description |
|---|---|
| text | Default custom field type when type is not specified |
| textarea | For multi-line text |
| checkbox | To capture a boolean value. Allowed values are true or false |
| date | Example: 2021-04-16 |
| integer | String composed of numbers. May contain an optional decimal point |
| decimal | For numbers containing decimals |
| regexp | Matches the Regex pattern found in the custom field settings |
| partialcreditcard | A credit card number. Only the last 4 digits are retained |
| multiselect | Enables users to choose multiple options from a dropdown menu |
| tagger | Single-select dropdown menu. It contains one or more tag values belonging to the field's options. Example: ( {id: 21938362, value: [ hd_3000, hd_5555]}) |
| lookup | A field to create a relationship (see lookup relationships) to another object such as a user, ticket, or organization |
See About custom field types in the Zendesk Help Center.
Allowed For
- Admins
Field limits
We recommend the following best practices for ticket fields limits. Creating more than these amounts can affect performance.
- 400 ticket fields per account if your account doesn't have ticket forms
- 400 ticket fields per ticket form if your account has ticket forms
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: Created
{"ticket_field":{"active":true,"agent_description":"Agent only description","collapsed_for_agents":false,"created_at":"2012-04-02T22:55:29Z","description":"Age","editable_in_portal":false,"id":89,"position":9999,"raw_description":"Age","raw_title":"Age","raw_title_in_portal":"Age","regexp_for_validation":null,"required":true,"required_in_portal":false,"tag":null,"title":"Age","title_in_portal":"Age","type":"text","updated_at":"2012-04-02T22:55:29Z","url":"https://company.zendesk.com/api/v2/ticket_fields/89.json","visible_in_portal":false}}