Update Custom Field
PATCH /v1/fields/{fieldId}
/v1/fields/{fieldId}{fieldId}Update a custom field
Updates the label, fallback text, and/or tags of an existing custom field. Only custom (non-system) fields can be updated. Use the field ID returned by the GET /fields endpoint.
Authorization
x-api-key<token>
API key for Open API authentication
In: header
Request Body
application/jsonRequiredProvide one or more fields to update. label changes the display name of the custom field. fallbackText changes the placeholder shown when a prospect has no value for this field. tags is a full-replacement list (separate namespace from Prospect Tags) — omit to leave tags unchanged, or pass an empty array to remove all tags; tags present here but not currently on the field are added (case-insensitively resolved, created if new), tags currently on the field but absent here are removed. At least one field must be provided.
labelstring
The new display name for the custom field. This label will appear in the prospect profile and throughout the application.
Example:"LinkedIn URL"fallbackTextstring
Updated placeholder text to display when the field has no value for a prospect.
Example:"Not available"tagsarray<string>
Full-replacement list of tags for this field (separate namespace from Prospect Tags). Omit to leave tags unchanged; pass an empty array to remove all tags. Tags present here but not currently on the field are added (case-insensitively resolved, created if new); tags currently on the field but absent here are removed.
Example:["CRM","Sales"]Path Parameters
fieldIdstring
Public custom-field ID returned by field read/list APIs.
Request Body Examples
{
"label": "LinkedIn URL"
}Responses
{
"message": "Custom field updated successfully"
}