Passer au contenu principal
PATCH
/
crm-object-schemas
/
v3
/
schemas
/
{objectType}
Mettre à jour le schéma d'un objet personnalisé spécifié.
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"
}
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.

Paramètres de chemin

​
objectType
string
requis

Nom complet ou identifiant de type d'objet de votre schéma.

Corps

application/json

Attributes to update in your schema.

Defines attributes to update on an object type.

​
allowsSensitiveProperties
boolean

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

​
clearDescription
boolean

Indique si la description du type d'objet doit être effacée.

​
description
string

Une brève explication du type d'objet.

​
labels
object

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

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

​
requiredProperties
string[]

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

​
restorable
boolean

Spécifie si le type d'objet peut être restauré après avoir été supprimé.

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

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

​
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

Indique si le type d'objet autorise les propriétés qui contiennent des données sensibles.

​
archived
boolean

Indique si le type d'objet est archivé.

​
createdAt
string<date-time>

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

​
description
string

Description du type d'objet.

​
fullyQualifiedName
string

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

​
objectTypeId
string

Un identifiant unique pour le type d'objet.

​
portalId
integer<int32>

L'identifiant du compte auquel ce type d'objet est spécifique.

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

Last modified on January 23, 2026