Skip to main content
PUT
/
objects
/
{key}
Update Object Schema By Key / Id
curl --request PUT \
  --url https://services.leadconnectorhq.com/objects/{key} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Version: <version>' \
  --data '
{
  "locationId": "632c34b4c9b7da3358ac9891",
  "searchableProperties": [
    "custom_objects.mad.mad",
    "custom_objects.mad.record_1",
    "custom_objects.mad.nn"
  ],
  "labels": {
    "singular": "Pet",
    "plural": "Pets"
  },
  "description": "These are non vaccinated pets"
}
'
{
  "object": {
    "id": "661c06b4ffde146bdb469442",
    "standard": false,
    "key": "custom_objects.pet",
    "labels": {
      "singular": "Pet",
      "plural": "Pets"
    },
    "locationId": "Q9DT3OAqEXDLYuob1G32",
    "primaryDisplayProperty": "custom_objects.pet.name",
    "dateAdded": "2023-11-07T05:31:56Z",
    "dateUpdated": "2023-11-07T05:31:56Z",
    "description": "These are non vaccinated pets",
    "type": "The Object type can either USER_DEFINED or SYSTEM_DEFINED"
  }
}

Authorizations

​
Authorization
string
header
required

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Headers

​
Version
enum<string>
required

API Version

Available options:
2021-07-28

Path Parameters

​
key
string
required

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"

Body

application/json
​
locationId
string
required

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
object
Example:
{ "singular": "Pet", "plural": "Pets" }
​
description
string | null

Pet Object`s description

Example:

"These are non vaccinated pets"

Response

Successful response

​
object
object
Last modified on March 4, 2026