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

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

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/2026-03/crm-schemas-v2026-03.json PATCH /crm-object-schemas/2026-03/schemas/{objectType}
openapi: 3.0.1
info:
  title: Schémas
  description: Basepom for all HubSpot Projects
  version: 2026-03
  x-hubspot-product-tier-requirements:
    marketing: ENTERPRISE
    sales: ENTERPRISE
    service: ENTERPRISE
    cms: ENTERPRISE
    commerce: ENTERPRISE
    crmHub: ENTERPRISE
    dataHub: ENTERPRISE
  x-hubspot-api-use-case: >-
    Créer un nouvel objet pour stocker des informations sur les voitures dans
    une concession automobile. La définition de votre objet pourrait inclure des
    propriétés pour stocker des informations ainsi que les filtres disponibles
    sur la page d'index de l'objet personnalisé.
  x-hubspot-introduction: >-
    Utilisez l'API de schéma d'objets personnalisés pour définir de nouveaux
    types d'enregistrements CRM dans votre compte. Après la configuration d'un
    schéma d'objet, vous serez alors en mesure de créer des fiches
    d'informations pour cet objet personnalisé, tant dans HubSpot qu'avec l'API
    d'objets.
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Advanced
  - name: Basic
  - name: Batch
paths:
  /crm-object-schemas/2026-03/schemas/{objectType}:
    patch:
      tags:
        - Basic
      summary: Mettre à jour le schéma d'un objet personnalisé spécifié.
      description: >-
        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.
      operationId: patch-/crm-object-schemas/2026-03/schemas/{objectType}_update
      parameters:
        - name: objectType
          in: path
          description: >-
            L'identifiant unique du type d'objet CRM dont le schéma doit être
            mis à jour.
          required: true
          style: simple
          explode: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ObjectTypeDefinitionPatch'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectTypeDefinition'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - crm.schemas.custom.write
components:
  schemas:
    ObjectTypeDefinitionPatch:
      required:
        - clearDescription
      type: object
      properties:
        allowsSensitiveProperties:
          type: boolean
          description: >-
            Détermine si le type d'objet peut inclure des propriétés marquées
            comme sensibles.
        clearDescription:
          type: boolean
          description: Indique si la description du type d'objet doit être effacée.
        description:
          type: string
          description: Une brève explication du type d'objet.
        labels:
          $ref: '#/components/schemas/ObjectTypeDefinitionLabels'
        primaryDisplayProperty:
          type: string
          description: >-
            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:
          type: array
          description: >-
            Les noms des propriétés qui devraient être **obligatoires** lors de
            la création d'un objet de ce type.
          items:
            type: string
        restorable:
          type: boolean
          description: >-
            Spécifie si le type d'objet peut être restauré après avoir été
            supprimé.
        searchableProperties:
          type: array
          description: >-
            Noms des propriétés qui seront indexées pour ce type d'objet dans la
            recherche de produits de HubSpot.
          items:
            type: string
        secondaryDisplayProperties:
          type: array
          description: >-
            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.
          items:
            type: string
    ObjectTypeDefinition:
      required:
        - allowsSensitiveProperties
        - archived
        - fullyQualifiedName
        - id
        - labels
        - name
        - objectTypeId
        - requiredProperties
        - searchableProperties
        - secondaryDisplayProperties
      type: object
      properties:
        allowsSensitiveProperties:
          type: boolean
          description: >-
            Indique si le type d'objet autorise les propriétés qui contiennent
            des données sensibles.
        archived:
          type: boolean
          description: Indique si le type d'objet est archivé.
        createdAt:
          type: string
          description: Lorsque le type d'objet a été créé.
          format: date-time
        description:
          type: string
          description: Description du type d'objet.
        fullyQualifiedName:
          type: string
          description: >-
            Un ID unique attribué pour l'objet, comprenant l'ID du portail et le
            nom de l'objet.
        id:
          type: string
          description: >-
            Un identifiant unique pour ce type d'objet. Sera défini comme
            {meta-type}-{unique ID}.
        labels:
          $ref: '#/components/schemas/ObjectTypeDefinitionLabels'
        name:
          type: string
          description: Un nom unique pour cet objet. Pour un usage interne uniquement.
        objectTypeId:
          type: string
          description: Un identifiant unique pour le type d'objet.
        portalId:
          type: integer
          description: L'identifiant du compte auquel ce type d'objet est spécifique.
          format: int32
        primaryDisplayProperty:
          type: string
          description: >-
            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:
          type: array
          description: >-
            Les noms des propriétés qui devraient être **obligatoires** lors de
            la création d'un objet de ce type.
          items:
            type: string
        searchableProperties:
          type: array
          description: >-
            Noms des propriétés qui seront indexées pour ce type d'objet dans la
            recherche de produits de HubSpot.
          items:
            type: string
        secondaryDisplayProperties:
          type: array
          description: >-
            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.
          items:
            type: string
        updatedAt:
          type: string
          description: Lors de la dernière mise à jour du type d'objet.
          format: date-time
    ObjectTypeDefinitionLabels:
      type: object
      properties:
        plural:
          type: string
          description: >-
            Le mot pour plusieurs objets. (Vous ne pourrez pas le changer plus
            tard.)
        singular:
          type: string
          description: Le mot pour un objet. (Vous ne pourrez pas le changer plus tard.)
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: La catégorie d'erreur
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexte concernant la condition d'erreur
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Un identifiant unique pour la demande. Incluez cette valeur dans
            tous les rapports d'erreurs ou tickets d'assistance
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: informations supplémentaires à propos de l'erreur
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Une carte des noms de liens vers les URI associés contenant de la
            documentation sur l'erreur ou les mesures correctives recommandées
        message:
          type: string
          description: >-
            Un message lisible par la personne décrivant l'erreur ainsi que les
            mesures correctives possibles, le cas échéant
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Une catégorie spécifique qui contient des détails plus précis sur
            l'erreur
      description: >-
        Représente une réponse d'erreur renvoyée par l'API lorsqu'une opération
        échoue. Ce composant est utilisé dans divers points de terminaison pour
        fournir des informations détaillées sur l'erreur rencontrée.
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: Le code du statut associé au détail de l'erreur
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexte concernant la condition d'erreur
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: Le nom du champ ou du paramètre dans lequel l'erreur a été trouvée.
        message:
          type: string
          description: >-
            Un message lisible par la personne décrivant l'erreur ainsi que les
            mesures correctives possibles, le cas échéant
        subCategory:
          type: string
          description: >-
            Une catégorie spécifique qui contient des détails plus précis sur
            l'erreur
      description: >-
        Représente des informations détaillées sur une erreur survenue dans
        l'API. Ce composant est utilisé pour fournir un contexte et des
        spécificités supplémentaires sur les erreurs, généralement dans le cadre
        d'une réponse d'erreur.
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            crm.objects.custom.highly_sensitive.read.v2: ''
            crm.objects.custom.highly_sensitive.write.v2: ''
            crm.objects.custom.read: ''
            crm.objects.custom.sensitive.read.v2: ''
            crm.objects.custom.sensitive.write.v2: ''
            crm.objects.custom.write: ''
            crm.schemas.custom.read: ''
            crm.schemas.custom.write: ''

````