Passer au contenu principal
POST
/
crm-object-schemas
/
v3
/
schemas
Créer un nouveau schéma d'objet personnalisé.
curl --request POST \
  --url https://api.hubapi.com/crm-object-schemas/v3/schemas \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "associatedObjects": [
    "CONTACT"
  ],
  "labels": {
    "plural": "My objects",
    "singular": "My object"
  },
  "metaType": "PORTAL_SPECIFIC",
  "name": "my_object",
  "primaryDisplayProperty": "my_object_property",
  "properties": [
    {
      "isPrimaryDisplayLabel": true,
      "label": "My object property",
      "name": "my_object_property"
    }
  ],
  "requiredProperties": [
    "my_object_property"
  ]
}
'
{
  "associations": [
    {
      "fromObjectTypeId": "2-123456",
      "id": "123",
      "name": "my_object_to_contact",
      "toObjectTypeId": "0-1"
    }
  ],
  "createdAt": "2020-02-20T18:07:11.390Z",
  "fullyQualifiedName": "p7878787_my_object\"",
  "id": "123456",
  "labels": {
    "plural": "My objects",
    "singular": "My object"
  },
  "metaType": "PORTAL_SPECIFIC",
  "name": "my_object",
  "primaryDisplayProperty": "my_object_property",
  "properties": [
    {
      "archived": false,
      "calculated": false,
      "createdAt": "2020-02-20T18:07:11.802Z",
      "displayOrder": -1,
      "externalOptions": false,
      "fieldType": "text",
      "groupName": "my_object_information",
      "hasUniqueValue": false,
      "label": "My object property",
      "name": "my_object_property",
      "type": "string",
      "updatedAt": "2020-02-20T18:07:11.802Z"
    }
  ],
  "requiredProperties": [
    "my_object_property"
  ],
  "searchableProperties": [
    "my_object_property"
  ],
  "updatedAt": "2020-02-20T18:09:07.555Z"
}
Produits pris en charge
Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing HubEntreprise
Sales HubSales HubEntreprise
Service HubService HubEntreprise
Content HubContent HubEntreprise

Autorisations

Authorization
string
header
requis

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

Corps

application/json

Object schema definition, including properties and associations.

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

associatedObjects
string[]
requis

Associations définies pour ce type d'objet.

labels
object
requis

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

Exemple:
{
"plural": "My objects",
"singular": "My object"
}
name
string
requis

Un nom unique pour cet objet. Pour un usage interne uniquement.

properties
object[]
requis

Propriétés définies pour ce type d'objet.

requiredProperties
string[]
requis

Les noms des propriétés qui devraient être obligatoires lors de la création d'un objet de ce type.

allowsSensitiveProperties
boolean

Détermine si le type d'objet peut inclure des propriétés marquées comme sensibles.

description
string

Une brève explication du type d'objet.

primaryDisplayProperty
string

Le nom de la propriété principale pour cet objet. Elle sera affichée comme principale sur la page de la fiche d'informations HubSpot pour ce type d'objet.

searchableProperties
string[]

Noms des propriétés qui seront indexées pour ce type d'objet dans la recherche de produits de HubSpot.

secondaryDisplayProperties
string[]

Les noms des propriétés secondaires pour cet objet. Elles seront affichées comme secondaires sur la page de la fiche d'informations HubSpot pour ce type d'objet.

Réponse

successful operation

Defines an object schema, including its properties and associations.

associations
object[]
requis

Associations définies pour un type d'objet donné.

id
string
requis

Un identifiant unique pour ce type d'objet. Sera défini comme {meta-type}-{unique ID}.

labels
object
requis

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

Exemple:
{
"plural": "My objects",
"singular": "My object"
}
name
string
requis

Un nom unique pour cet objet. Pour un usage interne uniquement.

properties
object[]
requis

Propriétés définies pour ce type d'objet.

requiredProperties
string[]
requis

Les noms des propriétés qui devraient être obligatoires lors de la création d'un objet de ce type.

allowsSensitiveProperties
boolean
archived
boolean
createdAt
string<date-time>

Lorsque le type d'objet a été créé.

createdByUserId
integer<int32>
description
string
fullyQualifiedName
string

Un ID unique attribué pour l'objet, comprenant l'ID du portail et le nom de l'objet.

objectTypeId
string
primaryDisplayProperty
string

Le nom de la propriété principale pour cet objet. Elle sera affichée comme principale sur la page de la fiche d'informations HubSpot pour ce type d'objet.

searchableProperties
string[]

Noms des propriétés qui seront indexées pour ce type d'objet dans la recherche de produits de HubSpot.

secondaryDisplayProperties
string[]

Les noms des propriétés secondaires pour cet objet. Elles seront affichées comme secondaires sur la page de la fiche d'informations HubSpot pour ce type d'objet.

updatedAt
string<date-time>

Lors de la dernière mise à jour du type d'objet.

updatedByUserId
integer<int32>
Last modified on January 23, 2026