Skip to main content
PATCH
/
crm-object-schemas
/
2026-03
/
schemas
/
{objectType}
Update the schema of a specified custom object.
curl --request PATCH \
  --url https://api.hubapi.com/crm-object-schemas/2026-03/schemas/{objectType} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clearDescription": true,
  "allowsSensitiveProperties": true,
  "description": "<string>",
  "labels": {
    "plural": "<string>",
    "singular": "<string>"
  },
  "primaryDisplayProperty": "<string>",
  "requiredProperties": [
    "<string>"
  ],
  "restorable": true,
  "searchableProperties": [
    "<string>"
  ],
  "secondaryDisplayProperties": [
    "<string>"
  ]
}
'
import requests

url = "https://api.hubapi.com/crm-object-schemas/2026-03/schemas/{objectType}"

payload = {
    "clearDescription": True,
    "allowsSensitiveProperties": True,
    "description": "<string>",
    "labels": {
        "plural": "<string>",
        "singular": "<string>"
    },
    "primaryDisplayProperty": "<string>",
    "requiredProperties": ["<string>"],
    "restorable": True,
    "searchableProperties": ["<string>"],
    "secondaryDisplayProperties": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    clearDescription: true,
    allowsSensitiveProperties: true,
    description: '<string>',
    labels: {plural: '<string>', singular: '<string>'},
    primaryDisplayProperty: '<string>',
    requiredProperties: ['<string>'],
    restorable: true,
    searchableProperties: ['<string>'],
    secondaryDisplayProperties: ['<string>']
  })
};

fetch('https://api.hubapi.com/crm-object-schemas/2026-03/schemas/{objectType}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/crm-object-schemas/2026-03/schemas/{objectType}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'clearDescription' => true,
    'allowsSensitiveProperties' => true,
    'description' => '<string>',
    'labels' => [
        'plural' => '<string>',
        'singular' => '<string>'
    ],
    'primaryDisplayProperty' => '<string>',
    'requiredProperties' => [
        '<string>'
    ],
    'restorable' => true,
    'searchableProperties' => [
        '<string>'
    ],
    'secondaryDisplayProperties' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/crm-object-schemas/2026-03/schemas/{objectType}"

	payload := strings.NewReader("{\n  \"clearDescription\": true,\n  \"allowsSensitiveProperties\": true,\n  \"description\": \"<string>\",\n  \"labels\": {\n    \"plural\": \"<string>\",\n    \"singular\": \"<string>\"\n  },\n  \"primaryDisplayProperty\": \"<string>\",\n  \"requiredProperties\": [\n    \"<string>\"\n  ],\n  \"restorable\": true,\n  \"searchableProperties\": [\n    \"<string>\"\n  ],\n  \"secondaryDisplayProperties\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.hubapi.com/crm-object-schemas/2026-03/schemas/{objectType}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"clearDescription\": true,\n  \"allowsSensitiveProperties\": true,\n  \"description\": \"<string>\",\n  \"labels\": {\n    \"plural\": \"<string>\",\n    \"singular\": \"<string>\"\n  },\n  \"primaryDisplayProperty\": \"<string>\",\n  \"requiredProperties\": [\n    \"<string>\"\n  ],\n  \"restorable\": true,\n  \"searchableProperties\": [\n    \"<string>\"\n  ],\n  \"secondaryDisplayProperties\": [\n    \"<string>\"\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/crm-object-schemas/2026-03/schemas/{objectType}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"clearDescription\": true,\n  \"allowsSensitiveProperties\": true,\n  \"description\": \"<string>\",\n  \"labels\": {\n    \"plural\": \"<string>\",\n    \"singular\": \"<string>\"\n  },\n  \"primaryDisplayProperty\": \"<string>\",\n  \"requiredProperties\": [\n    \"<string>\"\n  ],\n  \"restorable\": true,\n  \"searchableProperties\": [\n    \"<string>\"\n  ],\n  \"secondaryDisplayProperties\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "allowsSensitiveProperties": true,
  "archived": true,
  "fullyQualifiedName": "<string>",
  "id": "<string>",
  "labels": {
    "plural": "<string>",
    "singular": "<string>"
  },
  "name": "<string>",
  "objectTypeId": "<string>",
  "requiredProperties": [
    "<string>"
  ],
  "searchableProperties": [
    "<string>"
  ],
  "secondaryDisplayProperties": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "portalId": 123,
  "primaryDisplayProperty": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}
{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

Supported products

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
objectType
string
required

Body

application/json
​
clearDescription
boolean
required

Indicates whether the description of the object type should be cleared.

​
allowsSensitiveProperties
boolean

Determines if the object type can include properties that are marked as sensitive.

​
description
string

A brief explanation of the object type.

​
labels
object
​
primaryDisplayProperty
string

The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.

​
requiredProperties
string[]

The names of properties that should be required when creating an object of this type.

​
restorable
boolean

Specifies if the object type can be restored after being deleted.

​
searchableProperties
string[]

Names of properties that will be indexed for this object type in by HubSpot's product search.

​
secondaryDisplayProperties
string[]

The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.

Response

successful operation

​
allowsSensitiveProperties
boolean
required

Indicates whether the object type allows properties that contain sensitive data.

​
archived
boolean
required

Indicates whether the object type is archived.

​
fullyQualifiedName
string
required

An assigned unique ID for the object, including portal ID and object name.

​
id
string
required

A unique ID for this object type. Will be defined as {meta-type}-{unique ID}.

​
labels
object
required
​
name
string
required

A unique name for this object. For internal use only.

​
objectTypeId
string
required

A unique identifier for the object type.

​
requiredProperties
string[]
required

The names of properties that should be required when creating an object of this type.

​
searchableProperties
string[]
required

Names of properties that will be indexed for this object type in by HubSpot's product search.

​
secondaryDisplayProperties
string[]
required

The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.

​
createdAt
string<date-time>

When the object type was created.

​
description
string

A description of the object type.

​
portalId
integer<int32>

The ID of the account that this object type is specific to.

​
primaryDisplayProperty
string

The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.

​
updatedAt
string<date-time>

When the object type was last updated.

Last modified on March 31, 2026