API de piste

Rversion finale: Yokohama

Mis à jour 30 janv. 2025

67 minutes de lecture

L’API de piste fournit des points de terminaison qui vous permettent de créer, de mettre à jour et d’interroger/récupérer des prospects marketing et leurs éléments de ligne de piste associés à partir d’une instance.

Utilisez cette API pour intégrer votre instance à des sites web et systèmes externes, tels que des systèmes de capture automatisée de prospects, ou pour fournir des informations sur les prospects à des systèmes de génération de rapports externes.

Cette API est fournie dans l’espace de noms sn_lead_mgmt_core . Pour accéder à l’API, le module d’extension Lead Management Data Model (sn_lead_mgmt_core) doit être activé sur l’instance et l’utilisateur appelant doit disposer du rôle sn_lead_mgmt_core.lead_integrator.

Pour plus d’informations sur , reportez-vous à Gestion des pistesUsing Lead Management.

Extension de l’API de piste

Vous pouvez étendre l’API principale en remplaçant les méthodes de ses includes de script associés. La fonctionnalité d’API par défaut se trouve dans les includes de script se terminant par « OOB », tels que LeadAPIProcessUtilOOB. Pour remplacer cette fonctionnalité, créez des méthodes avec des noms et des paramètres identiques dans l’include de script qui a le même nom de fichier, mais ne se termine pas par « OOB », comme LeadAPIProcessUtil.

Vous trouverez ci-dessous une liste des includes de script que vous pouvez remplacer pour modifier le comportement de l’API principale :

LeadAPIProcessUtilOOB : contient des méthodes qui gèrent la récupération et la création d’enregistrements de piste et d’éléments de ligne de piste.
LeadApiValidationUtilOOB : contient des méthodes qui valident l’objet de demande JSON pour les points de terminaison POST et PATCH.
LeadAPIHelperOOB : contient des méthodes d’aide API qui :
- Renvoyer un tableau de pistes et d’éléments de ligne de piste connexes.
- Renvoyer un objet JSON à partir du GlideRecord associé.
- Supprimez tous les champs ignorés d’un objet JSON et effectuez d’autres transformations.
LeadAPIConstantsOOB : contient des constantes, des codes d’état et des messages pour toutes les opérations API. Elle comprend également la liste des champs ignorés par les points de terminaison POST et PATCH.

piste : GET /sn_lead_mgmt_core/lead

Récupère toutes les pistes et les éléments de ligne de piste associés en fonction des critères de filtre transmis dans les paramètres de requête.

Ce point de terminaison renvoie une réponse paginée selon la limite et le décalage spécifiés. Il récupère des informations à partir des tables suivantes :

Piste [sn_lead_mgmt_core_lead]
Élément de ligne de la piste [sn_lead_mgmt_core_lead_line_item]

Format d'URL

URL versionnée : /api/sn_lead_mgmt_core/{api_version}/lead

URL par défaut : /api/sn_lead_mgmt_core/{api_version}/lead

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 1. Paramètres de chemin d'accès
Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, `v1` ou `v2`. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne

Tableau 2. Paramètres de requête
Nom	Description
sysparm_fields	Liste des champs séparés par des virgules à envoyer dans la réponse. Les champs non valides sont ignorés. Type de données : chaîne Par défaut : renvoyer tous les champs.
sysparm_limit	Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d'enregistrements, utilisez le paramètre sysparm_offset pour paginer la récupération d'enregistrements. Cette limite est appliquée avant l'évaluation de l'ACL. Si aucun enregistrement n'est renvoyé (notamment ceux auxquels vous avez accès), réorganisez l'ordre des enregistrements pour que ceux auxquels vous avez accès soient renvoyés en premier. Remarque : Des valeurs sysparm_limit anormalement élevées peuvent avoir un impact sur les performances du système. Type de données : nombre Par défaut : 20 Maximum : 100
sysparm_offset	Index de début des enregistrements pour lequel commencer à récupérer des enregistrements. Utilisez cette valeur pour paginer la récupération des enregistrements. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit le nombre d'enregistrements, par petits blocs gérables. Par exemple, lors du premier appel de ce point de terminaison, sysparm_offset est défini sur « 0 ». Pour parcourir simplement tous les enregistrements disponibles, utilisez le paramètre `sysparm_offset=sysparm_offset+sysparm_limit`, jusqu'à atteindre la fin de tous les enregistrements. Ne transmettez pas de nombre négatif dans le sysparm_offset paramètre. Type de données : nombre Par défaut : 0
sysparm_query	Requête codée utilisée pour filtrer l'ensemble de résultats. Par exemple : `(sysparm_query=caller_id=javascript:gs.getUserID()^active=true)` La requête codée prend en charge le tri par. Pour trier les réponses en fonction de certains champs, utilisez les clauses ORDERBY et ORDERBYDESC dans sysparm_query. Par exemple, `sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory` filtre tous les enregistrements actifs et classe les résultats par ordre croissant par numéro d’abord, puis par ordre décroissant par catégorie. Si une partie de la requête n'est pas valide (par exemple, un nom de champ non valide a été spécifié), l'instance ignore la partie non valide. Puis, elle renvoie les lignes en utilisant uniquement la partie valide de la requête. Vous pouvez contrôler ce comportement à l'aide de la propriété glide.invalid_query.returns_no_rows. Définissez cette propriété sur true pour ne renvoyer aucune ligne dans une requête non valide. Remarque : La propriété glide.invalid_query.returns_no_rows contrôle le comportement de toutes les requêtes dans l'instance, par exemple dans les listes, les scripts (GlideRecord.query()) et les API de service Web. Type de données : chaîne

Tableau 3. Paramètres du corps de la demande
Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 4. En-têtes de demandes
En-tête	Description
Content-Type	Format de données du corps de la demande. Prend uniquement en charge application/json.

Tableau 5. En-têtes de réponses
En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Plage de contenu	Plage de contenu renvoyé lors d’un appel paginé. Par exemple, si offset=2 et limit=3, la valeur de l’en-tête Content-Range est les éléments 3-5.
Liens	Liens à travers lesquels naviguer dans les résultats de la requête : premier dernier suivant previous même
Nombre total	Nombre total d’enregistrements filtrés.

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 6. Codes d'état
Code d'état	Description
200	La demande a été traitée avec succès. Toutes les réponses ont été renvoyées (aucune pagination).
206	Demande traitée avec succès. Ressource partielle retournée en réponse (avec pagination).
400	Erreur. Raisons possibles : Limite/limite non valide supérieure au maximum autorisé. Décalage non valide.
403	Accès refusé à l’enregistrement. Autorisation insuffisante pour interroger l’enregistrement.
404	Introuvable. L’élément demandé est introuvable.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande.

Paramètres du corps de réponse


Nom	Description
compte	Compte lié à la piste. Type de données : objet `"account": { "name": "String", "sys_id": "String" }`
account.name	Nom du compte. Type de données : chaîne
account.sys_id	Sys_id de l’enregistrement du compte associé. Type de données : chaîne Table : Compte [customer_account]
business_phone	Numéro de téléphone professionnel du prospect. Type de données : chaîne
city	Ville dans laquelle réside le personnage principal. Type de données : chaîne
closed_date	Date et heure auxquelles la piste a été fermée. Type de données : objet `"closed_date": { "display_value": "String", "value": "String" }`
closed_date.display_value	Date et heure telles qu’affichées dans l’interface utilisateur. Type de données : chaîne Format : format et fuseau horaire de l’utilisateur.
closed_date.valeur	Date et heure auxquelles la piste s’est fermée telles que définies dans l’enregistrement associé. Type de données : chaîne Format : UTC
company	Nom de la société du prospect. Type de données : chaîne
consommateur	Consommateur associé à la piste. Type de données : objet `"consumer": { "name": "String", "sys_id": "String" }`
consumer.name	Nom du consommateur associé. Type de données : chaîne
consumer.sys_id	Sys_id de l’enregistrement de consommateur associé. Type de données : chaîne Table : Consommateur [csm_consumer]
contact	Contact associé au compte de piste. Type de données : objet `"contact": { "name": "String", "sys_id": "String" }`
contact.name	Nom du contact. Type de données : chaîne
contact.sys_id	Sys_id de l’enregistrement du contact associé. Type de données : chaîne Table : Contact [customer_contact]
pays	Pays dans lequel réside la piste. Type de données : chaîne
do_not_call	Marqueur indiquant si le mode de communication est par téléphone. Valeurs valides : vrai : peut appeler le contact. faux : N’appelez pas le contact. Type de données : booléennes
do_not_email	Marqueur indiquant si le mode de communication est par e-mail. Valeurs valides : vrai : peut contacter par e-mail. faux : ne pas envoyer d’e-mail au contact. Type de données : booléennes
do_not_share	Marqueur indiquant si les détails du prospect peuvent être partagés. Valeurs valides : vrai : les détails du prospect peuvent être partagés. faux : les détails du prospect ne peuvent pas être partagés. Type de données : booléennes
E-mail	Adresse e-mail du prospect. Type de données : chaîne
external_id	ID utilisé par le système qui a généré la piste pour identifier la piste dans le système associé. Type de données : chaîne
external_system	Nom du système externe associé à la piste, tel que HubSpot ou pipedrive. Type de données : chaîne
first_name	Prénom du contact associé à la piste. Type de données : chaîne
industrie	Secteur auquel appartient le chef de file. Type de données : chaîne Table : située dans le industry champ de la table Compte [customer_account].
last_name	Nom de famille du contact associé à la piste. Type de données : chaîne
lead_group	Groupe auquel la piste appartient. Type de données : objet `"lead_group": { "name: "String", "sys_id": "String" }`
lead_group.nom	Nom du groupe de pistes. Type de données : chaîne
lead_group.sys_id	Sys_id de l’enregistrement du groupe de pistes. Type de données : chaîne Table : Groupe [sys_user_group]
lead_line_items	Détails des éléments de ligne de piste associés à la piste. Type de données : tableau d’objets `"lead_line_items": [ { "external_id": "String", "external_system": "String", "lead": {Object}, "number": "String", "product_offering": {Object}, "quantity": Number, "sys_created_by”: "String", "sys_created_on {Object}, "sys_domain": "String", "sys_domain_path": "String", "sys_id": "String", "sys_mod_count": Number, "sys_tags": [Array], "sys_updated_by: "String", "sys_updated_on: {Object}, "unit_of_measurement": {Object}, "work_notes": [Array] } ]`
lead_line_items.external_id	ID utilisé par le système qui a généré l’élément de ligne de piste pour identifier l’élément de ligne dans le système associé. Type de données : chaîne
lead_line_items.external_system	Nom du système externe associé à l’élément de ligne de piste, tel que HubSpot ou pipedrive. Type de données : chaîne
lead_line_items.plomb	Détails sur la piste associée à l’élément de ligne. Type de données : objet `"lead: { "name": "String", "sys_id": "String" }`
lead_line_items.lead.name	Nom du prospect associé. Type de données : chaîne
lead_line_items.lead.sys_id	Sys_id de l’enregistrement de piste associé. Type de données : chaîne
lead_line_items.nombre	Numéro unique généré par le système de l’enregistrement d’élément de ligne de prospect. Type de données : chaîne
lead_line_items.product_offering	Informations sur l’offre de produit associée à l’élément de ligne de prospect. Type de données : objet `"product_offering": { "code": " String", "name": "String", "sys_id": "String" }`
lead_line_items.product_offering.code	Code lié à l’offre de produits. Remarque : Il s’agit d’un numéro alphanumérique généré par le système basé sur le nom du produit. Bien qu’il soit généré par le système, vous pouvez modifier le code pour représenter une référence SKU ou tout autre code produit spécifique au secteur. Type de données : chaîne
lead_line_items.product_offering.nom	Nom de l’offre de produits. Type de données : chaîne
lead_line_items.product_offering.sys_id	Sys_id de l’enregistrement d’offre de produit associé à l’élément de ligne de piste. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering]
lead_line_items.quantité	Quantité d’éléments que le prospect souhaite acheter de l’offre de produits associée. Type de données : nombre (entier)
lead_line_items.sys_created_by	Nom d’utilisateur de la personne qui a créé l’élément de ligne de piste. Type de données : chaîne
lead_line_items.sys_created_on	Date et heure de création de l’élément de ligne de piste générées par le système. Type de données : objet `"sys_created_on": { "display_value": "String", "value": "String" }`
lead_line_items.sys_created_on.valeur_display_value	Date et heure de création de l’élément de ligne de prospect. Type de données : chaîne Format : format d’instance et fuseau horaire par défaut
lead_line_items.sys_created_on.valeur	Date et heure de création de l’élément de ligne de prospect. Type de données : chaîne Format : UTC
lead_line_items.sys_domain	Sys_id de l’enregistrement du domaine auquel l’élément de ligne de la piste appartient. Remarque : Ce paramètre n’est renvoyé dans la réponse que si Séparation de domaine est activée. Type de données : chaîne
lead_line_items.sys_chemin_domaine	Chemin d’accès du domaine auquel l’élément de ligne de la piste appartient. Remarque : Ce paramètre n’est renvoyé dans la réponse que si Séparation de domaine est activée. Type de données : chaîne
lead_line_items.sys_id	Sys_id de l’enregistrement de l’élément de ligne de la piste. Type de données : chaîne
lead_line_items.sys_mod_count	Nombre de fois où l’enregistrement d’élément de ligne de piste associé a été modifié. Type de données : nombre (entier)
lead_line_items.sys_tags	Liste des balises système associées à l’élément de ligne de piste. Type de données : tableau
lead_line_items.sys_updated_by	Nom d’utilisateur de la personne qui a mis à jour pour la dernière fois l’élément de ligne de piste associé. Type de données : chaîne
lead_line_items.sys_updated_on	Date et heure de dernière mise à jour de l’élément de ligne de piste générées par le système. Type de données : objet `"sys_created_on": { "display_value": "String", "value": "String" }`
lead_line_items.sys_updated_on.display_value	Date et heure de dernière mise à jour de l’élément de ligne de prospect. Type de données : chaîne Format : format d’instance et fuseau horaire par défaut
lead_line_items.sys_updated_on.valeur	Date et heure de dernière mise à jour de l’élément de ligne de prospect. Type de données : chaîne Format : UTC
lead_line_items.unit_of_measurement	Détails de l’unité de mesure de l’élément de ligne de la piste. Type de données : objet `"unit_of_measurement": { "name": "String", "sys_id": "String" }`
lead_line_items.unit_of_measurement.nom	Nom de l’unité de mesure, par exemple, chaque pied cube. Type de données : chaîne
lead_line_items.unit_of_measurement.sys_id	Sys_id de l’enregistrement qui décrit l’unité de mesure. Type de données : chaîne Tableau : Unité de mesure [sn_prd_pm_uom]
lead_line_items.work_notes	Liste qui décrit les notes de travail créées pour l’élément de ligne de piste. Type de données : tableau d’objets `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
lead_line_items.work_notes.auteur	Nom d’utilisateur de la personne qui a rédigé la note de travail associée. Type de données : chaîne
lead_line_items.work_notes.date	Date de création de la note. Type de données : chaîne
lead_line_items.work_notes.SMS	Texte de la note rédigée par l’auteur. Type de données : chaîne
lead_rating	Évaluation de la piste telle que 100_cold, 200_warm, 300_hot ou 400_super_hot. Remarque : Il s’agit d’un champ de choix. Il doit contenir l’un des éléments de choix définis dans le champ lead_rating de la table Prospects. Type de données : chaîne
lead_score	Score pour l’en-tête. Type de données : Décimal Plage : 1 à 100
lead_source	Initiateur de la piste. Remarque : Il s’agit d’un champ de choix. Il doit contenir l’un des éléments de choix définis dans le champ lead_source de la table Prospects. Type de données : chaîne
lead_type	Type de prospect, tel que nouvelle affaire ou activité existante. Remarque : Il s’agit d’un champ de choix. Il doit contenir l’un des éléments de choix définis dans le champ lead_type de la table Prospects. Type de données : chaîne
middle_name	Deuxième prénom du contact de la piste. Type de données : chaîne
mobile_phone	Numéro de téléphone du contact de la piste. Type de données : chaîne
Numéro	Numéro unique généré par le système de l’enregistrement de prospect. Type de données : chaîne
other_reason	Raison supplémentaire de la disqualification de la tête. Type de données : chaîne Longueur maximale : 160 caractères
propriétaire	Détails de la personne associée à la piste. Type de données : objet `"owner": { "name": "String", "sys_id": "String" }`
owner.name	Nom de la personne qui possède la piste. Type de données : chaîne
owner.sys_id	Sys_id de l’enregistrement utilisateur de la personne qui possède la piste. Type de données : chaîne Table : Utilisateur [sys_user]
motif	Raison de la disqualification de la piste telle que Disqualifier. Type de données : chaîne Longueur maximale : 40 caractères
short_description	Brève description de la piste. Type de données : chaîne Longueur maximale : 160 caractères
similar_lead	Détails sur toute piste similaire. Utilisez cette option pour une éventuelle disqualification de la piste. Type de données : objet `"similar_lead": { "name": "String", "sys_id": "String" }`
similar_lead.nom	Nom de la piste en double. Type de données : chaîne
similar_lead.sys_id	Sys_id de l’enregistrement de piste qui est une piste possiblement en double. Type de données : chaîne Table : piste [sn_lead_mgmt_core_lead]
étape	Étape de la piste telle que 100_new. Remarque : Il s’agit d’un champ de choix. Il doit contenir l’un des éléments de choix définis dans le champ d’étape de la table Pistes. Type de données : chaîne
État	État dans lequel réside la piste. Type de données : chaîne
rue	Rue sur laquelle réside le plomb. Type de données : chaîne
sys_class_name	Nom de classe de la table principale généré par le système. Type de données : chaîne
sys_created_by	Nom d’utilisateur de la personne qui a créé la piste. Type de données : chaîne
sys_created_on	Date et heure de création de la piste générées par le système. Type de données : objet `"sys_created_on": { "display_value": "String", "value": "String" }`
sys_created_on.display_value	Date et heure auxquelles la piste a été créée. Type de données : chaîne Format : format d’instance et fuseau horaire par défaut
sys_created_on.valeur	Date et heure auxquelles la piste a été créée. Type de données : chaîne Format : UTC
sys_domain	Sys_id de l’enregistrement du domaine auquel la piste appartient. Remarque : Ce paramètre n’est renvoyé dans la réponse que si Séparation de domaine est activée. Type de données : chaîne
sys_domain_path	Chemin du domaine auquel la piste appartient. Remarque : Ce paramètre n’est renvoyé dans la réponse que si Séparation de domaine est activée. Type de données : chaîne
sys_id	Sys_id de l’enregistrement de prospect. Type de données : chaîne Table : piste [sn_lead_mgmt_core_lead]
sys_mod_count	Nombre de fois où l’enregistrement de prospect associé a été modifié. Type de données : nombre (entier)
sys_tags	Liste des balises système associées à la piste. Vous pouvez utiliser ces balises pour catégoriser les prospects. Type de données : tableau
sys_updated_by	Nom d’utilisateur de la personne qui a mis à jour l’enregistrement de piste pour la dernière fois. Type de données : chaîne
sys_updated_on	Date et heure de la dernière mise à jour de la piste générées par le système. Type de données : objet `"sys_created_on": { "display_value": "String", "value": "String" }`
sys_updated_on.display_value	Date et heure de la dernière mise à jour de la piste. Type de données : chaîne Format : format et fuseau horaire par défaut de l’instance
sys_updated_on.valeur	Date et heure de la dernière mise à jour de la piste. Type de données : chaîne Format : UTC
Titre	Titre de la piste. Type de données : chaîne
site internet	URL du site Web du prospect. Type de données : chaîne
work_notes	Liste des notes de travail créées pour la piste. Type de données : tableau d’objets `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
work_notes.auteur	Nom d’utilisateur de la personne qui a rédigé la note de travail associée. Type de données : chaîne
work_notes.date	Date de création de la note. Type de données : chaîne
work_notes.SMS	Texte de la note rédigée par l’auteur. Type de données : chaîne
code postal	Code postal de la piste associée. Type de données : chaîne

Demande cURL

L’exemple de code suivant montre comment transmettre des paramètres de requête pour spécifier les pistes à renvoyer.

curl "https://instance.service-now.com/api/sn_lead_mgmt_core/lead?sysparm_query=stage%3D400_closed_won&sysparm_fields=sys_id%2Cfirst_name%2Clast_name%2Cshort_description%2Cstage%2Clead_line_items&sysparm_offset=2" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user "username":"password"

Les pistes sont renvoyées dans un tableau d’objets :

[
  {
    "short_description": "Looking for a quote on preventative maintenance plans for their corporate office building elevators.",
    "reason": null,
    "country": "USA",
    "closed_date": null,
    "city": "San Francisco",
    "lead_source": "inbound_phone",
    "external_id": null,
    "industry": "manufacturing",
    "sys_updated_on": {
      "value": "2024-05-31 11:01:55",
      "display_value": "2024-05-31 04:01:55"
    },
    "title": "Director of Building operations",
    "sys_class_name": "Lead",
    "number": "LEAD0000001",
    "sys_id": "856b6a95ffde8210b85dffffffffffd7",
    "business_phone": "+1 (555) 123-4567",
    "similar_lead": null,
    "sys_updated_by": "admin",
    "mobile_phone": null,
    "street": "789, Industrial drive",
    "sys_created_on": {
      "value": "2024-05-20 10:32:41",
      "display_value": "2024-05-20 03:32:41"
    },
    "contact": null,
    "company": "Lee Manufacturing Inc",
    "state": "CA",
    "first_name": "James",
    "email": "james.wilson@email.com",
    "consumer": null,
    "sys_created_by": "admin",
    "zip": "94016",
    "owner": {
      "sys_id": "60058fe943fe3110d6c6cd60afb8f203",
      "name": "Max Blaze"
    },
    "website": null,
    "lead_group": null,
    "sys_mod_count": 1,
    "last_name": "Wilson",
    "other_reason": null,
    "middle_name": null,
    "sys_tags": null,
    "do_not_share": false,
    "lead_score": 92,
    "stage": "300_nurturing",
    "do_not_email": false,
    "lead_type": null,
    "work_notes": [
      {
        "author": "Abel Tuter",
        "date": "2024-12-04 06:52:07",
        "text": "Work notes for lead"
      }
    ],
    "do_not_call": false,
    "lead_rating": "400_super_hot",
    "account": null,
    "external_system": null,
    "lead_line_items": [
      {
        "quantity": 6,
        "product_offering": {
          "sys_id": "32619d9fd0a63110f8770dbf976be1f9",
          "name": "Safety Test Coverage",
          "code": "SAFETSTCVG1"
        },
        "sys_mod_count": 0,
        "external_id": null,
        "sys_updated_on": {
          "value": "2024-05-20 10:38:41",
          "display_value": "2024-05-20 03:38:41"
        },
        "sys_tags": null,
        "lead": {
          "sys_id": "856b6a95ffde8210b85dffffffffffd7",
          "name": "LEAD0000001"
        },
        "number": "LEADL0000003",
        "sys_id": "013daa19ffde8210b85dffffffffff82",
        "unit_of_measurement": {
          "sys_id": "cb2795d553020110286eddeeff7b12ff",
          "name": "Each"
        },
        "sys_updated_by": "admin",
        "sys_created_on": {
          "value": "2024-05-20 10:38:41",
          "display_value": "2024-05-20 03:38:41"
        },
        "work_notes": null,
        "sys_created_by": "admin",
        "external_system": null
      }
    ]
  },
  {
    "short_description": "Partner referral for a company interested in a reliable internet bundle with strong security features for their office.",
    "reason": null,
    "country": "USA",
    "closed_date": null,
    "city": "San Francisco",
    "lead_source": "partner_referral",
    "external_id": null,
    "industry": "technology_services",
    "sys_updated_on": {
      "value": "2024-05-20 10:53:59",
      "display_value": "2024-05-20 03:53:59"
    },
    "title": "IT Director",
    "sys_class_name": "Lead",
    "number": "LEAD0000002",
    "sys_id": "e71fa6d9ffde8210b85dffffffffff51",
    "business_phone": "(626) 722-6969",
    "similar_lead": null,
    "sys_updated_by": "admin",
    "mobile_phone": null,
    "street": "747 Howard St",
    "sys_created_on": {
      "value": "2024-05-20 10:49:12",
      "display_value": "2024-05-20 03:49:12"
    },
    "contact": {
      "sys_id": "4d147a386f0331003b3c498f5d3ee437",
      "name": ""
    },
    "company": "Boxeo",
    "state": "CA",
    "first_name": "Julie",
    "email": "julie.lewis@example.com",
    "consumer": null,
    "sys_created_by": "admin",
    "zip": "94013",
    "owner": {
      "sys_id": "60058fe943fe3110d6c6cd60afb8f203",
      "name": "Max Blaze"
    },
    "website": null,
    "lead_group": null,
    "sys_mod_count": 0,
    "last_name": "Lewis",
    "other_reason": null,
    "middle_name": null,
    "sys_tags": null,
    "do_not_share": false,
    "lead_score": 78,
    "stage": "400_closed_won",
    "do_not_email": false,
    "lead_type": null,
    "work_notes": [
      {
        "author": "Abel Tuter",
        "date": "2024-12-03 03:52:51",
        "text": "Work noted for LEAD0000002"
      }
    ],
    "do_not_call": false,
    "lead_rating": "200_warm",
    "account": {
      "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
      "name": ""
    },
    "external_system": null,
    "lead_line_items": [
      {
        "quantity": 50,
        "product_offering": {
          "sys_id": "0b61dd9fd0a63110f8770dbf976be171",
          "name": "Solana Modem M Series",
          "code": "SOLANAMODE2"
        },
        "sys_mod_count": 0,
        "external_id": null,
        "sys_updated_on": { 
          "value": "2024-05-20 10:51:57",
          "display_value": "2024-05-20 03:51:57"
        },
        "sys_tags": null,
        "lead": {
          "sys_id": "e71fa6d9ffde8210b85dffffffffff51",
          "name": "LEAD0000002"
        },
        "number": "LEADL0000009",
        "sys_id": "2130fa1dffde8210b85dffffffffffff",
        "unit_of_measurement": {
          "sys_id": "cb2795d553020110286eddeeff7b12ff",
          "name": "Each"
        },
        "sys_updated_by": "admin",
        "sys_created_on": { 
          "value": "2024-05-20 10:51:25", 
          "display_value": "2024-05-20 03:51:25"
        },
        "work_notes": null,
        "sys_created_by": "admin",
        "external_system": null
      } 
    ]
  }
]

piste : GET /sn_lead_mgmt_core/lead/{sys_id}

Renvoie l’enregistrement de piste et tous les éléments de ligne de piste associés pour la sys_id spécifiée.

Ce point de terminaison récupère les informations des tables suivantes :

Piste [sn_lead_mgmt_core_lead]
Élément de ligne de la piste [sn_lead_mgmt_core_lead_line_item]

Format d'URL

URL versionnée : /api/sn_lead_mgmt_core/{api_version}/lead/{sys_id}

URL par défaut : /api/sn_lead_mgmt_core/{api_version}/lead/{sys_id}

Remarque :

Paramètres de demande pris en charge

Tableau 7. Paramètres de chemin d'accès
Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, `v1` ou `v2`. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne
sys_id	Sys_id de la piste à récupérer. Type de données : chaîne Table : piste [sn_lead_mgmt_core_lead]

Tableau 8. Paramètres de requête
Nom	Description
Néant

Tableau 9. Paramètres de corps de demande (XML ou JSON)
Nom	Description
Néant

En-têtes

Tableau 10. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.

Tableau 11. En-têtes de réponses
En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 12. Codes d'état
Code d'état	Description
200	Réussi. La demande a été correctement traitée.
403	Interdit. L’utilisateur ne dispose pas des droits d’accès à l’enregistrement spécifié.
404	Introuvable. L’élément demandé est introuvable.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

Paramètres du corps de réponse


Nom	Description
compte	Compte lié à la piste. Type de données : objet `"account": { "name": "String", "sys_id": "String" }`
account.name	Nom du compte. Type de données : chaîne
account.sys_id	Sys_id de l’enregistrement du compte associé. Type de données : chaîne Table : Compte [customer_account]
business_phone	Numéro de téléphone professionnel du prospect. Type de données : chaîne
city	Ville dans laquelle réside le personnage principal. Type de données : chaîne
closed_date	Date et heure auxquelles la piste a été fermée. Type de données : objet `"closed_date": { "display_value": "String", "value": "String" }`
closed_date.display_value	Date et heure telles qu’affichées dans l’interface utilisateur. Type de données : chaîne Format : format et fuseau horaire de l’utilisateur.
closed_date.valeur	Date et heure auxquelles la piste s’est fermée telles que définies dans l’enregistrement associé. Type de données : chaîne Format : UTC
company	Nom de la société du prospect. Type de données : chaîne
consommateur	Consommateur associé à la piste. Type de données : objet `"consumer": { "name": "String", "sys_id": "String" }`
consumer.name	Nom du consommateur associé. Type de données : chaîne
consumer.sys_id	Sys_id de l’enregistrement de consommateur associé. Type de données : chaîne Table : Consommateur [csm_consumer]
contact	Contact associé au compte de piste. Type de données : objet `"contact": { "name": "String", "sys_id": "String" }`
contact.name	Nom du contact. Type de données : chaîne
contact.sys_id	Sys_id de l’enregistrement du contact associé. Type de données : chaîne Table : Contact [customer_contact]
pays	Pays dans lequel réside la piste. Type de données : chaîne
do_not_call	Marqueur indiquant si le mode de communication est par téléphone. Valeurs valides : vrai : peut appeler le contact. faux : N’appelez pas le contact. Type de données : booléennes
do_not_email	Marqueur indiquant si le mode de communication est par e-mail. Valeurs valides : vrai : peut contacter par e-mail. faux : ne pas envoyer d’e-mail au contact. Type de données : booléennes
do_not_share	Marqueur indiquant si les détails du prospect peuvent être partagés. Valeurs valides : vrai : les détails du prospect peuvent être partagés. faux : les détails du prospect ne peuvent pas être partagés. Type de données : booléennes
E-mail	Adresse e-mail du prospect. Type de données : chaîne
external_id	ID utilisé par le système qui a généré la piste pour identifier la piste dans le système associé. Type de données : chaîne
external_system	Nom du système externe associé à la piste, tel que HubSpot ou pipedrive. Type de données : chaîne
first_name	Prénom du contact associé à la piste. Type de données : chaîne
industrie	Secteur auquel appartient le chef de file. Type de données : chaîne Table : située dans le industry champ de la table Compte [customer_account].
last_name	Nom de famille du contact associé à la piste. Type de données : chaîne
lead_group	Groupe auquel la piste appartient. Type de données : objet `"lead_group": { "name: "String", "sys_id": "String" }`
lead_group.nom	Nom du groupe de pistes. Type de données : chaîne
lead_group.sys_id	Sys_id de l’enregistrement du groupe de pistes. Type de données : chaîne Table : Groupe [sys_user_group]
lead_line_items	Détails des éléments de ligne de piste associés à la piste. Type de données : tableau d’objets `"lead_line_items": [ { "external_id": "String", "external_system": "String", "lead": {Object}, "number": "String", "product_offering": {Object}, "quantity": Number, "sys_created_by”: "String", "sys_created_on {Object}, "sys_domain": "String", "sys_domain_path": "String", "sys_id": "String", "sys_mod_count": Number, "sys_tags": [Array], "sys_updated_by: "String", "sys_updated_on: {Object}, "unit_of_measurement": {Object}, "work_notes": [Array] } ]`
lead_line_items.external_id	ID utilisé par le système qui a généré l’élément de ligne de piste pour identifier l’élément de ligne dans le système associé. Type de données : chaîne
lead_line_items.external_system	Nom du système externe associé à l’élément de ligne de piste, tel que HubSpot ou pipedrive. Type de données : chaîne
lead_line_items.plomb	Détails sur la piste associée à l’élément de ligne. Type de données : objet `"lead: { "name": "String", "sys_id": "String" }`
lead_line_items.lead.name	Nom du prospect associé. Type de données : chaîne
lead_line_items.lead.sys_id	Sys_id de l’enregistrement de piste associé. Type de données : chaîne
lead_line_items.nombre	Numéro unique généré par le système de l’enregistrement d’élément de ligne de prospect. Type de données : chaîne
lead_line_items.product_offering	Informations sur l’offre de produit associée à l’élément de ligne de prospect. Type de données : objet `"product_offering": { "code": " String", "name": "String", "sys_id": "String" }`
lead_line_items.product_offering.code	Code lié à l’offre de produits. Remarque : Il s’agit d’un numéro alphanumérique généré par le système basé sur le nom du produit. Bien qu’il soit généré par le système, vous pouvez modifier le code pour représenter une référence SKU ou tout autre code produit spécifique au secteur. Type de données : chaîne
lead_line_items.product_offering.nom	Nom de l’offre de produits. Type de données : chaîne
lead_line_items.product_offering.sys_id	Sys_id de l’enregistrement d’offre de produit associé à l’élément de ligne de piste. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering]
lead_line_items.quantité	Quantité d’éléments que le prospect souhaite acheter de l’offre de produits associée. Type de données : nombre (entier)
lead_line_items.sys_created_by	Nom d’utilisateur de la personne qui a créé l’élément de ligne de piste. Type de données : chaîne
lead_line_items.sys_created_on	Date et heure de création de l’élément de ligne de piste générées par le système. Type de données : objet `"sys_created_on": { "display_value": "String", "value": "String" }`
lead_line_items.sys_created_on.valeur_display_value	Date et heure de création de l’élément de ligne de prospect. Type de données : chaîne Format : format d’instance et fuseau horaire par défaut
lead_line_items.sys_created_on.valeur	Date et heure de création de l’élément de ligne de prospect. Type de données : chaîne Format : UTC
lead_line_items.sys_domain	Sys_id de l’enregistrement du domaine auquel l’élément de ligne de la piste appartient. Remarque : Ce paramètre n’est renvoyé dans la réponse que si Séparation de domaine est activée. Type de données : chaîne
lead_line_items.sys_chemin_domaine	Chemin d’accès du domaine auquel l’élément de ligne de la piste appartient. Remarque : Ce paramètre n’est renvoyé dans la réponse que si Séparation de domaine est activée. Type de données : chaîne
lead_line_items.sys_id	Sys_id de l’enregistrement de l’élément de ligne de la piste. Type de données : chaîne
lead_line_items.sys_mod_count	Nombre de fois où l’enregistrement d’élément de ligne de piste associé a été modifié. Type de données : nombre (entier)
lead_line_items.sys_tags	Liste des balises système associées à l’élément de ligne de piste. Type de données : tableau
lead_line_items.sys_updated_by	Nom d’utilisateur de la personne qui a mis à jour pour la dernière fois l’élément de ligne de piste associé. Type de données : chaîne
lead_line_items.sys_updated_on	Date et heure de dernière mise à jour de l’élément de ligne de piste générées par le système. Type de données : objet `"sys_created_on": { "display_value": "String", "value": "String" }`
lead_line_items.sys_updated_on.display_value	Date et heure de dernière mise à jour de l’élément de ligne de prospect. Type de données : chaîne Format : format d’instance et fuseau horaire par défaut
lead_line_items.sys_updated_on.valeur	Date et heure de dernière mise à jour de l’élément de ligne de prospect. Type de données : chaîne Format : UTC
lead_line_items.unit_of_measurement	Détails de l’unité de mesure de l’élément de ligne de la piste. Type de données : objet `"unit_of_measurement": { "name": "String", "sys_id": "String" }`
lead_line_items.unit_of_measurement.nom	Nom de l’unité de mesure, par exemple, chaque pied cube. Type de données : chaîne
lead_line_items.unit_of_measurement.sys_id	Sys_id de l’enregistrement qui décrit l’unité de mesure. Type de données : chaîne Tableau : Unité de mesure [sn_prd_pm_uom]
lead_line_items.work_notes	Liste qui décrit les notes de travail créées pour l’élément de ligne de piste. Type de données : tableau d’objets `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
lead_line_items.work_notes.auteur	Nom d’utilisateur de la personne qui a rédigé la note de travail associée. Type de données : chaîne
lead_line_items.work_notes.date	Date de création de la note. Type de données : chaîne
lead_line_items.work_notes.SMS	Texte de la note rédigée par l’auteur. Type de données : chaîne
lead_rating	Évaluation de la piste telle que 100_cold, 200_warm, 300_hot ou 400_super_hot. Remarque : Il s’agit d’un champ de choix. Il doit contenir l’un des éléments de choix définis dans le champ lead_rating de la table Prospects. Type de données : chaîne
lead_score	Score pour l’en-tête. Type de données : Décimal Plage : 1 à 100
lead_source	Initiateur de la piste. Remarque : Il s’agit d’un champ de choix. Il doit contenir l’un des éléments de choix définis dans le champ lead_source de la table Prospects. Type de données : chaîne
lead_type	Type de prospect, tel que nouvelle affaire ou activité existante. Remarque : Il s’agit d’un champ de choix. Il doit contenir l’un des éléments de choix définis dans le champ lead_type de la table Prospects. Type de données : chaîne
middle_name	Deuxième prénom du contact de la piste. Type de données : chaîne
mobile_phone	Numéro de téléphone du contact de la piste. Type de données : chaîne
Numéro	Numéro unique généré par le système de l’enregistrement de prospect. Type de données : chaîne
other_reason	Raison supplémentaire de la disqualification de la tête. Type de données : chaîne Longueur maximale : 160 caractères
propriétaire	Détails de la personne associée à la piste. Type de données : objet `"owner": { "name": "String", "sys_id": "String" }`
owner.name	Nom de la personne qui possède la piste. Type de données : chaîne
owner.sys_id	Sys_id de l’enregistrement utilisateur de la personne qui possède la piste. Type de données : chaîne Table : Utilisateur [sys_user]
motif	Raison de la disqualification de la piste telle que Disqualifier. Type de données : chaîne Longueur maximale : 40 caractères
short_description	Brève description de la piste. Type de données : chaîne Longueur maximale : 160 caractères
similar_lead	Détails sur toute piste similaire. Utilisez cette option pour une éventuelle disqualification de la piste. Type de données : objet `"similar_lead": { "name": "String", "sys_id": "String" }`
similar_lead.nom	Nom de la piste en double. Type de données : chaîne
similar_lead.sys_id	Sys_id de l’enregistrement de piste qui est une piste possiblement en double. Type de données : chaîne Table : piste [sn_lead_mgmt_core_lead]
étape	Étape de la piste telle que 100_new. Remarque : Il s’agit d’un champ de choix. Il doit contenir l’un des éléments de choix définis dans le champ d’étape de la table Pistes. Type de données : chaîne
État	État dans lequel réside la piste. Type de données : chaîne
rue	Rue sur laquelle réside le plomb. Type de données : chaîne
sys_class_name	Nom de classe de la table principale généré par le système. Type de données : chaîne
sys_created_by	Nom d’utilisateur de la personne qui a créé la piste. Type de données : chaîne
sys_created_on	Date et heure de création de la piste générées par le système. Type de données : objet `"sys_created_on": { "display_value": "String", "value": "String" }`
sys_created_on.display_value	Date et heure auxquelles la piste a été créée. Type de données : chaîne Format : format d’instance et fuseau horaire par défaut
sys_created_on.valeur	Date et heure auxquelles la piste a été créée. Type de données : chaîne Format : UTC
sys_domain	Sys_id de l’enregistrement du domaine auquel la piste appartient. Remarque : Ce paramètre n’est renvoyé dans la réponse que si Séparation de domaine est activée. Type de données : chaîne
sys_domain_path	Chemin du domaine auquel la piste appartient. Remarque : Ce paramètre n’est renvoyé dans la réponse que si Séparation de domaine est activée. Type de données : chaîne
sys_id	Sys_id de l’enregistrement de prospect. Type de données : chaîne Table : piste [sn_lead_mgmt_core_lead]
sys_mod_count	Nombre de fois où l’enregistrement de prospect associé a été modifié. Type de données : nombre (entier)
sys_tags	Liste des balises système associées à la piste. Vous pouvez utiliser ces balises pour catégoriser les prospects. Type de données : tableau
sys_updated_by	Nom d’utilisateur de la personne qui a mis à jour l’enregistrement de piste pour la dernière fois. Type de données : chaîne
sys_updated_on	Date et heure de la dernière mise à jour de la piste générées par le système. Type de données : objet `"sys_created_on": { "display_value": "String", "value": "String" }`
sys_updated_on.display_value	Date et heure de la dernière mise à jour de la piste. Type de données : chaîne Format : format et fuseau horaire par défaut de l’instance
sys_updated_on.valeur	Date et heure de la dernière mise à jour de la piste. Type de données : chaîne Format : UTC
Titre	Titre de la piste. Type de données : chaîne
site internet	URL du site Web du prospect. Type de données : chaîne
work_notes	Liste des notes de travail créées pour la piste. Type de données : tableau d’objets `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
work_notes.auteur	Nom d’utilisateur de la personne qui a rédigé la note de travail associée. Type de données : chaîne
work_notes.date	Date de création de la note. Type de données : chaîne
work_notes.SMS	Texte de la note rédigée par l’auteur. Type de données : chaîne
code postal	Code postal de la piste associée. Type de données : chaîne

Demande cURL

L’exemple de code suivant montre comment récupérer l’enregistrement de piste avec le sys_id de 856b6a95ffde8210b85dffffffffffd7.

curl "https://instance.service-now.com /api/sn_lead_mgmt_core/lead/856b6a95ffde8210b85dffffffffffd7" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user "username":"password"

Les résultats des retours sont les suivants :

{ 
  "short_description": "Looking for a quote on preventative maintenance plans for their corporate office building elevators.",
  "reason": null,
  "country": "USA",
  "closed_date": null,
  "city": "San Francisco",
  "lead_source": "inbound_phone",
  "external_id": null,
  "industry": "manufacturing",
  "sys_updated_on": {
    "value": "2024-05-31 11:01:55",
    "display_value": "2024-05-31 04:01:55"
  },
  "title": "Director of Building operations",
  "sys_class_name": "Lead",
  "number": "LEAD0000001",
  "sys_id": "856b6a95ffde8210b85dffffffffffd7",
  "business_phone": "+1 (555) 123-4567",
  "similar_lead": null,
  "sys_updated_by": "abel.tuter",
  "mobile_phone": null,
  "street": "789, Industrial drive",
  "sys_created_on": {
    "value": "2024-05-20 10:32:41",
    "display_value": "2024-05-20 03:32:41"
  },
  "contact": null,
  "company": "Lee Manufacturing Inc",
  "state": "CA",
  "first_name": "James",
  "email": "james.wilson@email.com",
  "consumer": null,
  "sys_created_by": "abel.tuter",
  "zip": "94016",
  "owner": {
    "sys_id": "60058fe943fe3110d6c6cd60afb8f203",
    "name": "Max Blaze"
  },
  "website": null,
  "lead_group": null,
  "sys_mod_count": 1,
  "last_name": "Wilson",
  "other_reason": null,
  "middle_name": null,
  "sys_tags": null,
  "do_not_share": false,
  "lead_score": 92,
  "stage": "300_nurturing",
  "do_not_email": false,
  "lead_type": null,
  "work_notes": [
    {
      "author": "Abel Tuter",
      "date": "2024-12-04 06:52:07",
      "text": "Work notes for lead" 
    }
  ],
  "do_not_call": false,
  "lead_rating": "400_super_hot",
  "account": null,
  "external_system": null, 
  "lead_line_items": [
    {
      "quantity": 6,
      "product_offering": {
        "sys_id": "32619d9fd0a63110f8770dbf976be1f9",
        "name": "Safety Test Coverage",
        "code": "SAFETSTCVG1"
      },
      "sys_mod_count": 0,
      "external_id": null,
      "sys_updated_on": {
        "value": "2024-05-20 10:38:41",
        "display_value": "2024-05-20 03:38:41" 
      },
      "sys_tags": null,
      "lead": {
        "sys_id": "856b6a95ffde8210b85dffffffffffd7",
        "name": "LEAD0000001"
      },
      "number": "LEADL0000003", 
      "sys_id": "013daa19ffde8210b85dffffffffff82",
      "unit_of_measurement": { 
        "sys_id": "cb2795d553020110286eddeeff7b12ff",
        "name": "Each"
      },
      "sys_updated_by": "abel.tuter",
      "sys_created_on": {
        "value": "2024-05-20 10:38:41",
        "display_value": "2024-05-20 03:38:41"
      },
      "work_notes": null,
      "sys_created_by": "abel.tuter",
      "external_system": null
    }
  ]
}

responsable : correctif /sn_lead_mgmt_core/lead/{sys_id}

Met à jour l’enregistrement de piste spécifié et ses éléments de ligne de piste associés. Vous pouvez également utiliser ce point de terminaison pour associer de nouveaux éléments de ligne de piste à la piste spécifiée.

Ce point de terminaison met à jour les informations des tables suivantes :

Piste [sn_lead_mgmt_core_lead]
Élément de ligne de la piste [sn_lead_mgmt_core_lead_line_item]

Règles pour les paramètres transmis :

Les noms de paramètres non valides sont ignorés.
Les valeurs non valides pour les champs de choix et de référence non obligatoires sont ignorées.
Si l’accès en écriture est refusé pour un ou plusieurs champs, les champs restreints sont ignorés.
Vous ne pouvez pas insérer de valeurs de champ système à l’aide de cette API. Toutes les valeurs fournies sont ignorées. Les champs système font partie de la liste des champs ignorés, qui peut être configurée.
Les valeurs des paramètres account, contactet sont consumer ignorées si les account paramètres et consumer ne sont pas vides.
Sauf indication contraire, la valeur par défaut de tous les paramètres non transmis est « null ».

Remarque :

Ce point de terminaison ne modifie que les paramètres spécifiés. Si un paramètre qui existe dans l’enregistrement de piste ou d’élément de ligne de piste actuel n’est pas spécifié dans l’appel, son contenu reste inchangé.

Format d'URL

URL versionnée : /api/sn_lead_mgmt_core/{api_version}/lead/{sys_id}

URL par défaut : /api/sn_lead_mgmt_core/{api_version}/lead/{sys_id}

Remarque :

Paramètres de demande pris en charge

Tableau 13. Paramètres de chemin d'accès
Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, `v1` ou `v2`. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne
sys_id	Sys_id de l’enregistrement de piste à mettre à jour. Type de données : chaîne Table : piste [sn_lead_mgmt_core_lead]

Tableau 14. Paramètres de requête
Nom	Description
Néant

Tableau 15. Paramètres du corps de la demande
Nom	Description
compte	Détails du compte associé à la piste. Type de données : objet `"account": { "sys_id": "String" }`
account.sys_id	Sys_id de l’enregistrement du compte associé. Type de données : chaîne Table : Compte [customer_account]
business_phone	Numéro de téléphone professionnel du prospect. Type de données : chaîne
city	Ville dans laquelle réside le personnage principal. Type de données : chaîne
company	Nom de la société du prospect. Type de données : chaîne
consommateur	Consommateur associé à la piste. Type de données : objet `"consumer": { "sys_id": "String" }`
consumer.sys_id	Sys_id de l’enregistrement de consommateur associé. Type de données : chaîne Table : Consommateur [csm_consumer]
contact	Contact associé au compte de piste. Type de données : objet `"contact": { "sys_id": "String" }`
contact.sys_id	Sys_id de l’enregistrement du contact associé. Type de données : chaîne Table : Contact [customer_contact]
pays	Pays dans lequel réside la piste. Type de données : chaîne
do_not_call	Marqueur indiquant si le mode de communication est par téléphone. Valeurs valides : vrai : peut appeler le contact. faux : N’appelez pas le contact. Type de données : booléennes
do_not_email	Marqueur indiquant si le mode de communication est par e-mail. Valeurs valides : vrai : peut contacter par e-mail. faux : ne pas envoyer d’e-mail au contact. Type de données : booléennes
do_not_share	Marqueur indiquant si les détails du prospect peuvent être partagés. Valeurs valides : vrai : les détails du prospect peuvent être partagés. faux : les détails du prospect ne peuvent pas être partagés. Type de données : booléennes
E-mail	Adresse e-mail du prospect. Type de données : chaîne
external_id	ID utilisé par le système qui a généré la piste pour identifier la piste dans le système associé. Type de données : chaîne
external_system	Nom du système externe associé à la piste, tel que HubSpot ou pipedrive. Type de données : chaîne
first_name	Prénom du contact associé à la piste. Type de données : chaîne
industrie	Secteur auquel appartient le chef de file. Type de données : chaîne Table : située dans le industry champ de la table Compte [customer_account].
last_name	Requis. Nom de famille du contact associé à la piste. Type de données : chaîne
lead_group	Groupe auquel la piste appartient. Type de données : objet `"lead_group": { "sys_id": "String" }`
lead_group.sys_id	Sys_id de l’enregistrement du groupe de pistes. Type de données : chaîne Table : Groupe [sys_user_group]
lead_line_items	Liste des éléments de ligne de piste à associer à la piste. Groupe auquel la piste appartient. Type de données : objet `"lead_line_items": [ { "external_id": "String", "external_system": "String", "product_offering": {Object}, "quantity": Number, "work_notes": [Array], "unit_of_measurement": {Object} } ]` Nombre maximal d’éléments de ligne : 100 : tous les excédents ignorés
lead_line_items.external_id	ID utilisé par le système qui a généré l’élément de ligne de piste pour identifier l’élément de ligne dans le système associé. Type de données : chaîne
lead_line_items.external_system	Nom du système externe associé à l’élément de ligne de piste, tel que HubSpot ou pipedrive. Type de données : chaîne
lead_line_items.offre_produit	Requis. Informations sur l’offre de produit associée à l’élément de ligne de prospect. Type de données : objet `"product_offering": { "sys_id": "String" }`
lead_line_items.product_offering.sys_id	Requis. Sys_id de l’enregistrement d’offre de produit associé à l’élément de ligne de piste. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering]
lead_line_items.quantité	Quantité d’éléments que le prospect souhaite acheter de l’offre de produits associée. Type de données : nombre (entier)
lead_line_items.unit_of_measurement	Détails de l’unité de mesure de l’élément de ligne de la piste. Type de données : objet `"unit_of_measurement": { "sys_id": "String" }`
lead_line_items.unit_of_measurement.sys_id	Sys_id de l’enregistrement qui décrit l’unité de mesure. Type de données : chaîne Tableau : Unité de mesure [sn_prd_pm_uom]
lead_line_items.notes_de_travail	Liste qui décrit les notes de travail créées pour l’élément de ligne de piste. Type de données : tableau d’objets `"work_notes": [ "text": "String" } ]`
lead_line_items.work_notes.SMS	Texte de la note rédigée par l’auteur. Type de données : chaîne
lead_rating	Évaluation de la piste telle que 100_cold, 200_warm, 300_hot ou 400_super_hot. Remarque : Il s’agit d’un champ de choix. Il doit contenir l’un des éléments de choix définis dans le champ lead_rating de la table Prospects. Type de données : chaîne
lead_score	Score pour l’en-tête. Type de données : Décimal Plage : 1 à 100
lead_source	Initiateur de la piste. Remarque : Il s’agit d’un champ de choix. Il doit contenir l’un des éléments de choix définis dans le champ lead_source de la table Prospects. Type de données : chaîne
lead_type	Type de prospect, tel que nouvelle affaire ou activité existante. Remarque : Il s’agit d’un champ de choix. Il doit contenir l’un des éléments de choix définis dans le champ lead_type de la table Prospects. Type de données : chaîne
middle_name	Deuxième prénom du contact de la piste. Type de données : chaîne
mobile_phone	Numéro de téléphone du contact de la piste. Type de données : chaîne
other_reason	Raison supplémentaire de la disqualification de la tête. Type de données : chaîne Longueur maximale : 160 caractères
propriétaire	Détails de la personne associée à la piste. Type de données : objet `"owner": { "sys_id": "String" }`
owner.sys_id	Sys_id de l’enregistrement utilisateur de la personne qui possède la piste. Type de données : chaîne Table : Utilisateur [sys_user]
motif	Raison de la disqualification de la piste telle que Disqualifier. Type de données : chaîne Longueur maximale : 40 caractères
short_description	Brève description de la piste. Type de données : chaîne Longueur maximale : 160 caractères
similar_lead	Détails sur toute piste similaire. Utilisez cette option pour une éventuelle disqualification de la piste. Type de données : objet `"similar_lead": { "sys_id": "String" }`
similar_lead.sys_id	Sys_id de l’enregistrement de piste qui est une piste possiblement en double. Type de données : chaîne Table : piste [sn_lead_mgmt_core_lead]
étape	Étape de la piste telle que 100_new. Remarque : Il s’agit d’un champ de choix. Il doit contenir l’un des éléments de choix définis dans le champ d’étape de la table Pistes. Type de données : chaîne
État	État dans lequel réside la piste. Type de données : chaîne
rue	Rue sur laquelle réside le plomb. Type de données : chaîne
Titre	Titre de la piste. Type de données : chaîne
site internet	URL du site Web du prospect. Type de données : chaîne
work_notes	Liste des notes de travail créées pour la piste. Type de données : tableau d’objets `"work_notes": [ { "text": "String" } ]` Remarque : Un tableau des notes de travail de la demande est inséré sous la forme d’un texte unique. Ce texte est généré en combinant le contenu de tous les objets de note de travail de la demande, chaque entrée étant séparée par une virgule (,).
work_notes.SMS	Texte de la note rédigée par l’auteur. Type de données : chaîne
code postal	Code postal de la piste associée. Type de données : chaîne

En-têtes

Tableau 16. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Content-Type	Format de données du corps de la demande. Prend uniquement en charge application/json.

Tableau 17. En-têtes de réponses
En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 18. Codes d'état
Code d'état	Description
200	Réussi. Les enregistrements de piste et d’éléments de ligne de piste ont été mis à jour avec succès.
400	Erreur. Raisons possibles : Charge utile non valide : corps de demande non valide/vide. Charge utile non valide : valeur de champ non valide pour les champs d’e-mail/numéro de téléphone. Charge utile non valide : le champ obligatoire est absent ou sa valeur est vide. Charge utile non valide : l’étape est « 400_closed_won ». La qualification de la piste n’est pas prise en charge à l’aide de l’API. Si l’étape de la piste à mettre à jour est déjà à l’état fermé et que vous essayez de la mettre à jour.
403	Interdit. L’utilisateur ne dispose pas des droits d’accès à l’enregistrement spécifié.
404	Introuvable. L’élément demandé est introuvable.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

Paramètres du corps de réponse


Nom	Description
compte	Compte lié à la piste. Type de données : objet `"account": { "name": "String", "sys_id": "String" }`
account.name	Nom du compte. Type de données : chaîne
account.sys_id	Sys_id de l’enregistrement du compte associé. Type de données : chaîne Table : Compte [customer_account]
business_phone	Numéro de téléphone professionnel du prospect. Type de données : chaîne
city	Ville dans laquelle réside le personnage principal. Type de données : chaîne
closed_date	Date et heure auxquelles la piste a été fermée. Type de données : objet `"closed_date": { "display_value": "String", "value": "String" }`
closed_date.display_value	Date et heure telles qu’affichées dans l’interface utilisateur. Type de données : chaîne Format : format et fuseau horaire de l’utilisateur.
closed_date.valeur	Date et heure auxquelles la piste s’est fermée telles que définies dans l’enregistrement associé. Type de données : chaîne Format : UTC
company	Nom de la société du prospect. Type de données : chaîne
consommateur	Consommateur associé à la piste. Type de données : objet `"consumer": { "name": "String", "sys_id": "String" }`
consumer.name	Nom du consommateur associé. Type de données : chaîne
consumer.sys_id	Sys_id de l’enregistrement de consommateur associé. Type de données : chaîne Table : Consommateur [csm_consumer]
contact	Contact associé au compte de piste. Type de données : objet `"contact": { "name": "String", "sys_id": "String" }`
contact.name	Nom du contact. Type de données : chaîne
contact.sys_id	Sys_id de l’enregistrement du contact associé. Type de données : chaîne Table : Contact [customer_contact]
pays	Pays dans lequel réside la piste. Type de données : chaîne
do_not_call	Marqueur indiquant si le mode de communication est par téléphone. Valeurs valides : vrai : peut appeler le contact. faux : N’appelez pas le contact. Type de données : booléennes
do_not_email	Marqueur indiquant si le mode de communication est par e-mail. Valeurs valides : vrai : peut contacter par e-mail. faux : ne pas envoyer d’e-mail au contact. Type de données : booléennes
do_not_share	Marqueur indiquant si les détails du prospect peuvent être partagés. Valeurs valides : vrai : les détails du prospect peuvent être partagés. faux : les détails du prospect ne peuvent pas être partagés. Type de données : booléennes
E-mail	Adresse e-mail du prospect. Type de données : chaîne
external_id	ID utilisé par le système qui a généré la piste pour identifier la piste dans le système associé. Type de données : chaîne
external_system	Nom du système externe associé à la piste, tel que HubSpot ou pipedrive. Type de données : chaîne
first_name	Prénom du contact associé à la piste. Type de données : chaîne
industrie	Secteur auquel appartient le chef de file. Type de données : chaîne Table : située dans le industry champ de la table Compte [customer_account].
last_name	Nom de famille du contact associé à la piste. Type de données : chaîne
lead_group	Groupe auquel la piste appartient. Type de données : objet `"lead_group": { "name: "String", "sys_id": "String" }`
lead_group.nom	Nom du groupe de pistes. Type de données : chaîne
lead_group.sys_id	Sys_id de l’enregistrement du groupe de pistes. Type de données : chaîne Table : Groupe [sys_user_group]
lead_line_items	Détails des éléments de ligne de piste associés à la piste. Type de données : tableau d’objets `"lead_line_items": [ { "external_id": "String", "external_system": "String", "lead": {Object}, "number": "String", "product_offering": {Object}, "quantity": Number, "sys_created_by”: "String", "sys_created_on {Object}, "sys_domain": "String", "sys_domain_path": "String", "sys_id": "String", "sys_mod_count": Number, "sys_tags": [Array], "sys_updated_by: "String", "sys_updated_on: {Object}, "unit_of_measurement": {Object}, "work_notes": [Array] } ]`
lead_line_items.external_id	ID utilisé par le système qui a généré l’élément de ligne de piste pour identifier l’élément de ligne dans le système associé. Type de données : chaîne
lead_line_items.external_system	Nom du système externe associé à l’élément de ligne de piste, tel que HubSpot ou pipedrive. Type de données : chaîne
lead_line_items.plomb	Détails sur la piste associée à l’élément de ligne. Type de données : objet `"lead: { "name": "String", "sys_id": "String" }`
lead_line_items.lead.name	Nom du prospect associé. Type de données : chaîne
lead_line_items.lead.sys_id	Sys_id de l’enregistrement de piste associé. Type de données : chaîne
lead_line_items.nombre	Numéro unique généré par le système de l’enregistrement d’élément de ligne de prospect. Type de données : chaîne
lead_line_items.product_offering	Informations sur l’offre de produit associée à l’élément de ligne de prospect. Type de données : objet `"product_offering": { "code": " String", "name": "String", "sys_id": "String" }`
lead_line_items.product_offering.code	Code lié à l’offre de produits. Remarque : Il s’agit d’un numéro alphanumérique généré par le système basé sur le nom du produit. Bien qu’il soit généré par le système, vous pouvez modifier le code pour représenter une référence SKU ou tout autre code produit spécifique au secteur. Type de données : chaîne
lead_line_items.product_offering.nom	Nom de l’offre de produits. Type de données : chaîne
lead_line_items.product_offering.sys_id	Sys_id de l’enregistrement d’offre de produit associé à l’élément de ligne de piste. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering]
lead_line_items.quantité	Quantité d’éléments que le prospect souhaite acheter de l’offre de produits associée. Type de données : nombre (entier)
lead_line_items.sys_created_by	Nom d’utilisateur de la personne qui a créé l’élément de ligne de piste. Type de données : chaîne
lead_line_items.sys_created_on	Date et heure de création de l’élément de ligne de piste générées par le système. Type de données : objet `"sys_created_on": { "display_value": "String", "value": "String" }`
lead_line_items.sys_created_on.valeur_display_value	Date et heure de création de l’élément de ligne de prospect. Type de données : chaîne Format : format d’instance et fuseau horaire par défaut
lead_line_items.sys_created_on.valeur	Date et heure de création de l’élément de ligne de prospect. Type de données : chaîne Format : UTC
lead_line_items.sys_domain	Sys_id de l’enregistrement du domaine auquel l’élément de ligne de la piste appartient. Remarque : Ce paramètre n’est renvoyé dans la réponse que si Séparation de domaine est activée. Type de données : chaîne
lead_line_items.sys_chemin_domaine	Chemin d’accès du domaine auquel l’élément de ligne de la piste appartient. Remarque : Ce paramètre n’est renvoyé dans la réponse que si Séparation de domaine est activée. Type de données : chaîne
lead_line_items.sys_id	Sys_id de l’enregistrement de l’élément de ligne de la piste. Type de données : chaîne
lead_line_items.sys_mod_count	Nombre de fois où l’enregistrement d’élément de ligne de piste associé a été modifié. Type de données : nombre (entier)
lead_line_items.sys_tags	Liste des balises système associées à l’élément de ligne de piste. Type de données : tableau
lead_line_items.sys_updated_by	Nom d’utilisateur de la personne qui a mis à jour pour la dernière fois l’élément de ligne de piste associé. Type de données : chaîne
lead_line_items.sys_updated_on	Date et heure de dernière mise à jour de l’élément de ligne de piste générées par le système. Type de données : objet `"sys_created_on": { "display_value": "String", "value": "String" }`
lead_line_items.sys_updated_on.display_value	Date et heure de dernière mise à jour de l’élément de ligne de prospect. Type de données : chaîne Format : format d’instance et fuseau horaire par défaut
lead_line_items.sys_updated_on.valeur	Date et heure de dernière mise à jour de l’élément de ligne de prospect. Type de données : chaîne Format : UTC
lead_line_items.unit_of_measurement	Détails de l’unité de mesure de l’élément de ligne de la piste. Type de données : objet `"unit_of_measurement": { "name": "String", "sys_id": "String" }`
lead_line_items.unit_of_measurement.nom	Nom de l’unité de mesure, par exemple, chaque pied cube. Type de données : chaîne
lead_line_items.unit_of_measurement.sys_id	Sys_id de l’enregistrement qui décrit l’unité de mesure. Type de données : chaîne Tableau : Unité de mesure [sn_prd_pm_uom]
lead_line_items.work_notes	Liste qui décrit les notes de travail créées pour l’élément de ligne de piste. Type de données : tableau d’objets `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
lead_line_items.work_notes.auteur	Nom d’utilisateur de la personne qui a rédigé la note de travail associée. Type de données : chaîne
lead_line_items.work_notes.date	Date de création de la note. Type de données : chaîne
lead_line_items.work_notes.SMS	Texte de la note rédigée par l’auteur. Type de données : chaîne
lead_rating	Évaluation de la piste telle que 100_cold, 200_warm, 300_hot ou 400_super_hot. Remarque : Il s’agit d’un champ de choix. Il doit contenir l’un des éléments de choix définis dans le champ lead_rating de la table Prospects. Type de données : chaîne
lead_score	Score pour l’en-tête. Type de données : Décimal Plage : 1 à 100
lead_source	Initiateur de la piste. Remarque : Il s’agit d’un champ de choix. Il doit contenir l’un des éléments de choix définis dans le champ lead_source de la table Prospects. Type de données : chaîne
lead_type	Type de prospect, tel que nouvelle affaire ou activité existante. Remarque : Il s’agit d’un champ de choix. Il doit contenir l’un des éléments de choix définis dans le champ lead_type de la table Prospects. Type de données : chaîne
middle_name	Deuxième prénom du contact de la piste. Type de données : chaîne
mobile_phone	Numéro de téléphone du contact de la piste. Type de données : chaîne
Numéro	Numéro unique généré par le système de l’enregistrement de prospect. Type de données : chaîne
other_reason	Raison supplémentaire de la disqualification de la tête. Type de données : chaîne Longueur maximale : 160 caractères
propriétaire	Détails de la personne associée à la piste. Type de données : objet `"owner": { "name": "String", "sys_id": "String" }`
owner.name	Nom de la personne qui possède la piste. Type de données : chaîne
owner.sys_id	Sys_id de l’enregistrement utilisateur de la personne qui possède la piste. Type de données : chaîne Table : Utilisateur [sys_user]
motif	Raison de la disqualification de la piste telle que Disqualifier. Type de données : chaîne Longueur maximale : 40 caractères
short_description	Brève description de la piste. Type de données : chaîne Longueur maximale : 160 caractères
similar_lead	Détails sur toute piste similaire. Utilisez cette option pour une éventuelle disqualification de la piste. Type de données : objet `"similar_lead": { "name": "String", "sys_id": "String" }`
similar_lead.nom	Nom de la piste en double. Type de données : chaîne
similar_lead.sys_id	Sys_id de l’enregistrement de piste qui est une piste possiblement en double. Type de données : chaîne Table : piste [sn_lead_mgmt_core_lead]
étape	Étape de la piste telle que 100_new. Remarque : Il s’agit d’un champ de choix. Il doit contenir l’un des éléments de choix définis dans le champ d’étape de la table Pistes. Type de données : chaîne
État	État dans lequel réside la piste. Type de données : chaîne
rue	Rue sur laquelle réside le plomb. Type de données : chaîne
sys_class_name	Nom de classe de la table principale généré par le système. Type de données : chaîne
sys_created_by	Nom d’utilisateur de la personne qui a créé la piste. Type de données : chaîne
sys_created_on	Date et heure de création de la piste générées par le système. Type de données : objet `"sys_created_on": { "display_value": "String", "value": "String" }`
sys_created_on.display_value	Date et heure auxquelles la piste a été créée. Type de données : chaîne Format : format d’instance et fuseau horaire par défaut
sys_created_on.valeur	Date et heure auxquelles la piste a été créée. Type de données : chaîne Format : UTC
sys_domain	Sys_id de l’enregistrement du domaine auquel la piste appartient. Remarque : Ce paramètre n’est renvoyé dans la réponse que si Séparation de domaine est activée. Type de données : chaîne
sys_domain_path	Chemin du domaine auquel la piste appartient. Remarque : Ce paramètre n’est renvoyé dans la réponse que si Séparation de domaine est activée. Type de données : chaîne
sys_id	Sys_id de l’enregistrement de prospect. Type de données : chaîne Table : piste [sn_lead_mgmt_core_lead]
sys_mod_count	Nombre de fois où l’enregistrement de prospect associé a été modifié. Type de données : nombre (entier)
sys_tags	Liste des balises système associées à la piste. Vous pouvez utiliser ces balises pour catégoriser les prospects. Type de données : tableau
sys_updated_by	Nom d’utilisateur de la personne qui a mis à jour l’enregistrement de piste pour la dernière fois. Type de données : chaîne
sys_updated_on	Date et heure de la dernière mise à jour de la piste générées par le système. Type de données : objet `"sys_created_on": { "display_value": "String", "value": "String" }`
sys_updated_on.display_value	Date et heure de la dernière mise à jour de la piste. Type de données : chaîne Format : format et fuseau horaire par défaut de l’instance
sys_updated_on.valeur	Date et heure de la dernière mise à jour de la piste. Type de données : chaîne Format : UTC
Titre	Titre de la piste. Type de données : chaîne
site internet	URL du site Web du prospect. Type de données : chaîne
work_notes	Liste des notes de travail créées pour la piste. Type de données : tableau d’objets `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
work_notes.auteur	Nom d’utilisateur de la personne qui a rédigé la note de travail associée. Type de données : chaîne
work_notes.date	Date de création de la note. Type de données : chaîne
work_notes.SMS	Texte de la note rédigée par l’auteur. Type de données : chaîne
code postal	Code postal de la piste associée. Type de données : chaîne

Demande cURL

L’exemple de code suivant montre comment mettre à jour l’enregistrement de piste avec le sys_id 856b6a95ffde8210b85dffffffffffd7.

curl " https://instance.service-now.com/api/sn_lead_mgmt_core/v1/lead/856b6a95ffde8210b85dffffffffffd7" \ 
--request PATCH \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data " {
  "lead_source": "inbount_web",
  "business_phone": "+1 (555) 123-4567",
  "do_not_share": true,
  "lead_score": 40,
  "stage": "300_nurturning",
  "do_not_email": false,
  "lead_type": "new_business",
  "work_notes": [
    {
      "text": "Work notes for lead"
    }
  ],
  "lead_rating": "200_warm",
  "lead_line_items": [
    {
      "sys_id" : "013daa19ffde8210b85dffffffffff82",
      "quantity": 10
    },
    {
      "product_offering": {
        "sys_id": "0b61dd9fd0a63110f8770dbf976be171"
      }
    }
  ]
}"

La réponse contient tous les champs d’enregistrement de piste.

{ 
  "short_description": "Looking for a quote on preventative maintenance plans for their corporate office building elevators.",
  "reason": null,
  "country": "USA",
  "closed_date": null,
  "city": "San Francisco",
  "lead_source": "inbount_web",
  "external_id": null,
  "industry": "manufacturing",
  "sys_updated_on": {
    "value": "2024-12-11 08:45:52",
    "display_value": "2024-12-11 00:45:52"
  },
  "title": "Director of Building operations",
  "sys_class_name": "Lead",
  "number": "LEAD0000001",
  "sys_id": "856b6a95ffde8210b85dffffffffffd7",
  "business_phone": "+1 (555) 123-4567",
  "similar_lead": null,
  "sys_updated_by": "abel.tuter",
  "mobile_phone": null,
  "street": "789, Industrial drive",
  "sys_created_on": {
    "value": "2024-05-20 10:32:41",
    "display_value": "2024-05-20 03:32:41"
  },
  "contact": null,
  "company": "Lee Manufacturing Inc",
  "state": "CA",
  "first_name": "James",
  "email": "james.wilson@email.com",
  "consumer": null,
  "sys_created_by": "abel.tuter",
  "zip": "94016",
  "owner": {
    "sys_id": "60058fe943fe3110d6c6cd60afb8f203",
    "name": "Max Blaze"
  },
  "website": null,
  "lead_group": null,
  "sys_mod_count": 4,
  "last_name": "Wilson",
  "other_reason": null,
  "middle_name": null,
  "sys_tags": null,
  "do_not_share": true,
  "lead_score": 40,
  "stage": "300_nurturing",
  "do_not_email": false,
  "lead_type": "new_business",
  "work_notes": [
    {
      "author": "Abel Tuter",
      "date": "2024-12-11 00:45:52",
      "text": "Lead Line Item [code]<a href='/sn_lead_mgmt_core_lead_line_item.do?sys_id=013daa19ffde8210b85dffffffffff82'>LEADL0000003</a>[/code] has been updated  [code] <b> Quantity </b> [/code] 10 [code] <i>was</i> [/code] 6"
    },
    {
      "author": "Abel Tuter",
      "date": "2024-12-11 00:45:52",
      "text": "Lead Line Item [code]<a href='/sn_lead_mgmt_core_lead_line_item.do?sys_id=37610e1780925210f877983fa0be6725'>LEADL0001002</a>[/code] has been created  [code] <b> Product Offering </b> [/code] Solana Modem M Series [code] <b> Quantity </b> [/code] 1"
    },
    {
      "author": "Abel Tuter",
      "date": "2024-12-11 00:45:51",
      "text": "Work notes for lead"
    }
  ],
  "do_not_call": false,
  "lead_rating": "200_warm",
  "account": null,
  "external_system": null,
  "lead_line_items": [
    {
      "quantity": 10,
      "product_offering": {
        "sys_id": "32619d9fd0a63110f8770dbf976be1f9",
        "name": "Safety Test Coverage",
        "code": "SAFETSTCVG1"
      },
      "sys_mod_count": 1,
      "external_id": null,
      "sys_updated_on": {
        "value": "2024-12-11 08:45:52",
        "display_value": "2024-12-11 00:45:52"
      },
      "sys_tags": null,
      "lead": {
        "sys_id": "856b6a95ffde8210b85dffffffffffd7",
        "name": "LEAD0000001"
      },
      "number": "LEADL0000003",
      "sys_id": "013daa19ffde8210b85dffffffffff82",
      "unit_of_measurement": {
        "sys_id": "cb2795d553020110286eddeeff7b12ff",
        "name": "Each"
      },
      "sys_updated_by": "abel.tuter",
      "sys_created_on": {
        "value": "2024-05-20 10:38:41",
        "display_value": "2024-05-20 03:38:41"
      },
      "work_notes": null,
      "sys_created_by": "abel.tuter",
      "external_system": null
    },
    {
      "quantity": 1,
      "product_offering": {
        "sys_id": "0b61dd9fd0a63110f8770dbf976be171",
        "name": "Solana Modem M Series",
        "code": "SOLANAMODE2"
      },
      "sys_mod_count": 0,
      "external_id": null,
      "sys_updated_on": {
        "value": "2024-12-11 08:45:52",
        "display_value": "2024-12-11 00:45:52"
      },
      "sys_tags": null,
      "lead": {
        "sys_id": "856b6a95ffde8210b85dffffffffffd7",
        "name": "LEAD0000001"
      },
      "number": "LEADL0001002",
      "sys_id": "37610e1780925210f877983fa0be6725",
      "unit_of_measurement": null,
      "sys_updated_by": "abel.tuter",
      "sys_created_on": {
        "value": "2024-12-11 08:45:52",
        "display_value": "2024-12-11 00:45:52"
      },
      "work_notes": null,
      "sys_created_by": "abel.tuter",
      "external_system": null
    }
  ]
}

piste : POST /sn_lead_mgmt_core/lead

Crée un enregistrement de piste et ses éléments de ligne de piste associés à l’aide des paramètres spécifiés.

Une fois traités, les enregistrements sont créés dans les tables suivantes :

Piste [sn_lead_mgmt_core_lead]
Élément de ligne de la piste [sn_lead_mgmt_core_lead_line_item]

Règles pour les paramètres transmis :

Les noms de paramètres non valides sont ignorés.
Les valeurs non valides pour les champs de choix et de référence non obligatoires sont ignorées.
Si l’accès en écriture est refusé pour un ou plusieurs champs, les champs restreints sont ignorés.
Vous ne pouvez pas insérer de valeurs de champ système à l’aide de cette API. Toutes les valeurs fournies sont ignorées. Les champs système font partie de la liste des champs ignorés, qui peut être configurée.
Les valeurs des paramètres account, contactet sont consumer ignorées si les account paramètres et consumer ne sont pas vides.
Sauf indication contraire, la valeur par défaut de tous les paramètres non transmis est « null ».

Format d'URL

URL versionnée : /api/sn_lead_mgmt_core/{api_version}/lead

URL par défaut : /api/sn_lead_mgmt_core/{api_version}/lead

Remarque :

Paramètres de demande pris en charge

Tableau 19. Paramètres de chemin d'accès
Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, `v1` ou `v2`. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne

Tableau 20. Paramètres de requête
Nom	Description
Néant

Tableau 21. Paramètres du corps de la demande
Nom	Description
compte	Détails sur le compte associé à la piste. Type de données : objet `"account": { "sys_id": "String" }`
account.sys_id	Sys_id de l’enregistrement du compte associé. Type de données : chaîne Table : Compte [customer_account]
business_phone	Numéro de téléphone professionnel du prospect. Type de données : chaîne
city	Ville dans laquelle réside le personnage principal. Type de données : chaîne
company	Nom de la société du prospect. Type de données : chaîne
consommateur	Consommateur associé à la piste. Type de données : objet `"consumer": { "sys_id": "String" }`
consumer.sys_id	Sys_id de l’enregistrement de consommateur associé. Type de données : chaîne Table : Consommateur [csm_consumer]
contact	Contact associé au compte de piste. Type de données : objet `"contact": { "sys_id": "String" }`
contact.sys_id	Sys_id de l’enregistrement du contact associé. Type de données : chaîne Table : Contact [customer_contact]
pays	Pays dans lequel réside la piste. Type de données : chaîne
do_not_call	Marqueur indiquant si le mode de communication est par téléphone. Valeurs valides : vrai : peut appeler le contact. faux : N’appelez pas le contact. Type de données : booléennes Valeur par défaut : false
do_not_email	Marqueur indiquant si le mode de communication est par e-mail. Valeurs valides : vrai : peut contacter par e-mail. faux : ne pas envoyer d’e-mail au contact. Type de données : booléennes Valeur par défaut : false
do_not_share	Marqueur indiquant si les détails du prospect peuvent être partagés. Valeurs valides : vrai : les détails du prospect peuvent être partagés. faux : les détails du prospect ne peuvent pas être partagés. Type de données : booléennes Valeur par défaut : false
E-mail	Adresse e-mail du prospect. Type de données : chaîne
external_id	ID utilisé par le système qui a généré la piste pour identifier la piste dans le système associé. Type de données : chaîne
external_system	Nom du système externe associé à la piste, tel que HubSpot ou pipedrive. Type de données : chaîne
first_name	Prénom du contact associé à la piste. Type de données : chaîne
industrie	Secteur auquel appartient le chef de file. Type de données : chaîne Table : située dans le industry champ de la table Compte [customer_account].
last_name	Requis. Nom de famille du contact associé à la piste. Type de données : chaîne
lead_group	Groupe auquel la piste appartient. Type de données : objet `"lead_group": { "sys_id": "String" }`
lead_group.sys_id	Sys_id de l’enregistrement du groupe de pistes. Type de données : chaîne Table : Groupe [sys_user_group]
lead_line_items	Liste des éléments de ligne de piste à associer à la piste. Groupe auquel la piste appartient. Type de données : objet `"lead_line_items": [ { "external_id": "String", "external_system": "String", "product_offering": {Object}, "quantity": Number, "work_notes": [Array], "unit_of_measurement": {Object} } ]` Nombre maximal d’éléments de ligne : 100 : tous les excédents ignorés
lead_line_items.external_id	ID utilisé par le système qui a généré l’élément de ligne de piste pour identifier l’élément de ligne dans le système associé. Type de données : chaîne
lead_line_items.external_system	Nom du système externe associé à l’élément de ligne de piste, tel que HubSpot ou pipedrive. Type de données : chaîne
lead_line_items.offre_produit	Requis. Informations sur l’offre de produit associée à l’élément de ligne de prospect. Type de données : objet `"product_offering": { "sys_id": "String" }`
lead_line_items.product_offering.sys_id	Requis. Sys_id de l’enregistrement d’offre de produit associé à l’élément de ligne de piste. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering]
lead_line_items.quantité	Quantité d’éléments que le prospect souhaite acheter de l’offre de produits associée. Type de données : nombre (entier) Valeur par défaut : 1
lead_line_items.unité_de_mesure	Détails de l’unité de mesure de l’élément de ligne de la piste. Type de données : objet `"unit_of_measurement": { "sys_id": "String" }`
lead_line_items.unit_of_measurement.sys_id	Sys_id de l’enregistrement qui décrit l’unité de mesure. Type de données : chaîne Tableau : Unité de mesure [sn_prd_pm_uom]
lead_line_items.notes_de_travail	Liste qui décrit les notes de travail créées pour l’élément de ligne de piste. Type de données : tableau d’objets `"work_notes": [ "text": "String" } ]` Par défaut : tableau vide
lead_line_items.work_notes.SMS	Texte de la note rédigée par l’auteur. Type de données : chaîne
lead_rating	Évaluation de la piste telle que 100_cold, 200_warm, 300_hot ou 400_super_hot. Remarque : Il s’agit d’un champ de choix. Il doit contenir l’un des éléments de choix définis dans le champ lead_rating de la table Prospects. Type de données : chaîne
lead_score	Score pour l’en-tête. Type de données : Décimal Plage : 1 à 100
lead_source	Initiateur de la piste. Remarque : Il s’agit d’un champ de choix. Il doit contenir l’un des éléments de choix définis dans le champ lead_source de la table Prospects. Type de données : chaîne
lead_type	Type de prospect, tel que nouvelle affaire ou activité existante. Remarque : Il s’agit d’un champ de choix. Il doit contenir l’un des éléments de choix définis dans le champ lead_type de la table Prospects. Type de données : chaîne
middle_name	Deuxième prénom du contact de la piste. Type de données : chaîne
mobile_phone	Numéro de téléphone du contact de la piste. Type de données : chaîne
other_reason	Raison supplémentaire de la disqualification de la tête. Type de données : chaîne Longueur maximale : 160 caractères
propriétaire	Détails de la personne associée à la piste. Type de données : objet `"owner": { "sys_id": "String" }`
owner.sys_id	Sys_id de l’enregistrement utilisateur de la personne qui possède la piste. Type de données : chaîne Table : Utilisateur [sys_user]
motif	Raison de la disqualification de la piste telle que Disqualifier. Type de données : chaîne Longueur maximale : 40 caractères
short_description	Brève description de la piste. Type de données : chaîne Longueur maximale : 160 caractères
similar_lead	Détails sur toute piste similaire. Utilisez cette option pour une éventuelle disqualification de la piste. Type de données : objet `"similar_lead": { "sys_id": "String" }`
similar_lead.sys_id	Sys_id de l’enregistrement de piste qui est une piste possiblement en double. Type de données : chaîne Table : piste [sn_lead_mgmt_core_lead]
étape	Étape de la piste telle que 100_new. Remarque : Il s’agit d’un champ de choix. Il doit contenir l’un des éléments de choix définis dans le champ d’étape de la table Pistes. Type de données : chaîne Par défaut : 100_new
État	État dans lequel réside la piste. Type de données : chaîne
rue	Rue sur laquelle réside le plomb. Type de données : chaîne
Titre	Titre de la piste. Type de données : chaîne
site internet	URL du site Web du prospect. Type de données : chaîne
work_notes	Liste des notes de travail créées pour la piste. Type de données : tableau d’objets `"work_notes": [ { "text": "String" } ]` Remarque : Un tableau des notes de travail de la demande est inséré sous la forme d’un texte unique. Ce texte est généré en combinant le contenu de tous les objets de note de travail de la demande, chaque entrée étant séparée par une virgule (,). Par défaut : tableau vide
work_notes.SMS	Texte de la note rédigée par l’auteur. Type de données : chaîne
code postal	Code postal de la piste associée. Type de données : chaîne

En-têtes

Tableau 22. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.

Tableau 23. En-têtes de réponses
En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 24. Codes d'état
Code d'état	Description
201	Réussi. La piste et ses éléments de ligne associés sont insérés avec succès.
400	Erreur. Raisons possibles : Charge utile non valide : corps de demande non valide/vide. Charge utile non valide : valeur de champ non valide pour les champs d’e-mail/numéro de téléphone. Charge utile non valide : le champ obligatoire est absent ou sa valeur est vide. Violation de la règle métier/de la politique relative aux données.
403	Interdit. L’utilisateur ne dispose pas des droits d’accès à l’enregistrement spécifié.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

Paramètres du corps de réponse


Nom	Description
compte	Compte lié à la piste. Type de données : objet `"account": { "name": "String", "sys_id": "String" }`
account.name	Nom du compte. Type de données : chaîne
account.sys_id	Sys_id de l’enregistrement du compte associé. Type de données : chaîne Table : Compte [customer_account]
business_phone	Numéro de téléphone professionnel du prospect. Type de données : chaîne
city	Ville dans laquelle réside le personnage principal. Type de données : chaîne
closed_date	Date et heure auxquelles la piste a été fermée. Type de données : objet `"closed_date": { "display_value": "String", "value": "String" }`
closed_date.display_value	Date et heure telles qu’affichées dans l’interface utilisateur. Type de données : chaîne Format : format et fuseau horaire de l’utilisateur.
closed_date.valeur	Date et heure auxquelles la piste s’est fermée telles que définies dans l’enregistrement associé. Type de données : chaîne Format : UTC
company	Nom de la société du prospect. Type de données : chaîne
consommateur	Consommateur associé à la piste. Type de données : objet `"consumer": { "name": "String", "sys_id": "String" }`
consumer.name	Nom du consommateur associé. Type de données : chaîne
consumer.sys_id	Sys_id de l’enregistrement de consommateur associé. Type de données : chaîne Table : Consommateur [csm_consumer]
contact	Contact associé au compte de piste. Type de données : objet `"contact": { "name": "String", "sys_id": "String" }`
contact.name	Nom du contact. Type de données : chaîne
contact.sys_id	Sys_id de l’enregistrement du contact associé. Type de données : chaîne Table : Contact [customer_contact]
pays	Pays dans lequel réside la piste. Type de données : chaîne
do_not_call	Marqueur indiquant si le mode de communication est par téléphone. Valeurs valides : vrai : peut appeler le contact. faux : N’appelez pas le contact. Type de données : booléennes
do_not_email	Marqueur indiquant si le mode de communication est par e-mail. Valeurs valides : vrai : peut contacter par e-mail. faux : ne pas envoyer d’e-mail au contact. Type de données : booléennes
do_not_share	Marqueur indiquant si les détails du prospect peuvent être partagés. Valeurs valides : vrai : les détails du prospect peuvent être partagés. faux : les détails du prospect ne peuvent pas être partagés. Type de données : booléennes
E-mail	Adresse e-mail du prospect. Type de données : chaîne
external_id	ID utilisé par le système qui a généré la piste pour identifier la piste dans le système associé. Type de données : chaîne
external_system	Nom du système externe associé à la piste, tel que HubSpot ou pipedrive. Type de données : chaîne
first_name	Prénom du contact associé à la piste. Type de données : chaîne
industrie	Secteur auquel appartient le chef de file. Type de données : chaîne Table : située dans le industry champ de la table Compte [customer_account].
last_name	Nom de famille du contact associé à la piste. Type de données : chaîne
lead_group	Groupe auquel la piste appartient. Type de données : objet `"lead_group": { "name: "String", "sys_id": "String" }`
lead_group.nom	Nom du groupe de pistes. Type de données : chaîne
lead_group.sys_id	Sys_id de l’enregistrement du groupe de pistes. Type de données : chaîne Table : Groupe [sys_user_group]
lead_line_items	Détails des éléments de ligne de piste associés à la piste. Type de données : tableau d’objets `"lead_line_items": [ { "external_id": "String", "external_system": "String", "lead": {Object}, "number": "String", "product_offering": {Object}, "quantity": Number, "sys_created_by”: "String", "sys_created_on {Object}, "sys_domain": "String", "sys_domain_path": "String", "sys_id": "String", "sys_mod_count": Number, "sys_tags": [Array], "sys_updated_by: "String", "sys_updated_on: {Object}, "unit_of_measurement": {Object}, "work_notes": [Array] } ]`
lead_line_items.external_id	ID utilisé par le système qui a généré l’élément de ligne de piste pour identifier l’élément de ligne dans le système associé. Type de données : chaîne
lead_line_items.external_system	Nom du système externe associé à l’élément de ligne de piste, tel que HubSpot ou pipedrive. Type de données : chaîne
lead_line_items.plomb	Détails sur la piste associée à l’élément de ligne. Type de données : objet `"lead: { "name": "String", "sys_id": "String" }`
lead_line_items.lead.name	Nom du prospect associé. Type de données : chaîne
lead_line_items.lead.sys_id	Sys_id de l’enregistrement de piste associé. Type de données : chaîne
lead_line_items.nombre	Numéro unique généré par le système de l’enregistrement d’élément de ligne de prospect. Type de données : chaîne
lead_line_items.product_offering	Informations sur l’offre de produit associée à l’élément de ligne de prospect. Type de données : objet `"product_offering": { "code": " String", "name": "String", "sys_id": "String" }`
lead_line_items.product_offering.code	Code lié à l’offre de produits. Remarque : Il s’agit d’un numéro alphanumérique généré par le système basé sur le nom du produit. Bien qu’il soit généré par le système, vous pouvez modifier le code pour représenter une référence SKU ou tout autre code produit spécifique au secteur. Type de données : chaîne
lead_line_items.product_offering.nom	Nom de l’offre de produits. Type de données : chaîne
lead_line_items.product_offering.sys_id	Sys_id de l’enregistrement d’offre de produit associé à l’élément de ligne de piste. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering]
lead_line_items.quantité	Quantité d’éléments que le prospect souhaite acheter de l’offre de produits associée. Type de données : nombre (entier)
lead_line_items.sys_created_by	Nom d’utilisateur de la personne qui a créé l’élément de ligne de piste. Type de données : chaîne
lead_line_items.sys_created_on	Date et heure de création de l’élément de ligne de piste générées par le système. Type de données : objet `"sys_created_on": { "display_value": "String", "value": "String" }`
lead_line_items.sys_created_on.valeur_display_value	Date et heure de création de l’élément de ligne de prospect. Type de données : chaîne Format : format d’instance et fuseau horaire par défaut
lead_line_items.sys_created_on.valeur	Date et heure de création de l’élément de ligne de prospect. Type de données : chaîne Format : UTC
lead_line_items.sys_domain	Sys_id de l’enregistrement du domaine auquel l’élément de ligne de la piste appartient. Remarque : Ce paramètre n’est renvoyé dans la réponse que si Séparation de domaine est activée. Type de données : chaîne
lead_line_items.sys_chemin_domaine	Chemin d’accès du domaine auquel l’élément de ligne de la piste appartient. Remarque : Ce paramètre n’est renvoyé dans la réponse que si Séparation de domaine est activée. Type de données : chaîne
lead_line_items.sys_id	Sys_id de l’enregistrement de l’élément de ligne de la piste. Type de données : chaîne
lead_line_items.sys_mod_count	Nombre de fois où l’enregistrement d’élément de ligne de piste associé a été modifié. Type de données : nombre (entier)
lead_line_items.sys_tags	Liste des balises système associées à l’élément de ligne de piste. Type de données : tableau
lead_line_items.sys_updated_by	Nom d’utilisateur de la personne qui a mis à jour pour la dernière fois l’élément de ligne de piste associé. Type de données : chaîne
lead_line_items.sys_updated_on	Date et heure de dernière mise à jour de l’élément de ligne de piste générées par le système. Type de données : objet `"sys_created_on": { "display_value": "String", "value": "String" }`
lead_line_items.sys_updated_on.display_value	Date et heure de dernière mise à jour de l’élément de ligne de prospect. Type de données : chaîne Format : format d’instance et fuseau horaire par défaut
lead_line_items.sys_updated_on.valeur	Date et heure de dernière mise à jour de l’élément de ligne de prospect. Type de données : chaîne Format : UTC
lead_line_items.unit_of_measurement	Détails de l’unité de mesure de l’élément de ligne de la piste. Type de données : objet `"unit_of_measurement": { "name": "String", "sys_id": "String" }`
lead_line_items.unit_of_measurement.nom	Nom de l’unité de mesure, par exemple, chaque pied cube. Type de données : chaîne
lead_line_items.unit_of_measurement.sys_id	Sys_id de l’enregistrement qui décrit l’unité de mesure. Type de données : chaîne Tableau : Unité de mesure [sn_prd_pm_uom]
lead_line_items.work_notes	Liste qui décrit les notes de travail créées pour l’élément de ligne de piste. Type de données : tableau d’objets `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
lead_line_items.work_notes.auteur	Nom d’utilisateur de la personne qui a rédigé la note de travail associée. Type de données : chaîne
lead_line_items.work_notes.date	Date de création de la note. Type de données : chaîne
lead_line_items.work_notes.SMS	Texte de la note rédigée par l’auteur. Type de données : chaîne
lead_rating	Évaluation de la piste telle que 100_cold, 200_warm, 300_hot ou 400_super_hot. Remarque : Il s’agit d’un champ de choix. Il doit contenir l’un des éléments de choix définis dans le champ lead_rating de la table Prospects. Type de données : chaîne
lead_score	Score pour l’en-tête. Type de données : Décimal Plage : 1 à 100
lead_source	Initiateur de la piste. Remarque : Il s’agit d’un champ de choix. Il doit contenir l’un des éléments de choix définis dans le champ lead_source de la table Prospects. Type de données : chaîne
lead_type	Type de prospect, tel que nouvelle affaire ou activité existante. Remarque : Il s’agit d’un champ de choix. Il doit contenir l’un des éléments de choix définis dans le champ lead_type de la table Prospects. Type de données : chaîne
middle_name	Deuxième prénom du contact de la piste. Type de données : chaîne
mobile_phone	Numéro de téléphone du contact de la piste. Type de données : chaîne
Numéro	Numéro unique généré par le système de l’enregistrement de prospect. Type de données : chaîne
other_reason	Raison supplémentaire de la disqualification de la tête. Type de données : chaîne Longueur maximale : 160 caractères
propriétaire	Détails de la personne associée à la piste. Type de données : objet `"owner": { "name": "String", "sys_id": "String" }`
owner.name	Nom de la personne qui possède la piste. Type de données : chaîne
owner.sys_id	Sys_id de l’enregistrement utilisateur de la personne qui possède la piste. Type de données : chaîne Table : Utilisateur [sys_user]
motif	Raison de la disqualification de la piste telle que Disqualifier. Type de données : chaîne Longueur maximale : 40 caractères
short_description	Brève description de la piste. Type de données : chaîne Longueur maximale : 160 caractères
similar_lead	Détails sur toute piste similaire. Utilisez cette option pour une éventuelle disqualification de la piste. Type de données : objet `"similar_lead": { "name": "String", "sys_id": "String" }`
similar_lead.nom	Nom de la piste en double. Type de données : chaîne
similar_lead.sys_id	Sys_id de l’enregistrement de piste qui est une piste possiblement en double. Type de données : chaîne Table : piste [sn_lead_mgmt_core_lead]
étape	Étape de la piste telle que 100_new. Remarque : Il s’agit d’un champ de choix. Il doit contenir l’un des éléments de choix définis dans le champ d’étape de la table Pistes. Type de données : chaîne
État	État dans lequel réside la piste. Type de données : chaîne
rue	Rue sur laquelle réside le plomb. Type de données : chaîne
sys_class_name	Nom de classe de la table principale généré par le système. Type de données : chaîne
sys_created_by	Nom d’utilisateur de la personne qui a créé la piste. Type de données : chaîne
sys_created_on	Date et heure de création de la piste générées par le système. Type de données : objet `"sys_created_on": { "display_value": "String", "value": "String" }`
sys_created_on.display_value	Date et heure auxquelles la piste a été créée. Type de données : chaîne Format : format d’instance et fuseau horaire par défaut
sys_created_on.valeur	Date et heure auxquelles la piste a été créée. Type de données : chaîne Format : UTC
sys_domain	Sys_id de l’enregistrement du domaine auquel la piste appartient. Remarque : Ce paramètre n’est renvoyé dans la réponse que si Séparation de domaine est activée. Type de données : chaîne
sys_domain_path	Chemin du domaine auquel la piste appartient. Remarque : Ce paramètre n’est renvoyé dans la réponse que si Séparation de domaine est activée. Type de données : chaîne
sys_id	Sys_id de l’enregistrement de prospect. Type de données : chaîne Table : piste [sn_lead_mgmt_core_lead]
sys_mod_count	Nombre de fois où l’enregistrement de prospect associé a été modifié. Type de données : nombre (entier)
sys_tags	Liste des balises système associées à la piste. Vous pouvez utiliser ces balises pour catégoriser les prospects. Type de données : tableau
sys_updated_by	Nom d’utilisateur de la personne qui a mis à jour l’enregistrement de piste pour la dernière fois. Type de données : chaîne
sys_updated_on	Date et heure de la dernière mise à jour de la piste générées par le système. Type de données : objet `"sys_created_on": { "display_value": "String", "value": "String" }`
sys_updated_on.display_value	Date et heure de la dernière mise à jour de la piste. Type de données : chaîne Format : format et fuseau horaire par défaut de l’instance
sys_updated_on.valeur	Date et heure de la dernière mise à jour de la piste. Type de données : chaîne Format : UTC
Titre	Titre de la piste. Type de données : chaîne
site internet	URL du site Web du prospect. Type de données : chaîne
work_notes	Liste des notes de travail créées pour la piste. Type de données : tableau d’objets `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
work_notes.auteur	Nom d’utilisateur de la personne qui a rédigé la note de travail associée. Type de données : chaîne
work_notes.date	Date de création de la note. Type de données : chaîne
work_notes.SMS	Texte de la note rédigée par l’auteur. Type de données : chaîne
code postal	Code postal de la piste associée. Type de données : chaîne

Demande cURL

L’exemple de code suivant montre comment créer un enregistrement de piste avec un élément de ligne de piste.

curl " https://instance.service-now.com/api/sn_lead_mgmt_core/v1/lead" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data " {
    "short_description": "Looking for a quote on preventative maintenance plans for their corporate office building elevators.",
    "country": "USA",
    "city": "San Francisco",
    "lead_source": "inbound_phone",
    "industry": "manufacturing",
    "title": "Director of Building operations",
    "business_phone": "+1 (555) 123-4567",
    "street": "789, Industrial drive",
    "company": "Lee Manufacturing Inc",
    "state": "CA",
    "first_name": "James",
    "email": "james.wilson@email.com",
    "consumer": {
      "sys_id": "46ce64ef99ca5210f8779c3cc41bb03c"
    },
    "zip": "94016",
    "website": "example.com",
    "last_name": "Wilson",
    "middle_name": null,
    "do_not_share": false,
    "lead_score": 92,
    "stage": "100_new",
    "do_not_email": false,
    "lead_type": "existing_business",
    "work_notes": [
      {
        "text": "Work notes for lead"
      }
    ],
    "do_not_call": true,
    "lead_rating": "200_warm",
    "lead_line_items": [
      {
        "quantity": 1,
        "product_offering": {
          "sys_id": "32619d9fd0a63110f8770dbf976be1f9"
        },
        "unit_of_measurement": { 
          "sys_id": "cb2795d553020110286eddeeff7b12ff"
        }
      }
  ]
}

La réponse contient les champs dans les enregistrements de piste et d’éléments de ligne de piste.

{
  "short_description": "Looking for a quote on preventative maintenance plans for their corporate office building elevators.",
  "reason": null,
  "country": "USA",
  "closed_date": null,
  "city": "San Francisco",
  "lead_source": "inbound_phone",
  "external_id": null,
  "industry": "manufacturing",
  "sys_updated_on": {
    "value": "2024-12-11 08:35:26",
    "display_value": "2024-12-11 00:35:26"
  },
  "title": "Director of Building operations",
  "sys_class_name": "Lead",
  "number": "LEAD0001001",
  "sys_id": "030f795380925210f877983fa0be67c0",
  "business_phone": "+1 (555) 123-4567",
  "similar_lead": null,
  "sys_updated_by": "abel.tuter",
  "mobile_phone": null,
  "street": "789, Industrial drive",
  "sys_created_on": {
    "value": "2024-12-11 08:35:26",
    "display_value": "2024-12-11 00:35:26"
  },
  "contact": null,
  "company": "Lee Manufacturing Inc",
  "state": "CA",
  "first_name": "James",
  "email": "james.wilson@email.com",
  "consumer": {
    "sys_id": "46ce64ef99ca5210f8779c3cc41bb03c",
    "name": "test"
  },
  "sys_created_by": "abel.tuter",
  "zip": "94016",
  "owner": {
    "sys_id": "62826bf03710200044e0bfc8bcbe5df1",
    "name": "Abel Tuter"
  },
  "website": "example.com",
  "lead_group": null,
  "sys_mod_count": 1,
  "last_name": "Wilson",
  "other_reason": null,
  "middle_name": null,
  "sys_tags": null,
  "do_not_share": false,
  "lead_score": 92,
  "stage": "100_new",
  "do_not_email": false,
  "lead_type": "existing_business",
  "work_notes": [
    {
      "author": "Abel Tuter",
      "date": "2024-12-11 00:35:26",
      "text": "Work notes for lead"
    },
    {
      "author": "Abel Tuter",
      "date": "2024-12-11 00:35:26",
      "text": "Lead Line Item [code]<a href='/sn_lead_mgmt_core_lead_line_item.do?sys_id=830f795380925210f877983fa0be67c5'>LEADL0001001</a>[/code] has been created  [code] <b> Product Offering </b> [/code] Safety Test Coverage [code] <b> Quantity </b> [/code] 1 [code] <b> Unit of Measure </b> [/code] Each"
    }
  ],
  "do_not_call": true,
  "lead_rating": "200_warm",
  "account": null,
  "external_system": null,
  "lead_line_items": [
    {
      "quantity": 1,
      "product_offering": {
        "sys_id": "32619d9fd0a63110f8770dbf976be1f9",
        "name": "Safety Test Coverage",
        "code": "SAFETSTCVG1"
      },
      "sys_mod_count": 0,
      "external_id": null,
      "sys_updated_on": {
        "value": "2024-12-11 08:35:26",
        "display_value": "2024-12-11 00:35:26"
      },
      "sys_tags": null,
      "lead": {
        "sys_id": "030f795380925210f877983fa0be67c0",
        "name": "LEAD0001001"
      },
      "number": "LEADL0001001",
      "sys_id": "830f795380925210f877983fa0be67c5",
      "unit_of_measurement": {
        "sys_id": "cb2795d553020110286eddeeff7b12ff",
        "name": "Each"
      },
      "sys_updated_by": "abel.tuter",
      "sys_created_on": {
        "value": "2024-12-11 08:35:26",
        "display_value": "2024-12-11 00:35:26"
      },
      "work_notes": null,
      "sys_created_by": "abel.tuter",
      "external_system": null
    }
  ]
}