Create a new Custom Object Custom Field | Close

curl -X POST https://api.close.com/api/v1/custom_field/custom_object_type/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "custom_object_type_id": "cotype_1h5m6uHM9BZOpwVhyRJb4Y",
  "description": "Number of users belonging to this Account.",
  "name": "User Count",
  "required": true,
  "type": "number"
}'

{
  "accepts_multiple_values": false,
  "created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
  "custom_object_type_id": "cotype_1h5m6uHM9BZOpwVhyRJb4Y",
  "date_created": "2020-08-07T17:11:44.299904",
  "date_updated": "2020-08-07T17:11:44.299904",
  "description": "Number of users belonging to this Account.",
  "editable_with_roles": [],
  "id": "cf_1nkEcnaoAiTJBfYmTBsOQqFCuIkqc82Q f4yKUx01e0K",
  "name": "User Count",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "required": true,
  "type": "number",
  "updated_ by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
}

Custom Object Custom Fields belong to Custom Objects, and have additional attributes:

custom_object_type_id – the ID of the Custom Object Type this Field should belong to.
required – whether the Field will be required to save the object.

Custom Object Custom Fields belong to Custom Objects, and have additional attributes: - `custom_object_type_id` – the ID of the Custom Object Type this Field should belong to. - `required` – whether the Field will be required to save the object.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:)>.

AuthorizationBearer

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

Request

This endpoint expects any.

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error