Email SupportCall Us Go to Close

Lead Custom Fields

List all the Lead Custom Fields for your organization.

GET /custom_field/lead/

Create a new Lead Custom Field.

POST /custom_field/lead/

Fetch Lead Custom Field's details.

GET /custom_field/lead/{id}/

Update a Lead Custom Field.

PUT /custom_field/lead/{custom_field_id}/

You can rename it, change its type, change whether it accepts multiple values or not, change whether editing its values is restricted to specific Roles, or update the options for a "choices" field type. The updated name will immediately appear in the Close UI and only valid values for the updated type will be returned by the Lead API.

Some of the type changes need to convert all of the existing values for a given Custom Field to the new type. When this is required, the response will include an additional converting_to_type field. When the conversion is done, converting_to_type will no longer be returned.

Delete a Lead Custom Field.

DELETE /custom_field/lead/{custom_field_id}/

The field will immediately disappear from any Lead API responses.