Create new Custom Object Type | Close | Developer API Documentation

curl -X POST https://api.close.com/api/v1/custom_object_type/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "api_create_only": false,
  "description": "An account managed by this client",
  "editable_with_roles": [
    "admin"
  ],
  "name": "Account",
  "name_plural": "Accounts"
}'

{
  "api_create_only": false,
  "back_reference_fields": [],
  "created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
  "date_created": "2020-08-07T15:18:33.797245",
  "date_updated": "2020-08-07T15:18:33.797245",
  "description": "An account managed by this client",
  "editable_with_roles": [
    "admin"
  ],
  "fields": [],
  "id": "cotype_4hQsScWF3hnUOyngoaAV00",
  "name": "Account",
  "name_plural": "Accounts",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
}

The type must be created before Custom Fields can be added.

The following fields are required:

name: The name of the Custom Object Type
name_plural: A pluralized version of the name, for some UI display.

The following fields are optional:

description: A longer description of the Custom Object Type.
api_create_only: If true, instances can only be created by API clients. Defaults to false.
editable_with_roles: Only users with the given roles can edit instances of this type. By default, any user in your organization can make changes to the instances of this type.

The type must be created before Custom Fields can be added. The following fields are required: - `name`: The name of the Custom Object Type - `name_plural`: A pluralized version of the name, for some UI display. The following fields are optional: - `description`: A longer description of the Custom Object Type. - `api_create_only`: If `true`, instances can only be created by API clients. Defaults to `false`. - `editable_with_roles`: Only users with the given roles can edit instances of this type. By default, any user in your organization can make changes to the instances of this type.

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