Lead-API

Freigeben Version: Yokohama

Aktualisiert 30. Januar 2025

51 Minuten Lesedauer

Die Lead- API bietet Endpunkte, mit denen Sie Marketing-Leads und die zugehörigen Lead-Positionen aus einer Instanz erstellen, aktualisieren und abfragen/abrufen können.

Verwenden Sie diese API, um Ihre Instanz in externe Websites und Systeme zu integrieren, z. B. automatisierte Lead-Erfassungssysteme, oder um Lead-Informationen für externe Berichterstellungssysteme bereitzustellen.

Diese API wird im Namespace sn_lead_mgmt_core bereitgestellt. Für den Zugriff auf die API muss das Plugin „Lead Management Data Model“ (sn_lead_mgmt_core) in der Instanz aktiviert sein, und der aufrufende Benutzer muss über die Rolle sn_lead_mgmt_core.lead_integrator verfügen.

Weitere Informationen zu Lead Managementfinden Sie unter Using Lead Management.

Erweiterung der Lead API

Sie können die Lead -API erweitern, indem Sie die Methoden in den zugehörigen Skripteinbindungen überschreiben. Die standardmäßige API-Funktionalität befindet sich in Skripteinbindungen mit der Endung „OOB“, z. B. LeadAPIProcessUtilOOB. Um diese Funktionalität zu überschreiben, erstellen Sie Methoden mit identischen Namen und Parametern in der Skripteinbindung, die denselben Dateinamen hat, aber nicht mit „OOB“ endet, z. B. LeadAPIProcessUtil.

Im Folgenden finden Sie eine Liste der Skripteinbindungen, die Sie überschreiben können, um das Verhalten der Lead -API zu ändern:

LeadAPIProcessUtilOOB: Enthält Methoden, die das Abrufen und Erstellen von Datensätzen für Leads und Lead-Positionselemente verarbeiten.
LeadApiValidationUtilOOB: Enthält Methoden, die das JSON-Anforderungsobjekt für die POST- und PATCH-Endpunkte validieren.
LeadAPIHelperOOB: Enthält API-Hilfsmethoden, die:
- Geben Sie ein Array von Leads und zugehörigen Lead-Positionselementen zurück.
- Geben Sie ein JSON-Objekt aus dem zugeordneten GlideRecord zurück.
- Entfernen Sie alle ignorierten Felder aus einem JSON-Objekt, und führen Sie andere Transformationen durch.
LeadAPIConstantsOOB: Enthält Konstanten, Statuscodes und Nachrichten für alle API-Vorgänge. Sie enthält auch die Liste der Felder, die von den POST- und PATCH-Endpunkten ignoriert werden.

Lead: GET /sn_lead_mgmt_core/lead

Ruft alle Leads und zugehörigen Lead-Positionselemente basierend auf den in den Abfrageparametern übergebenen Filterkriterien ab.

Dieser Endpunkt gibt eine paginierte Antwort gemäß dem angegebenen Grenzwert und Offset zurück. Sie ruft Informationen aus den folgenden Tabellen ab:

Lead [sn_lead_mgmt_core_lead]
Lead-Positionselement [sn_lead_mgmt_core_lead_line_item]

URL-Format

URL mit Versionsnummer: /api/sn_lead_mgmt_core/{api_version}/lead

Standard-URL: /api/sn_lead_mgmt_core/{api_version}/lead

Hinweis:

Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter
Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel `v1` oder `v2`. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 2. Abfrageparameter
Name	Beschreibung
sysparm_fields	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Datentyp: Zeichenfolge Standard: Gibt alle Felder zurück.
sysparm_limit	Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter sysparm_offset, um den Datensatzabruf zu paginieren. Dieser Grenzwert wird vor der ACL-Bewertung angewendet. Erfolgt keine Datensatzrückgabe, einschließlich Datensätzen, auf die Sie Zugriff haben, ordnen Sie die Datensatzreihenfolge neu, sodass Datensätze, auf die Sie zugreifen können, zuerst zurückgegeben werden. Hinweis: Ungewöhnlich große Werte für sysparm_limit können die Systemleistung beeinträchtigen. Datentyp: Zahl Standard: 20 Maximum: 100
sysparm_offset	Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie `sysparm_offset=sysparm_offset+sysparm_limit` zum einfachen Durchblättern aller verfügbaren Datensätze, bis das Ende aller Datensätze erreicht ist. Übergeben Sie keine negative Zahl im Parameter sysparm_offset. Datentyp: Zahl Standard: 0
sysparm_query	Codierte Abfrage zum Filtern der Ergebnismenge. Beispiel: `(sysparm_query=caller_id=javascript:gs.getUserID()^active=true)` Die codierte Abfrage unterstützt Sortieren nach. Verwenden Sie die Klauseln ORDERBY und ORDERBYDESC in sysparm_query, um Antworten anhand bestimmter Felder zu sortieren. Zum Beispiel filtert `sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory` alle aktiven Datensätze und sortiert die Ergebnisse zuerst in aufsteigender Reihenfolge nach Nummer und dann in absteigender Reihenfolge nach Kategorie. Wenn ein Teil der Abfrage ungültig ist, z. B. durch Angabe eines ungültigen Feldnamens, ignoriert die Instanz den ungültigen Teil. Es werden dann nur Zeilen unter Verwendung des gültigen Teils der Abfrage zurückgegeben. Sie können dieses Verhalten mithilfe der Eigenschaft glide.invalid_query.returns_no_rows steuern. Legen Sie diese Eigenschaft auf „true“ fest, um bei einer ungültigen Abfrage keine Zeilen zurückzugeben. Hinweis: Diese Eigenschaft glide.invalid_query.returns_no_rows steuert das Verhalten aller Abfragen in der Instanz, beispielsweise in Listen, Skripts (GlideRecord.query()) und Webservice-APIs. Datentyp: Zeichenfolge

Tabelle : 3. Anforderungstextparameter
Name	Beschreibung
Keine

Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

Tabelle : 4. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

Tabelle : 5. Antwortkopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.
Inhaltsbereich	Inhaltsbereich, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn Offset = 2 und Limit = 3, ist der Wert des Content-Range-Headers die Elemente 3 bis 5.
Links	Links, über die Sie in den Abfrageergebnissen navigieren können: zuerst letzte Weiter vorheriger selbst
Gesamtanzahl	Gesamtzahl der gefilterten Datensätze.

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.

Tabelle : 6. Statuscodes
Statuscode	Beschreibung
200	Anforderung wurde erfolgreich verarbeitet. Alle Antworten zurückgegeben (keine Paginierung).
206	Anforderung erfolgreich verarbeitet. Teilressource, die als Antwort zurückgegeben wird (mit Paginierung).
400	Fehler. Mögliche Gründe: Ungültiger Grenzwert/Grenze höher als zulässig. Ungültiger Offset.
403	Datensatz mit verweigertem Zugriff. Unzureichende Berechtigung zum Abfragen des Datensatzes.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

Parameter des Antwort-Haupttexts


Name	Beschreibung
Account	Account, der mit dem Lead verknüpft ist. Datentyp: Objekt `"account": { "name": "String", "sys_id": "String" }`
account.name	Name des Kontos. Datentyp: Zeichenfolge
account.sys_id	Sys_id des zugeordneten Account-Datensatzes. Datentyp: Zeichenfolge Tabelle: Account [customer_account]
business_phone	Geschäftliche Telefonnummer des Lead. Datentyp: Zeichenfolge
city	Stadt, in der sich der Lead befindet. Datentyp: Zeichenfolge
closed_date	Datum und Uhrzeit des Abschlusses des Leads. Datentyp: Objekt `"closed_date": { "display_value": "String", "value": "String" }`
closed_date.display_value	Datum und Uhrzeit, wie in der Anwenderoberfläche angezeigt. Datentyp: Zeichenfolge Format: Format und Zeitzone des Anwenders.
closed_date.value	Datum und Uhrzeit des Abschlusses des Leads, wie im zugehörigen Datensatz definiert. Datentyp: Zeichenfolge Format: UTC
Unternehmen	Unternehmensname des Leads. Datentyp: Zeichenfolge
Verbraucher	Verbraucher, der dem Lead zugeordnet ist. Datentyp: Objekt `"consumer": { "name": "String", "sys_id": "String" }`
consumer.name	Name des zugeordneten Verbrauchers Datentyp: Zeichenfolge
Verbraucher.sys_id	Sys_id des zugeordneten Verbraucherdatensatzes. Datentyp: Zeichenfolge Tabelle: Verbraucher [csm_consumer]
Kontakt	Kontakt, der dem Lead-Account zugeordnet ist. Datentyp: Objekt `"contact": { "name": "String", "sys_id": "String" }`
kontakt.name	Kontaktname Datentyp: Zeichenfolge
kontakt.sys_id	Sys_id des zugeordneten Kontaktdatensatzes. Datentyp: Zeichenfolge Tabelle: Kontakt [customer_contact]
country	Land, in dem der Lead ansässig ist Datentyp: Zeichenfolge
do_not_call	Kennzeichnung, die angibt, ob der Kommunikationsmodus Telefon ist. Gültige Werte: wahr: Kann Kontakt anrufen. false: Kontakt nicht anrufen. Datentyp: Boolesch
do_not_email	Kennzeichnung, die angibt, ob der Kommunikationsmodus per E-Mail erfolgt. Gültige Werte: true: Kann Kontakt per E-Mail senden. „falsch“: Keine E-Mail an Kontakt senden. Datentyp: Boolesch
do_not_share	Kennzeichnung, die angibt, ob die Lead-Details geteilt werden können. Gültige Werte: wahr: Lead-Details können geteilt werden. „falsch“: Lead-Details können nicht geteilt werden. Datentyp: Boolesch
E-Mail	E-Mail-Adresse des Leads. Datentyp: Zeichenfolge
external_id	ID, die vom System, das den Lead generiert hat, verwendet wird, um den Lead im zugeordneten System zu identifizieren. Datentyp: Zeichenfolge
external_system	Name des externen Systems, das dem Lead zugeordnet ist, z. B. HubSpot oder Pipedrive. Datentyp: Zeichenfolge
first_name	Vorname des Kontakts, der dem Lead zugeordnet ist Datentyp: Zeichenfolge
Branche	Branche, zu der der Lead gehört. Datentyp: Zeichenfolge Tabelle: Befindet sich im Feld industry der Tabelle „Account“ [customer_account].
last_name	Nachname des Kontakts, der dem Lead zugeordnet ist Datentyp: Zeichenfolge
Lead_group	Gruppe, zu der der Lead gehört Datentyp: Objekt `"lead_group": { "name: "String", "sys_id": "String" }`
Lead_group.name	Name der Lead-Gruppe. Datentyp: Zeichenfolge
„lead_group.sys_id“	Sys_id des Lead-Gruppendatensatzes. Datentyp: Zeichenfolge Tabelle: Gruppe [sys_user_group]
„lead_line_items“	Details der Lead-Positionselemente, die dem Lead zugeordnet sind. Datentyp: Array von Objekten `"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, die vom System verwendet wird, das das Lead-Positionselement generiert hat, um das Positionselement im zugeordneten System zu identifizieren. Datentyp: Zeichenfolge
„lead_line_items.external_system“	Name des externen Systems, das dem Lead-Positionselement zugeordnet ist, z. B. HubSpot oder Pipedrive. Datentyp: Zeichenfolge
Lead_line_items.Lead	Details zum Lead, der der Position zugeordnet ist. Datentyp: Objekt `"lead: { "name": "String", "sys_id": "String" }`
„lead_line_items.lead.name“	Name des zugeordneten Leads. Datentyp: Zeichenfolge
„lead_line_items.lead.sys_id“	Sys_id des zugeordneten Lead-Datensatzes. Datentyp: Zeichenfolge
„lead_line_items.number“	Eindeutige, vom System generierte Nummer des Lead-Positionselement-Datensatzes. Datentyp: Zeichenfolge
„lead_line_items.product_offering“	Informationen zum Produktangebot, das dem Lead-Positionselement zugeordnet ist. Datentyp: Objekt `"product_offering": { "code": " String", "name": "String", "sys_id": "String" }`
„lead_line_items.product_offering.code“	Code, der mit dem Produktangebot verknüpft ist. Hinweis: Dies ist eine vom System generierte alphanumerische Nummer, die auf dem Produktnamen basiert. Obwohl der Code vom System generiert wird, können Sie den Code so bearbeiten, dass er eine SKU oder andere branchenspezifische Produktcodes darstellt. Datentyp: Zeichenfolge
„lead_line_items.product_offering.name“	Name des Produktangebots Datentyp: Zeichenfolge
„lead_line_items.product_offering.sys_id“	Sys_id des Produktangebotdatensatzes, der dem Lead-Positionselement zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering]
„lead_line_items.menge“	Menge der Artikel, die der Lead für das zugehörige Produktangebot kaufen möchte. Datentyp: Zahl (Ganzzahl)
„lead_line_items.sys_created_by“	Anwendername der Person, die das Lead-Positionselement erstellt hat Datentyp: Zeichenfolge
„lead_line_items.sys_created_on“	Vom System generierter Zeitpunkt (Datum und Uhrzeit), zu dem das Lead-Positionselement erstellt wurde Datentyp: Objekt `"sys_created_on": { "display_value": "String", "value": "String" }`
„lead_line_items.sys_created_on.display_value“	Datum und Uhrzeit der Erstellung des Lead-Positionselements. Datentyp: Zeichenfolge Format: Standardformat und Zeitzone für Instanz
„lead_line_items.sys_created_on.value“	Datum und Uhrzeit der Erstellung des Lead-Positionselements. Datentyp: Zeichenfolge Format: UTC
„lead_line_items.sys_domain“	Sys_id des Domänendatensatzes, zu dem das Lead-Positionselement gehört. Hinweis: Dieser Parameter wird nur in der Antwort zurückgegeben, wenn Domain Separation aktiviert ist. Datentyp: Zeichenfolge
„lead_line_items.sys_domain_path“	Pfad der Domäne, zu der das Lead-Positionselement gehört. Hinweis: Dieser Parameter wird nur in der Antwort zurückgegeben, wenn Domain Separation aktiviert ist. Datentyp: Zeichenfolge
„lead_line_items.sys_id“	Sys_id des Lead-Positionselement-Datensatzes. Datentyp: Zeichenfolge
„lead_line_items.sys_mod_count“	Anzahl der Änderungen des zugehörigen Lead-Positionselement-Datensatzes. Datentyp: Zahl (Ganzzahl)
„lead_line_items.sys_tags“	Liste der System-Tags, die dem Lead-Positionselement zugeordnet sind Datentyp: Array
„lead_line_items.sys_updated_by“	Anwendername der Person, die das zugehörige Lead-Positionselement zuletzt aktualisiert hat. Datentyp: Zeichenfolge
„lead_line_items.sys_updated_on“	Vom System generiertes Datum und Uhrzeit der letzten Aktualisierung des Lead-Positionselements. Datentyp: Objekt `"sys_created_on": { "display_value": "String", "value": "String" }`
„lead_line_items.sys_updated_on.display_value“	Datum und Uhrzeit der letzten Aktualisierung des Lead-Positionselements. Datentyp: Zeichenfolge Format: Standardformat und Zeitzone für Instanz
„lead_line_items.sys_updated_on.value“	Datum und Uhrzeit der letzten Aktualisierung des Lead-Positionselements. Datentyp: Zeichenfolge Format: UTC
Lead_line_items.unit_of_measurement	Details zur Maßeinheit des Lead-Positionselements. Datentyp: Objekt `"unit_of_measurement": { "name": "String", "sys_id": "String" }`
„lead_line_items.unit_of_measurement.name“	Name der Maßeinheit, z. B. Stück oder Kubikfuß. Datentyp: Zeichenfolge
„lead_line_items.unit_of_measurement.sys_id“	Sys_id des Datensatzes, der die Maßeinheit beschreibt. Datentyp: Zeichenfolge Tabelle: Maßeinheit [sn_prd_pm_uom]
„lead_line_items.work_notes“	Liste, die die für das Lead-Positionselement erstellten Arbeitsnotizen beschreibt. Datentyp: Array von Objekten `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
Lead_line_items.work_notes.author	Anwendername der Person, die die zugehörige Arbeitsnotiz verfasst hat. Datentyp: Zeichenfolge
„lead_line_items.work_notes.date“	Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge
„lead_line_items.work_notes.text“	Text der Notiz vom Autor. Datentyp: Zeichenfolge
Lead_rating	Bewertung für den Lead, z. B. 100_cold, 200_warm, 300_Hot oder 400_Super_Hot. Hinweis: Dies ist ein Auswahlfeld. Sie muss eines der Auswahlelemente enthalten, die im Feld „lead_rating“ der Lead-Tabelle definiert sind. Datentyp: Zeichenfolge
Lead_score	Punktzahl für den Lead. Datentyp: Dezimalzahl Bereich: 1 bis 100
Lead_source	Urheber des Leads. Hinweis: Dies ist ein Auswahlfeld. Sie muss eines der Auswahlelemente enthalten, die im Feld „lead_source“ der Lead-Tabelle definiert sind. Datentyp: Zeichenfolge
Lead_type	Typ des Leads, z. B. „Neues Geschäft“ oder „Bestehendes Geschäft“. Hinweis: Dies ist ein Auswahlfeld. Sie muss eines der Auswahlelemente enthalten, die im Feld „lead_type“ der Lead-Tabelle definiert sind. Datentyp: Zeichenfolge
Middle_name	Zweiter Vorname des Kontakts für den Lead Datentyp: Zeichenfolge
mobile_phone	Telefonnummer des Kontakts für den Lead Datentyp: Zeichenfolge
Nummer	Eindeutige, vom System generierte Nummer des Lead-Datensatzes. Datentyp: Zeichenfolge
other_reason	Zusätzlicher Grund für die Disqualifikation des Leads. Datentyp: Zeichenfolge Max. Länge: 160 Zeichen
owner	Details der Person, die dem Lead zugeordnet ist. Datentyp: Objekt `"owner": { "name": "String", "sys_id": "String" }`
owner.name	Name der Person, die Besitzer des Leads ist. Datentyp: Zeichenfolge
owner.sys_id	Sys_id des Anwenderdatensatzes der Person, die Besitzer des Leads ist. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
Grund	Grund für die Disqualifikation des Leads, z. B. Disqualifizieren. Datentyp: Zeichenfolge Max. Länge: 40 Zeichen
short_description	Kurze Beschreibung des Leads. Datentyp: Zeichenfolge Max. Länge: 160 Zeichen
Similar_Lead	Details zu einem ähnlichen Lead. Verwenden Sie dies für eine mögliche Lead-Disqualifizierung. Datentyp: Objekt `"similar_lead": { "name": "String", "sys_id": "String" }`
ähnliche_lead.name	Name des doppelten Leads Datentyp: Zeichenfolge
Similar_Lead.Sys_ID	Sys_id des Lead-Datensatzes, bei dem es sich um einen möglichen doppelten Lead handelt. Datentyp: Zeichenfolge Tabelle: Lead [sn_lead_mgmt_core_lead]
Phase	Phase des Leads, z. B. 100_new. Hinweis: Dies ist ein Auswahlfeld. Sie muss eines der Auswahlelemente enthalten, die im Feld „Phase“ der Tabelle „Leads“ definiert sind. Datentyp: Zeichenfolge
state	Bundesstaat, in dem sich der Lead befindet. Datentyp: Zeichenfolge
Straße	Straße, in der der Lead ansässig ist Datentyp: Zeichenfolge
sys_class_name	Vom System generierter Klassenname für die Lead-Tabelle Datentyp: Zeichenfolge
sys_created_by	Anwendername der Person, die den Lead erstellt hat Datentyp: Zeichenfolge
sys_created_on	Vom System generierter Zeitpunkt (Datum und Uhrzeit), zu dem der Lead erstellt wurde Datentyp: Objekt `"sys_created_on": { "display_value": "String", "value": "String" }`
sys_created_on.display_value	Datum und Uhrzeit der Erstellung des Leads. Datentyp: Zeichenfolge Format: Standardformat und Zeitzone für Instanz
sys_created_on.Wert	Datum und Uhrzeit der Erstellung des Leads. Datentyp: Zeichenfolge Format: UTC
sys_domain	Sys_id des Domänendatensatzes, zu dem der Lead gehört. Hinweis: Dieser Parameter wird nur in der Antwort zurückgegeben, wenn Domain Separation aktiviert ist. Datentyp: Zeichenfolge
sys_domain_path	Pfad der Domäne, zu der der Lead gehört. Hinweis: Dieser Parameter wird nur in der Antwort zurückgegeben, wenn Domain Separation aktiviert ist. Datentyp: Zeichenfolge
sys_id	Sys_id des Lead-Datensatzes. Datentyp: Zeichenfolge Tabelle: Lead [sn_lead_mgmt_core_lead]
sys_mod_count	Anzahl der Änderungen des zugeordneten Lead-Datensatzes. Datentyp: Zahl (Ganzzahl)
sys_tags	Liste der System-Tags, die dem Lead zugeordnet sind Sie können diese Tags verwenden, um Leads zu kategorisieren. Datentyp: Array
sys_updated_by	Anwendername der Person, die den Lead-Datensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge
sys_updated_on	Vom System generierter Zeitpunkt (Datum und Uhrzeit) der letzten Aktualisierung des Leads Datentyp: Objekt `"sys_created_on": { "display_value": "String", "value": "String" }`
sys_updated_on.display_value	Datum und Uhrzeit der letzten Aktualisierung des Leads. Datentyp: Zeichenfolge Format: Standardformat und Zeitzone der Instanz
sys_updated_on.Wert	Datum und Uhrzeit der letzten Aktualisierung des Leads. Datentyp: Zeichenfolge Format: UTC
Titel	Titel des Leads. Datentyp: Zeichenfolge
Website von	Website-URL des Lead. Datentyp: Zeichenfolge
work_notes	Liste der für den Lead erstellten Arbeitsnotizen Datentyp: Array von Objekten `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
work_notes.author	Anwendername der Person, die die zugehörige Arbeitsnotiz verfasst hat. Datentyp: Zeichenfolge
work_notes.date	Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge
work_notes.text	Text der Notiz vom Autor. Datentyp: Zeichenfolge
Postleitzahl	Postleitzahl des zugeordneten Leads. Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Codebeispiel zeigt, wie Abfrageparameter übergeben werden, um die zurückzugebenden Leads anzugeben.

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"

Leads werden in einem Array von Objekten zurückgegeben:

[
  {
    "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
      } 
    ]
  }
]

Lead – GET /sn_lead_mgmt_core/lead/{sys_id}

Gibt den Lead-Datensatz und alle zugehörigen Lead-Positionselemente für die angegebene sys_id zurück.

Dieser Endpunkt ruft Informationen aus den folgenden Tabellen ab:

Lead [sn_lead_mgmt_core_lead]
Lead-Positionselement [sn_lead_mgmt_core_lead_line_item]

URL-Format

URL mit Versionsnummer: /api/sn_lead_mgmt_core/{api_version}/lead/{sys_id}

Standard-URL: /api/sn_lead_mgmt_core/{api_version}/lead/{sys_id}

Hinweis:

Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

Unterstützte Anforderungsparameter

Tabelle : 7. Pfadparameter
Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel `v1` oder `v2`. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
sys_id	Sys_id des abzurufenden Leads. Datentyp: Zeichenfolge Tabelle: Lead [sn_lead_mgmt_core_lead]

Tabelle : 8. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 9. Anforderungstextparameter (XML oder JSON)
Name	Beschreibung
Keine

Kopfzeilen

Tabelle : 10. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.

Tabelle : 11. Antwortkopfzeilen
Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.

Tabelle : 12. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
403	Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antwort-Haupttexts


Name	Beschreibung
Account	Account, der mit dem Lead verknüpft ist. Datentyp: Objekt `"account": { "name": "String", "sys_id": "String" }`
account.name	Name des Kontos. Datentyp: Zeichenfolge
account.sys_id	Sys_id des zugeordneten Account-Datensatzes. Datentyp: Zeichenfolge Tabelle: Account [customer_account]
business_phone	Geschäftliche Telefonnummer des Lead. Datentyp: Zeichenfolge
city	Stadt, in der sich der Lead befindet. Datentyp: Zeichenfolge
closed_date	Datum und Uhrzeit des Abschlusses des Leads. Datentyp: Objekt `"closed_date": { "display_value": "String", "value": "String" }`
closed_date.display_value	Datum und Uhrzeit, wie in der Anwenderoberfläche angezeigt. Datentyp: Zeichenfolge Format: Format und Zeitzone des Anwenders.
closed_date.value	Datum und Uhrzeit des Abschlusses des Leads, wie im zugehörigen Datensatz definiert. Datentyp: Zeichenfolge Format: UTC
Unternehmen	Unternehmensname des Leads. Datentyp: Zeichenfolge
Verbraucher	Verbraucher, der dem Lead zugeordnet ist. Datentyp: Objekt `"consumer": { "name": "String", "sys_id": "String" }`
consumer.name	Name des zugeordneten Verbrauchers Datentyp: Zeichenfolge
Verbraucher.sys_id	Sys_id des zugeordneten Verbraucherdatensatzes. Datentyp: Zeichenfolge Tabelle: Verbraucher [csm_consumer]
Kontakt	Kontakt, der dem Lead-Account zugeordnet ist. Datentyp: Objekt `"contact": { "name": "String", "sys_id": "String" }`
kontakt.name	Kontaktname Datentyp: Zeichenfolge
kontakt.sys_id	Sys_id des zugeordneten Kontaktdatensatzes. Datentyp: Zeichenfolge Tabelle: Kontakt [customer_contact]
country	Land, in dem der Lead ansässig ist Datentyp: Zeichenfolge
do_not_call	Kennzeichnung, die angibt, ob der Kommunikationsmodus Telefon ist. Gültige Werte: wahr: Kann Kontakt anrufen. false: Kontakt nicht anrufen. Datentyp: Boolesch
do_not_email	Kennzeichnung, die angibt, ob der Kommunikationsmodus per E-Mail erfolgt. Gültige Werte: true: Kann Kontakt per E-Mail senden. „falsch“: Keine E-Mail an Kontakt senden. Datentyp: Boolesch
do_not_share	Kennzeichnung, die angibt, ob die Lead-Details geteilt werden können. Gültige Werte: wahr: Lead-Details können geteilt werden. „falsch“: Lead-Details können nicht geteilt werden. Datentyp: Boolesch
E-Mail	E-Mail-Adresse des Leads. Datentyp: Zeichenfolge
external_id	ID, die vom System, das den Lead generiert hat, verwendet wird, um den Lead im zugeordneten System zu identifizieren. Datentyp: Zeichenfolge
external_system	Name des externen Systems, das dem Lead zugeordnet ist, z. B. HubSpot oder Pipedrive. Datentyp: Zeichenfolge
first_name	Vorname des Kontakts, der dem Lead zugeordnet ist Datentyp: Zeichenfolge
Branche	Branche, zu der der Lead gehört. Datentyp: Zeichenfolge Tabelle: Befindet sich im Feld industry der Tabelle „Account“ [customer_account].
last_name	Nachname des Kontakts, der dem Lead zugeordnet ist Datentyp: Zeichenfolge
Lead_group	Gruppe, zu der der Lead gehört Datentyp: Objekt `"lead_group": { "name: "String", "sys_id": "String" }`
Lead_group.name	Name der Lead-Gruppe. Datentyp: Zeichenfolge
„lead_group.sys_id“	Sys_id des Lead-Gruppendatensatzes. Datentyp: Zeichenfolge Tabelle: Gruppe [sys_user_group]
„lead_line_items“	Details der Lead-Positionselemente, die dem Lead zugeordnet sind. Datentyp: Array von Objekten `"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, die vom System verwendet wird, das das Lead-Positionselement generiert hat, um das Positionselement im zugeordneten System zu identifizieren. Datentyp: Zeichenfolge
„lead_line_items.external_system“	Name des externen Systems, das dem Lead-Positionselement zugeordnet ist, z. B. HubSpot oder Pipedrive. Datentyp: Zeichenfolge
Lead_line_items.Lead	Details zum Lead, der der Position zugeordnet ist. Datentyp: Objekt `"lead: { "name": "String", "sys_id": "String" }`
„lead_line_items.lead.name“	Name des zugeordneten Leads. Datentyp: Zeichenfolge
„lead_line_items.lead.sys_id“	Sys_id des zugeordneten Lead-Datensatzes. Datentyp: Zeichenfolge
„lead_line_items.number“	Eindeutige, vom System generierte Nummer des Lead-Positionselement-Datensatzes. Datentyp: Zeichenfolge
„lead_line_items.product_offering“	Informationen zum Produktangebot, das dem Lead-Positionselement zugeordnet ist. Datentyp: Objekt `"product_offering": { "code": " String", "name": "String", "sys_id": "String" }`
„lead_line_items.product_offering.code“	Code, der mit dem Produktangebot verknüpft ist. Hinweis: Dies ist eine vom System generierte alphanumerische Nummer, die auf dem Produktnamen basiert. Obwohl der Code vom System generiert wird, können Sie den Code so bearbeiten, dass er eine SKU oder andere branchenspezifische Produktcodes darstellt. Datentyp: Zeichenfolge
„lead_line_items.product_offering.name“	Name des Produktangebots Datentyp: Zeichenfolge
„lead_line_items.product_offering.sys_id“	Sys_id des Produktangebotdatensatzes, der dem Lead-Positionselement zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering]
„lead_line_items.menge“	Menge der Artikel, die der Lead für das zugehörige Produktangebot kaufen möchte. Datentyp: Zahl (Ganzzahl)
„lead_line_items.sys_created_by“	Anwendername der Person, die das Lead-Positionselement erstellt hat Datentyp: Zeichenfolge
„lead_line_items.sys_created_on“	Vom System generierter Zeitpunkt (Datum und Uhrzeit), zu dem das Lead-Positionselement erstellt wurde Datentyp: Objekt `"sys_created_on": { "display_value": "String", "value": "String" }`
„lead_line_items.sys_created_on.display_value“	Datum und Uhrzeit der Erstellung des Lead-Positionselements. Datentyp: Zeichenfolge Format: Standardformat und Zeitzone für Instanz
„lead_line_items.sys_created_on.value“	Datum und Uhrzeit der Erstellung des Lead-Positionselements. Datentyp: Zeichenfolge Format: UTC
„lead_line_items.sys_domain“	Sys_id des Domänendatensatzes, zu dem das Lead-Positionselement gehört. Hinweis: Dieser Parameter wird nur in der Antwort zurückgegeben, wenn Domain Separation aktiviert ist. Datentyp: Zeichenfolge
„lead_line_items.sys_domain_path“	Pfad der Domäne, zu der das Lead-Positionselement gehört. Hinweis: Dieser Parameter wird nur in der Antwort zurückgegeben, wenn Domain Separation aktiviert ist. Datentyp: Zeichenfolge
„lead_line_items.sys_id“	Sys_id des Lead-Positionselement-Datensatzes. Datentyp: Zeichenfolge
„lead_line_items.sys_mod_count“	Anzahl der Änderungen des zugehörigen Lead-Positionselement-Datensatzes. Datentyp: Zahl (Ganzzahl)
„lead_line_items.sys_tags“	Liste der System-Tags, die dem Lead-Positionselement zugeordnet sind Datentyp: Array
„lead_line_items.sys_updated_by“	Anwendername der Person, die das zugehörige Lead-Positionselement zuletzt aktualisiert hat. Datentyp: Zeichenfolge
„lead_line_items.sys_updated_on“	Vom System generiertes Datum und Uhrzeit der letzten Aktualisierung des Lead-Positionselements. Datentyp: Objekt `"sys_created_on": { "display_value": "String", "value": "String" }`
„lead_line_items.sys_updated_on.display_value“	Datum und Uhrzeit der letzten Aktualisierung des Lead-Positionselements. Datentyp: Zeichenfolge Format: Standardformat und Zeitzone für Instanz
„lead_line_items.sys_updated_on.value“	Datum und Uhrzeit der letzten Aktualisierung des Lead-Positionselements. Datentyp: Zeichenfolge Format: UTC
Lead_line_items.unit_of_measurement	Details zur Maßeinheit des Lead-Positionselements. Datentyp: Objekt `"unit_of_measurement": { "name": "String", "sys_id": "String" }`
„lead_line_items.unit_of_measurement.name“	Name der Maßeinheit, z. B. Stück oder Kubikfuß. Datentyp: Zeichenfolge
„lead_line_items.unit_of_measurement.sys_id“	Sys_id des Datensatzes, der die Maßeinheit beschreibt. Datentyp: Zeichenfolge Tabelle: Maßeinheit [sn_prd_pm_uom]
„lead_line_items.work_notes“	Liste, die die für das Lead-Positionselement erstellten Arbeitsnotizen beschreibt. Datentyp: Array von Objekten `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
Lead_line_items.work_notes.author	Anwendername der Person, die die zugehörige Arbeitsnotiz verfasst hat. Datentyp: Zeichenfolge
„lead_line_items.work_notes.date“	Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge
„lead_line_items.work_notes.text“	Text der Notiz vom Autor. Datentyp: Zeichenfolge
Lead_rating	Bewertung für den Lead, z. B. 100_cold, 200_warm, 300_Hot oder 400_Super_Hot. Hinweis: Dies ist ein Auswahlfeld. Sie muss eines der Auswahlelemente enthalten, die im Feld „lead_rating“ der Lead-Tabelle definiert sind. Datentyp: Zeichenfolge
Lead_score	Punktzahl für den Lead. Datentyp: Dezimalzahl Bereich: 1 bis 100
Lead_source	Urheber des Leads. Hinweis: Dies ist ein Auswahlfeld. Sie muss eines der Auswahlelemente enthalten, die im Feld „lead_source“ der Lead-Tabelle definiert sind. Datentyp: Zeichenfolge
Lead_type	Typ des Leads, z. B. „Neues Geschäft“ oder „Bestehendes Geschäft“. Hinweis: Dies ist ein Auswahlfeld. Sie muss eines der Auswahlelemente enthalten, die im Feld „lead_type“ der Lead-Tabelle definiert sind. Datentyp: Zeichenfolge
Middle_name	Zweiter Vorname des Kontakts für den Lead Datentyp: Zeichenfolge
mobile_phone	Telefonnummer des Kontakts für den Lead Datentyp: Zeichenfolge
Nummer	Eindeutige, vom System generierte Nummer des Lead-Datensatzes. Datentyp: Zeichenfolge
other_reason	Zusätzlicher Grund für die Disqualifikation des Leads. Datentyp: Zeichenfolge Max. Länge: 160 Zeichen
owner	Details der Person, die dem Lead zugeordnet ist. Datentyp: Objekt `"owner": { "name": "String", "sys_id": "String" }`
owner.name	Name der Person, die Besitzer des Leads ist. Datentyp: Zeichenfolge
owner.sys_id	Sys_id des Anwenderdatensatzes der Person, die Besitzer des Leads ist. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
Grund	Grund für die Disqualifikation des Leads, z. B. Disqualifizieren. Datentyp: Zeichenfolge Max. Länge: 40 Zeichen
short_description	Kurze Beschreibung des Leads. Datentyp: Zeichenfolge Max. Länge: 160 Zeichen
Similar_Lead	Details zu einem ähnlichen Lead. Verwenden Sie dies für eine mögliche Lead-Disqualifizierung. Datentyp: Objekt `"similar_lead": { "name": "String", "sys_id": "String" }`
ähnliche_lead.name	Name des doppelten Leads Datentyp: Zeichenfolge
Similar_Lead.Sys_ID	Sys_id des Lead-Datensatzes, bei dem es sich um einen möglichen doppelten Lead handelt. Datentyp: Zeichenfolge Tabelle: Lead [sn_lead_mgmt_core_lead]
Phase	Phase des Leads, z. B. 100_new. Hinweis: Dies ist ein Auswahlfeld. Sie muss eines der Auswahlelemente enthalten, die im Feld „Phase“ der Tabelle „Leads“ definiert sind. Datentyp: Zeichenfolge
state	Bundesstaat, in dem sich der Lead befindet. Datentyp: Zeichenfolge
Straße	Straße, in der der Lead ansässig ist Datentyp: Zeichenfolge
sys_class_name	Vom System generierter Klassenname für die Lead-Tabelle Datentyp: Zeichenfolge
sys_created_by	Anwendername der Person, die den Lead erstellt hat Datentyp: Zeichenfolge
sys_created_on	Vom System generierter Zeitpunkt (Datum und Uhrzeit), zu dem der Lead erstellt wurde Datentyp: Objekt `"sys_created_on": { "display_value": "String", "value": "String" }`
sys_created_on.display_value	Datum und Uhrzeit der Erstellung des Leads. Datentyp: Zeichenfolge Format: Standardformat und Zeitzone für Instanz
sys_created_on.Wert	Datum und Uhrzeit der Erstellung des Leads. Datentyp: Zeichenfolge Format: UTC
sys_domain	Sys_id des Domänendatensatzes, zu dem der Lead gehört. Hinweis: Dieser Parameter wird nur in der Antwort zurückgegeben, wenn Domain Separation aktiviert ist. Datentyp: Zeichenfolge
sys_domain_path	Pfad der Domäne, zu der der Lead gehört. Hinweis: Dieser Parameter wird nur in der Antwort zurückgegeben, wenn Domain Separation aktiviert ist. Datentyp: Zeichenfolge
sys_id	Sys_id des Lead-Datensatzes. Datentyp: Zeichenfolge Tabelle: Lead [sn_lead_mgmt_core_lead]
sys_mod_count	Anzahl der Änderungen des zugeordneten Lead-Datensatzes. Datentyp: Zahl (Ganzzahl)
sys_tags	Liste der System-Tags, die dem Lead zugeordnet sind Sie können diese Tags verwenden, um Leads zu kategorisieren. Datentyp: Array
sys_updated_by	Anwendername der Person, die den Lead-Datensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge
sys_updated_on	Vom System generierter Zeitpunkt (Datum und Uhrzeit) der letzten Aktualisierung des Leads Datentyp: Objekt `"sys_created_on": { "display_value": "String", "value": "String" }`
sys_updated_on.display_value	Datum und Uhrzeit der letzten Aktualisierung des Leads. Datentyp: Zeichenfolge Format: Standardformat und Zeitzone der Instanz
sys_updated_on.Wert	Datum und Uhrzeit der letzten Aktualisierung des Leads. Datentyp: Zeichenfolge Format: UTC
Titel	Titel des Leads. Datentyp: Zeichenfolge
Website von	Website-URL des Lead. Datentyp: Zeichenfolge
work_notes	Liste der für den Lead erstellten Arbeitsnotizen Datentyp: Array von Objekten `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
work_notes.author	Anwendername der Person, die die zugehörige Arbeitsnotiz verfasst hat. Datentyp: Zeichenfolge
work_notes.date	Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge
work_notes.text	Text der Notiz vom Autor. Datentyp: Zeichenfolge
Postleitzahl	Postleitzahl des zugeordneten Leads. Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Codebeispiel zeigt, wie der Lead-Datensatz mit der sys_id 856b6a95ffde8210b85dffffffffffd7 abgerufen wird.

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

Die folgenden Ergebnisse wurden zurückgegeben:

{ 
  "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
    }
  ]
}

Lead – PATCH /sn_lead_mgmt_core/lead/{sys_id}

Aktualisiert den angegebenen Lead-Datensatz und die zugehörigen Lead-Positionselemente. Sie können diesen Endpunkt auch verwenden, um dem angegebenen Lead neue Lead-Positionselemente zuzuordnen.

Dieser Endpunkt aktualisiert Informationen in den folgenden Tabellen:

Lead [sn_lead_mgmt_core_lead]
Lead-Positionselement [sn_lead_mgmt_core_lead_line_item]

Regeln für übergebene Parameter:

Ungültige Parameternamen werden ignoriert.
Ungültige Werte für nicht obligatorische Auswahl- und Referenzfelder werden ignoriert.
Wenn der Feld-Schreibzugriff für ein oder mehrere Felder verweigert wird, werden die eingeschränkten Felder ignoriert.
Sie können mit dieser API keine Systemfeldwerte einfügen. Alle angegebenen Werte werden ignoriert. Systemfelder sind Teil der Liste der ignorierten Felder, die konfigurierbar ist.
Die Werte der Parameter account, contactund consumer werden ignoriert, wenn die Parameter account und consumer nicht leer sind.
Sofern nicht anders angegeben, ist der Standardwert für alle nicht übergebenen Parameter „null“.

Hinweis:

Dieser Endpunkt ändert nur die angegebenen Parameter. Wenn ein Parameter, der im aktuellen Lead- oder Lead-Positionselement-Datensatz vorhanden ist, im Anruf nicht angegeben wird, bleibt sein Inhalt unverändert.

URL-Format

URL mit Versionsnummer: /api/sn_lead_mgmt_core/{api_version}/lead/{sys_id}

Standard-URL: /api/sn_lead_mgmt_core/{api_version}/lead/{sys_id}

Hinweis:

Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

Unterstützte Anforderungsparameter

Tabelle : 13. Pfadparameter
Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel `v1` oder `v2`. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
sys_id	Sys_id des zu aktualisierenden Lead-Datensatzes. Datentyp: Zeichenfolge Tabelle: Lead [sn_lead_mgmt_core_lead]

Tabelle : 14. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 15. Anforderungstextparameter
Name	Beschreibung
Account	Details des Accounts, der dem Lead zugeordnet ist. Datentyp: Objekt `"account": { "sys_id": "String" }`
account.sys_id	Sys_id des zugeordneten Account-Datensatzes. Datentyp: Zeichenfolge Tabelle: Account [customer_account]
business_phone	Geschäftliche Telefonnummer des Lead. Datentyp: Zeichenfolge
city	Stadt, in der sich der Lead befindet. Datentyp: Zeichenfolge
Unternehmen	Unternehmensname des Leads. Datentyp: Zeichenfolge
Verbraucher	Verbraucher, der dem Lead zugeordnet ist. Datentyp: Objekt `"consumer": { "sys_id": "String" }`
Verbraucher.sys_id	Sys_id des zugeordneten Verbraucherdatensatzes. Datentyp: Zeichenfolge Tabelle: Verbraucher [csm_consumer]
Kontakt	Kontakt, der dem Lead-Account zugeordnet ist. Datentyp: Objekt `"contact": { "sys_id": "String" }`
kontakt.sys_id	Sys_id des zugeordneten Kontaktdatensatzes. Datentyp: Zeichenfolge Tabelle: Kontakt [customer_contact]
country	Land, in dem der Lead ansässig ist Datentyp: Zeichenfolge
do_not_call	Kennzeichnung, die angibt, ob der Kommunikationsmodus Telefon ist. Gültige Werte: wahr: Kann Kontakt anrufen. false: Kontakt nicht anrufen. Datentyp: Boolesch
do_not_email	Kennzeichnung, die angibt, ob der Kommunikationsmodus per E-Mail erfolgt. Gültige Werte: true: Kann Kontakt per E-Mail senden. „falsch“: Keine E-Mail an Kontakt senden. Datentyp: Boolesch
do_not_share	Kennzeichnung, die angibt, ob die Lead-Details geteilt werden können. Gültige Werte: wahr: Lead-Details können geteilt werden. „falsch“: Lead-Details können nicht geteilt werden. Datentyp: Boolesch
E-Mail	E-Mail-Adresse des Leads. Datentyp: Zeichenfolge
external_id	ID, die vom System, das den Lead generiert hat, verwendet wird, um den Lead im zugeordneten System zu identifizieren. Datentyp: Zeichenfolge
external_system	Name des externen Systems, das dem Lead zugeordnet ist, z. B. HubSpot oder Pipedrive. Datentyp: Zeichenfolge
first_name	Vorname des Kontakts, der dem Lead zugeordnet ist Datentyp: Zeichenfolge
Branche	Branche, zu der der Lead gehört. Datentyp: Zeichenfolge Tabelle: Befindet sich im Feld industry der Tabelle „Account“ [customer_account].
last_name	Erforderlich. Nachname des Kontakts, der dem Lead zugeordnet ist Datentyp: Zeichenfolge
Lead_group	Gruppe, zu der der Lead gehört Datentyp: Objekt `"lead_group": { "sys_id": "String" }`
„lead_group.sys_id“	Sys_id des Lead-Gruppendatensatzes. Datentyp: Zeichenfolge Tabelle: Gruppe [sys_user_group]
„lead_line_items“	Liste der Lead-Positionselemente, die dem Lead zugeordnet werden sollen. Gruppe, zu der der Lead gehört Datentyp: Objekt `"lead_line_items": [ { "external_id": "String", "external_system": "String", "product_offering": {Object}, "quantity": Number, "work_notes": [Array], "unit_of_measurement": {Object} } ]` Maximale Einzelposten: 100 - alle darüber hinaus werden ignoriert
„lead_line_items.external_id“	ID, die vom System verwendet wird, das das Lead-Positionselement generiert hat, um das Positionselement im zugeordneten System zu identifizieren. Datentyp: Zeichenfolge
„lead_line_items.external_system“	Name des externen Systems, das dem Lead-Positionselement zugeordnet ist, z. B. HubSpot oder Pipedrive. Datentyp: Zeichenfolge
„lead_line_items.product_offering“	Erforderlich. Informationen zum Produktangebot, das dem Lead-Positionselement zugeordnet ist. Datentyp: Objekt `"product_offering": { "sys_id": "String" }`
„lead_line_items.product_offering.sys_id“	Erforderlich. Sys_id des Produktangebotdatensatzes, der dem Lead-Positionselement zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering]
„lead_line_items.quantity“	Menge der Artikel, die der Lead für das zugehörige Produktangebot kaufen möchte. Datentyp: Zahl (Ganzzahl)
Lead_line_items.unit_of_measurement	Details zur Maßeinheit des Lead-Positionselements. Datentyp: Objekt `"unit_of_measurement": { "sys_id": "String" }`
„lead_line_items.unit_of_measurement.sys_id“	Sys_id des Datensatzes, der die Maßeinheit beschreibt. Datentyp: Zeichenfolge Tabelle: Maßeinheit [sn_prd_pm_uom]
„lead_line_items.work_notes“	Liste, die die für das Lead-Positionselement erstellten Arbeitsnotizen beschreibt. Datentyp: Array von Objekten `"work_notes": [ "text": "String" } ]`
„lead_line_items.work_notes.text“	Text der Notiz vom Autor. Datentyp: Zeichenfolge
Lead_rating	Bewertung für den Lead, z. B. 100_cold, 200_warm, 300_Hot oder 400_Super_Hot. Hinweis: Dies ist ein Auswahlfeld. Sie muss eines der Auswahlelemente enthalten, die im Feld „lead_rating“ der Lead-Tabelle definiert sind. Datentyp: Zeichenfolge
Lead_score	Punktzahl für den Lead. Datentyp: Dezimalzahl Bereich: 1 bis 100
Lead_source	Urheber des Leads. Hinweis: Dies ist ein Auswahlfeld. Sie muss eines der Auswahlelemente enthalten, die im Feld „lead_source“ der Lead-Tabelle definiert sind. Datentyp: Zeichenfolge
Lead_type	Typ des Leads, z. B. „Neues Geschäft“ oder „Bestehendes Geschäft“. Hinweis: Dies ist ein Auswahlfeld. Sie muss eines der Auswahlelemente enthalten, die im Feld „lead_type“ der Lead-Tabelle definiert sind. Datentyp: Zeichenfolge
Middle_name	Zweiter Vorname des Kontakts für den Lead Datentyp: Zeichenfolge
mobile_phone	Telefonnummer des Kontakts für den Lead Datentyp: Zeichenfolge
other_reason	Zusätzlicher Grund für die Disqualifikation des Leads. Datentyp: Zeichenfolge Max. Länge: 160 Zeichen
owner	Details der Person, die dem Lead zugeordnet ist. Datentyp: Objekt `"owner": { "sys_id": "String" }`
owner.sys_id	Sys_id des Anwenderdatensatzes der Person, die Besitzer des Leads ist. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
Grund	Grund für die Disqualifikation des Leads, z. B. Disqualifizieren. Datentyp: Zeichenfolge Max. Länge: 40 Zeichen
short_description	Kurze Beschreibung des Leads. Datentyp: Zeichenfolge Max. Länge: 160 Zeichen
Similar_Lead	Details zu einem ähnlichen Lead. Verwenden Sie dies für eine mögliche Lead-Disqualifizierung. Datentyp: Objekt `"similar_lead": { "sys_id": "String" }`
Similar_Lead.Sys_ID	Sys_id des Lead-Datensatzes, bei dem es sich um einen möglichen doppelten Lead handelt. Datentyp: Zeichenfolge Tabelle: Lead [sn_lead_mgmt_core_lead]
Phase	Phase des Leads, z. B. 100_new. Hinweis: Dies ist ein Auswahlfeld. Sie muss eines der Auswahlelemente enthalten, die im Feld „Phase“ der Tabelle „Leads“ definiert sind. Datentyp: Zeichenfolge
state	Bundesstaat, in dem sich der Lead befindet. Datentyp: Zeichenfolge
Straße	Straße, in der der Lead ansässig ist Datentyp: Zeichenfolge
Titel	Titel des Leads. Datentyp: Zeichenfolge
Website von	Website-URL des Lead. Datentyp: Zeichenfolge
work_notes	Liste der für den Lead erstellten Arbeitsnotizen Datentyp: Array von Objekten `"work_notes": [ { "text": "String" } ]` Hinweis: Ein Array von Arbeitsnotizen in der Anforderung wird als einzelner Text eingefügt. Dieser Text wird durch Kombinieren des Inhalts aus allen Arbeitsnotizobjekten in der Anforderung generiert, wobei jeder Eintrag durch ein Komma (,) getrennt wird.
work_notes.text	Text der Notiz vom Autor. Datentyp: Zeichenfolge
Postleitzahl	Postleitzahl des zugeordneten Leads. Datentyp: Zeichenfolge

Header

Tabelle : 16. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

Tabelle : 17. Antwortkopfzeilen
Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.

Tabelle : 18. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Lead- und Lead-Positionselemente-Datensätze wurden erfolgreich aktualisiert.
400	Fehler. Mögliche Gründe: Ungültige Nutzlast: Ungültiger/leerer Anforderungstext. Ungültige Nutzlast: Ungültiger Feldwert für E-Mail-/Telefonnummernfelder. Ungültige Nutzlast: Pflichtfeld fehlt, oder sein Wert ist leer. Ungültige Nutzlast: Phase ist „400_closed_won“. Qualifizierender Lead wird bei Verwendung der API nicht unterstützt. Wenn sich die Phase des zu aktualisierenden Leads bereits im Status „Geschlossen“ befindet und Sie versuchen, sie zu aktualisieren.
403	Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antwort-Haupttexts


Name	Beschreibung
Account	Account, der mit dem Lead verknüpft ist. Datentyp: Objekt `"account": { "name": "String", "sys_id": "String" }`
account.name	Name des Kontos. Datentyp: Zeichenfolge
account.sys_id	Sys_id des zugeordneten Account-Datensatzes. Datentyp: Zeichenfolge Tabelle: Account [customer_account]
business_phone	Geschäftliche Telefonnummer des Lead. Datentyp: Zeichenfolge
city	Stadt, in der sich der Lead befindet. Datentyp: Zeichenfolge
closed_date	Datum und Uhrzeit des Abschlusses des Leads. Datentyp: Objekt `"closed_date": { "display_value": "String", "value": "String" }`
closed_date.display_value	Datum und Uhrzeit, wie in der Anwenderoberfläche angezeigt. Datentyp: Zeichenfolge Format: Format und Zeitzone des Anwenders.
closed_date.value	Datum und Uhrzeit des Abschlusses des Leads, wie im zugehörigen Datensatz definiert. Datentyp: Zeichenfolge Format: UTC
Unternehmen	Unternehmensname des Leads. Datentyp: Zeichenfolge
Verbraucher	Verbraucher, der dem Lead zugeordnet ist. Datentyp: Objekt `"consumer": { "name": "String", "sys_id": "String" }`
consumer.name	Name des zugeordneten Verbrauchers Datentyp: Zeichenfolge
Verbraucher.sys_id	Sys_id des zugeordneten Verbraucherdatensatzes. Datentyp: Zeichenfolge Tabelle: Verbraucher [csm_consumer]
Kontakt	Kontakt, der dem Lead-Account zugeordnet ist. Datentyp: Objekt `"contact": { "name": "String", "sys_id": "String" }`
kontakt.name	Kontaktname Datentyp: Zeichenfolge
kontakt.sys_id	Sys_id des zugeordneten Kontaktdatensatzes. Datentyp: Zeichenfolge Tabelle: Kontakt [customer_contact]
country	Land, in dem der Lead ansässig ist Datentyp: Zeichenfolge
do_not_call	Kennzeichnung, die angibt, ob der Kommunikationsmodus Telefon ist. Gültige Werte: wahr: Kann Kontakt anrufen. false: Kontakt nicht anrufen. Datentyp: Boolesch
do_not_email	Kennzeichnung, die angibt, ob der Kommunikationsmodus per E-Mail erfolgt. Gültige Werte: true: Kann Kontakt per E-Mail senden. „falsch“: Keine E-Mail an Kontakt senden. Datentyp: Boolesch
do_not_share	Kennzeichnung, die angibt, ob die Lead-Details geteilt werden können. Gültige Werte: wahr: Lead-Details können geteilt werden. „falsch“: Lead-Details können nicht geteilt werden. Datentyp: Boolesch
E-Mail	E-Mail-Adresse des Leads. Datentyp: Zeichenfolge
external_id	ID, die vom System, das den Lead generiert hat, verwendet wird, um den Lead im zugeordneten System zu identifizieren. Datentyp: Zeichenfolge
external_system	Name des externen Systems, das dem Lead zugeordnet ist, z. B. HubSpot oder Pipedrive. Datentyp: Zeichenfolge
first_name	Vorname des Kontakts, der dem Lead zugeordnet ist Datentyp: Zeichenfolge
Branche	Branche, zu der der Lead gehört. Datentyp: Zeichenfolge Tabelle: Befindet sich im Feld industry der Tabelle „Account“ [customer_account].
last_name	Nachname des Kontakts, der dem Lead zugeordnet ist Datentyp: Zeichenfolge
Lead_group	Gruppe, zu der der Lead gehört Datentyp: Objekt `"lead_group": { "name: "String", "sys_id": "String" }`
Lead_group.name	Name der Lead-Gruppe. Datentyp: Zeichenfolge
„lead_group.sys_id“	Sys_id des Lead-Gruppendatensatzes. Datentyp: Zeichenfolge Tabelle: Gruppe [sys_user_group]
„lead_line_items“	Details der Lead-Positionselemente, die dem Lead zugeordnet sind. Datentyp: Array von Objekten `"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, die vom System verwendet wird, das das Lead-Positionselement generiert hat, um das Positionselement im zugeordneten System zu identifizieren. Datentyp: Zeichenfolge
„lead_line_items.external_system“	Name des externen Systems, das dem Lead-Positionselement zugeordnet ist, z. B. HubSpot oder Pipedrive. Datentyp: Zeichenfolge
Lead_line_items.Lead	Details zum Lead, der der Position zugeordnet ist. Datentyp: Objekt `"lead: { "name": "String", "sys_id": "String" }`
„lead_line_items.lead.name“	Name des zugeordneten Leads. Datentyp: Zeichenfolge
„lead_line_items.lead.sys_id“	Sys_id des zugeordneten Lead-Datensatzes. Datentyp: Zeichenfolge
„lead_line_items.number“	Eindeutige, vom System generierte Nummer des Lead-Positionselement-Datensatzes. Datentyp: Zeichenfolge
„lead_line_items.product_offering“	Informationen zum Produktangebot, das dem Lead-Positionselement zugeordnet ist. Datentyp: Objekt `"product_offering": { "code": " String", "name": "String", "sys_id": "String" }`
„lead_line_items.product_offering.code“	Code, der mit dem Produktangebot verknüpft ist. Hinweis: Dies ist eine vom System generierte alphanumerische Nummer, die auf dem Produktnamen basiert. Obwohl der Code vom System generiert wird, können Sie den Code so bearbeiten, dass er eine SKU oder andere branchenspezifische Produktcodes darstellt. Datentyp: Zeichenfolge
„lead_line_items.product_offering.name“	Name des Produktangebots Datentyp: Zeichenfolge
„lead_line_items.product_offering.sys_id“	Sys_id des Produktangebotdatensatzes, der dem Lead-Positionselement zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering]
„lead_line_items.menge“	Menge der Artikel, die der Lead für das zugehörige Produktangebot kaufen möchte. Datentyp: Zahl (Ganzzahl)
„lead_line_items.sys_created_by“	Anwendername der Person, die das Lead-Positionselement erstellt hat Datentyp: Zeichenfolge
„lead_line_items.sys_created_on“	Vom System generierter Zeitpunkt (Datum und Uhrzeit), zu dem das Lead-Positionselement erstellt wurde Datentyp: Objekt `"sys_created_on": { "display_value": "String", "value": "String" }`
„lead_line_items.sys_created_on.display_value“	Datum und Uhrzeit der Erstellung des Lead-Positionselements. Datentyp: Zeichenfolge Format: Standardformat und Zeitzone für Instanz
„lead_line_items.sys_created_on.value“	Datum und Uhrzeit der Erstellung des Lead-Positionselements. Datentyp: Zeichenfolge Format: UTC
„lead_line_items.sys_domain“	Sys_id des Domänendatensatzes, zu dem das Lead-Positionselement gehört. Hinweis: Dieser Parameter wird nur in der Antwort zurückgegeben, wenn Domain Separation aktiviert ist. Datentyp: Zeichenfolge
„lead_line_items.sys_domain_path“	Pfad der Domäne, zu der das Lead-Positionselement gehört. Hinweis: Dieser Parameter wird nur in der Antwort zurückgegeben, wenn Domain Separation aktiviert ist. Datentyp: Zeichenfolge
„lead_line_items.sys_id“	Sys_id des Lead-Positionselement-Datensatzes. Datentyp: Zeichenfolge
„lead_line_items.sys_mod_count“	Anzahl der Änderungen des zugehörigen Lead-Positionselement-Datensatzes. Datentyp: Zahl (Ganzzahl)
„lead_line_items.sys_tags“	Liste der System-Tags, die dem Lead-Positionselement zugeordnet sind Datentyp: Array
„lead_line_items.sys_updated_by“	Anwendername der Person, die das zugehörige Lead-Positionselement zuletzt aktualisiert hat. Datentyp: Zeichenfolge
„lead_line_items.sys_updated_on“	Vom System generiertes Datum und Uhrzeit der letzten Aktualisierung des Lead-Positionselements. Datentyp: Objekt `"sys_created_on": { "display_value": "String", "value": "String" }`
„lead_line_items.sys_updated_on.display_value“	Datum und Uhrzeit der letzten Aktualisierung des Lead-Positionselements. Datentyp: Zeichenfolge Format: Standardformat und Zeitzone für Instanz
„lead_line_items.sys_updated_on.value“	Datum und Uhrzeit der letzten Aktualisierung des Lead-Positionselements. Datentyp: Zeichenfolge Format: UTC
Lead_line_items.unit_of_measurement	Details zur Maßeinheit des Lead-Positionselements. Datentyp: Objekt `"unit_of_measurement": { "name": "String", "sys_id": "String" }`
„lead_line_items.unit_of_measurement.name“	Name der Maßeinheit, z. B. Stück oder Kubikfuß. Datentyp: Zeichenfolge
„lead_line_items.unit_of_measurement.sys_id“	Sys_id des Datensatzes, der die Maßeinheit beschreibt. Datentyp: Zeichenfolge Tabelle: Maßeinheit [sn_prd_pm_uom]
„lead_line_items.work_notes“	Liste, die die für das Lead-Positionselement erstellten Arbeitsnotizen beschreibt. Datentyp: Array von Objekten `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
Lead_line_items.work_notes.author	Anwendername der Person, die die zugehörige Arbeitsnotiz verfasst hat. Datentyp: Zeichenfolge
„lead_line_items.work_notes.date“	Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge
„lead_line_items.work_notes.text“	Text der Notiz vom Autor. Datentyp: Zeichenfolge
Lead_rating	Bewertung für den Lead, z. B. 100_cold, 200_warm, 300_Hot oder 400_Super_Hot. Hinweis: Dies ist ein Auswahlfeld. Sie muss eines der Auswahlelemente enthalten, die im Feld „lead_rating“ der Lead-Tabelle definiert sind. Datentyp: Zeichenfolge
Lead_score	Punktzahl für den Lead. Datentyp: Dezimalzahl Bereich: 1 bis 100
Lead_source	Urheber des Leads. Hinweis: Dies ist ein Auswahlfeld. Sie muss eines der Auswahlelemente enthalten, die im Feld „lead_source“ der Lead-Tabelle definiert sind. Datentyp: Zeichenfolge
Lead_type	Typ des Leads, z. B. „Neues Geschäft“ oder „Bestehendes Geschäft“. Hinweis: Dies ist ein Auswahlfeld. Sie muss eines der Auswahlelemente enthalten, die im Feld „lead_type“ der Lead-Tabelle definiert sind. Datentyp: Zeichenfolge
Middle_name	Zweiter Vorname des Kontakts für den Lead Datentyp: Zeichenfolge
mobile_phone	Telefonnummer des Kontakts für den Lead Datentyp: Zeichenfolge
Nummer	Eindeutige, vom System generierte Nummer des Lead-Datensatzes. Datentyp: Zeichenfolge
other_reason	Zusätzlicher Grund für die Disqualifikation des Leads. Datentyp: Zeichenfolge Max. Länge: 160 Zeichen
owner	Details der Person, die dem Lead zugeordnet ist. Datentyp: Objekt `"owner": { "name": "String", "sys_id": "String" }`
owner.name	Name der Person, die Besitzer des Leads ist. Datentyp: Zeichenfolge
owner.sys_id	Sys_id des Anwenderdatensatzes der Person, die Besitzer des Leads ist. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
Grund	Grund für die Disqualifikation des Leads, z. B. Disqualifizieren. Datentyp: Zeichenfolge Max. Länge: 40 Zeichen
short_description	Kurze Beschreibung des Leads. Datentyp: Zeichenfolge Max. Länge: 160 Zeichen
Similar_Lead	Details zu einem ähnlichen Lead. Verwenden Sie dies für eine mögliche Lead-Disqualifizierung. Datentyp: Objekt `"similar_lead": { "name": "String", "sys_id": "String" }`
ähnliche_lead.name	Name des doppelten Leads Datentyp: Zeichenfolge
Similar_Lead.Sys_ID	Sys_id des Lead-Datensatzes, bei dem es sich um einen möglichen doppelten Lead handelt. Datentyp: Zeichenfolge Tabelle: Lead [sn_lead_mgmt_core_lead]
Phase	Phase des Leads, z. B. 100_new. Hinweis: Dies ist ein Auswahlfeld. Sie muss eines der Auswahlelemente enthalten, die im Feld „Phase“ der Tabelle „Leads“ definiert sind. Datentyp: Zeichenfolge
state	Bundesstaat, in dem sich der Lead befindet. Datentyp: Zeichenfolge
Straße	Straße, in der der Lead ansässig ist Datentyp: Zeichenfolge
sys_class_name	Vom System generierter Klassenname für die Lead-Tabelle Datentyp: Zeichenfolge
sys_created_by	Anwendername der Person, die den Lead erstellt hat Datentyp: Zeichenfolge
sys_created_on	Vom System generierter Zeitpunkt (Datum und Uhrzeit), zu dem der Lead erstellt wurde Datentyp: Objekt `"sys_created_on": { "display_value": "String", "value": "String" }`
sys_created_on.display_value	Datum und Uhrzeit der Erstellung des Leads. Datentyp: Zeichenfolge Format: Standardformat und Zeitzone für Instanz
sys_created_on.Wert	Datum und Uhrzeit der Erstellung des Leads. Datentyp: Zeichenfolge Format: UTC
sys_domain	Sys_id des Domänendatensatzes, zu dem der Lead gehört. Hinweis: Dieser Parameter wird nur in der Antwort zurückgegeben, wenn Domain Separation aktiviert ist. Datentyp: Zeichenfolge
sys_domain_path	Pfad der Domäne, zu der der Lead gehört. Hinweis: Dieser Parameter wird nur in der Antwort zurückgegeben, wenn Domain Separation aktiviert ist. Datentyp: Zeichenfolge
sys_id	Sys_id des Lead-Datensatzes. Datentyp: Zeichenfolge Tabelle: Lead [sn_lead_mgmt_core_lead]
sys_mod_count	Anzahl der Änderungen des zugeordneten Lead-Datensatzes. Datentyp: Zahl (Ganzzahl)
sys_tags	Liste der System-Tags, die dem Lead zugeordnet sind Sie können diese Tags verwenden, um Leads zu kategorisieren. Datentyp: Array
sys_updated_by	Anwendername der Person, die den Lead-Datensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge
sys_updated_on	Vom System generierter Zeitpunkt (Datum und Uhrzeit) der letzten Aktualisierung des Leads Datentyp: Objekt `"sys_created_on": { "display_value": "String", "value": "String" }`
sys_updated_on.display_value	Datum und Uhrzeit der letzten Aktualisierung des Leads. Datentyp: Zeichenfolge Format: Standardformat und Zeitzone der Instanz
sys_updated_on.Wert	Datum und Uhrzeit der letzten Aktualisierung des Leads. Datentyp: Zeichenfolge Format: UTC
Titel	Titel des Leads. Datentyp: Zeichenfolge
Website von	Website-URL des Lead. Datentyp: Zeichenfolge
work_notes	Liste der für den Lead erstellten Arbeitsnotizen Datentyp: Array von Objekten `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
work_notes.author	Anwendername der Person, die die zugehörige Arbeitsnotiz verfasst hat. Datentyp: Zeichenfolge
work_notes.date	Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge
work_notes.text	Text der Notiz vom Autor. Datentyp: Zeichenfolge
Postleitzahl	Postleitzahl des zugeordneten Leads. Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Codebeispiel zeigt, wie Sie den Lead-Datensatz mit der sys_id 856b6a95ffde8210b85dffffffffffd7 aktualisieren.

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"
      }
    }
  ]
}"

Die Antwort enthält alle Lead-Datensatzfelder.

{ 
  "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
    }
  ]
}

Lead: POST /sn_lead_mgmt_core/lead

Erstellt einen Lead-Datensatz und die zugehörigen Lead-Positionselemente anhand der angegebenen Parameter.

Nach der Verarbeitung werden Datensätze in den folgenden Tabellen erstellt:

Lead [sn_lead_mgmt_core_lead]
Lead-Positionselement [sn_lead_mgmt_core_lead_line_item]

Regeln für übergebene Parameter:

Ungültige Parameternamen werden ignoriert.
Ungültige Werte für nicht obligatorische Auswahl- und Referenzfelder werden ignoriert.
Wenn der Feld-Schreibzugriff für ein oder mehrere Felder verweigert wird, werden die eingeschränkten Felder ignoriert.
Sie können mit dieser API keine Systemfeldwerte einfügen. Alle angegebenen Werte werden ignoriert. Systemfelder sind Teil der Liste der ignorierten Felder, die konfigurierbar ist.
Die Werte der Parameter account, contactund consumer werden ignoriert, wenn die Parameter account und consumer nicht leer sind.
Sofern nicht anders angegeben, ist der Standardwert für alle nicht übergebenen Parameter „null“.

URL-Format

URL mit Versionsnummer: /api/sn_lead_mgmt_core/{api_version}/lead

Standard-URL: /api/sn_lead_mgmt_core/{api_version}/lead

Hinweis:

Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

Unterstützte Anforderungsparameter

Tabelle : 19. Pfadparameter
Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel `v1` oder `v2`. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 20. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 21. Anforderungstextparameter
Name	Beschreibung
Account	Details zum Account, der dem Lead zugeordnet ist. Datentyp: Objekt `"account": { "sys_id": "String" }`
account.sys_id	Sys_id des zugeordneten Account-Datensatzes. Datentyp: Zeichenfolge Tabelle: Account [customer_account]
business_phone	Geschäftliche Telefonnummer des Lead. Datentyp: Zeichenfolge
city	Stadt, in der sich der Lead befindet. Datentyp: Zeichenfolge
Unternehmen	Unternehmensname des Leads. Datentyp: Zeichenfolge
Verbraucher	Verbraucher, der dem Lead zugeordnet ist. Datentyp: Objekt `"consumer": { "sys_id": "String" }`
Verbraucher.sys_id	Sys_id des zugeordneten Verbraucherdatensatzes. Datentyp: Zeichenfolge Tabelle: Verbraucher [csm_consumer]
Kontakt	Kontakt, der dem Lead-Account zugeordnet ist. Datentyp: Objekt `"contact": { "sys_id": "String" }`
kontakt.sys_id	Sys_id des zugeordneten Kontaktdatensatzes. Datentyp: Zeichenfolge Tabelle: Kontakt [customer_contact]
country	Land, in dem der Lead ansässig ist Datentyp: Zeichenfolge
do_not_call	Kennzeichnung, die angibt, ob der Kommunikationsmodus Telefon ist. Gültige Werte: wahr: Kann Kontakt anrufen. false: Kontakt nicht anrufen. Datentyp: Boolesch Standardwert: false
do_not_email	Kennzeichnung, die angibt, ob der Kommunikationsmodus per E-Mail erfolgt. Gültige Werte: true: Kann Kontakt per E-Mail senden. „falsch“: Keine E-Mail an Kontakt senden. Datentyp: Boolesch Standardwert: false
do_not_share	Kennzeichnung, die angibt, ob die Lead-Details geteilt werden können. Gültige Werte: wahr: Lead-Details können geteilt werden. „falsch“: Lead-Details können nicht geteilt werden. Datentyp: Boolesch Standardwert: false
E-Mail	E-Mail-Adresse des Leads. Datentyp: Zeichenfolge
external_id	ID, die vom System, das den Lead generiert hat, verwendet wird, um den Lead im zugeordneten System zu identifizieren. Datentyp: Zeichenfolge
external_system	Name des externen Systems, das dem Lead zugeordnet ist, z. B. HubSpot oder Pipedrive. Datentyp: Zeichenfolge
first_name	Vorname des Kontakts, der dem Lead zugeordnet ist Datentyp: Zeichenfolge
Branche	Branche, zu der der Lead gehört. Datentyp: Zeichenfolge Tabelle: Befindet sich im Feld industry der Tabelle „Account“ [customer_account].
last_name	Erforderlich. Nachname des Kontakts, der dem Lead zugeordnet ist Datentyp: Zeichenfolge
Lead_group	Gruppe, zu der der Lead gehört Datentyp: Objekt `"lead_group": { "sys_id": "String" }`
„lead_group.sys_id“	Sys_id des Lead-Gruppendatensatzes. Datentyp: Zeichenfolge Tabelle: Gruppe [sys_user_group]
„lead_line_items“	Liste der Lead-Positionselemente, die dem Lead zugeordnet werden sollen. Gruppe, zu der der Lead gehört Datentyp: Objekt `"lead_line_items": [ { "external_id": "String", "external_system": "String", "product_offering": {Object}, "quantity": Number, "work_notes": [Array], "unit_of_measurement": {Object} } ]` Maximale Einzelposten: 100 - alle darüber hinaus werden ignoriert
„lead_line_items.external_id“	ID, die vom System verwendet wird, das das Lead-Positionselement generiert hat, um das Positionselement im zugeordneten System zu identifizieren. Datentyp: Zeichenfolge
„lead_line_items.external_system“	Name des externen Systems, das dem Lead-Positionselement zugeordnet ist, z. B. HubSpot oder Pipedrive. Datentyp: Zeichenfolge
„lead_line_items.product_offering“	Erforderlich. Informationen zum Produktangebot, das dem Lead-Positionselement zugeordnet ist. Datentyp: Objekt `"product_offering": { "sys_id": "String" }`
„lead_line_items.product_offering.sys_id“	Erforderlich. Sys_id des Produktangebotdatensatzes, der dem Lead-Positionselement zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering]
„lead_line_items.quantity“	Menge der Artikel, die der Lead für das zugehörige Produktangebot kaufen möchte. Datentyp: Zahl (Ganzzahl) Standard: 1
„lead_line_items.unit_of_measurement“	Details zur Maßeinheit des Lead-Positionselements. Datentyp: Objekt `"unit_of_measurement": { "sys_id": "String" }`
„lead_line_items.unit_of_measurement.sys_id“	Sys_id des Datensatzes, der die Maßeinheit beschreibt. Datentyp: Zeichenfolge Tabelle: Maßeinheit [sn_prd_pm_uom]
„lead_line_items.work_notes“	Liste, die die für das Lead-Positionselement erstellten Arbeitsnotizen beschreibt. Datentyp: Array von Objekten `"work_notes": [ "text": "String" } ]` Standard: Leeres Array
„lead_line_items.work_notes.text“	Text der Notiz vom Autor. Datentyp: Zeichenfolge
Lead_rating	Bewertung für den Lead, z. B. 100_cold, 200_warm, 300_Hot oder 400_Super_Hot. Hinweis: Dies ist ein Auswahlfeld. Sie muss eines der Auswahlelemente enthalten, die im Feld „lead_rating“ der Lead-Tabelle definiert sind. Datentyp: Zeichenfolge
Lead_score	Punktzahl für den Lead. Datentyp: Dezimalzahl Bereich: 1 bis 100
Lead_source	Urheber des Leads. Hinweis: Dies ist ein Auswahlfeld. Sie muss eines der Auswahlelemente enthalten, die im Feld „lead_source“ der Lead-Tabelle definiert sind. Datentyp: Zeichenfolge
Lead_type	Typ des Leads, z. B. „Neues Geschäft“ oder „Bestehendes Geschäft“. Hinweis: Dies ist ein Auswahlfeld. Sie muss eines der Auswahlelemente enthalten, die im Feld „lead_type“ der Lead-Tabelle definiert sind. Datentyp: Zeichenfolge
Middle_name	Zweiter Vorname des Kontakts für den Lead Datentyp: Zeichenfolge
mobile_phone	Telefonnummer des Kontakts für den Lead Datentyp: Zeichenfolge
other_reason	Zusätzlicher Grund für die Disqualifikation des Leads. Datentyp: Zeichenfolge Max. Länge: 160 Zeichen
owner	Details der Person, die dem Lead zugeordnet ist. Datentyp: Objekt `"owner": { "sys_id": "String" }`
owner.sys_id	Sys_id des Anwenderdatensatzes der Person, die Besitzer des Leads ist. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
Grund	Grund für die Disqualifikation des Leads, z. B. Disqualifizieren. Datentyp: Zeichenfolge Max. Länge: 40 Zeichen
short_description	Kurze Beschreibung des Leads. Datentyp: Zeichenfolge Max. Länge: 160 Zeichen
Similar_Lead	Details zu einem ähnlichen Lead. Verwenden Sie dies für eine mögliche Lead-Disqualifizierung. Datentyp: Objekt `"similar_lead": { "sys_id": "String" }`
Similar_Lead.Sys_ID	Sys_id des Lead-Datensatzes, bei dem es sich um einen möglichen doppelten Lead handelt. Datentyp: Zeichenfolge Tabelle: Lead [sn_lead_mgmt_core_lead]
Phase	Phase des Leads, z. B. 100_new. Hinweis: Dies ist ein Auswahlfeld. Sie muss eines der Auswahlelemente enthalten, die im Feld „Phase“ der Tabelle „Leads“ definiert sind. Datentyp: Zeichenfolge Standard: 100_new
state	Bundesstaat, in dem sich der Lead befindet. Datentyp: Zeichenfolge
Straße	Straße, in der der Lead ansässig ist Datentyp: Zeichenfolge
Titel	Titel des Leads. Datentyp: Zeichenfolge
Website von	Website-URL des Lead. Datentyp: Zeichenfolge
work_notes	Liste der für den Lead erstellten Arbeitsnotizen Datentyp: Array von Objekten `"work_notes": [ { "text": "String" } ]` Hinweis: Ein Array von Arbeitsnotizen in der Anforderung wird als einzelner Text eingefügt. Dieser Text wird durch Kombinieren des Inhalts aus allen Arbeitsnotizobjekten in der Anforderung generiert, wobei jeder Eintrag durch ein Komma (,) getrennt wird. Standard: Leeres Array
work_notes.text	Text der Notiz vom Autor. Datentyp: Zeichenfolge
Postleitzahl	Postleitzahl des zugeordneten Leads. Datentyp: Zeichenfolge

Header

Tabelle : 22. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.

Tabelle : 23. Antwortkopfzeilen
Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.

Tabelle : 24. Statuscodes
Statuscode	Beschreibung
201	Erfolgreich. Lead und zugehörige Einzelposten wurden erfolgreich eingefügt.
400	Fehler. Mögliche Gründe: Ungültige Nutzlast: Ungültiger/leerer Anforderungstext. Ungültige Nutzlast: Ungültiger Feldwert für E-Mail-/Telefonnummernfelder. Ungültige Nutzlast: Pflichtfeld fehlt, oder sein Wert ist leer. Verstoß gegen Business-Regel/Datenrichtlinie.
403	Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antwort-Haupttexts


Name	Beschreibung
Account	Account, der mit dem Lead verknüpft ist. Datentyp: Objekt `"account": { "name": "String", "sys_id": "String" }`
account.name	Name des Kontos. Datentyp: Zeichenfolge
account.sys_id	Sys_id des zugeordneten Account-Datensatzes. Datentyp: Zeichenfolge Tabelle: Account [customer_account]
business_phone	Geschäftliche Telefonnummer des Lead. Datentyp: Zeichenfolge
city	Stadt, in der sich der Lead befindet. Datentyp: Zeichenfolge
closed_date	Datum und Uhrzeit des Abschlusses des Leads. Datentyp: Objekt `"closed_date": { "display_value": "String", "value": "String" }`
closed_date.display_value	Datum und Uhrzeit, wie in der Anwenderoberfläche angezeigt. Datentyp: Zeichenfolge Format: Format und Zeitzone des Anwenders.
closed_date.value	Datum und Uhrzeit des Abschlusses des Leads, wie im zugehörigen Datensatz definiert. Datentyp: Zeichenfolge Format: UTC
Unternehmen	Unternehmensname des Leads. Datentyp: Zeichenfolge
Verbraucher	Verbraucher, der dem Lead zugeordnet ist. Datentyp: Objekt `"consumer": { "name": "String", "sys_id": "String" }`
consumer.name	Name des zugeordneten Verbrauchers Datentyp: Zeichenfolge
Verbraucher.sys_id	Sys_id des zugeordneten Verbraucherdatensatzes. Datentyp: Zeichenfolge Tabelle: Verbraucher [csm_consumer]
Kontakt	Kontakt, der dem Lead-Account zugeordnet ist. Datentyp: Objekt `"contact": { "name": "String", "sys_id": "String" }`
kontakt.name	Kontaktname Datentyp: Zeichenfolge
kontakt.sys_id	Sys_id des zugeordneten Kontaktdatensatzes. Datentyp: Zeichenfolge Tabelle: Kontakt [customer_contact]
country	Land, in dem der Lead ansässig ist Datentyp: Zeichenfolge
do_not_call	Kennzeichnung, die angibt, ob der Kommunikationsmodus Telefon ist. Gültige Werte: wahr: Kann Kontakt anrufen. false: Kontakt nicht anrufen. Datentyp: Boolesch
do_not_email	Kennzeichnung, die angibt, ob der Kommunikationsmodus per E-Mail erfolgt. Gültige Werte: true: Kann Kontakt per E-Mail senden. „falsch“: Keine E-Mail an Kontakt senden. Datentyp: Boolesch
do_not_share	Kennzeichnung, die angibt, ob die Lead-Details geteilt werden können. Gültige Werte: wahr: Lead-Details können geteilt werden. „falsch“: Lead-Details können nicht geteilt werden. Datentyp: Boolesch
E-Mail	E-Mail-Adresse des Leads. Datentyp: Zeichenfolge
external_id	ID, die vom System, das den Lead generiert hat, verwendet wird, um den Lead im zugeordneten System zu identifizieren. Datentyp: Zeichenfolge
external_system	Name des externen Systems, das dem Lead zugeordnet ist, z. B. HubSpot oder Pipedrive. Datentyp: Zeichenfolge
first_name	Vorname des Kontakts, der dem Lead zugeordnet ist Datentyp: Zeichenfolge
Branche	Branche, zu der der Lead gehört. Datentyp: Zeichenfolge Tabelle: Befindet sich im Feld industry der Tabelle „Account“ [customer_account].
last_name	Nachname des Kontakts, der dem Lead zugeordnet ist Datentyp: Zeichenfolge
Lead_group	Gruppe, zu der der Lead gehört Datentyp: Objekt `"lead_group": { "name: "String", "sys_id": "String" }`
Lead_group.name	Name der Lead-Gruppe. Datentyp: Zeichenfolge
„lead_group.sys_id“	Sys_id des Lead-Gruppendatensatzes. Datentyp: Zeichenfolge Tabelle: Gruppe [sys_user_group]
„lead_line_items“	Details der Lead-Positionselemente, die dem Lead zugeordnet sind. Datentyp: Array von Objekten `"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, die vom System verwendet wird, das das Lead-Positionselement generiert hat, um das Positionselement im zugeordneten System zu identifizieren. Datentyp: Zeichenfolge
„lead_line_items.external_system“	Name des externen Systems, das dem Lead-Positionselement zugeordnet ist, z. B. HubSpot oder Pipedrive. Datentyp: Zeichenfolge
Lead_line_items.Lead	Details zum Lead, der der Position zugeordnet ist. Datentyp: Objekt `"lead: { "name": "String", "sys_id": "String" }`
„lead_line_items.lead.name“	Name des zugeordneten Leads. Datentyp: Zeichenfolge
„lead_line_items.lead.sys_id“	Sys_id des zugeordneten Lead-Datensatzes. Datentyp: Zeichenfolge
„lead_line_items.number“	Eindeutige, vom System generierte Nummer des Lead-Positionselement-Datensatzes. Datentyp: Zeichenfolge
„lead_line_items.product_offering“	Informationen zum Produktangebot, das dem Lead-Positionselement zugeordnet ist. Datentyp: Objekt `"product_offering": { "code": " String", "name": "String", "sys_id": "String" }`
„lead_line_items.product_offering.code“	Code, der mit dem Produktangebot verknüpft ist. Hinweis: Dies ist eine vom System generierte alphanumerische Nummer, die auf dem Produktnamen basiert. Obwohl der Code vom System generiert wird, können Sie den Code so bearbeiten, dass er eine SKU oder andere branchenspezifische Produktcodes darstellt. Datentyp: Zeichenfolge
„lead_line_items.product_offering.name“	Name des Produktangebots Datentyp: Zeichenfolge
„lead_line_items.product_offering.sys_id“	Sys_id des Produktangebotdatensatzes, der dem Lead-Positionselement zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering]
„lead_line_items.menge“	Menge der Artikel, die der Lead für das zugehörige Produktangebot kaufen möchte. Datentyp: Zahl (Ganzzahl)
„lead_line_items.sys_created_by“	Anwendername der Person, die das Lead-Positionselement erstellt hat Datentyp: Zeichenfolge
„lead_line_items.sys_created_on“	Vom System generierter Zeitpunkt (Datum und Uhrzeit), zu dem das Lead-Positionselement erstellt wurde Datentyp: Objekt `"sys_created_on": { "display_value": "String", "value": "String" }`
„lead_line_items.sys_created_on.display_value“	Datum und Uhrzeit der Erstellung des Lead-Positionselements. Datentyp: Zeichenfolge Format: Standardformat und Zeitzone für Instanz
„lead_line_items.sys_created_on.value“	Datum und Uhrzeit der Erstellung des Lead-Positionselements. Datentyp: Zeichenfolge Format: UTC
„lead_line_items.sys_domain“	Sys_id des Domänendatensatzes, zu dem das Lead-Positionselement gehört. Hinweis: Dieser Parameter wird nur in der Antwort zurückgegeben, wenn Domain Separation aktiviert ist. Datentyp: Zeichenfolge
„lead_line_items.sys_domain_path“	Pfad der Domäne, zu der das Lead-Positionselement gehört. Hinweis: Dieser Parameter wird nur in der Antwort zurückgegeben, wenn Domain Separation aktiviert ist. Datentyp: Zeichenfolge
„lead_line_items.sys_id“	Sys_id des Lead-Positionselement-Datensatzes. Datentyp: Zeichenfolge
„lead_line_items.sys_mod_count“	Anzahl der Änderungen des zugehörigen Lead-Positionselement-Datensatzes. Datentyp: Zahl (Ganzzahl)
„lead_line_items.sys_tags“	Liste der System-Tags, die dem Lead-Positionselement zugeordnet sind Datentyp: Array
„lead_line_items.sys_updated_by“	Anwendername der Person, die das zugehörige Lead-Positionselement zuletzt aktualisiert hat. Datentyp: Zeichenfolge
„lead_line_items.sys_updated_on“	Vom System generiertes Datum und Uhrzeit der letzten Aktualisierung des Lead-Positionselements. Datentyp: Objekt `"sys_created_on": { "display_value": "String", "value": "String" }`
„lead_line_items.sys_updated_on.display_value“	Datum und Uhrzeit der letzten Aktualisierung des Lead-Positionselements. Datentyp: Zeichenfolge Format: Standardformat und Zeitzone für Instanz
„lead_line_items.sys_updated_on.value“	Datum und Uhrzeit der letzten Aktualisierung des Lead-Positionselements. Datentyp: Zeichenfolge Format: UTC
Lead_line_items.unit_of_measurement	Details zur Maßeinheit des Lead-Positionselements. Datentyp: Objekt `"unit_of_measurement": { "name": "String", "sys_id": "String" }`
„lead_line_items.unit_of_measurement.name“	Name der Maßeinheit, z. B. Stück oder Kubikfuß. Datentyp: Zeichenfolge
„lead_line_items.unit_of_measurement.sys_id“	Sys_id des Datensatzes, der die Maßeinheit beschreibt. Datentyp: Zeichenfolge Tabelle: Maßeinheit [sn_prd_pm_uom]
„lead_line_items.work_notes“	Liste, die die für das Lead-Positionselement erstellten Arbeitsnotizen beschreibt. Datentyp: Array von Objekten `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
Lead_line_items.work_notes.author	Anwendername der Person, die die zugehörige Arbeitsnotiz verfasst hat. Datentyp: Zeichenfolge
„lead_line_items.work_notes.date“	Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge
„lead_line_items.work_notes.text“	Text der Notiz vom Autor. Datentyp: Zeichenfolge
Lead_rating	Bewertung für den Lead, z. B. 100_cold, 200_warm, 300_Hot oder 400_Super_Hot. Hinweis: Dies ist ein Auswahlfeld. Sie muss eines der Auswahlelemente enthalten, die im Feld „lead_rating“ der Lead-Tabelle definiert sind. Datentyp: Zeichenfolge
Lead_score	Punktzahl für den Lead. Datentyp: Dezimalzahl Bereich: 1 bis 100
Lead_source	Urheber des Leads. Hinweis: Dies ist ein Auswahlfeld. Sie muss eines der Auswahlelemente enthalten, die im Feld „lead_source“ der Lead-Tabelle definiert sind. Datentyp: Zeichenfolge
Lead_type	Typ des Leads, z. B. „Neues Geschäft“ oder „Bestehendes Geschäft“. Hinweis: Dies ist ein Auswahlfeld. Sie muss eines der Auswahlelemente enthalten, die im Feld „lead_type“ der Lead-Tabelle definiert sind. Datentyp: Zeichenfolge
Middle_name	Zweiter Vorname des Kontakts für den Lead Datentyp: Zeichenfolge
mobile_phone	Telefonnummer des Kontakts für den Lead Datentyp: Zeichenfolge
Nummer	Eindeutige, vom System generierte Nummer des Lead-Datensatzes. Datentyp: Zeichenfolge
other_reason	Zusätzlicher Grund für die Disqualifikation des Leads. Datentyp: Zeichenfolge Max. Länge: 160 Zeichen
owner	Details der Person, die dem Lead zugeordnet ist. Datentyp: Objekt `"owner": { "name": "String", "sys_id": "String" }`
owner.name	Name der Person, die Besitzer des Leads ist. Datentyp: Zeichenfolge
owner.sys_id	Sys_id des Anwenderdatensatzes der Person, die Besitzer des Leads ist. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
Grund	Grund für die Disqualifikation des Leads, z. B. Disqualifizieren. Datentyp: Zeichenfolge Max. Länge: 40 Zeichen
short_description	Kurze Beschreibung des Leads. Datentyp: Zeichenfolge Max. Länge: 160 Zeichen
Similar_Lead	Details zu einem ähnlichen Lead. Verwenden Sie dies für eine mögliche Lead-Disqualifizierung. Datentyp: Objekt `"similar_lead": { "name": "String", "sys_id": "String" }`
ähnliche_lead.name	Name des doppelten Leads Datentyp: Zeichenfolge
Similar_Lead.Sys_ID	Sys_id des Lead-Datensatzes, bei dem es sich um einen möglichen doppelten Lead handelt. Datentyp: Zeichenfolge Tabelle: Lead [sn_lead_mgmt_core_lead]
Phase	Phase des Leads, z. B. 100_new. Hinweis: Dies ist ein Auswahlfeld. Sie muss eines der Auswahlelemente enthalten, die im Feld „Phase“ der Tabelle „Leads“ definiert sind. Datentyp: Zeichenfolge
state	Bundesstaat, in dem sich der Lead befindet. Datentyp: Zeichenfolge
Straße	Straße, in der der Lead ansässig ist Datentyp: Zeichenfolge
sys_class_name	Vom System generierter Klassenname für die Lead-Tabelle Datentyp: Zeichenfolge
sys_created_by	Anwendername der Person, die den Lead erstellt hat Datentyp: Zeichenfolge
sys_created_on	Vom System generierter Zeitpunkt (Datum und Uhrzeit), zu dem der Lead erstellt wurde Datentyp: Objekt `"sys_created_on": { "display_value": "String", "value": "String" }`
sys_created_on.display_value	Datum und Uhrzeit der Erstellung des Leads. Datentyp: Zeichenfolge Format: Standardformat und Zeitzone für Instanz
sys_created_on.Wert	Datum und Uhrzeit der Erstellung des Leads. Datentyp: Zeichenfolge Format: UTC
sys_domain	Sys_id des Domänendatensatzes, zu dem der Lead gehört. Hinweis: Dieser Parameter wird nur in der Antwort zurückgegeben, wenn Domain Separation aktiviert ist. Datentyp: Zeichenfolge
sys_domain_path	Pfad der Domäne, zu der der Lead gehört. Hinweis: Dieser Parameter wird nur in der Antwort zurückgegeben, wenn Domain Separation aktiviert ist. Datentyp: Zeichenfolge
sys_id	Sys_id des Lead-Datensatzes. Datentyp: Zeichenfolge Tabelle: Lead [sn_lead_mgmt_core_lead]
sys_mod_count	Anzahl der Änderungen des zugeordneten Lead-Datensatzes. Datentyp: Zahl (Ganzzahl)
sys_tags	Liste der System-Tags, die dem Lead zugeordnet sind Sie können diese Tags verwenden, um Leads zu kategorisieren. Datentyp: Array
sys_updated_by	Anwendername der Person, die den Lead-Datensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge
sys_updated_on	Vom System generierter Zeitpunkt (Datum und Uhrzeit) der letzten Aktualisierung des Leads Datentyp: Objekt `"sys_created_on": { "display_value": "String", "value": "String" }`
sys_updated_on.display_value	Datum und Uhrzeit der letzten Aktualisierung des Leads. Datentyp: Zeichenfolge Format: Standardformat und Zeitzone der Instanz
sys_updated_on.Wert	Datum und Uhrzeit der letzten Aktualisierung des Leads. Datentyp: Zeichenfolge Format: UTC
Titel	Titel des Leads. Datentyp: Zeichenfolge
Website von	Website-URL des Lead. Datentyp: Zeichenfolge
work_notes	Liste der für den Lead erstellten Arbeitsnotizen Datentyp: Array von Objekten `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
work_notes.author	Anwendername der Person, die die zugehörige Arbeitsnotiz verfasst hat. Datentyp: Zeichenfolge
work_notes.date	Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge
work_notes.text	Text der Notiz vom Autor. Datentyp: Zeichenfolge
Postleitzahl	Postleitzahl des zugeordneten Leads. Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Codebeispiel zeigt, wie Sie mit einem Lead-Positionselement einen neuen Lead-Datensatz erstellen.

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"
        }
      }
  ]
}

Die Antwort enthält die Felder in den Datensätzen Lead und Lead Items.

{
  "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
    }
  ]
}