Custom Fields
v1
Update Custom Field
Update an existing custom field's name and/or configuration.
At least one of name or configuration must be provided. If name is present, it must not be blank. The configuration attribute is only meaningful for prompt-capable field types (ai_score, ai_text, ai_number, ai_boolean, contact_collection); it is silently ignored for simple types (text, number, boolean, date).
Credit Note: Updating custom fields does not consume credits.
:::info Requires the custom_fields:write OAuth2 scope. :::
patch/v1/custom-fields/{id}
Path parameters
idstring required
The custom field internal name.
Query parameters
account_idstring required
The Leadfeeder Account ID. The Account ID can be retrieved using the List Accounts endpoint.
Request body
Example request
{
"data": {
"attributes": {
"configuration": {
"prompt_category": "technologies"
}
}
}
}Response
Success
Example response
{
"data": {
"type": "custom_field",
"id": "score",
"attributes": {
"name": "Prospect",
"scope": "company",
"type": "text",
"source": "user",
"created_at": "2024-12-10T15:57:25Z",
"updated_at": "2024-11-24T11:50:00Z",
"configuration": {
"prompt_category": "technologies"
}
},
"relationships": {
"created_by": {
"id": "12345"
}
}
},
"meta": {
"request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
}
}