LEleadfeeder
Custom Fields
v1

Update Custom Field

Changed on

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}

Request

  • Base URL
    https://api.leadfeeder.com
  • URL
    https://api.leadfeeder.com/v1/custom-fields/{id}
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.leadfeeder.com/v1/oauth/authorize
      Token URL: https://api.leadfeeder.com/v1/oauth/token scopes: custom_fields:write

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": {
    "attributes": {
      "configuration": {
        "prompt_category": "technologies"
      },
      "created_at": "2024-12-10T15:57:25Z",
      "name": "Prospect",
      "scope": "company",
      "source": "user",
      "type": "text",
      "updated_at": "2024-11-24T11:50:00Z"
    },
    "id": "score",
    "relationships": {
      "created_by": {
        "id": "12345"
      }
    },
    "type": "custom_field"
  },
  "meta": {
    "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
  }
}

Changes

  • ac752c6c2be0Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 12ae8a6b9fadRevision changes
    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      the endpoint scheme security OAuth2 was added to the API

    • info

      added the non-success response with the status