Update existing Custom Object Type | Close | Developer API Documentation

curl -X PUT https://api.close.com/api/v1/custom_object_type/id/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "name": "Managed Resource",
  "name_plural": "Managed Resources"
}'

{
  "api_create_only": true,
  "back_reference_fields": [],
  "created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
  "date_created": "2020-07-09T15:36:16.795350",
  "date_updated": "2020-07-09T15:36:16.795350",
  "description": "A Resource tracked by an external system.",
  "editable_with_roles": [],
  "fields": [
    {
      "accepts_multiple_values": true,
      "back_reference_is_visible": true,
      "description": "Account objects using this Resource.",
      "editable_with_roles": [],
      "id": "cf_UpyNBvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jg64S",
      "name": "Linked Accounts",
      "referenced_custom_type_id": "cotype_4hQsScWF3hnUOyngoaAV00",
      "required": true,
      "type": "custom_object"
    }
  ],
  "id": "cotype_1h5m6uHM9BZOpwVhyRJb4Y",
  "name": "Managed Resource",
  "name_plural": "Managed Resources",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
}

The type’s name, name_plural, description, api_create_only and editable_with_roles properties may be updated here. These properties will be updated immediately in the Custom Object API. You cannot add, modify, remove or reorder fields from a Custom Object Type using this resource. See Custom Object Custom Fields and Custom Field Schema API for these features.

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