Update a Lead Custom Field | Close | Developer API Documentation

curl -X PUT https://api.close.com/api/v1/custom_field/lead/id/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "name": "Number of users",
  "type": "text"
}'

{
  "accepts_multiple_values": false,
  "choices": null,
  "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "date_created": "2014-11-07T05:06:09.422000+00:00",
  "date_updated": "2014-11-10T20:56:16.784000+00:00",
  "description": "The number of users in the company",
  "editable_with_roles": [],
  "id": "cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c",
  "name": "Number of users",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "type": "text",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
}

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.

curl -X PUT https://api.close.com/api/v1/custom_field/lead/id/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "name": "Number of users",
  "type": "text"
}'

{
  "accepts_multiple_values": false,
  "choices": null,
  "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "date_created": "2014-11-07T05:06:09.422000+00:00",
  "date_updated": "2014-11-10T20:56:16.784000+00:00",
  "description": "The number of users in the company",
  "editable_with_roles": [],
  "id": "cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c",
  "name": "Number of users",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "type": "text",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
}

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.

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Request

This endpoint expects any.

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

$	curl -X PUT https://api.close.com/api/v1/custom_field/lead/id/ \
>	-H "Content-Type: application/json" \
>	-u "<CLOSE_API_KEY>:" \
>	-d '{
>	"name": "Number of users",
>	"type": "text"
>	}'

1	{
2	"accepts_multiple_values": false,
3	"choices": null,
4	"created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
5	"date_created": "2014-11-07T05:06:09.422000+00:00",
6	"date_updated": "2014-11-10T20:56:16.784000+00:00",
7	"description": "The number of users in the company",
8	"editable_with_roles": [],
9	"id": "cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c",
10	"name": "Number of users",
11	"organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
12	"type": "text",
13	"updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
14	}