Update Object Schema By Key / Id

PUThttps://services.leadconnectorhq.com/objects/{key}

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

Request

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

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

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

Headers

Authorization
string
required

Access Token

Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
string
required

API Version

Allowed value:
2021-07-28

Body

labels
object

This is how your custom object will be displayed

Example:
{"singular":"Pet","plural":"Pets"}
singular
string

Singular name of the custom object

Example:
Car
plural
string

Plural name of the custom object

Example:
Cars
description
string or null

Pet Object`s description

Example:
These are non vaccinated pets
locationId
string
required

location id

Example:
632c34b4c9b7da3358ac9891
searchableProperties
array[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"]

Responses

Successful response

Body

object
object
id
string
required

id of the custom / standard object schema

Example:
661c06b4ffde146bdb469442
standard
boolean
required

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

Example:
false
key
string
required

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
object
required

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

Example:
{"singular":"Pet","plural":"Pets"}
description
string

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

Example:
These are non vaccinated pets
locationId
string
required

location's id

Example:
Q9DT3OAqEXDLYuob1G32
primaryDisplayProperty
string
required

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

Bad Request

Body

statusCode
number
Example:
400
message
string
Example:
Bad Request

Unauthorized

Body

statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized

Unprocessable Entity

Body

statusCode
number
Example:
422
message
array[string]
Example:
["Unprocessable Entity"]
error
string
Example:
Unprocessable Entity