Zum Hauptinhalt springen
PATCH
/
crm-object-schemas
/
v3
/
schemas
/
{objectType}
Aktualisieren Sie das Schema eines angegebenen benutzerdefinierten Objekts.
curl --request PATCH \
  --url https://api.hubapi.com/crm-object-schemas/v3/schemas/{objectType} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "primaryDisplayProperty": "my_object_property",
  "requiredProperties": [
    "my_object_property"
  ],
  "searchableProperties": [
    "my_object_property"
  ]
}
'
{
  "createdAt": "2020-02-20T18:07:11.390Z",
  "id": "123456",
  "labels": {
    "plural": "My objects",
    "singular": "My object"
  },
  "metaType": "PORTAL_SPECIFIC",
  "name": "my_object",
  "portalId": 12345678,
  "primaryDisplayProperty": "my_object_property",
  "requiredProperties": [
    "my_object_property"
  ],
  "searchableProperties": [
    "my_object_property"
  ],
  "updatedAt": "2020-02-21T14:13:28.818002Z"
}

Unterstützte Produkte

Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing Hub -Enterprise
Sales HubSales Hub -Enterprise
Service HubService Hub -Enterprise
Content HubContent Hub -Enterprise

Autorisierungen

​
Authorization
string
header
erforderlich

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

Pfadparameter

​
objectType
string
erforderlich

Vollständig qualifizierter Name oder Objekttyp-ID Ihres Schemas.

Body

application/json

Attributes to update in your schema.

Defines attributes to update on an object type.

​
allowsSensitiveProperties
boolean

Legt fest, ob der Objekttyp Eigenschaften enthalten kann, die als vertraulich markiert sind.

​
clearDescription
boolean

Gibt an, ob die Beschreibung des Objekttyps gelöscht werden soll.

​
description
string

Eine kurze Erläuterung des Objekttyps.

​
labels
object

Singular and plural labels for the object. Used in CRM display.

Beispiel:
{
  "plural": "My objects",
  "singular": "My object"
}
​
primaryDisplayProperty
string

Der Name der primären Eigenschaft für dieses Objekt. Diese wird auf der HubSpot-Datensatzseite für diesen Objekttyp als primär angezeigt.

​
requiredProperties
string[]

Die Namen der erforderlichen Eigenschaften beim Erstellen eines Objekts dieses Typs.

​
restorable
boolean

Gibt an, ob der Objekttyp nach dem Löschen wiederhergestellt werden kann.

​
searchableProperties
string[]

Namen von Eigenschaften, die für diesen Objekttyp in HubSpots Produktsuche indexiert werden.

​
secondaryDisplayProperties
string[]

Die Namen der sekundären Eigenschaften für dieses Objekt. Diese werden auf der HubSpot-Datensatzseite für diesen Objekttyp als sekundär angezeigt.

Antwort

successful operation

Defines an object type.

​
id
string
erforderlich

Eine eindeutige ID für diesen Objekttyp. Wird definiert als {meta-type}-{unique ID}.

​
labels
object
erforderlich

Singular and plural labels for the object. Used in CRM display.

Beispiel:
{
  "plural": "My objects",
  "singular": "My object"
}
​
name
string
erforderlich

Ein eindeutiger Name für dieses Objekt. Nur zur internen Verwendung.

​
requiredProperties
string[]
erforderlich

Die Namen der erforderlichen Eigenschaften beim Erstellen eines Objekts dieses Typs.

​
allowsSensitiveProperties
boolean

Gibt an, ob der Objekttyp Eigenschaften zulässt, die vertrauliche Daten enthalten.

​
archived
boolean

Gibt an, ob der Objekttyp archiviert ist.

​
createdAt
string<date-time>

Wann der Objekttyp erstellt wurde.

​
description
string

Eine Beschreibung des Objekttyps.

​
fullyQualifiedName
string

Eine zugewiesene eindeutige ID für das Objekt, einschließlich Portal-ID und Objektname.

​
objectTypeId
string

Eine eindeutige ID für den Objekttyp.

​
portalId
integer<int32>

Die ID des Accounts, für das dieser Objekttyp spezifisch ist.

​
primaryDisplayProperty
string

Der Name der primären Eigenschaft für dieses Objekt. Diese wird auf der HubSpot-Datensatzseite für diesen Objekttyp als primär angezeigt.

​
searchableProperties
string[]

Namen von Eigenschaften, die für diesen Objekttyp in HubSpots Produktsuche indexiert werden.

​
secondaryDisplayProperties
string[]

Die Namen der sekundären Eigenschaften für dieses Objekt. Diese werden auf der HubSpot-Datensatzseite für diesen Objekttyp als sekundär angezeigt.

​
updatedAt
string<date-time>

Wann der Objekttyp zuletzt aktualisiert wurde.

Last modified on March 24, 2026