post {protocol}://{base-url}/integration/v2/custom_field/
This endpoint can be used to create new Custom Fields. Maximum 1000 items per batch.
The following table summarizes the body parameters and their possible values for each type of custom field. You may need to scroll to the right to see all the columns.
The maximum length for all string values is 255 characters. The recommended length is 30-50 characters due to the limited amount of display space in the UI.
| Body Param | Object Set | People Set | Reference | Picker | Multi-Select Picker | Rich Text | Date |
|---|---|---|---|---|---|---|---|
| allow_multiple | Required: true | Required:true | Required:false | - | - | - | - |
| allowed_otypes | Required array from: - article- attribute- business_policy- data- glossary_term*- glossary_v3*- groupprofile- schema- table- user | Required array of exactly:[user, groupprofile] | Required array from: - article- attribute- business_policy- data- glossary_term*- glossary_v3*- groupprofile- schema- table- user | - | - | - | - |
| backref_name | Required | Required | Required | - | - | - | - |
| backref_tooltip_text | Optional | Optional | Optional | - | - | - | - |
| field_type | Required: OBJECT_SET | Required: OBJECT_SET | Required: OBJECT_SET | Required: PICKER | Required: MULTI_PICKER | Required: RICH_TEXT | Required: DATE |
| name_plural | Required | Required | - | - | Required | - | - |
| name_singular | Required | Required | Required | Required | Required | Required | Required |
| options | - | - | - | Required | Required | - | - |
| tooltip_text | Optional | Optional | Optional | Optional | Optional | Optional | Optional |
* glossary_term refers to document objects when Document Hubs is enabled. Otherwise it refers to terms.
* glossary_v3refers to folder objects when Document Hubs is enabled. Otherwise refers to glossaries.