Zum Hauptinhalt springen
PATCH
/
crm-object-schemas
/
v3
/
schemas
/
{objectType}
cURL
curl --request PATCH \
  --url https://api.hubapi.com/crm-object-schemas/v3/schemas/{objectType} \
  --header 'Content-Type: application/json' \
  --header 'private-app: <api-key>' \
  --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"
}
Unterstützte Produkte
Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing HubEnterprise
Sales HubSales HubEnterprise
Service HubService HubEnterprise
Content HubContent HubEnterprise

Authorizations

​
private-app
string
header
required

Path Parameters

​
objectType
string
required

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.

​
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.

​
requiredProperties
string[]

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

​
searchableProperties
string[]

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

​
clearDescription
boolean
​
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.

​
description
string
​
restorable
boolean
​
labels
object

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

Example:
{
  "singular": "My object",
  "plural": "My objects"
}

Response

successful operation

Defines an object type.

​
labels
object
required

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

Example:
{
  "singular": "My object",
  "plural": "My objects"
}
​
requiredProperties
string[]
required

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

​
name
string
required

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

​
id
string
required

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

​
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.

​
objectTypeId
string
​
description
string
​
fullyQualifiedName
string
​
archived
boolean
​
createdAt
string<date-time>

Wann der Objekttyp erstellt wurde.

​
searchableProperties
string[]

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

​
portalId
integer

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.

​
updatedAt
string<date-time>

Wann der Objekttyp zuletzt aktualisiert wurde.