# Update Object Schema By Key / Id

- **URL:** https://marketplace.gohighlevel.com/docs/ghl/objects/update-custom-object
- **Summary:** Update Custom Object Schema  or standard object's like contact, opportunity, business searchable fields. To understand objects and records, please have a look at the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0

[Skip to main content](https://marketplace.gohighlevel.com/docs/ghl/objects/update-custom-object#__docusaurus_skipToContent_fallback)

Version: v3

Update Object Schema By Key / Id
================================

PUT 

https://services.leadconnectorhq.com/objects/:key

Copy for LLMView as MarkdownOpen in ClaudeOpen in ChatGPTOpen in Cursor

Update Custom Object Schema or standard object's like contact, opportunity, business searchable fields. To understand objects and records, please have a look at the documentation here : [https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0](https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0)

### Requirements

#### Scope(s)

`objects/schema.write`

#### Auth Method(s)

`OAuth Access Token``Private Integration Token`

#### Token Type(s)

`Sub-Account Token`

Request[​](https://marketplace.gohighlevel.com/docs/ghl/objects/update-custom-object#request "Direct link to request")

### Header Parameters

**Version** stringrequired

**Possible values:** \[`v3`\]

API Version

### Path Parameters

**key** stringrequired

key of the custom or standard object. For custom objects, the key must include the prefix “custom_objects.”. This key can be found on the Object Details page under Settings in the UI.

**Example:** `custom_objects.pet`

*   application/json

*   Body
*   Example (auto)

### Body**required**

**labels** object

This is how your custom object will be displayed

**singular**string

Singular name of the custom object

**Example:** `Car`

**plural**string

Plural name of the custom object

**Example:** `Cars`

**description**stringnullable

Pet Object\`s description

**Example:** `These are non vaccinated pets`

**locationId**stringrequired

location id

**Example:** `632c34b4c9b7da3358ac9891`

**searchableProperties**string\[\]required

Searchable Fields: Provide the field key of your object that you want to search on, using the format (custom_object.<object_name>.<field_key>).

**Example:** `["custom_objects.mad.mad","custom_objects.mad.record_1","custom_objects.mad.nn"]`

    {  "labels": {    "singular": "Pet",    "plural": "Pets"  },  "description": "These are non vaccinated pets",  "locationId": "632c34b4c9b7da3358ac9891",  "searchableProperties": [    "custom_objects.mad.mad",    "custom_objects.mad.record_1",    "custom_objects.mad.nn"  ]}

Responses[​](https://marketplace.gohighlevel.com/docs/ghl/objects/update-custom-object#responses "Direct link to Responses")

*   200
*   400
*   401
*   422

Successful response

*   application/json

*   Schema
*   Example (auto)

**Schema**

**object** object

**id**stringrequired

id of the custom / standard object schema

**Example:** `661c06b4ffde146bdb469442`

**standard**booleanrequired

false in case of custom objects and true in case of standard objects like contacts and opportunities

**Example:** `false`

**key**stringrequired

key that would be used to refer the custom / standard Object internally (lowercase + underscore_separated). For custom objects, 'custom_objects.' would be added as prefix by default

**Example:** `custom_objects.pet`

**labels** objectrequired

This is what your custom / standard object will be called. These labels will be used to display your custom object on the UI

**singular**stringrequired

Singular name of the custom object

**Example:** `Pet`

**plural**stringrequired

Plural name of the custom object

**Example:** `Pets`

**description**string

Custom / Standard Object Descriptions for example , Pet Object\`s description

**Example:** `These are non vaccinated pets`

**locationId**stringrequired

location's id

**Example:** `Q9DT3OAqEXDLYuob1G32`

**primaryDisplayProperty**stringrequired

Primary property for the custom / standard Object. This would be used as primary data when rendering the UI. 'custom_objects.{{object_key}} or business.{{object_key}} (for company)' would be added as prefix by default for all the custom / standard objects

**Example:** `custom_objects.pet.name`

**dateAdded**string<date-time>required

Date and time when the object was added

**dateUpdated**string<date-time>required

Date and time when the object was last updated

**type**object

Object\`s Type

**Example:** `The Object type can either USER_DEFINED or SYSTEM_DEFINED`

    {  "object": {    "id": "661c06b4ffde146bdb469442",    "standard": false,    "key": "custom_objects.pet",    "labels": {      "singular": "Pet",      "plural": "Pets"    },    "description": "These are non vaccinated pets",    "locationId": "Q9DT3OAqEXDLYuob1G32",    "primaryDisplayProperty": "custom_objects.pet.name",    "dateAdded": "2024-07-29T15:51:28.071Z",    "dateUpdated": "2024-07-29T15:51:28.071Z",    "type": "The Object type can either USER_DEFINED or SYSTEM_DEFINED"  }}
> Common reference appendix (shared error/status catalog): see [../_shared-appendix.md](../_shared-appendix.md).
**name:** [Authorization](https://marketplace.gohighlevel.com/docs/ghl/objects/custom-objects-api#authentication)
**type:** http**scopes:** `objects/schema.write`**scheme:** bearer**bearerFormat:** JWT**in:** header**description:** Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

*   curl
*   nodejs
*   python
*   php
*   java
*   go
*   ruby
*   powershell

*   CURL

    curl -L -X PUT 'https://services.leadconnectorhq.com/objects/custom_objects.pet' \-H 'Content-Type: application/json' \-H 'Accept: application/json' \-H 'Authorization: Bearer <Authorization>' \-d '{  "labels": {    "singular": "Car",    "plural": "Cars"  },  "description": "These are non vaccinated pets",  "locationId": "632c34b4c9b7da3358ac9891",  "searchableProperties": [    "custom_objects.mad.mad",    "custom_objects.mad.record_1",    "custom_objects.mad.nn"  ]}'

RequestCollapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

key — pathrequired

Version — headerrequired\---v3

Body required

{
  "labels": {    "singular": "Car",    "plural": "Cars"  },  "description": "These are non vaccinated pets",  "locationId": "632c34b4c9b7da3358ac9891",  "searchableProperties": \[    "custom_objects.mad.mad",    "custom_objects.mad.record_1",    "custom_objects.mad.nn"  \]
}
Send API Request

ResponseClear

Click the `Send API Request` button above and see the response here!