Lead-API
Die Lead Die API bietet Endpunkte, mit denen Sie Marketing-Leads und die zugehörigen Lead-Positionselemente aus einer Instanz erstellen, aktualisieren und abfragen/abrufen können.
Verwenden Sie diese API, um Ihre Instanz in externe Websites und Systeme wie automatisierte Lead-Erfassungssysteme zu integrieren oder Lead-Informationen für externe Reporting-Systeme bereitzustellen.
Diese API wird in bereitgestellt sn_lead_mgmt_core Namespace. Um auf die API zuzugreifen, muss das Plugin „Lead-Management-Datenmodell“ (sn_lead_mgmt_core) in der Instanz aktiviert sein, und der aufrufende Anwender muss über die sn_lead_mgmt_core.lead_integrator-Rolle verfügen.
Für zusätzliche Informationen zu Lead Management, Siehe Using Lead Management.
Lead-API wird erweitert
Sie können erweitern Lead API durch Überschreiben der Methoden in den zugehörigen Skripteinbindungen. Die Standard-API-Funktionalität befindet sich in Skripteinbindungen, die auf „OOB“ enden, z. B. LeadAPIProcessUtilOOB . Um diese Funktionalität zu überschreiben, erstellen Sie Methoden mit identischen Namen und Parametern in der Skripteinbindung, die denselben Dateinamen haben, aber nicht auf „OOB“ enden, z. B. LeadAPIProzessUtil .
Im Folgenden finden Sie eine Liste der Skripteinbindungen, die Sie überschreiben können, um das Verhalten von zu ändern Lead API:
- LeadAPIProcessUtilOOB : Enthält Methoden, die den Abruf und die Erstellung von Lead- und Lead-Positionselementdatensätzen verarbeiten.
- LeadApiValidationUtilOOB : Enthält Methoden, die das JSON-Anforderungsobjekt für die POST- und PATCH-Endpunkte validieren.
- LeadAPIHelperOOB : Enthält API-Hilfsmethoden, die:
- Gibt ein Array von Leads und zugehörigen Lead-Positionselementen zurück.
- Gibt ein JSON-Objekt aus dem zugehörigen GlideRecord zurück.
- Entfernen Sie alle ignorierten Felder aus einem JSON-Objekt, und führen Sie andere Transformationen durch.
- LeadAPIKonstantenOOB : Enthält Konstanten, Statuscodes und Nachrichten für alle API-Vorgänge. Es enthält auch die Liste der Felder, die von den POST- und PATCH-Endpunkten ignoriert werden.
Lead: RUFT /sn_lead_mgmt_core/Lead AB
Ruft alle Leads und zugehörigen Lead-Positionselemente basierend auf den in den Abfrageparametern übergebenen Filterkriterien ab.
- Lead [sn_lead_mgmt_core_lead]
- Lead-Positionselement [sn_lead_mgmt_core_lead_line_item]
URL-Format
Versionierte URL: /api/sn_lead_mgmt_core/{api_Version}/Lead
Standard-URL: /api/sn_lead_mgmt_core/{api_Version}/Lead
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Sysparm_fields | Kommagetrennte Liste von Feldern, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Datentyp: Zeichenfolge Standard: Alle Felder zurückgeben. |
| Sysparm_limit | Maximale Anzahl zurückzugebender Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie sysparm_offsetParameter zum Paginieren des Datensatzabrufs. Dieser Grenzwert wird vor der ACL-Auswertung angewendet. Wenn keine Datensätze zurückgegeben werden, einschließlich der Datensätze, auf die Sie Zugriff haben, ordnen Sie die Datensatzreihenfolge so an, dass Datensätze, auf die Sie zuerst zugreifen können, zurückgegeben werden. Hinweis:
Ungewöhnlich groß sysparm_limitWerte können sich auf die Systemleistung auswirken. Datentyp: Zahl Standard: 20 Maximum: 100 |
| Sysparm_Offset | Startdatensatzindex, für den mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktionalität ermöglicht den Abruf aller Datensätze, unabhängig von der Anzahl der Datensätze, in kleinen verwaltbaren Blöcken. Beispiel: Wenn Sie diesen Endpunkt zum ersten Mal aufrufen, sysparm_offsetIst auf „0“ festgelegt. Um einfach alle verfügbaren Datensätze durchzublättern, verwenden Sie Datentyp: Zahl Standard: 0 |
| Sysparm_query | Codierte Abfrage, die zum Filtern des Ergebnissatzes verwendet wird. Zum Beispiel:
Die codierte Abfrage unterstützt Sortieren nach . Um Antworten basierend auf bestimmten Feldern zu sortieren, verwenden Sie SORTIEREN NACH Und ORDERBYDESC Klauseln in sysparm_query. Beispiel: Wenn ein Teil der Abfrage ungültig ist, z. B. durch Angabe eines ungültigen Feldnamens, ignoriert die Instanz den ungültigen Teil. Gibt dann Zeilen zurück, die nur den gültigen Teil der Abfrage verwenden. Sie können dieses Verhalten mithilfe der Eigenschaft steuern glide.invalid_query.returns_no_rows. Legen Sie diese Eigenschaft auf „wahr“ fest, um keine Zeilen für eine ungültige Abfrage zurückzugeben. Hinweis: Die glide.invalid_query.returns_no_rowsEigenschaft steuert das Verhalten aller Abfragen in der Instanz, z. B. in Listen, Skripts ( GlideRecord.Abfrage() ) Und Webservice-APIs. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Inhaltstyp | Datenformat des Anforderungstexts. Nur unterstützt application/json. |
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
| Inhaltsbereich | Inhaltsbereich, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn Offset=2 und Limit=3, ist der Wert des Inhaltsbereichs-Headers die Elemente 3–5. |
| Links | Links zum Navigieren in den Abfrageergebnissen:
|
| Gesamtanzahl | Gesamtanzahl 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 REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung wurde erfolgreich verarbeitet. Alle Antworten zurückgegeben (keine Paginierung). |
| 206 | Anforderung erfolgreich verarbeitet. In Antwort zurückgegebene Teilressource (mit Paginierung). |
| 400 | Fehler. Mögliche Gründe:
|
| 403 | Datensatz hat Zugriff verweigert. 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. |
Antworttext-Parameter
| Name | Beschreibung |
|---|---|
| Account | Account, der mit dem Lead verknüpft ist. Datentyp: Objekt |
| account.name | Name des Accounts. Datentyp: Zeichenfolge |
| Account.sys_ID |
SYS_ID des zugeordneten Account-Datensatzes.
Datentyp: Zeichenfolge Tabelle: Account [Customer_Account] |
| business_phone | Geschäftliche Telefonnummer des Leads. Datentyp: Zeichenfolge |
| city | Stadt, in der sich der Lead befindet. Datentyp: Zeichenfolge |
| Closed_date | Datum und Uhrzeit der Schließung des Leads. Datentyp: Objekt |
| 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, zu der der Lead geschlossen wurde, wie im zugehörigen Datensatz definiert. Datentyp: Zeichenfolge Format: UTC |
| Unternehmen | Unternehmensname des Leads. Datentyp: Zeichenfolge |
| consumer | Verbraucher, der dem Lead zugeordnet ist. Datentyp: Objekt |
| consumer.name | Name des zugeordneten Verbrauchers. Datentyp: Zeichenfolge |
| Consumer.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 | Name des Kontakts. Datentyp: Zeichenfolge |
| Contact.sys_ID |
SYS_ID des zugeordneten Kontaktdatensatzes.
Datentyp: Zeichenfolge Tabelle: Kontakt [Customer_contact] |
| country | Land, in dem sich der Lead befindet. Datentyp: Zeichenfolge |
| Do_Not_Call |
Kennzeichnung, die angibt, ob der Kommunikationsmodus per Telefon erfolgt.
Gültige Werte:
Datentyp: Boolescher Wert |
| Do_Not_email |
Kennzeichnung, die angibt, ob der Kommunikationsmodus per E-Mail erfolgt.
Gültige Werte:
Datentyp: Boolescher Wert |
| Nicht_freigeben | |
| E-Mail-Adresse des Leads. Datentyp: Zeichenfolge |
|
| external_id | ID, die vom System verwendet wird, das den Lead generiert hat, um den Lead im zugehörigen 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 in industryFeld der Account-Tabelle [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 | 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 | ID, die vom System verwendet wird, das die Lead-Position generiert hat, um die Position im zugehörigen 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_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. Nummer | Eindeutige vom System generierte Nummer des Lead-Positionselementdatensatzes. Datentyp: Zeichenfolge |
| Lead_line_items. Product_Offering | Informationen zum Produktangebot, das der Lead-Position zugeordnet ist. Datentyp: Objekt |
| Lead_line_items. Product_offering.Code | Code, der mit dem Produktangebot verknüpft ist. Hinweis: Dies ist eine vom System generierte alphanumerische Nummer basierend auf dem Produktnamen. Obwohl vom System generiert, können Sie den Code bearbeiten, um eine SKU oder andere branchenspezifische Produktcodes darzustellen. Datentyp: Zeichenfolge |
| Lead_line_items. product_offering.name | Name des Produktangebots. Datentyp: Zeichenfolge |
| Lead_line_items. Product_Offering.sys_ID |
SYS_ID des Produktangebotsdatensatzes, der der Lead-Position zugeordnet ist.
Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering] |
| Lead_line_items. Menge |
Menge der Artikel, die der Lead des zugehörigen Produktangebots kaufen möchte.
Datentyp: Zahl (Ganzzahl) |
| Lead_line_items. sys_created_by | Anwendername der Person, die die Lead-Position erstellt hat. Datentyp: Zeichenfolge |
| Lead_line_items. sys_created_on | Vom System generiertes Datum und Uhrzeit der Erstellung des Lead-Positionselements. Datentyp: Objekt |
| Lead_line_items. sys_created_on.display_value | Datum und Uhrzeit der Erstellung des Lead-Positionselements. Datentyp: Zeichenfolge Format: Standardinstanzformat und Zeitzone |
| 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 die Domänentrennung 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 die Domänentrennung aktiviert ist. Datentyp: Zeichenfolge |
| Lead_line_items. sys_ID | SYS_ID des Lead-Positionselementdatensatzes. Datentyp: Zeichenfolge |
| Lead_line_items. sys_mod_count | Gibt an, wie oft der zugehörige Lead-Positionselementdatensatz geändert wurde. 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 die zugehörige Lead-Position 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 |
| Lead_line_items. sys_updated_on. Display_value | Datum und Uhrzeit der letzten Aktualisierung des Lead-Positionselements. Datentyp: Zeichenfolge Format: Standardinstanzformat und Zeitzone |
| Lead_line_items. sys_updated_on. Wert | Datum und Uhrzeit der letzten Aktualisierung des Lead-Positionselements. Datentyp: Zeichenfolge Format: UTC |
| Lead_line_items. Unit_of_Measurement |
Details der Maßeinheit des Lead-Positionselements.
Datentyp: Objekt
|
| Lead_line_items. Unit_of_Measurement. Name | Name der Maßeinheit, z. B. „einzeln“ 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 die Lead-Position erstellten Arbeitsnotizen beschreibt.
Datentyp: Array von Objekten
|
| Lead_line_items. Work_Notes. Autor | Anwendername der Person, die die zugehörige Arbeitsnotiz erstellt hat. Datentyp: Zeichenfolge |
| Lead_line_items. Work_Notes. Datum | Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge |
| Lead_line_items. Work_Notes. Text | Text der Notiz des Autors. Datentyp: Zeichenfolge |
| Lead_Rating | Bewertung für den Lead, z. B. 100_kalt, 200_warm, 300_hot oder 400_super_hot. Hinweis: Dies ist ein Auswahlfeld. Es muss eines der Auswahlelemente enthalten, die im Feld „Lead_Rating“ der Leads-Tabelle definiert sind. Datentyp: Zeichenfolge |
| Lead_Score | Punktzahl für den Lead. Datentyp: Decimal 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 Leads-Tabelle definiert sind. Datentyp: Zeichenfolge |
| Lead_type |
Typ des Leads, z. B. „Neues Geschäft“ oder „vorhandenes Geschäft“.
Hinweis:
Dies ist ein Auswahlfeld. Es muss eines der Auswahlelemente enthalten, die im Feld „Lead_type“ der Leads-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 Lead-Disqualifizierung. Datentyp: Zeichenfolge Max. Länge: 160 Zeichen |
| Eigentümer |
Details der Person, die dem Lead zugeordnet ist.
Datentyp: Objekt
|
| owner.name | Name der Person, die den Lead besitzt. Datentyp: Zeichenfolge |
| Besitzer.sys_ID | SYS_ID des Anwenderdatensatzes der Person, die den Lead besitzt. Datentyp: Zeichenfolge Tabelle: Anwender [sys_user] |
| Grund | Grund für die Lead-Disqualifizierung, z. B. disqualifizieren. Datentyp: Zeichenfolge Max. Länge: 40 Zeichen |
| short_description | Kurzbeschreibung des Leads. Datentyp: Zeichenfolge Max. Länge: 160 Zeichen |
| Similar_Lead |
Details zu ähnlichen Leads. Verwenden Sie dies für eine mögliche Lead-Disqualifizierung.
Datentyp: Objekt
|
| similar_lead.name | Name des doppelten Leads. Datentyp: Zeichenfolge |
| Similar_Lead.sys_ID | SYS_ID des Lead-Datensatzes, der ein möglicher doppelter Lead ist. 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 Phasenfeld der Leads-Tabelle definiert sind. Datentyp: Zeichenfolge |
| Staat | Status, in dem sich der Lead befindet. Datentyp: Zeichenfolge |
| Straße | Straße, in der sich der Lead befindet. Datentyp: Zeichenfolge |
| sys_class_name | Vom System generierter Klassenname der Lead-Tabelle. Datentyp: Zeichenfolge |
| sys_created_by | Anwendername der Person, die den Lead erstellt hat. Datentyp: Zeichenfolge |
| sys_created_on | Vom System generiertes Datum und Uhrzeit der Erstellung des Leads. Datentyp: Objekt |
| sys_created_on. Display_value | Datum und Uhrzeit der Erstellung des Leads. Datentyp: Zeichenfolge Format: Standardinstanzformat und Zeitzone |
| 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 die Domänentrennung 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 die Domänentrennung aktiviert ist. Datentyp: Zeichenfolge |
| sys_id | SYS_ID des Lead-Datensatzes. Datentyp: Zeichenfolge Tabelle: Lead [sn_lead_mgmt_core_lead] |
| sys_mod_count | Gibt an, wie oft der zugeordnete Lead-Datensatz geändert wurde. 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 generiertes Datum und Uhrzeit der letzten Aktualisierung des Leads. Datentyp: Objekt |
| 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 | Website-URL des Lead. Datentyp: Zeichenfolge |
| Work_Notes |
Liste der für den Lead erstellten Arbeitsnotizen.
Datentyp: Array von Objekten
|
| Work_Notes. Autor | Anwendername der Person, die die zugehörige Arbeitsnotiz erstellt hat. Datentyp: Zeichenfolge |
| Work_Notes. Datum | Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge |
| Work_Notes. Text | Text der Notiz des Autors. 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 – RUFT /sn_lead_mgmt_core/Lead/{sys_ID} AB
Gibt den Lead-Datensatz und alle zugehörigen Lead-Positionselemente für die angegebene sys_ID zurück
- Lead [sn_lead_mgmt_core_lead]
- Lead-Positionselement [sn_lead_mgmt_core_lead_line_item]
URL-Format
Versionierte URL: /api/sn_lead_mgmt_core/{api_Version}/Lead/{sys_ID}
Standard-URL: /api/sn_lead_mgmt_core/{api_Version}/Lead/{sys_ID}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. 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] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
| Header | 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 REST-API-HTTP-Antwortcodes .
| 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. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter
| Name | Beschreibung |
|---|---|
| Account | Account, der mit dem Lead verknüpft ist. Datentyp: Objekt |
| account.name | Name des Accounts. Datentyp: Zeichenfolge |
| Account.sys_ID |
SYS_ID des zugeordneten Account-Datensatzes.
Datentyp: Zeichenfolge Tabelle: Account [Customer_Account] |
| business_phone | Geschäftliche Telefonnummer des Leads. Datentyp: Zeichenfolge |
| city | Stadt, in der sich der Lead befindet. Datentyp: Zeichenfolge |
| Closed_date | Datum und Uhrzeit der Schließung des Leads. Datentyp: Objekt |
| 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, zu der der Lead geschlossen wurde, wie im zugehörigen Datensatz definiert. Datentyp: Zeichenfolge Format: UTC |
| Unternehmen | Unternehmensname des Leads. Datentyp: Zeichenfolge |
| consumer | Verbraucher, der dem Lead zugeordnet ist. Datentyp: Objekt |
| consumer.name | Name des zugeordneten Verbrauchers. Datentyp: Zeichenfolge |
| Consumer.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 | Name des Kontakts. Datentyp: Zeichenfolge |
| Contact.sys_ID |
SYS_ID des zugeordneten Kontaktdatensatzes.
Datentyp: Zeichenfolge Tabelle: Kontakt [Customer_contact] |
| country | Land, in dem sich der Lead befindet. Datentyp: Zeichenfolge |
| Do_Not_Call |
Kennzeichnung, die angibt, ob der Kommunikationsmodus per Telefon erfolgt.
Gültige Werte:
Datentyp: Boolescher Wert |
| Do_Not_email |
Kennzeichnung, die angibt, ob der Kommunikationsmodus per E-Mail erfolgt.
Gültige Werte:
Datentyp: Boolescher Wert |
| Nicht_freigeben | |
| E-Mail-Adresse des Leads. Datentyp: Zeichenfolge |
|
| external_id | ID, die vom System verwendet wird, das den Lead generiert hat, um den Lead im zugehörigen 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 in industryFeld der Account-Tabelle [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 | 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 | ID, die vom System verwendet wird, das die Lead-Position generiert hat, um die Position im zugehörigen 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_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. Nummer | Eindeutige vom System generierte Nummer des Lead-Positionselementdatensatzes. Datentyp: Zeichenfolge |
| Lead_line_items. Product_Offering | Informationen zum Produktangebot, das der Lead-Position zugeordnet ist. Datentyp: Objekt |
| Lead_line_items. Product_offering.Code | Code, der mit dem Produktangebot verknüpft ist. Hinweis: Dies ist eine vom System generierte alphanumerische Nummer basierend auf dem Produktnamen. Obwohl vom System generiert, können Sie den Code bearbeiten, um eine SKU oder andere branchenspezifische Produktcodes darzustellen. Datentyp: Zeichenfolge |
| Lead_line_items. product_offering.name | Name des Produktangebots. Datentyp: Zeichenfolge |
| Lead_line_items. Product_Offering.sys_ID |
SYS_ID des Produktangebotsdatensatzes, der der Lead-Position zugeordnet ist.
Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering] |
| Lead_line_items. Menge |
Menge der Artikel, die der Lead des zugehörigen Produktangebots kaufen möchte.
Datentyp: Zahl (Ganzzahl) |
| Lead_line_items. sys_created_by | Anwendername der Person, die die Lead-Position erstellt hat. Datentyp: Zeichenfolge |
| Lead_line_items. sys_created_on | Vom System generiertes Datum und Uhrzeit der Erstellung des Lead-Positionselements. Datentyp: Objekt |
| Lead_line_items. sys_created_on.display_value | Datum und Uhrzeit der Erstellung des Lead-Positionselements. Datentyp: Zeichenfolge Format: Standardinstanzformat und Zeitzone |
| 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 die Domänentrennung 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 die Domänentrennung aktiviert ist. Datentyp: Zeichenfolge |
| Lead_line_items. sys_ID | SYS_ID des Lead-Positionselementdatensatzes. Datentyp: Zeichenfolge |
| Lead_line_items. sys_mod_count | Gibt an, wie oft der zugehörige Lead-Positionselementdatensatz geändert wurde. 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 die zugehörige Lead-Position 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 |
| Lead_line_items. sys_updated_on. Display_value | Datum und Uhrzeit der letzten Aktualisierung des Lead-Positionselements. Datentyp: Zeichenfolge Format: Standardinstanzformat und Zeitzone |
| Lead_line_items. sys_updated_on. Wert | Datum und Uhrzeit der letzten Aktualisierung des Lead-Positionselements. Datentyp: Zeichenfolge Format: UTC |
| Lead_line_items. Unit_of_Measurement |
Details der Maßeinheit des Lead-Positionselements.
Datentyp: Objekt
|
| Lead_line_items. Unit_of_Measurement. Name | Name der Maßeinheit, z. B. „einzeln“ 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 die Lead-Position erstellten Arbeitsnotizen beschreibt.
Datentyp: Array von Objekten
|
| Lead_line_items. Work_Notes. Autor | Anwendername der Person, die die zugehörige Arbeitsnotiz erstellt hat. Datentyp: Zeichenfolge |
| Lead_line_items. Work_Notes. Datum | Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge |
| Lead_line_items. Work_Notes. Text | Text der Notiz des Autors. Datentyp: Zeichenfolge |
| Lead_Rating | Bewertung für den Lead, z. B. 100_kalt, 200_warm, 300_hot oder 400_super_hot. Hinweis: Dies ist ein Auswahlfeld. Es muss eines der Auswahlelemente enthalten, die im Feld „Lead_Rating“ der Leads-Tabelle definiert sind. Datentyp: Zeichenfolge |
| Lead_Score | Punktzahl für den Lead. Datentyp: Decimal 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 Leads-Tabelle definiert sind. Datentyp: Zeichenfolge |
| Lead_type |
Typ des Leads, z. B. „Neues Geschäft“ oder „vorhandenes Geschäft“.
Hinweis:
Dies ist ein Auswahlfeld. Es muss eines der Auswahlelemente enthalten, die im Feld „Lead_type“ der Leads-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 Lead-Disqualifizierung. Datentyp: Zeichenfolge Max. Länge: 160 Zeichen |
| Eigentümer |
Details der Person, die dem Lead zugeordnet ist.
Datentyp: Objekt
|
| owner.name | Name der Person, die den Lead besitzt. Datentyp: Zeichenfolge |
| Besitzer.sys_ID | SYS_ID des Anwenderdatensatzes der Person, die den Lead besitzt. Datentyp: Zeichenfolge Tabelle: Anwender [sys_user] |
| Grund | Grund für die Lead-Disqualifizierung, z. B. disqualifizieren. Datentyp: Zeichenfolge Max. Länge: 40 Zeichen |
| short_description | Kurzbeschreibung des Leads. Datentyp: Zeichenfolge Max. Länge: 160 Zeichen |
| Similar_Lead |
Details zu ähnlichen Leads. Verwenden Sie dies für eine mögliche Lead-Disqualifizierung.
Datentyp: Objekt
|
| similar_lead.name | Name des doppelten Leads. Datentyp: Zeichenfolge |
| Similar_Lead.sys_ID | SYS_ID des Lead-Datensatzes, der ein möglicher doppelter Lead ist. 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 Phasenfeld der Leads-Tabelle definiert sind. Datentyp: Zeichenfolge |
| Staat | Status, in dem sich der Lead befindet. Datentyp: Zeichenfolge |
| Straße | Straße, in der sich der Lead befindet. Datentyp: Zeichenfolge |
| sys_class_name | Vom System generierter Klassenname der Lead-Tabelle. Datentyp: Zeichenfolge |
| sys_created_by | Anwendername der Person, die den Lead erstellt hat. Datentyp: Zeichenfolge |
| sys_created_on | Vom System generiertes Datum und Uhrzeit der Erstellung des Leads. Datentyp: Objekt |
| sys_created_on. Display_value | Datum und Uhrzeit der Erstellung des Leads. Datentyp: Zeichenfolge Format: Standardinstanzformat und Zeitzone |
| 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 die Domänentrennung 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 die Domänentrennung aktiviert ist. Datentyp: Zeichenfolge |
| sys_id | SYS_ID des Lead-Datensatzes. Datentyp: Zeichenfolge Tabelle: Lead [sn_lead_mgmt_core_lead] |
| sys_mod_count | Gibt an, wie oft der zugeordnete Lead-Datensatz geändert wurde. 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 generiertes Datum und Uhrzeit der letzten Aktualisierung des Leads. Datentyp: Objekt |
| 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 | Website-URL des Lead. Datentyp: Zeichenfolge |
| Work_Notes |
Liste der für den Lead erstellten Arbeitsnotizen.
Datentyp: Array von Objekten
|
| Work_Notes. Autor | Anwendername der Person, die die zugehörige Arbeitsnotiz erstellt hat. Datentyp: Zeichenfolge |
| Work_Notes. Datum | Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge |
| Work_Notes. Text | Text der Notiz des Autors. Datentyp: Zeichenfolge |
| Postleitzahl | Postleitzahl des zugeordneten Leads. Datentyp: Zeichenfolge |
Curl-Anforderung
Das folgende Codebeispiel zeigt, wie der Lead-Datensatz mit der sys_ID 856b6a95ffde8210b85dffffffffd7 abgerufen wird.
curl "https://instance.service-now.com /api/sn_lead_mgmt_core/lead/856b6a95ffde8210b85dffffffffffd7" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
Im Folgenden werden die Rückgabeergebnisse aufgeführt:
{
"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.
- Lead [sn_lead_mgmt_core_lead]
- Lead-Positionselement [sn_lead_mgmt_core_lead_line_item]
- Ungültige Parameternamen werden ignoriert.
- Ungültige Werte für nicht obligatorische Auswahlfelder und Referenzfelder werden ignoriert.
- Wenn der FELDSCHREIBZUGRIFF 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 „ignorierte Felder“, die konfigurierbar ist.
- Die Werte der Parameter account, contact, Und consumerWerden ignoriert, wenn beide verwendet werden accountUnd consumerParameter sind nicht leer.
- Sofern nicht anders angegeben, ist der Standardwert für alle nicht übergebenen Parameter „null“.
URL-Format
Versionierte URL: /api/sn_lead_mgmt_core/{api_Version}/Lead/{sys_ID}
Standard-URL: /api/sn_lead_mgmt_core/{api_Version}/Lead/{sys_ID}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. 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] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Account | Details des Accounts, der dem Lead zugeordnet ist. Datentyp: Objekt |
| Account.sys_ID |
SYS_ID des zugeordneten Account-Datensatzes.
Datentyp: Zeichenfolge Tabelle: Account [Customer_Account] |
| business_phone | Geschäftliche Telefonnummer des Leads. Datentyp: Zeichenfolge |
| city | Stadt, in der sich der Lead befindet. Datentyp: Zeichenfolge |
| Unternehmen | Unternehmensname des Leads. Datentyp: Zeichenfolge |
| consumer | Verbraucher, der dem Lead zugeordnet ist. Datentyp: Objekt |
| Consumer.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 |
SYS_ID des zugeordneten Kontaktdatensatzes.
Datentyp: Zeichenfolge Tabelle: Kontakt [Customer_contact] |
| country | Land, in dem sich der Lead befindet. Datentyp: Zeichenfolge |
| Do_Not_Call |
Kennzeichnung, die angibt, ob der Kommunikationsmodus per Telefon erfolgt.
Gültige Werte:
Datentyp: Boolescher Wert |
| Do_Not_email |
Kennzeichnung, die angibt, ob der Kommunikationsmodus per E-Mail erfolgt.
Gültige Werte:
Datentyp: Boolescher Wert |
| Nicht_freigeben | |
| E-Mail-Adresse des Leads. Datentyp: Zeichenfolge |
|
| external_id | ID, die vom System verwendet wird, das den Lead generiert hat, um den Lead im zugehörigen 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 in industryFeld der Account-Tabelle [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 | 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 Maximale Anzahl von Einzelposten: 100 – alle über, die ignoriert werden |
| Lead_line_items. External_ID | ID, die vom System verwendet wird, das die Lead-Position generiert hat, um die Position im zugehörigen 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 der Lead-Position zugeordnet ist. Datentyp: Objekt |
| lead_line_items.product_offering.sys_id | Erforderlich. SYS_ID des Produktangebotsdatensatzes, der der Lead-Position zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering] |
| Lead_line_items.quantity |
Menge der Artikel, die der Lead des zugehörigen Produktangebots kaufen möchte.
Datentyp: Zahl (Ganzzahl) |
| Lead_line_items. Unit_of_Measurement |
Details der Maßeinheit des Lead-Positionselements.
Datentyp: Objekt
|
| 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 die Lead-Position erstellten Arbeitsnotizen beschreibt.
Datentyp: Array von Objekten
|
| Lead_line_items. Work_Notes. Text | Text der Notiz des Autors. Datentyp: Zeichenfolge |
| Lead_Rating | Bewertung für den Lead, z. B. 100_kalt, 200_warm, 300_hot oder 400_super_hot. Hinweis: Dies ist ein Auswahlfeld. Es muss eines der Auswahlelemente enthalten, die im Feld „Lead_Rating“ der Leads-Tabelle definiert sind. Datentyp: Zeichenfolge |
| Lead_Score | Punktzahl für den Lead. Datentyp: Decimal 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 Leads-Tabelle definiert sind. Datentyp: Zeichenfolge |
| Lead_type |
Typ des Leads, z. B. „Neues Geschäft“ oder „vorhandenes Geschäft“.
Hinweis:
Dies ist ein Auswahlfeld. Es muss eines der Auswahlelemente enthalten, die im Feld „Lead_type“ der Leads-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 Lead-Disqualifizierung. Datentyp: Zeichenfolge Max. Länge: 160 Zeichen |
| Eigentümer |
Details der Person, die dem Lead zugeordnet ist.
Datentyp: Objekt
|
| Besitzer.sys_ID | SYS_ID des Anwenderdatensatzes der Person, die den Lead besitzt. Datentyp: Zeichenfolge Tabelle: Anwender [sys_user] |
| Grund | Grund für die Lead-Disqualifizierung, z. B. disqualifizieren. Datentyp: Zeichenfolge Max. Länge: 40 Zeichen |
| short_description | Kurzbeschreibung des Leads. Datentyp: Zeichenfolge Max. Länge: 160 Zeichen |
| Similar_Lead |
Details zu ähnlichen Leads. Verwenden Sie dies für eine mögliche Lead-Disqualifizierung.
Datentyp: Objekt
|
| Similar_Lead.sys_ID | SYS_ID des Lead-Datensatzes, der ein möglicher doppelter Lead ist. 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 Phasenfeld der Leads-Tabelle definiert sind. Datentyp: Zeichenfolge |
| Staat | Status, in dem sich der Lead befindet. Datentyp: Zeichenfolge |
| Straße | Straße, in der sich der Lead befindet. Datentyp: Zeichenfolge |
| Titel | Titel des Leads. Datentyp: Zeichenfolge |
| Website | Website-URL des Lead. Datentyp: Zeichenfolge |
| Work_Notes |
Liste der für den Lead erstellten Arbeitsnotizen.
Datentyp: Array von Objekten
Hinweis:
Ein Array von Arbeitsnotizen in der Anforderung wird als einzelner Text eingefügt. Dieser Text wird generiert, indem der Inhalt aus allen Arbeitsnotizobjekten in der Anforderung kombiniert wird, wobei jeder Eintrag durch ein Komma (,) getrennt wird. |
| Work_Notes. Text | Text der Notiz des Autors. Datentyp: Zeichenfolge |
| Postleitzahl | Postleitzahl des zugeordneten Leads. Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
| Inhaltstyp | Datenformat des Anforderungstexts. Nur unterstützt application/json. |
| Header | 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 REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Datensätze für Lead- und Lead-Positionselemente wurden erfolgreich aktualisiert. |
| 400 | Fehler. Mögliche Gründe:
|
| 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. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter
| Name | Beschreibung |
|---|---|
| Account | Account, der mit dem Lead verknüpft ist. Datentyp: Objekt |
| account.name | Name des Accounts. Datentyp: Zeichenfolge |
| Account.sys_ID |
SYS_ID des zugeordneten Account-Datensatzes.
Datentyp: Zeichenfolge Tabelle: Account [Customer_Account] |
| business_phone | Geschäftliche Telefonnummer des Leads. Datentyp: Zeichenfolge |
| city | Stadt, in der sich der Lead befindet. Datentyp: Zeichenfolge |
| Closed_date | Datum und Uhrzeit der Schließung des Leads. Datentyp: Objekt |
| 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, zu der der Lead geschlossen wurde, wie im zugehörigen Datensatz definiert. Datentyp: Zeichenfolge Format: UTC |
| Unternehmen | Unternehmensname des Leads. Datentyp: Zeichenfolge |
| consumer | Verbraucher, der dem Lead zugeordnet ist. Datentyp: Objekt |
| consumer.name | Name des zugeordneten Verbrauchers. Datentyp: Zeichenfolge |
| Consumer.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 | Name des Kontakts. Datentyp: Zeichenfolge |
| Contact.sys_ID |
SYS_ID des zugeordneten Kontaktdatensatzes.
Datentyp: Zeichenfolge Tabelle: Kontakt [Customer_contact] |
| country | Land, in dem sich der Lead befindet. Datentyp: Zeichenfolge |
| Do_Not_Call |
Kennzeichnung, die angibt, ob der Kommunikationsmodus per Telefon erfolgt.
Gültige Werte:
Datentyp: Boolescher Wert |
| Do_Not_email |
Kennzeichnung, die angibt, ob der Kommunikationsmodus per E-Mail erfolgt.
Gültige Werte:
Datentyp: Boolescher Wert |
| Nicht_freigeben |
Kennzeichnung, die angibt, ob die Lead-Details freigegeben werden können.
Gültige Werte:
Datentyp: Boolescher Wert |
| E-Mail-Adresse des Leads. Datentyp: Zeichenfolge |
|
| external_id | ID, die vom System verwendet wird, das den Lead generiert hat, um den Lead im zugehörigen 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 in industryFeld der Account-Tabelle [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 | 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 | ID, die vom System verwendet wird, das die Lead-Position generiert hat, um die Position im zugehörigen 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_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. Nummer | Eindeutige vom System generierte Nummer des Lead-Positionselementdatensatzes. Datentyp: Zeichenfolge |
| Lead_line_items. Product_Offering | Informationen zum Produktangebot, das der Lead-Position zugeordnet ist. Datentyp: Objekt |
| Lead_line_items. Product_offering.Code | Code, der mit dem Produktangebot verknüpft ist. Hinweis: Dies ist eine vom System generierte alphanumerische Nummer basierend auf dem Produktnamen. Obwohl vom System generiert, können Sie den Code bearbeiten, um eine SKU oder andere branchenspezifische Produktcodes darzustellen. Datentyp: Zeichenfolge |
| Lead_line_items. product_offering.name | Name des Produktangebots. Datentyp: Zeichenfolge |
| Lead_line_items. Product_Offering.sys_ID |
SYS_ID des Produktangebotsdatensatzes, der der Lead-Position zugeordnet ist.
Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering] |
| Lead_line_items. Menge |
Menge der Artikel, die der Lead des zugehörigen Produktangebots kaufen möchte.
Datentyp: Zahl (Ganzzahl) |
| Lead_line_items. sys_created_by | Anwendername der Person, die die Lead-Position erstellt hat. Datentyp: Zeichenfolge |
| Lead_line_items. sys_created_on | Vom System generiertes Datum und Uhrzeit der Erstellung des Lead-Positionselements. Datentyp: Objekt |
| Lead_line_items. sys_created_on.display_value | Datum und Uhrzeit der Erstellung des Lead-Positionselements. Datentyp: Zeichenfolge Format: Standardinstanzformat und Zeitzone |
| 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 die Domänentrennung 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 die Domänentrennung aktiviert ist. Datentyp: Zeichenfolge |
| Lead_line_items. sys_ID | SYS_ID des Lead-Positionselementdatensatzes. Datentyp: Zeichenfolge |
| Lead_line_items. sys_mod_count | Gibt an, wie oft der zugehörige Lead-Positionselementdatensatz geändert wurde. 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 die zugehörige Lead-Position 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 |
| Lead_line_items. sys_updated_on. Display_value | Datum und Uhrzeit der letzten Aktualisierung des Lead-Positionselements. Datentyp: Zeichenfolge Format: Standardinstanzformat und Zeitzone |
| Lead_line_items. sys_updated_on. Wert | Datum und Uhrzeit der letzten Aktualisierung des Lead-Positionselements. Datentyp: Zeichenfolge Format: UTC |
| Lead_line_items. Unit_of_Measurement |
Details der Maßeinheit des Lead-Positionselements.
Datentyp: Objekt
|
| Lead_line_items. Unit_of_Measurement. Name | Name der Maßeinheit, z. B. „einzeln“ 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 die Lead-Position erstellten Arbeitsnotizen beschreibt.
Datentyp: Array von Objekten
|
| Lead_line_items. Work_Notes. Autor | Anwendername der Person, die die zugehörige Arbeitsnotiz erstellt hat. Datentyp: Zeichenfolge |
| Lead_line_items. Work_Notes. Datum | Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge |
| Lead_line_items. Work_Notes. Text | Text der Notiz des Autors. Datentyp: Zeichenfolge |
| Lead_Rating | Bewertung für den Lead, z. B. 100_kalt, 200_warm, 300_hot oder 400_super_hot. Hinweis: Dies ist ein Auswahlfeld. Es muss eines der Auswahlelemente enthalten, die im Feld „Lead_Rating“ der Leads-Tabelle definiert sind. Datentyp: Zeichenfolge |
| Lead_Score | Punktzahl für den Lead. Datentyp: Decimal 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 Leads-Tabelle definiert sind. Datentyp: Zeichenfolge |
| Lead_type |
Typ des Leads, z. B. „Neues Geschäft“ oder „vorhandenes Geschäft“.
Hinweis:
Dies ist ein Auswahlfeld. Es muss eines der Auswahlelemente enthalten, die im Feld „Lead_type“ der Leads-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 Lead-Disqualifizierung. Datentyp: Zeichenfolge Max. Länge: 160 Zeichen |
| Eigentümer |
Details der Person, die dem Lead zugeordnet ist.
Datentyp: Objekt
|
| owner.name | Name der Person, die den Lead besitzt. Datentyp: Zeichenfolge |
| Besitzer.sys_ID | SYS_ID des Anwenderdatensatzes der Person, die den Lead besitzt. Datentyp: Zeichenfolge Tabelle: Anwender [sys_user] |
| Grund | Grund für die Lead-Disqualifizierung, z. B. disqualifizieren. Datentyp: Zeichenfolge Max. Länge: 40 Zeichen |
| short_description | Kurzbeschreibung des Leads. Datentyp: Zeichenfolge Max. Länge: 160 Zeichen |
| Similar_Lead |
Details zu ähnlichen Leads. Verwenden Sie dies für eine mögliche Lead-Disqualifizierung.
Datentyp: Objekt
|
| similar_lead.name | Name des doppelten Leads. Datentyp: Zeichenfolge |
| Similar_Lead.sys_ID | SYS_ID des Lead-Datensatzes, der ein möglicher doppelter Lead ist. 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 Phasenfeld der Leads-Tabelle definiert sind. Datentyp: Zeichenfolge |
| Staat | Status, in dem sich der Lead befindet. Datentyp: Zeichenfolge |
| Straße | Straße, in der sich der Lead befindet. Datentyp: Zeichenfolge |
| sys_class_name | Vom System generierter Klassenname der Lead-Tabelle. Datentyp: Zeichenfolge |
| sys_created_by | Anwendername der Person, die den Lead erstellt hat. Datentyp: Zeichenfolge |
| sys_created_on | Vom System generiertes Datum und Uhrzeit der Erstellung des Leads. Datentyp: Objekt |
| sys_created_on. Display_value | Datum und Uhrzeit der Erstellung des Leads. Datentyp: Zeichenfolge Format: Standardinstanzformat und Zeitzone |
| 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 die Domänentrennung 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 die Domänentrennung aktiviert ist. Datentyp: Zeichenfolge |
| sys_id | SYS_ID des Lead-Datensatzes. Datentyp: Zeichenfolge Tabelle: Lead [sn_lead_mgmt_core_lead] |
| sys_mod_count | Gibt an, wie oft der zugeordnete Lead-Datensatz geändert wurde. 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 generiertes Datum und Uhrzeit der letzten Aktualisierung des Leads. Datentyp: Objekt |
| 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 | Website-URL des Lead. Datentyp: Zeichenfolge |
| Work_Notes |
Liste der für den Lead erstellten Arbeitsnotizen.
Datentyp: Array von Objekten
|
| Work_Notes. Autor | Anwendername der Person, die die zugehörige Arbeitsnotiz erstellt hat. Datentyp: Zeichenfolge |
| Work_Notes. Datum | Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge |
| Work_Notes. Text | Text der Notiz des Autors. Datentyp: Zeichenfolge |
| Postleitzahl | Postleitzahl des zugeordneten Leads. Datentyp: Zeichenfolge |
Curl-Anforderung
Das folgende Codebeispiel zeigt, wie der Lead-Datensatz mit der sys_ID 856b6a95ffde8210b85dffffffffd7 aktualisiert wird.
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 – POSTEN /sn_lead_mgmt_core/Lead
Erstellt einen Lead-Datensatz und die zugehörigen Lead-Positionselemente mit den angegebenen Parametern.
- Lead [sn_lead_mgmt_core_lead]
- Lead-Positionselement [sn_lead_mgmt_core_lead_line_item]
- Ungültige Parameternamen werden ignoriert.
- Ungültige Werte für nicht obligatorische Auswahlfelder und Referenzfelder werden ignoriert.
- Wenn der FELDSCHREIBZUGRIFF 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 „ignorierte Felder“, die konfigurierbar ist.
- Die Werte der Parameter account, contact, Und consumerWerden ignoriert, wenn beide verwendet werden accountUnd consumerParameter sind nicht leer.
- Sofern nicht anders angegeben, ist der Standardwert für alle nicht übergebenen Parameter „null“.
URL-Format
Versionierte URL: /api/sn_lead_mgmt_core/{api_Version}/Lead
Standard-URL: /api/sn_lead_mgmt_core/{api_Version}/Lead
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Account | Details zum Account, der dem Lead zugeordnet ist. Datentyp: Objekt |
| Account.sys_ID |
SYS_ID des zugeordneten Account-Datensatzes.
Datentyp: Zeichenfolge Tabelle: Account [Customer_Account] |
| business_phone | Geschäftliche Telefonnummer des Leads. Datentyp: Zeichenfolge |
| city | Stadt, in der sich der Lead befindet. Datentyp: Zeichenfolge |
| Unternehmen | Unternehmensname des Leads. Datentyp: Zeichenfolge |
| consumer | Verbraucher, der dem Lead zugeordnet ist. Datentyp: Objekt |
| Consumer.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 |
SYS_ID des zugeordneten Kontaktdatensatzes.
Datentyp: Zeichenfolge Tabelle: Kontakt [Customer_contact] |
| country | Land, in dem sich der Lead befindet. Datentyp: Zeichenfolge |
| Do_Not_Call |
Kennzeichnung, die angibt, ob der Kommunikationsmodus per Telefon erfolgt.
Gültige Werte:
Datentyp: Boolescher Wert Standard: Falsch |
| Do_Not_email |
Kennzeichnung, die angibt, ob der Kommunikationsmodus per E-Mail erfolgt.
Gültige Werte:
Datentyp: Boolescher Wert Standard: Falsch |
| Nicht_freigeben |
Kennzeichnung, die angibt, ob die Lead-Details freigegeben werden können.
Gültige Werte:
Datentyp: Boolescher Wert Standard: Falsch |
| E-Mail-Adresse des Leads. Datentyp: Zeichenfolge |
|
| external_id | ID, die vom System verwendet wird, das den Lead generiert hat, um den Lead im zugehörigen 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 in industryFeld der Account-Tabelle [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 | 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 Maximale Anzahl von Einzelposten: 100 – alle über, die ignoriert werden |
| Lead_line_items. External_ID | ID, die vom System verwendet wird, das die Lead-Position generiert hat, um die Position im zugehörigen 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 der Lead-Position zugeordnet ist. Datentyp: Objekt |
| lead_line_items.product_offering.sys_id | Erforderlich. SYS_ID des Produktangebotsdatensatzes, der der Lead-Position zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering] |
| Lead_line_items.quantity |
Menge der Artikel, die der Lead des zugehörigen Produktangebots kaufen möchte.
Datentyp: Zahl (Ganzzahl) Standard: 1 |
| lead_line_items.unit_of_measurement |
Details der Maßeinheit des Lead-Positionselements.
Datentyp: Objekt
|
| 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 die Lead-Position erstellten Arbeitsnotizen beschreibt. Datentyp: Array von Objekten Standard: Leeres Array |
| Lead_line_items. Work_Notes. Text | Text der Notiz des Autors. Datentyp: Zeichenfolge |
| Lead_Rating | Bewertung für den Lead, z. B. 100_kalt, 200_warm, 300_hot oder 400_super_hot. Hinweis: Dies ist ein Auswahlfeld. Es muss eines der Auswahlelemente enthalten, die im Feld „Lead_Rating“ der Leads-Tabelle definiert sind. Datentyp: Zeichenfolge |
| Lead_Score | Punktzahl für den Lead. Datentyp: Decimal 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 Leads-Tabelle definiert sind. Datentyp: Zeichenfolge |
| Lead_type |
Typ des Leads, z. B. „Neues Geschäft“ oder „vorhandenes Geschäft“.
Hinweis:
Dies ist ein Auswahlfeld. Es muss eines der Auswahlelemente enthalten, die im Feld „Lead_type“ der Leads-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 Lead-Disqualifizierung. Datentyp: Zeichenfolge Max. Länge: 160 Zeichen |
| Eigentümer |
Details der Person, die dem Lead zugeordnet ist.
Datentyp: Objekt
|
| Besitzer.sys_ID | SYS_ID des Anwenderdatensatzes der Person, die den Lead besitzt. Datentyp: Zeichenfolge Tabelle: Anwender [sys_user] |
| Grund | Grund für die Lead-Disqualifizierung, z. B. disqualifizieren. Datentyp: Zeichenfolge Max. Länge: 40 Zeichen |
| short_description | Kurzbeschreibung des Leads. Datentyp: Zeichenfolge Max. Länge: 160 Zeichen |
| Similar_Lead |
Details zu ähnlichen Leads. Verwenden Sie dies für eine mögliche Lead-Disqualifizierung.
Datentyp: Objekt
|
| Similar_Lead.sys_ID | SYS_ID des Lead-Datensatzes, der ein möglicher doppelter Lead ist. 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 Phasenfeld der Leads-Tabelle definiert sind. Datentyp: Zeichenfolge Standard: 100_New |
| Staat | Status, in dem sich der Lead befindet. Datentyp: Zeichenfolge |
| Straße | Straße, in der sich der Lead befindet. Datentyp: Zeichenfolge |
| Titel | Titel des Leads. Datentyp: Zeichenfolge |
| Website | Website-URL des Lead. Datentyp: Zeichenfolge |
| Work_Notes |
Liste der für den Lead erstellten Arbeitsnotizen.
Datentyp: Array von Objekten
Hinweis:
Ein Array von Arbeitsnotizen in der Anforderung wird als einzelner Text eingefügt. Dieser Text wird generiert, indem der Inhalt aus allen Arbeitsnotizobjekten in der Anforderung kombiniert wird, wobei jeder Eintrag durch ein Komma (,) getrennt wird. Standard: Leeres Array |
| Work_Notes. Text | Text der Notiz des Autors. Datentyp: Zeichenfolge |
| Postleitzahl | Postleitzahl des zugeordneten Leads. Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
| Header | 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 REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 201 | Erfolgreich. Lead und die zugehörigen Einzelposten wurden erfolgreich eingefügt. |
| 400 | Fehler. Mögliche Gründe:
|
| 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. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter
| Name | Beschreibung |
|---|---|
| Account | Account, der mit dem Lead verknüpft ist. Datentyp: Objekt |
| account.name | Name des Accounts. Datentyp: Zeichenfolge |
| Account.sys_ID |
SYS_ID des zugeordneten Account-Datensatzes.
Datentyp: Zeichenfolge Tabelle: Account [Customer_Account] |
| business_phone | Geschäftliche Telefonnummer des Leads. Datentyp: Zeichenfolge |
| city | Stadt, in der sich der Lead befindet. Datentyp: Zeichenfolge |
| Closed_date | Datum und Uhrzeit der Schließung des Leads. Datentyp: Objekt |
| 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, zu der der Lead geschlossen wurde, wie im zugehörigen Datensatz definiert. Datentyp: Zeichenfolge Format: UTC |
| Unternehmen | Unternehmensname des Leads. Datentyp: Zeichenfolge |
| consumer | Verbraucher, der dem Lead zugeordnet ist. Datentyp: Objekt |
| consumer.name | Name des zugeordneten Verbrauchers. Datentyp: Zeichenfolge |
| Consumer.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 | Name des Kontakts. Datentyp: Zeichenfolge |
| Contact.sys_ID |
SYS_ID des zugeordneten Kontaktdatensatzes.
Datentyp: Zeichenfolge Tabelle: Kontakt [Customer_contact] |
| country | Land, in dem sich der Lead befindet. Datentyp: Zeichenfolge |
| Do_Not_Call |
Kennzeichnung, die angibt, ob der Kommunikationsmodus per Telefon erfolgt.
Gültige Werte:
Datentyp: Boolescher Wert |
| Do_Not_email |
Kennzeichnung, die angibt, ob der Kommunikationsmodus per E-Mail erfolgt.
Gültige Werte:
Datentyp: Boolescher Wert |
| Nicht_freigeben | |
| E-Mail-Adresse des Leads. Datentyp: Zeichenfolge |
|
| external_id | ID, die vom System verwendet wird, das den Lead generiert hat, um den Lead im zugehörigen 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 in industryFeld der Account-Tabelle [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 | 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 | ID, die vom System verwendet wird, das die Lead-Position generiert hat, um die Position im zugehörigen 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_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. Nummer | Eindeutige vom System generierte Nummer des Lead-Positionselementdatensatzes. Datentyp: Zeichenfolge |
| Lead_line_items. Product_Offering | Informationen zum Produktangebot, das der Lead-Position zugeordnet ist. Datentyp: Objekt |
| Lead_line_items. Product_offering.Code | Code, der mit dem Produktangebot verknüpft ist. Hinweis: Dies ist eine vom System generierte alphanumerische Nummer basierend auf dem Produktnamen. Obwohl vom System generiert, können Sie den Code bearbeiten, um eine SKU oder andere branchenspezifische Produktcodes darzustellen. Datentyp: Zeichenfolge |
| Lead_line_items. product_offering.name | Name des Produktangebots. Datentyp: Zeichenfolge |
| Lead_line_items. Product_Offering.sys_ID |
SYS_ID des Produktangebotsdatensatzes, der der Lead-Position zugeordnet ist.
Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering] |
| Lead_line_items. Menge |
Menge der Artikel, die der Lead des zugehörigen Produktangebots kaufen möchte.
Datentyp: Zahl (Ganzzahl) |
| Lead_line_items. sys_created_by | Anwendername der Person, die die Lead-Position erstellt hat. Datentyp: Zeichenfolge |
| Lead_line_items. sys_created_on | Vom System generiertes Datum und Uhrzeit der Erstellung des Lead-Positionselements. Datentyp: Objekt |
| Lead_line_items. sys_created_on.display_value | Datum und Uhrzeit der Erstellung des Lead-Positionselements. Datentyp: Zeichenfolge Format: Standardinstanzformat und Zeitzone |
| 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 die Domänentrennung 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 die Domänentrennung aktiviert ist. Datentyp: Zeichenfolge |
| Lead_line_items. sys_ID | SYS_ID des Lead-Positionselementdatensatzes. Datentyp: Zeichenfolge |
| Lead_line_items. sys_mod_count | Gibt an, wie oft der zugehörige Lead-Positionselementdatensatz geändert wurde. 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 die zugehörige Lead-Position 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 |
| Lead_line_items. sys_updated_on. Display_value | Datum und Uhrzeit der letzten Aktualisierung des Lead-Positionselements. Datentyp: Zeichenfolge Format: Standardinstanzformat und Zeitzone |
| Lead_line_items. sys_updated_on. Wert | Datum und Uhrzeit der letzten Aktualisierung des Lead-Positionselements. Datentyp: Zeichenfolge Format: UTC |
| Lead_line_items. Unit_of_Measurement |
Details der Maßeinheit des Lead-Positionselements.
Datentyp: Objekt
|
| Lead_line_items. Unit_of_Measurement. Name | Name der Maßeinheit, z. B. „einzeln“ 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 die Lead-Position erstellten Arbeitsnotizen beschreibt.
Datentyp: Array von Objekten
|
| Lead_line_items. Work_Notes. Autor | Anwendername der Person, die die zugehörige Arbeitsnotiz erstellt hat. Datentyp: Zeichenfolge |
| Lead_line_items. Work_Notes. Datum | Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge |
| Lead_line_items. Work_Notes. Text | Text der Notiz des Autors. Datentyp: Zeichenfolge |
| Lead_Rating | Bewertung für den Lead, z. B. 100_kalt, 200_warm, 300_hot oder 400_super_hot. Hinweis: Dies ist ein Auswahlfeld. Es muss eines der Auswahlelemente enthalten, die im Feld „Lead_Rating“ der Leads-Tabelle definiert sind. Datentyp: Zeichenfolge |
| Lead_Score | Punktzahl für den Lead. Datentyp: Decimal 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 Leads-Tabelle definiert sind. Datentyp: Zeichenfolge |
| Lead_type |
Typ des Leads, z. B. „Neues Geschäft“ oder „vorhandenes Geschäft“.
Hinweis:
Dies ist ein Auswahlfeld. Es muss eines der Auswahlelemente enthalten, die im Feld „Lead_type“ der Leads-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 Lead-Disqualifizierung. Datentyp: Zeichenfolge Max. Länge: 160 Zeichen |
| Eigentümer |
Details der Person, die dem Lead zugeordnet ist.
Datentyp: Objekt
|
| owner.name | Name der Person, die den Lead besitzt. Datentyp: Zeichenfolge |
| Besitzer.sys_ID | SYS_ID des Anwenderdatensatzes der Person, die den Lead besitzt. Datentyp: Zeichenfolge Tabelle: Anwender [sys_user] |
| Grund | Grund für die Lead-Disqualifizierung, z. B. disqualifizieren. Datentyp: Zeichenfolge Max. Länge: 40 Zeichen |
| short_description | Kurzbeschreibung des Leads. Datentyp: Zeichenfolge Max. Länge: 160 Zeichen |
| Similar_Lead |
Details zu ähnlichen Leads. Verwenden Sie dies für eine mögliche Lead-Disqualifizierung.
Datentyp: Objekt
|
| similar_lead.name | Name des doppelten Leads. Datentyp: Zeichenfolge |
| Similar_Lead.sys_ID | SYS_ID des Lead-Datensatzes, der ein möglicher doppelter Lead ist. 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 Phasenfeld der Leads-Tabelle definiert sind. Datentyp: Zeichenfolge |
| Staat | Status, in dem sich der Lead befindet. Datentyp: Zeichenfolge |
| Straße | Straße, in der sich der Lead befindet. Datentyp: Zeichenfolge |
| sys_class_name | Vom System generierter Klassenname der Lead-Tabelle. Datentyp: Zeichenfolge |
| sys_created_by | Anwendername der Person, die den Lead erstellt hat. Datentyp: Zeichenfolge |
| sys_created_on | Vom System generiertes Datum und Uhrzeit der Erstellung des Leads. Datentyp: Objekt |
| sys_created_on. Display_value | Datum und Uhrzeit der Erstellung des Leads. Datentyp: Zeichenfolge Format: Standardinstanzformat und Zeitzone |
| 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 die Domänentrennung 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 die Domänentrennung aktiviert ist. Datentyp: Zeichenfolge |
| sys_id | SYS_ID des Lead-Datensatzes. Datentyp: Zeichenfolge Tabelle: Lead [sn_lead_mgmt_core_lead] |
| sys_mod_count | Gibt an, wie oft der zugeordnete Lead-Datensatz geändert wurde. 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 generiertes Datum und Uhrzeit der letzten Aktualisierung des Leads. Datentyp: Objekt |
| 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 | Website-URL des Lead. Datentyp: Zeichenfolge |
| Work_Notes |
Liste der für den Lead erstellten Arbeitsnotizen.
Datentyp: Array von Objekten
|
| Work_Notes. Autor | Anwendername der Person, die die zugehörige Arbeitsnotiz erstellt hat. Datentyp: Zeichenfolge |
| Work_Notes. Datum | Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge |
| Work_Notes. Text | Text der Notiz des Autors. Datentyp: Zeichenfolge |
| Postleitzahl | Postleitzahl des zugeordneten Leads. Datentyp: Zeichenfolge |
Curl-Anforderung
Das folgende Codebeispiel zeigt, wie ein neuer Lead-Datensatz mit einer Lead-Position erstellt wird.
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 der Lead- und Lead-Positionselemente.
{
"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
}
]
}