POST /api/v2/custom_objects/{custom_object_key}/fields
Creates any of the following custom field types:
- text (default when no "type" is specified)
- textarea
- checkbox
- date
- integer
- decimal
- regexp
- dropdown
- lookup
- multiselect
See About custom field types in Zendesk help.
Allowed For
- Admins
Servers
- https://{subdomain}.{domain}.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
custom_object_key |
String | Yes |
The key of a custom object |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
custom_object_field |
Object | No | |
custom_object_field.description |
String | No |
User-defined description of this field's purpose |
custom_object_field.regexp_for_validation |
String | No |
Regular expression field only. The validation pattern for a field value to be deemed valid |
custom_object_field.url |
String | No |
The URL for this resource |
custom_object_field.properties |
Object | No |
A set of properties which describe the standard::name field's autonumbering and uniqueness behavior. Autonumbering and uniqueness can't be used together |
custom_object_field.properties.is_unique |
Boolean | No |
Turns uniqueness on or off |
custom_object_field.properties.autoincrement_next_sequence |
Integer | No |
The next number in the autonumbering sequence. It can't be negative or less than the current autonumbering value |
custom_object_field.properties.autoincrement_prefix |
String | No |
A prefix to autogenerated numbers that can't exceed 30 characters |
custom_object_field.properties.autoincrement_enabled |
Boolean | No |
Turns autonumbering on or off |
custom_object_field.properties.autoincrement_padding |
Integer | No |
Sets the number of digits for autogenerated numbers. Valid values are 0-9 |
custom_object_field.custom_field_options[] |
Array | No |
Required and presented for a custom field of type "dropdown". Each option is represented by an object with a |
custom_object_field.custom_field_options[].id |
Integer | No |
Automatically assigned upon creation |
custom_object_field.custom_field_options[].name |
String | Yes |
Name of the dropdown option |
custom_object_field.custom_field_options[].url |
String | No |
URL of the dropdown option |
custom_object_field.custom_field_options[].raw_name |
String | No |
Raw name of the dropdown option |
custom_object_field.custom_field_options[].value |
String | Yes |
Value of the dropdown option |
custom_object_field.custom_field_options[].position |
Integer | No |
Position of the dropdown option |
custom_object_field.position |
Integer | No |
Ordering of the field relative to other fields |
custom_object_field.tag |
String | No |
Optional for custom field of type "checkbox"; not presented otherwise. |
custom_object_field.relationship_target_type |
String | No |
A representation of what type of object the field references. Options are "zen:user", "zen:organization", "zen:ticket", and "zen:custom_object:{key}" where key is a custom object key. For example "zen:custom_object:apartment". |
custom_object_field.updated_at |
String | No |
The time of the last update of the ticket field |
custom_object_field.id |
Integer | No |
Automatically assigned upon creation |
custom_object_field.relationship_filter |
Object | No |
A filter definition that allows your autocomplete to filter down results |
custom_object_field.raw_description |
String | No |
The dynamic content placeholder, if present, or the |
custom_object_field.active |
Boolean | No |
If true, this field is available for use |
custom_object_field.key |
String | Yes |
A unique key that identifies this custom field. This is used for updating the field and referencing in placeholders. The key must consist of only letters, numbers, and underscores. It can't be only numbers |
custom_object_field.raw_title |
String | No |
The dynamic content placeholder, if present, or the |
custom_object_field.system |
Boolean | No |
If true, only active and position values of this field can be changed |
custom_object_field.title |
String | Yes |
The title of the custom field |
custom_object_field.type |
String | Yes |
The custom field type: "checkbox", "date", "decimal", "dropdown", "integer", "lookup", "multiselect", "regexp", "text", or "textarea" |
custom_object_field.created_at |
String | No |
The time of the last update of the ticket field |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.