Update Custom Field - Leadfeeder API

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.

Request

Authorization

API Key

Add parameter in header

X-Api-Key

Example:

X-Api-Key: ********************

Path Params

Query Params

Body Params application/jsonRequired

Examples

Rename a custom fieldUpdate AI field configurationUpdate name and configuration

{
    "data": {
        "type": "custom_field",
        "attributes": {
            "name": "Updated Field Name"
        }
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Bodyapplication/json

Example

{
    "data": {
        "type": "custom_field",
        "id": "score",
        "attributes": {
            "name": "Prospect",
            "scope": "company",
            "type": "text",
            "read_only": true,
            "source": "system",
            "created_at": "2024-12-10T15:57:25Z",
            "updated_at": "2024-11-24T11:50:00Z",
            "configuration": {
                "prompt": "string",
                "prompt_category": "job_listings",
                "prompt_with_external_data": true
            }
        },
        "relationships": {
            "created_by": {
                "id": "12345",
                "type": "user"
            }
        }
    },
    "meta": {
        "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429Server Error

🔴500Server Error

🔴504Gateway Timeout