PATCH
/
crm-object-schemas
/
v3
/
schemas
/
{objectType}
Update a schema
curl --request PATCH \
  --url https://api.hubapi.com/crm-object-schemas/v3/schemas/{objectType} \
  --header 'Content-Type: application/json' \
  --data '{
  "primaryDisplayProperty": "my_object_property",
  "requiredProperties": [
    "my_object_property"
  ],
  "searchableProperties": [
    "my_object_property"
  ]
}'
{
  "id": "123456",
  "createdAt": "2020-02-20T18:07:11.390Z",
  "updatedAt": "2020-02-21T14:13:28.818002Z",
  "labels": {
    "singular": "My object",
    "plural": "My objects"
  },
  "requiredProperties": [
    "my_object_property"
  ],
  "searchableProperties": [
    "my_object_property"
  ],
  "primaryDisplayProperty": "my_object_property",
  "portalId": 12345678,
  "metaType": "PORTAL_SPECIFIC",
  "name": "my_object"
}
Supported products
Requires one of the following products or higher.
Marketing HubMarketing HubEnterprise
Sales HubSales HubEnterprise
Service HubService HubEnterprise
Content HubContent HubEnterprise

Path Parameters

​
objectType
string
required

Fully qualified name or object type ID of your schema.

Body

application/json

Attributes to update in your schema.

Defines attributes to update on an object type.

Response

200
application/json

successful operation

Defines an object type.