Skip to main content
PUT
Update Object Schema By Key / Id

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:
labels
object
Example:
description
string | null

Pet Object`s description

Example:

"These are non vaccinated pets"

Response

Successful response

object
object
Last modified on March 8, 2026