Account & Settings
Gestion des applications
Authentification
Automatisation
CMS
Communication preferences
Conversations
Événements
Fichiers
Marketing
Scheduler
curl --request PATCH \
--url https://api.hubapi.com/crm-object-schemas/2026-03/schemas/{objectType} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"clearDescription": true,
"allowsSensitiveProperties": true,
"description": "<string>",
"labels": {
"plural": "<string>",
"singular": "<string>"
},
"primaryDisplayProperty": "<string>",
"requiredProperties": [
"<string>"
],
"restorable": true,
"searchableProperties": [
"<string>"
],
"secondaryDisplayProperties": [
"<string>"
]
}
'{
"allowsSensitiveProperties": true,
"archived": true,
"fullyQualifiedName": "<string>",
"id": "<string>",
"labels": {
"plural": "<string>",
"singular": "<string>"
},
"name": "<string>",
"objectTypeId": "<string>",
"requiredProperties": [
"<string>"
],
"searchableProperties": [
"<string>"
],
"secondaryDisplayProperties": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"portalId": 123,
"primaryDisplayProperty": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}Update the schema of a specified custom object.
Mettre à jour les attributs d’un schéma d’objet personnalisé, tels que les propriétés et les libellés, à l’aide de l’ID de type d’objet ou du nom complet.
curl --request PATCH \
--url https://api.hubapi.com/crm-object-schemas/2026-03/schemas/{objectType} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"clearDescription": true,
"allowsSensitiveProperties": true,
"description": "<string>",
"labels": {
"plural": "<string>",
"singular": "<string>"
},
"primaryDisplayProperty": "<string>",
"requiredProperties": [
"<string>"
],
"restorable": true,
"searchableProperties": [
"<string>"
],
"secondaryDisplayProperties": [
"<string>"
]
}
'{
"allowsSensitiveProperties": true,
"archived": true,
"fullyQualifiedName": "<string>",
"id": "<string>",
"labels": {
"plural": "<string>",
"singular": "<string>"
},
"name": "<string>",
"objectTypeId": "<string>",
"requiredProperties": [
"<string>"
],
"searchableProperties": [
"<string>"
],
"secondaryDisplayProperties": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"portalId": 123,
"primaryDisplayProperty": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}Documentation Index
Fetch the complete documentation index at: https://developers.hubspot.fr/docs/llms.txt
Use this file to discover all available pages before exploring further.
Supported products
Supported products
Required Scopes
Required Scopes
Autorisations
The access token received from the authorization server in the OAuth 2.0 flow.
Paramètres de chemin
Nom complet ou identifiant de type d'objet de votre schéma.
Corps
Indique si la description du type d'objet doit être effacée.
Détermine si le type d'objet peut inclure des propriétés marquées comme sensibles.
Une brève explication du type d'objet.
Show child attributes
Show child attributes
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.
Les noms des propriétés qui devraient être obligatoires lors de la création d'un objet de ce type.
Spécifie si le type d'objet peut être restauré après avoir été supprimé.
Noms des propriétés qui seront indexées pour ce type d'objet dans la recherche de produits de HubSpot.
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
Indique si le type d'objet autorise les propriétés qui contiennent des données sensibles.
Indique si le type d'objet est archivé.
Un ID unique attribué pour l'objet, comprenant l'ID du portail et le nom de l'objet.
Un identifiant unique pour ce type d'objet. Sera défini comme {meta-type}-{unique ID}.
Show child attributes
Show child attributes
Un nom unique pour cet objet. Pour un usage interne uniquement.
Un identifiant unique pour le type d'objet.
Les noms des propriétés qui devraient être obligatoires lors de la création d'un objet de ce type.
Noms des propriétés qui seront indexées pour ce type d'objet dans la recherche de produits de HubSpot.
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.
Lorsque le type d'objet a été créé.
Description du type d'objet.
L'identifiant du compte auquel ce type d'objet est spécifique.
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.
Lors de la dernière mise à jour du type d'objet.