Un ticket représente une demande de support ou d’aide d’un client. Les points de terminaison des tickets vous permettent de gérer ces données et de les synchroniser entre HubSpot et d’autres systèmes.
POST
à /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).
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.
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. |
GET
à /crm/v3/objects/tickets/{ticketId}
.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. |
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 à :
PATCH
à /crm/v3/objects/tickets/{ticketId}
et incluez les données que vous souhaitez mettre à jour.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.PUT
à /crm/v3/objects/tickets/{ticketId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
.
associationTypeId
, reportez-vous à cette liste de valeurs par défaut ou effectuez une requête GET
à /crm/v4/associations/{fromObjectType}/{toObjectType}/labels
.DELETE
à l’URL suivante : /crm/v3/objects/tickets/{ticketId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
.
hs_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 à :
DELETE
vers /crm/v3/objects/tickets/{ticketId}
.
Pour en savoir plus sur la suppression des tickets, consultez la documentation de référence.