Zum Hauptinhalt springen
POST
/
crm-object-schemas
/
v3
/
schemas
cURL
curl --request POST \
  --url https://api.hubapi.com/crm-object-schemas/v3/schemas \
  --header 'Content-Type: application/json' \
  --header 'private-app: <api-key>' \
  --data '{
  "name": "my_object",
  "labels": {
    "singular": "My object",
    "plural": "My objects"
  },
  "primaryDisplayProperty": "my_object_property",
  "requiredProperties": [
    "my_object_property"
  ],
  "properties": [
    {
      "name": "my_object_property",
      "label": "My object property",
      "isPrimaryDisplayLabel": true
    }
  ],
  "associatedObjects": [
    "CONTACT"
  ],
  "metaType": "PORTAL_SPECIFIC"
}'
{
  "id": "123456",
  "createdAt": "2020-02-20T18:07:11.390Z",
  "updatedAt": "2020-02-20T18:09:07.555Z",
  "properties": [
    {
      "updatedAt": "2020-02-20T18:07:11.802Z",
      "createdAt": "2020-02-20T18:07:11.802Z",
      "name": "my_object_property",
      "label": "My object property",
      "type": "string",
      "fieldType": "text",
      "groupName": "my_object_information",
      "displayOrder": -1,
      "calculated": false,
      "externalOptions": false,
      "archived": false,
      "hasUniqueValue": false
    }
  ],
  "associations": [
    {
      "id": "123",
      "fromObjectTypeId": "2-123456",
      "toObjectTypeId": "0-1",
      "name": "my_object_to_contact"
    }
  ],
  "labels": {
    "singular": "My object",
    "plural": "My objects"
  },
  "requiredProperties": [
    "my_object_property"
  ],
  "searchableProperties": [
    "my_object_property"
  ],
  "primaryDisplayProperty": "my_object_property",
  "metaType": "PORTAL_SPECIFIC",
  "fullyQualifiedName": "p7878787_my_object\"",
  "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

Body

application/json

Object schema definition, including properties and associations.

Defines a new object type, its properties, and associations.

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.

associatedObjects
string[]
required

Für diesen Objekttyp definierte Zuordnungen.

properties
object[]
required

Für diesen Objekttyp definierte Eigenschaften.

labels
object
required

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

Example:
{
"singular": "My object",
"plural": "My objects"
}
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.

searchableProperties
string[]

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

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

Response

successful operation

Defines an object schema, including its properties and associations.

associations
object[]
required

Für einen angegebenen Objekttyp definierte Zuordnungen.

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 den Objekttyp des Schemas.

id
string
required

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

properties
object[]
required

Für diesen Objekttyp definierte Eigenschaften.

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.

createdByUserId
integer
objectTypeId
string
description
string
updatedByUserId
integer
fullyQualifiedName
string

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

archived
boolean
createdAt
string<date-time>

Wann das Objektschema erstellt wurde.

searchableProperties
string[]

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

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 das Objektschema zuletzt aktualisiert wurde.