Update an Activity Custom Field

PUT

https://api.close.com/api/v1/custom_field/activity/:id/

PUT

/api/v1/custom_field/activity/:id/

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

1 {
2   "accepts_multiple_values": false,
3   "created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
4   "custom_activity_type_id": "actitype_1h5m6uHM9BZOpwVhyRJb4Y",
5   "date_created": "2020-08-07T17:11:44.299904",
6   "date_updated": "2020-08-07T17:11:44.299904",
7   "description": null,
8   "editable_with_roles": [],
9   "id": "cf_1nkEcnaoAiTJBfYmTBsOQqFCuIkqc82Q f4yKUx01e0K",
10   "name": "Free-form Notes",
11   "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
12   "required": false,
13   "type": "text",
14   "updated_ by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
15 }

You can rename it, change whether it accepts multiple values or not, change the "required" flag, 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 Custom Activity API. The `custom_activity_type_id` and `type` values cannot be changed.

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

{
  "accepts_multiple_values": false,
  "created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
  "custom_activity_type_id": "actitype_1h5m6uHM9BZOpwVhyRJb4Y",
  "date_created": "2020-08-07T17:11:44.299904",
  "date_updated": "2020-08-07T17:11:44.299904",
  "description": null,
  "editable_with_roles": [],
  "id": "cf_1nkEcnaoAiTJBfYmTBsOQqFCuIkqc82Q f4yKUx01e0K",
  "name": "Free-form Notes",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "required": false,
  "type": "text",
  "updated_ by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
}

You can rename it, change whether it accepts multiple values or not, change the “required” flag, 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 Custom Activity API.

The custom_activity_type_id and type values 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

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

1	{
2	"accepts_multiple_values": false,
3	"created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
4	"custom_activity_type_id": "actitype_1h5m6uHM9BZOpwVhyRJb4Y",
5	"date_created": "2020-08-07T17:11:44.299904",
6	"date_updated": "2020-08-07T17:11:44.299904",
7	"description": null,
8	"editable_with_roles": [],
9	"id": "cf_1nkEcnaoAiTJBfYmTBsOQqFCuIkqc82Q f4yKUx01e0K",
10	"name": "Free-form Notes",
11	"organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
12	"required": false,
13	"type": "text",
14	"updated_ by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
15	}