Update a custom field schema | Close | Developer API Documentation

curl -X PUT https://api.close.com/api/v1/custom_field_schema/object_type/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "fields": [
    {
      "id": "cf_aU54Bvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jgaKq"
    },
    {
      "id": "cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c"
    }
  ]
}'

{
  "fields": [
    {
      "accepts_multiple_values": false,
      "associations": [
        {
          "editable_with_roles": [],
          "object_type": "lead",
          "required": false
        },
        {
          "editable_with_roles": [],
          "object_type": "contact",
          "required": false
        },
        {
          "custom_activity_type_id": "actitype_2FqdeKTAEfMTwD4SVWwXqX",
          "editable_with_roles": [],
          "object_type": "custom_activity_type",
          "required": true
        }
      ],
      "created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
      "date_created": "2021-04-10T17:36:09.235000+00:00",
      "date_updated": "2021-04-10T17:36:09.235000+00:00",
      "description": "User responsible for this Lead/Contact/Activity.",
      "id": "cf_aU54Bvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jgaKq",
      "name": "Owner",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "type": "user",
      "updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
    },
    {
      "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": "# of users",
      "organization_id": "orga_vfvFDAKGLybddKDJn8n7ElZZ3qyRF3QI8fJxTSAYr5X",
      "type": "number",
      "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
    }
  ],
  "name": "Lead",
  "object_type": "lead",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH"
}

To reorder Custom Fields (and thus change the order in which they are displayed in the Close UI), you simply need to supply a `fields` list with `{"id": ...}` items corresponding to the IDs of the Custom Fields belonging to the given Schema. Note that any IDs that are omitted from the list with be automatically appended to the end of the list. If you want to remove some Fields from the Schema, then delete the Custom Field or – in case of Shared Custom Fields – disassociate the Field from the given object.

curl -X PUT https://api.close.com/api/v1/custom_field_schema/object_type/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "fields": [
    {
      "id": "cf_aU54Bvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jgaKq"
    },
    {
      "id": "cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c"
    }
  ]
}'

{
  "fields": [
    {
      "accepts_multiple_values": false,
      "associations": [
        {
          "editable_with_roles": [],
          "object_type": "lead",
          "required": false
        },
        {
          "editable_with_roles": [],
          "object_type": "contact",
          "required": false
        },
        {
          "custom_activity_type_id": "actitype_2FqdeKTAEfMTwD4SVWwXqX",
          "editable_with_roles": [],
          "object_type": "custom_activity_type",
          "required": true
        }
      ],
      "created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
      "date_created": "2021-04-10T17:36:09.235000+00:00",
      "date_updated": "2021-04-10T17:36:09.235000+00:00",
      "description": "User responsible for this Lead/Contact/Activity.",
      "id": "cf_aU54Bvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jgaKq",
      "name": "Owner",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "type": "user",
      "updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
    },
    {
      "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": "# of users",
      "organization_id": "orga_vfvFDAKGLybddKDJn8n7ElZZ3qyRF3QI8fJxTSAYr5X",
      "type": "number",
      "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
    }
  ],
  "name": "Lead",
  "object_type": "lead",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH"
}

To reorder Custom Fields (and thus change the order in which they are displayed in the Close UI), you simply need to supply a fields list with {"id": ...} items corresponding to the IDs of the Custom Fields belonging to the given Schema. Note that any IDs that are omitted from the list with be automatically appended to the end of the list. If you want to remove some Fields from the Schema, then delete the Custom Field or – in case of Shared Custom Fields – disassociate the Field from the given object.

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

object_typestringRequired

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_schema/object_type/ \
>	-H "Content-Type: application/json" \
>	-u "<CLOSE_API_KEY>:" \
>	-d '{
>	"fields": [
>	{
>	"id": "cf_aU54Bvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jgaKq"
>	},
>	{
>	"id": "cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c"
>	}
>	]
>	}'

1	{
2	"fields": [
3	{
4	"accepts_multiple_values": false,
5	"associations": [
6	{
7	"editable_with_roles": [],
8	"object_type": "lead",
9	"required": false
10	},
11	{
12	"editable_with_roles": [],
13	"object_type": "contact",
14	"required": false
15	},
16	{
17	"custom_activity_type_id": "actitype_2FqdeKTAEfMTwD4SVWwXqX",
18	"editable_with_roles": [],
19	"object_type": "custom_activity_type",
20	"required": true
21	}
22	],
23	"created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
24	"date_created": "2021-04-10T17:36:09.235000+00:00",
25	"date_updated": "2021-04-10T17:36:09.235000+00:00",
26	"description": "User responsible for this Lead/Contact/Activity.",
27	"id": "cf_aU54Bvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jgaKq",
28	"name": "Owner",
29	"organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
30	"type": "user",
31	"updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
32	},
33	{
34	"accepts_multiple_values": false,
35	"choices": null,
36	"created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
37	"date_created": "2014-11-07T05:06:09.422000+00:00",
38	"date_updated": "2014-11-10T20:56:16.784000+00:00",
39	"description": "The number of users in the company",
40	"editable_with_roles": [],
41	"id": "cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c",
42	"name": "# of users",
43	"organization_id": "orga_vfvFDAKGLybddKDJn8n7ElZZ3qyRF3QI8fJxTSAYr5X",
44	"type": "number",
45	"updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
46	}
47	],
48	"name": "Lead",
49	"object_type": "lead",
50	"organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH"
51	}