Dernière modification : 22 août 2025
Run in Postman
Créer des tickets
Pour créer de nouveaux tickets, effectuez une requêtePOST
à /crm/v3/objects/tickets
.
Dans votre requête, incluez les données de votre ticket dans un objet de propriétés. Vous pouvez également ajouter un objet d’association pour associer votre nouveau ticket à des fiches d’informations existantes (par exemple, des contacts ou des entreprises) ou à des activités (par exemple, des réunions ou des notes).
Propriétés
Les détails du ticket sont stockés dans des propriétés de ticket. Il existe des propriétés de ticket HubSpot par défaut, mais vous pouvez également créer des propriétés personnalisées. Lorsque vous créez un nouveau ticket, vous devez inclure les propriétés suivantes dans votre requête :subject
(le nom du ticket), hs_pipeline_stage
(le statut du ticket) et, si vous avez plusieurs pipelines, hs_pipeline
. Si aucun pipeline n’est spécifié, le pipeline par défaut sera utilisé.
Pour afficher toutes les propriétés disponibles, vous pouvez récupérer une liste des propriétés de tickets de votre compte en effectuant une requête GET
à /crm/v3/properties/tickets
. Découvrez-en davantage sur l’API des propriétés.
Remarque : vous devez utiliser l’ID interne d’un statut de ticket ou d’un pipeline lors de la création d’un ticket via l’API. L’ID interne est un numéro, qui sera également retourné lorsque vous récupérerez des tickets via l’API. Vous pouvez trouver le statut de ticket ou l’ID interne d’un pipeline dans les paramètres de votre pipeline de tickets.
Associations
Lorsque vous créez un nouveau ticket, vous pouvez également associer le ticket à des fiches d’informations ou activités existantes en incluant un objet d’associations. Par exemple, pour associer un nouveau ticket à un contact et à une entreprise existants, votre requête ressemblerait à ce qui suit :Paramètre | Description |
---|---|
to | La fiche d’informations ou l’activité à laquelle vous souhaitez associer le ticket, en fonction de sa valeur unique id . |
types | Le type d’association entre le ticket et la fiche d’informations/l’activité. Inclut associationCategory et associationTypeId . Les ID de types d’association par défaut sont répertoriés ici, ou vous pouvez récupérer la valeur des types d’associations personnalisés (c’est-à-dire les libellés) via l’API des associations. |
Récupérer des tickets
Vous pouvez récupérer des tickets individuellement ou par lots.- Pour récupérer un ticket individuel, effectuez une requête
GET
à/crm/v3/objects/tickets/{ticketId}
. - Pour demander une liste de tous les tickets, effectuez une requête
GET
à/crm/v3/objects/tickets
.
Paramètre | Description |
---|---|
properties | Une liste séparée par des virgules des propriétés à renvoyer dans la réponse. Si le ticket demandé n’a pas de valeur pour une propriété, il n’apparaîtra pas dans la réponse. |
propertiesWithHistory | Une liste séparée par des virgules des propriétés actuelles et historiques à renvoyer dans la réponse. Si le ticket demandé n’a pas de valeur pour une propriété, il n’apparaîtra pas dans la réponse. |
associations | Une liste séparée par des virgules des objets pour lesquels récupérer les ID associés. Les associations spécifiées qui n’existent pas ne seront pas renvoyées dans la réponse. Découvrez-en davantage sur l’API des associations. |
- Pour récupérer un lot de tickets spécifiques par ID de fiche d’informations ou selon une propriété d’identifiant unique personnalisée, effectuez une requête
POST
àcrm/v3/objects/tickets/batch/read
. Le point de terminaison du lot ne peut pas récupérer les associations. Découvrez comment lire par lots les associations avec l’API des associations.
idProperty
facultatif pour récupérer les tickets en fonction d’une propriété d’identifiant unique personnalisée. Par défaut, les valeurs d’id
dans la requête font référence à l’ID de fiche d’informations (hs_object_id
), de sorte que le paramètre idProperty
n’est pas requis lors de la récupération par ID de fiche d’informations. Pour utiliser une propriété de valeur unique personnalisée pour récupérer des tickets, vous devez inclure le paramètre idProperty
.
Par exemple, pour récupérer un lot de tickets, votre requête peut ressembler à ce qui suit :
Pour récupérer des tickets avec des valeurs actuelles et historiques pour une propriété, votre requête pourrait ressembler à :
Mettre à jour des tickets
Vous pouvez mettre à jour des tickets individuellement ou par lots. Pour les tickets existants, l’ID de fiche d’informations est une valeur unique par défaut que vous pouvez utiliser pour mettre à jour le ticket via l’API, mais vous pouvez également identifier et mettre à jour les tickets à l’aide de propriétés d’identifiant unique personnalisées.- Pour mettre à jour un ticket individuel avec son ID de fiche d’informations, effectuez une requête
PATCH
à/crm/v3/objects/tickets/{ticketId}
et incluez les données que vous souhaitez mettre à jour. - Pour mettre à jour plusieurs tickets, effectuez une requête
POST
vers/crm/v3/objects/tickets/batch/update
. Dans le corps de la requête, incluez un tableau avec les identifiants des tickets et les propriétés que vous souhaitez mettre à jour.
Associer des tickets existants à des fiches d’informations ou activités
Pour associer un ticket à d’autres fiches d’informations de CRM ou à une activité, effectuez une requêtePUT
à /crm/v3/objects/tickets/{ticketId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
.
Pour récupérer la valeur
associationTypeId
, reportez-vous à cette liste de valeurs par défaut ou effectuez une requête GET
à /crm/v4/associations/{fromObjectType}/{toObjectType}/labels
.Supprimer une association
Pour supprimer une association entre un ticket et une fiche d’informations ou une activité, effectuez une requêteDELETE
à l’URL suivante : /crm/v3/objects/tickets/{ticketId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
.
Épingler une activité à un ticket
Vous pouvez épingler une activité à une fiche d’informations d’un ticket via l’API en incluant le champhs_pinned_engagement_id
dans votre requête. Dans le champ, incluez l’id
de l’activité à épingler, qui peut être récupéré via les API d’engagement. Vous pouvez épingler une activité par fiche d’informations, et l’activité doit déjà être associée au ticket avant l’épinglage.
Pour définir ou mettre à jour l’activité épinglée d’un ticket, votre requête peut ressembler à :
Supprimer des tickets
Vous pouvez supprimer des tickets individuellement ou par lots, ce qui placera le ticket dans la corbeille dans HubSpot. Vous pourrez ensuite restaurer le ticket dans HubSpot. Pour supprimer un ticket avec son ID, effectuez une requêteDELETE
vers /crm/v3/objects/tickets/{ticketId}
.
Pour en savoir plus sur la suppression des tickets, consultez la documentation de référence.