Updates a custom field template.
Notice
To add additional custom fields to a custom field template, see the Update Custom Field API.
PUT vs PATCH
PUT is used to fully update an existing resource. It replaces the entire resource with the data provided.
🔸 Any fields not included in the request body will be overwritten to null or their default value.
🔹 Use PUT when you are sending the complete updated object.PATCH is used to partially update a resource. It modifies only the specified fields without affecting others.
🔸 Fields not included in the PATCH request body will be left unchanged.
🔹 Use PATCH when you only need to update a few fields.✅ Tip: Always double-check which method to use based on your update logic. Use PUT carefully to avoid unintentionally nulling out data.
Endpoint URL
https://{{base_url}}/api/v2/custom-field-template
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-template/{id}" \
--header "Authorization: Bearer $BEARER_TOKEN" \
--header "Content-Type: application/json" \
--data-raw "$JSON"
Request Syntax
{
"company": integer,
"name": "string",
"is_active": true | false,
"fields": [
{
"id": integer,
"name": "string",
"is_active": true | false
},
]
}
Query Parameters
- id (integer) --
[REQUIRED] The ID of the custom field template.
The id parameter is passed as part of the request url/custom-field-template/$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. - name (string) --
[REQUIRED]
The name of the custom field template.
Max characters =50
The name of the custom field template must be unique per the type of the custom field template. - is_active (boolean) --
[REQUIRED]
Whether the custom field template is active.
Options:true|false - fields (list) --
[REQUIRED] all existing custom fields must be included
- id (integer) --
[REQUIRED]
The ID of the custom field.
To lookup a specific custom field ID, see the List Custom Field Template API. - 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. - is_active (boolean) --
[REQUIRED]
Whether the custom field is active.
Options:true|false
- id (integer) --