Add additional custom fields to a custom field template.
Notice
To update a custom field template, see the Update Custom Field Template API.
Endpoint URL
https://{{base_url}}/api/v2/custom-field
Authentication and rate limits
| Item | Details |
|---|---|
| Authentication method | OAuth 2.0 Bearer token |
| Rate limit | Rate Limit |
Requests Example
curl --request PUT \
--url "https://{{base_url}}/api/v2/custom-field/{id}" \
--header "Authorization: Bearer $BEARER_TOKEN" \
--header "Content-Type: application/json" \
--data-raw "$JSON"
Request Syntax
{
"company": integer,
"fields": [
{
"name": "string",
"data_type": "date" | "money" | "number" | "text"
},
]
}
Body Parameters
- id (integer) --
[REQUIRED] The ID of the custom field template.
The id parameter is passed as part of the request url/custom-field/$id.
To lookup a specific custom field template ID, see the List Custom Field Template API. - company (integer) --
[REQUIRED]
The ID of the specific company your API is calling. For accounts with only one company, the default value is1.
To lookup a specific company ID, see the List Company API. - fields (list) --
[REQUIRED] at least one custom field must be added
- name (string) --
[REQUIRED]
The name of the custom field.
Max characters =50
The name of the custom field must be unique per the custom field template. - data_type (string) --
[REQUIRED]
The data type of the custom field.
Options:date|money|number|text
- name (string) --