Update a Shared Custom Field | Close | Developer API Documentation

curl -X PUT https://api.close.com/api/v1/custom_field/shared/id/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "name": "Free-form Notes"
}'

{
  "accepts_multiple_values": false,
  "associations": [
    {
      "custom_activity_type_id": "actitype_2FqdeKTAEfMTwD4SVWwXqX",
      "editable_with_roles": [],
      "object_type": "custom_activity_type",
      "required": true
    },
    {
      "custom_activity_type_id": "actitype_9ab3QuzEAmFTvd56kByOMn",
      "editable_with_roles": [],
      "object_type": "custom_activity_type",
      "required": true
    }
  ],
  "choices": null,
  "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "date_created": "2021-04-10T05:06:09.422000+00:00",
  "date_updated": "2021-04-10T20:56:16.784000+00:00",
  "description": null,
  "id": "cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c",
  "name": "Free-form Notes",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "type": "text",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
}

You can rename it 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 choices will be returned by the Lead/Contact/Custom Activity APIs.

The type value cannot be changed.

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