リード API

リリースバージョン: Australia

更新日 2026年03月12日

所要時間：117分

リード API は、インスタンスからマーケティングリードとそれに関連するリード品目を作成、更新、およびクエリ/取得できるようにするエンドポイントを提供します。

この API を使用して、インスタンスを外部の Web サイトやシステム (自動リードキャプチャシステムなど) と統合したり、リード情報を外部レポートシステムに提供したりします。

この API は、 sn_lead_mgmt_core 名前空間内で提供されます。API にアクセスするには、リード管理データモデル (sn_lead_mgmt_core) プラグインをインスタンスでアクティブ化する必要があり、呼び出し元ユーザーには sn_lead_mgmt_core.lead_integrator ロールが必要です。

リード管理の詳細については、「Using Lead Management」を参照してください。

リード API の拡張

関連するスクリプトインクルードのメソッドを上書きすることで、リード API を拡張できます。デフォルトの API 機能は、 LeadAPIProcessUtilOOB など、末尾が「OOB」のスクリプトインクルードにあります。この機能を上書きするには、 LeadAPIProcessUtil など、同じファイル名を持ちながら末尾が「OOB」で終わらない同じ名前とパラメーターを持つメソッドをスクリプトインクルードに作成します。

リード API の動作を変更するために上書きできるスクリプトインクルードのリストを次に示します。

LeadAPIProcessUtilOOB:リードおよびリード品目レコードの取得と作成を処理するメソッドが含まれています。
LeadApiValidationUtilOOB:POST および PATCH エンドポイントの JSON 要求オブジェクトを検証するメソッドが含まれます。
LeadAPIHelperOOB:次のような API ヘルパーメソッドが含まれています。
- リードと関連するリード品目のアレイを返します。
- 関連付けられた GlideRecord から JSON オブジェクトを返します。
- 無視されたすべてのフィールドを JSON オブジェクトから削除し、他の変換を実行します。
LeadAPIConstantsOOB:すべての API 操作の定数、ステータスコード、およびメッセージを含みます。また、POST エンドポイントと PATCH エンドポイントによって無視されるフィールドのリストも含まれます。

lead:GET /sn_lead_mgmt_core/lead

クエリパラメーターで渡されたフィルター基準に基づいて、すべてのリードと関連するリード品目を取得します。

このエンドポイントは、指定された制限とオフセットに従ってページネーションされた応答を返します。次のテーブルから情報を取得します。

リード [sn_lead_mgmt_core_lead]
リード品目 [sn_lead_mgmt_core_lead_line_item]

URL 形式

バージョニングされた URL: /api/sn_lead_mgmt_core/{api_version}/lead

デフォルト URL: /api/sn_lead_mgmt_core/{api_version}/lead

注:

使用可能なバージョンは、REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 1. パスパラメーター
名前	説明
api_version	オプション。アクセスするエンドポイントのバージョン。たとえば、 `v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列

表 : 2. クエリパラメーター
名前	説明
sysparm_fields	応答で返すフィールドのカンマ区切りリスト。無効なフィールドは無視されます。データタイプ：文字列デフォルト:すべてのフィールドを返します。
sysparm_limit	返されるレコードの最大数。このレコード数を超える要求の場合は、 sysparm_offset パラメーターを使用してレコード取得をページネーションします。この制限は、ACL 評価の前に適用されます。アクセス権のあるレコードを含めて、レコードが返されない場合は、アクセス権のあるレコードが最初に返されるようにレコードの順序を並べ替えます。注: sysparm_limit値が異常に大きいと、システムのパフォーマンスに影響を与える可能性があります。データタイプ：数値デフォルト：10000
sysparm_offset	レコード取得を開始する開始レコードインデックス。この値を使用して、レコード取得をページネーションします。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。たとえば、このエンドポイントを初めて呼び出すとき、 sysparm_offset は「0」に設定されます。使用可能なすべてのレコードを単純にページングするには、すべてのレコードの最後に到達するまで `sysparm_offset=sysparm_offset+sysparm_limit` を使用します。 sysparm_offset パラメーターに負の数を渡さないでください。データタイプ：数値デフォルト：0
sysparm_query	結果セットのフィルタリングに使用されるエンコードクエリ。例： `(sysparm_query=caller_id=javascript:gs.getUserID()^active=true)` エンコードされたクエリは順番をサポートしています。特定のフィールドに基づいて応答をソートするには、sysparm_queryで ORDERBY 句と ORDERBYDESC 句を使用します。たとえば、 `sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory` は、すべてのアクティブなレコードをフィルタリングし、結果を最初に番号の昇順に並べ替え、次にカテゴリ別の降順に並べ替えます。無効なフィールド名を指定するなどしてクエリーの一部が無効な場合、インスタンスは無効な部分を無視します。次に、クエリの有効な部分のみを使用して行を返します。この動作は、プロパティ glide.invalid_query.returns_no_rows を使用して制御できます。無効なクエリで行を返さない場合は、このプロパティを true に設定します。注: glide.invalid_query.returns_no_rows プロパティは、リスト、スクリプト (GlideRecord.query())、Web サービス API など、インスタンス全体のすべてのクエリの動作を制御します。データタイプ：文字列

表 : 3. 要求本文のパラメーター
名前	説明
なし

ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 4. 要求ヘッダー
ヘッダー	説明
Content-Type	要求本文のデータ形式。application/json のみをサポートします。

表 : 5. 応答ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。
Content-Range	ページネーションされた呼び出しで返されるコンテンツの範囲。たとえば、offset=2 および limit=3 の場合、Content-Range ヘッダーの値はアイテム 3 から 5 です。
リンク	クエリ結果を移動するためのリンク: 第 1 最終次へ前へ自己
total-count	フィルタリングされたレコードの合計数。

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 6. ステータスコード
ステータスコード	説明
200	要求が正常に処理されました。すべての回答が返されました (ページネーションなし)。
206	要求が正常に処理されました。応答で返された部分的なリソース (ページネーションあり)。
400	エラー。考えられる理由: 無効な制限/最大許容限度を超えています。無効なオフセットです。
403	レコードがアクセスを拒否しました。レコードをクエリするための十分な権限がありません。
404	見つかりません。要求されたアイテムが見つかりませんでした。
500	内部サーバーエラー要求の処理中に予期しないエラーが発生しました。

応答本文のパラメーター


名前	説明
アカウント	見込み客にリンクされたアカウント。データタイプ: オブジェクト `"account": { "name": "String", "sys_id": "String" }`
account.name	アカウントの名前。データタイプ：文字列
account.sys_id	関連付けられたアカウントレコードのSys_id。データタイプ：文字列テーブル:アカウント [customer_account]
会社_電話番号	リードの勤務先電話番号。データタイプ：文字列
city	リードが所在する市区町村。データタイプ：文字列
closed_date	リードがクローズされた日時。データタイプ: オブジェクト `"closed_date": { "display_value": "String", "value": "String" }`
closed_date。display_value	UI に表示される日時。データタイプ：文字列形式:ユーザーの形式とタイムゾーン。
closed_date.value	関連レコードで定義されているとおりにリードがクローズした日時。データタイプ：文字列形式:UTC
会社	リードの会社名。データタイプ：文字列
consumer	見込み客に関連付けられているコンシューマー。データタイプ: オブジェクト `"consumer": { "name": "String", "sys_id": "String" }`
consumer.name	関連付けられたコンシューマーの名前。データタイプ：文字列
consumer.sys_id	関連付けられたコンシューマーレコードのSys_id。データタイプ：文字列テーブル:コンシューマー [csm_consumer]
連絡先	リードアカウントに関連付けられている連絡先。データタイプ: オブジェクト `"contact": { "name": "String", "sys_id": "String" }`
contact.name	連絡先の名前。データタイプ：文字列
contact.sys_id	関連付けられた連絡先レコードのSys_id。データタイプ：文字列テーブル:連絡先 [customer_contact]
country	リードが所在する国。データタイプ：文字列
do_not_call	通信モードが電話であるかどうかを示すフラグ。有効な値： true:連絡先に電話をかけることができます。 false:連絡先に電話をかけません。データタイプ：ブーリアン
do_not_email	通信モードがメールかどうかを示すフラグ。有効な値： true:メールで連絡できます。 false:メールで連絡しません。データタイプ：ブーリアン
do_not_share	リードの詳細を共有できるかどうかを示すフラグ。有効な値： true:リードの詳細を共有できます。 false:リードの詳細を共有できません。データタイプ：ブーリアン
email	リードのメールアドレス。データタイプ：文字列
external_id	関連するシステム内のリードを識別するために、リードを生成したシステムによって使用された ID。データタイプ：文字列
external_system	HubSpot や pipedrive など、見込み客に関連付けられた外部システムの名前。データタイプ：文字列
first_name	見込み客に関連付けられた連絡先の名。データタイプ：文字列
業種	リードが属する業界。データタイプ：文字列テーブル:アカウント [customer_account] テーブルの industry フィールドにあります。
last_name	見込み客に関連付けられた連絡先の名前 (姓)。データタイプ：文字列
lead_group	見込み客が属するグループ。データタイプ: オブジェクト `"lead_group": { "name: "String", "sys_id": "String" }`
lead_group.name	リードグループの名前。データタイプ：文字列
lead_group.sys_id	リードグループレコードのSys_id。データタイプ：文字列テーブル： Group [sys_user_group]
lead_line_items	リードに関連付けられたリード品目の詳細。データタイプ：オブジェクトのアレイ `"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。データタイプ：文字列
lead_line_items。external_system	HubSpot や pipedrive など、リード品目に関連付けられた外部システムの名前。データタイプ：文字列
lead_line_items。鉛	品目に関連付けられたリードに関する詳細。データタイプ: オブジェクト `"lead: { "name": "String", "sys_id": "String" }`
lead_line_items。lead.name	関連するリードの名前。データタイプ：文字列
lead_line_items。lead.sys_id	関連するリードレコードのSys_id。データタイプ：文字列
lead_line_items。数	見込み顧客品目レコードの一意のシステム生成番号。データタイプ：文字列
lead_line_items。product_offering	リード品目に関連付けられた製品オファリングに関する情報。データタイプ: オブジェクト `"product_offering": { "code": " String", "name": "String", "sys_id": "String" }`
lead_line_items。product_offering.code	製品オファリングにリンクされたコード。注: これは、製品名に基づいてシステムによって生成された英数字です。システムで生成されますが、コードを編集して SKU またはその他の業界固有の製品コードを表すことができます。データタイプ：文字列
lead_line_items。product_offering.name	製品オファリングの名前。データタイプ：文字列
lead_line_items。product_offering.sys_id	リード品目に関連付けられた製品オファリングレコードのSys_id。データタイプ：文字列テーブル:製品オファリング [sn_prd_pm_product_offering]
lead_line_items。量	関連製品オファリングのうち、リードが購入を希望するアイテムの数量。データタイプ:数値 (整数)
lead_line_items。sys_created_by	リード品目を作成したユーザーの名前。データタイプ：文字列
lead_line_items。sys_created_on	見込み顧客品目が作成されたシステム生成日時。データタイプ: オブジェクト `"sys_created_on": { "display_value": "String", "value": "String" }`
lead_line_items。sys_created_on.display_value	リード品目が作成された日時。データタイプ：文字列形式:デフォルトのインスタンス形式とタイムゾーン
lead_line_items。sys_created_on.value	リード品目が作成された日時。データタイプ：文字列形式:UTC
lead_line_items。sys_domain	リード品目が属するドメインレコードのSys_id。注: このパラメーターは、ドメインセパレーションが有効になっている場合にのみ応答で返されます。データタイプ：文字列
lead_line_items.sys_domain_path	リード品目が属するドメインのパス。注: このパラメーターは、ドメインセパレーションが有効になっている場合にのみ応答で返されます。データタイプ：文字列
lead_line_items。sys_id	リード品目レコードのSys_id。データタイプ：文字列
lead_line_items。sys_mod_count	関連するリード品目レコードが変更された回数。データタイプ:数値 (整数)
lead_line_items。sys_tags	リード品目に関連付けられたシステムタグのリスト。データタイプ：アレイ
lead_line_items。sys_updated_by	関連するリード品目を最後に更新したユーザーの名前。データタイプ：文字列
lead_line_items。sys_updated_on	リード品目が最後に更新されたシステム生成日時。データタイプ: オブジェクト `"sys_created_on": { "display_value": "String", "value": "String" }`
lead_line_items。sys_updated_on。display_value	リード品目が最後に更新された日時。データタイプ：文字列形式:デフォルトのインスタンス形式とタイムゾーン
lead_line_items。sys_updated_on。価値	リード品目が最後に更新された日時。データタイプ：文字列形式:UTC
lead_line_items。unit_of_measurement	リード品目の測定単位の詳細。データタイプ: オブジェクト `"unit_of_measurement": { "name": "String", "sys_id": "String" }`
lead_line_items。unit_of_measurement。名前	各、立方フィートなどの測定単位の名前。データタイプ：文字列
lead_line_items。unit_of_measurement。sys_id	測定単位を説明するレコードのSys_id。データタイプ：文字列テーブル:測定単位 [sn_prd_pm_uom]
lead_line_items。work_notes	リード品目に対して作成された作業メモを説明するリスト。データタイプ：オブジェクトのアレイ `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
lead_line_items。work_notes。著者	関連する作業メモを作成したユーザーのユーザー名。データタイプ：文字列
lead_line_items。work_notes。日付	メモが作成された日付。データタイプ：文字列
lead_line_items。work_notes。テキスト	作成者が作成したメモのテキスト。データタイプ：文字列
lead_rating	リードの評価 (100_cold、200_warm、300_hot、400_super_hotなど)。注: これは選択肢フィールドです。リードテーブルの [lead_rating] フィールドで定義されている選択肢アイテムのいずれかが含まれている必要があります。データタイプ：文字列
lead_score	リードのスコア。データタイプ:10 進数範囲:1〜100
lead_source	見込み客のオリジネータ。注: これは選択肢フィールドです。リードテーブルの [lead_source] フィールドで定義されている選択肢アイテムのいずれかが含まれている必要があります。データタイプ：文字列
lead_type	新規ビジネスや既存ビジネスなどのリードのタイプ。注: これは選択肢フィールドです。リードテーブルの [lead_type] フィールドで定義されている選択肢アイテムのいずれかが含まれている必要があります。データタイプ：文字列
middle_name	リードの連絡先のミドルネーム。データタイプ：文字列
mobile_phone	見込み客の連絡先の電話番号。データタイプ：文字列
number	システムによって生成されたリードレコードの一意の番号。データタイプ：文字列
other_reason	リードを認定解除するその他の理由。データタイプ：文字列最大長:160 文字
owner	リードに関連付けられているユーザーの詳細。データタイプ: オブジェクト `"owner": { "name": "String", "sys_id": "String" }`
owner.name	リードを所有するユーザーの名前。データタイプ：文字列
owner.sys_id	リードを所有するユーザーのユーザーレコードのSys_id。データタイプ：文字列テーブル：ユーザー [sys_user]
理由	リードを認定解除する理由 (「認定しない」など)。データタイプ：文字列最大長:40 文字
short_description	リードの簡単な説明。データタイプ：文字列最大長:160 文字
similar_lead	類似のリードの詳細。これは、リードを失格する場合に使用します。データタイプ: オブジェクト `"similar_lead": { "name": "String", "sys_id": "String" }`
similar_lead.name	重複リードの名前。データタイプ：文字列
similar_lead.sys_id	重複している可能性があるリードレコードのSys_id。データタイプ：文字列テーブル:リード [sn_lead_mgmt_core_lead]
ステージ	リードのステージ (100_new など)。注: これは選択肢フィールドです。リードテーブルのステージフィールドで定義された選択肢アイテムのいずれかが含まれている必要があります。データタイプ：文字列
状況	リードが存在する都道府県。データタイプ：文字列
street	見込み客が存在する番地。データタイプ：文字列
sys_class_name	リードテーブルのシステム生成クラス名。データタイプ：文字列
sys_created_by	リードを作成したユーザーのユーザー名。データタイプ：文字列
sys_created_on	見込み客が作成されたシステム生成の日時。データタイプ: オブジェクト `"sys_created_on": { "display_value": "String", "value": "String" }`
sys_created_on。display_value	見込み客が作成された日時。データタイプ：文字列形式:デフォルトのインスタンス形式とタイムゾーン
sys_created_on。価値	見込み客が作成された日時。データタイプ：文字列形式:UTC
sys_domain	見込み客が属するドメインレコードのSys_id。注: このパラメーターは、ドメインセパレーションが有効になっている場合にのみ応答で返されます。データタイプ：文字列
sys_domain_path	リードが属するドメインのパス。注: このパラメーターは、ドメインセパレーションが有効になっている場合にのみ応答で返されます。データタイプ：文字列
sys_id	リードレコードのSys_id。データタイプ：文字列テーブル:リード [sn_lead_mgmt_core_lead]
sys_mod_count	関連するリードレコードが変更された回数。データタイプ:数値 (整数)
sys_tags	見込み客に関連付けられているシステムタグのリスト。これらのタグを使用して、リードを分類できます。データタイプ：アレイ
sys_updated_by	リードレコードを最後に更新したユーザーの名前。データタイプ：文字列
sys_updated_on	リードが最後に更新されたシステム生成日時。データタイプ: オブジェクト `"sys_created_on": { "display_value": "String", "value": "String" }`
sys_updated_on。display_value	リードが最後に更新された日時。データタイプ：文字列形式:インスタンスのデフォルトの形式とタイムゾーン
sys_updated_on。価値	リードが最後に更新された日時。データタイプ：文字列形式:UTC
タイトル	リードの役職。データタイプ：文字列
Web サイト	リードの Web サイト URL。データタイプ：文字列
work_notes	リードに対して作成された作業メモのリスト。データタイプ：オブジェクトのアレイ `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
work_notes。著者	関連する作業メモを作成したユーザーのユーザー名。データタイプ：文字列
work_notes。日付	メモが作成された日付。データタイプ：文字列
work_notes。テキスト	作成者が作成したメモのテキスト。データタイプ：文字列
zip	関連するリードの郵便番号。データタイプ：文字列

cURL 要求

次のコード例は、クエリパラメーターを渡して、返されるリードを指定する方法を示しています。

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"

リードは、オブジェクトのアレイで返されます。

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

指定されたsys_idのリードレコードと関連するすべてのリード品目を返します。

このエンドポイントは、次のテーブルから情報を取得します。

リード [sn_lead_mgmt_core_lead]
リード品目 [sn_lead_mgmt_core_lead_line_item]

URL 形式

バージョニングされた URL: /api/sn_lead_mgmt_core/{api_version}/lead/{sys_id}

デフォルト URL: /api/sn_lead_mgmt_core/{api_version}/lead/{sys_id}

注:

サポートされている要求パラメーター

表 : 7. パスパラメーター
名前	説明
api_version	オプション。アクセスするエンドポイントのバージョン。たとえば、 `v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列
sys_id	取得するリードのSys_id。データタイプ：文字列テーブル:リード [sn_lead_mgmt_core_lead]

表 : 8. クエリパラメーター
名前	説明
なし

表 : 9. 要求本文パラメーター (XML または JSON)
名前	説明
なし

ヘッダー

表 : 10. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 11. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 12. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
403	禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。
404	見つかりません。要求されたアイテムが見つかりませんでした。
500	内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

応答本文のパラメーター


名前	説明
アカウント	見込み客にリンクされたアカウント。データタイプ: オブジェクト `"account": { "name": "String", "sys_id": "String" }`
account.name	アカウントの名前。データタイプ：文字列
account.sys_id	関連付けられたアカウントレコードのSys_id。データタイプ：文字列テーブル:アカウント [customer_account]
会社_電話番号	リードの勤務先電話番号。データタイプ：文字列
city	リードが所在する市区町村。データタイプ：文字列
closed_date	リードがクローズされた日時。データタイプ: オブジェクト `"closed_date": { "display_value": "String", "value": "String" }`
closed_date。display_value	UI に表示される日時。データタイプ：文字列形式:ユーザーの形式とタイムゾーン。
closed_date.value	関連レコードで定義されているとおりにリードがクローズした日時。データタイプ：文字列形式:UTC
会社	リードの会社名。データタイプ：文字列
consumer	見込み客に関連付けられているコンシューマー。データタイプ: オブジェクト `"consumer": { "name": "String", "sys_id": "String" }`
consumer.name	関連付けられたコンシューマーの名前。データタイプ：文字列
consumer.sys_id	関連付けられたコンシューマーレコードのSys_id。データタイプ：文字列テーブル:コンシューマー [csm_consumer]
連絡先	リードアカウントに関連付けられている連絡先。データタイプ: オブジェクト `"contact": { "name": "String", "sys_id": "String" }`
contact.name	連絡先の名前。データタイプ：文字列
contact.sys_id	関連付けられた連絡先レコードのSys_id。データタイプ：文字列テーブル:連絡先 [customer_contact]
country	リードが所在する国。データタイプ：文字列
do_not_call	通信モードが電話であるかどうかを示すフラグ。有効な値： true:連絡先に電話をかけることができます。 false:連絡先に電話をかけません。データタイプ：ブーリアン
do_not_email	通信モードがメールかどうかを示すフラグ。有効な値： true:メールで連絡できます。 false:メールで連絡しません。データタイプ：ブーリアン
do_not_share	リードの詳細を共有できるかどうかを示すフラグ。有効な値： true:リードの詳細を共有できます。 false:リードの詳細を共有できません。データタイプ：ブーリアン
email	リードのメールアドレス。データタイプ：文字列
external_id	関連するシステム内のリードを識別するために、リードを生成したシステムによって使用された ID。データタイプ：文字列
external_system	HubSpot や pipedrive など、見込み客に関連付けられた外部システムの名前。データタイプ：文字列
first_name	見込み客に関連付けられた連絡先の名。データタイプ：文字列
業種	リードが属する業界。データタイプ：文字列テーブル:アカウント [customer_account] テーブルの industry フィールドにあります。
last_name	見込み客に関連付けられた連絡先の名前 (姓)。データタイプ：文字列
lead_group	見込み客が属するグループ。データタイプ: オブジェクト `"lead_group": { "name: "String", "sys_id": "String" }`
lead_group.name	リードグループの名前。データタイプ：文字列
lead_group.sys_id	リードグループレコードのSys_id。データタイプ：文字列テーブル： Group [sys_user_group]
lead_line_items	リードに関連付けられたリード品目の詳細。データタイプ：オブジェクトのアレイ `"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。データタイプ：文字列
lead_line_items。external_system	HubSpot や pipedrive など、リード品目に関連付けられた外部システムの名前。データタイプ：文字列
lead_line_items。鉛	品目に関連付けられたリードに関する詳細。データタイプ: オブジェクト `"lead: { "name": "String", "sys_id": "String" }`
lead_line_items。lead.name	関連するリードの名前。データタイプ：文字列
lead_line_items。lead.sys_id	関連するリードレコードのSys_id。データタイプ：文字列
lead_line_items。数	見込み顧客品目レコードの一意のシステム生成番号。データタイプ：文字列
lead_line_items。product_offering	リード品目に関連付けられた製品オファリングに関する情報。データタイプ: オブジェクト `"product_offering": { "code": " String", "name": "String", "sys_id": "String" }`
lead_line_items。product_offering.code	製品オファリングにリンクされたコード。注: これは、製品名に基づいてシステムによって生成された英数字です。システムで生成されますが、コードを編集して SKU またはその他の業界固有の製品コードを表すことができます。データタイプ：文字列
lead_line_items。product_offering.name	製品オファリングの名前。データタイプ：文字列
lead_line_items。product_offering.sys_id	リード品目に関連付けられた製品オファリングレコードのSys_id。データタイプ：文字列テーブル:製品オファリング [sn_prd_pm_product_offering]
lead_line_items。量	関連製品オファリングのうち、リードが購入を希望するアイテムの数量。データタイプ:数値 (整数)
lead_line_items。sys_created_by	リード品目を作成したユーザーの名前。データタイプ：文字列
lead_line_items。sys_created_on	見込み顧客品目が作成されたシステム生成日時。データタイプ: オブジェクト `"sys_created_on": { "display_value": "String", "value": "String" }`
lead_line_items。sys_created_on.display_value	リード品目が作成された日時。データタイプ：文字列形式:デフォルトのインスタンス形式とタイムゾーン
lead_line_items。sys_created_on.value	リード品目が作成された日時。データタイプ：文字列形式:UTC
lead_line_items。sys_domain	リード品目が属するドメインレコードのSys_id。注: このパラメーターは、ドメインセパレーションが有効になっている場合にのみ応答で返されます。データタイプ：文字列
lead_line_items.sys_domain_path	リード品目が属するドメインのパス。注: このパラメーターは、ドメインセパレーションが有効になっている場合にのみ応答で返されます。データタイプ：文字列
lead_line_items。sys_id	リード品目レコードのSys_id。データタイプ：文字列
lead_line_items。sys_mod_count	関連するリード品目レコードが変更された回数。データタイプ:数値 (整数)
lead_line_items。sys_tags	リード品目に関連付けられたシステムタグのリスト。データタイプ：アレイ
lead_line_items。sys_updated_by	関連するリード品目を最後に更新したユーザーの名前。データタイプ：文字列
lead_line_items。sys_updated_on	リード品目が最後に更新されたシステム生成日時。データタイプ: オブジェクト `"sys_created_on": { "display_value": "String", "value": "String" }`
lead_line_items。sys_updated_on。display_value	リード品目が最後に更新された日時。データタイプ：文字列形式:デフォルトのインスタンス形式とタイムゾーン
lead_line_items。sys_updated_on。価値	リード品目が最後に更新された日時。データタイプ：文字列形式:UTC
lead_line_items。unit_of_measurement	リード品目の測定単位の詳細。データタイプ: オブジェクト `"unit_of_measurement": { "name": "String", "sys_id": "String" }`
lead_line_items。unit_of_measurement。名前	各、立方フィートなどの測定単位の名前。データタイプ：文字列
lead_line_items。unit_of_measurement。sys_id	測定単位を説明するレコードのSys_id。データタイプ：文字列テーブル:測定単位 [sn_prd_pm_uom]
lead_line_items。work_notes	リード品目に対して作成された作業メモを説明するリスト。データタイプ：オブジェクトのアレイ `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
lead_line_items。work_notes。著者	関連する作業メモを作成したユーザーのユーザー名。データタイプ：文字列
lead_line_items。work_notes。日付	メモが作成された日付。データタイプ：文字列
lead_line_items。work_notes。テキスト	作成者が作成したメモのテキスト。データタイプ：文字列
lead_rating	リードの評価 (100_cold、200_warm、300_hot、400_super_hotなど)。注: これは選択肢フィールドです。リードテーブルの [lead_rating] フィールドで定義されている選択肢アイテムのいずれかが含まれている必要があります。データタイプ：文字列
lead_score	リードのスコア。データタイプ:10 進数範囲:1〜100
lead_source	見込み客のオリジネータ。注: これは選択肢フィールドです。リードテーブルの [lead_source] フィールドで定義されている選択肢アイテムのいずれかが含まれている必要があります。データタイプ：文字列
lead_type	新規ビジネスや既存ビジネスなどのリードのタイプ。注: これは選択肢フィールドです。リードテーブルの [lead_type] フィールドで定義されている選択肢アイテムのいずれかが含まれている必要があります。データタイプ：文字列
middle_name	リードの連絡先のミドルネーム。データタイプ：文字列
mobile_phone	見込み客の連絡先の電話番号。データタイプ：文字列
number	システムによって生成されたリードレコードの一意の番号。データタイプ：文字列
other_reason	リードを認定解除するその他の理由。データタイプ：文字列最大長:160 文字
owner	リードに関連付けられているユーザーの詳細。データタイプ: オブジェクト `"owner": { "name": "String", "sys_id": "String" }`
owner.name	リードを所有するユーザーの名前。データタイプ：文字列
owner.sys_id	リードを所有するユーザーのユーザーレコードのSys_id。データタイプ：文字列テーブル：ユーザー [sys_user]
理由	リードを認定解除する理由 (「認定しない」など)。データタイプ：文字列最大長:40 文字
short_description	リードの簡単な説明。データタイプ：文字列最大長:160 文字
similar_lead	類似のリードの詳細。これは、リードを失格する場合に使用します。データタイプ: オブジェクト `"similar_lead": { "name": "String", "sys_id": "String" }`
similar_lead.name	重複リードの名前。データタイプ：文字列
similar_lead.sys_id	重複している可能性があるリードレコードのSys_id。データタイプ：文字列テーブル:リード [sn_lead_mgmt_core_lead]
ステージ	リードのステージ (100_new など)。注: これは選択肢フィールドです。リードテーブルのステージフィールドで定義された選択肢アイテムのいずれかが含まれている必要があります。データタイプ：文字列
状況	リードが存在する都道府県。データタイプ：文字列
street	見込み客が存在する番地。データタイプ：文字列
sys_class_name	リードテーブルのシステム生成クラス名。データタイプ：文字列
sys_created_by	リードを作成したユーザーのユーザー名。データタイプ：文字列
sys_created_on	見込み客が作成されたシステム生成の日時。データタイプ: オブジェクト `"sys_created_on": { "display_value": "String", "value": "String" }`
sys_created_on。display_value	見込み客が作成された日時。データタイプ：文字列形式:デフォルトのインスタンス形式とタイムゾーン
sys_created_on。価値	見込み客が作成された日時。データタイプ：文字列形式:UTC
sys_domain	見込み客が属するドメインレコードのSys_id。注: このパラメーターは、ドメインセパレーションが有効になっている場合にのみ応答で返されます。データタイプ：文字列
sys_domain_path	リードが属するドメインのパス。注: このパラメーターは、ドメインセパレーションが有効になっている場合にのみ応答で返されます。データタイプ：文字列
sys_id	リードレコードのSys_id。データタイプ：文字列テーブル:リード [sn_lead_mgmt_core_lead]
sys_mod_count	関連するリードレコードが変更された回数。データタイプ:数値 (整数)
sys_tags	見込み客に関連付けられているシステムタグのリスト。これらのタグを使用して、リードを分類できます。データタイプ：アレイ
sys_updated_by	リードレコードを最後に更新したユーザーの名前。データタイプ：文字列
sys_updated_on	リードが最後に更新されたシステム生成日時。データタイプ: オブジェクト `"sys_created_on": { "display_value": "String", "value": "String" }`
sys_updated_on。display_value	リードが最後に更新された日時。データタイプ：文字列形式:インスタンスのデフォルトの形式とタイムゾーン
sys_updated_on。価値	リードが最後に更新された日時。データタイプ：文字列形式:UTC
タイトル	リードの役職。データタイプ：文字列
Web サイト	リードの Web サイト URL。データタイプ：文字列
work_notes	リードに対して作成された作業メモのリスト。データタイプ：オブジェクトのアレイ `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
work_notes。著者	関連する作業メモを作成したユーザーのユーザー名。データタイプ：文字列
work_notes。日付	メモが作成された日付。データタイプ：文字列
work_notes。テキスト	作成者が作成したメモのテキスト。データタイプ：文字列
zip	関連するリードの郵便番号。データタイプ：文字列

cURL 要求

次のコード例は、sys_idが 856b6a95ffde8210b85dffffffffffd7 のリードレコードを取得する方法を示しています。

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

返される結果は次のとおりです。

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

リード - PATCH /sn_lead_mgmt_core/lead/{sys_id}

指定されたリードレコードとそれに関連するリード品目を更新します。このエンドポイントを使用して、指定したリードに新しいリード品目を関連付けることもできます。

このエンドポイントは、次のテーブルの情報を更新します。

リード [sn_lead_mgmt_core_lead]
リード品目 [sn_lead_mgmt_core_lead_line_item]

渡されたパラメーターのルール:

無効なパラメーター名は無視されます。
必須ではない選択肢フィールドと参照フィールドの無効な値は無視されます。
1 つ以上のフィールドでフィールド書き込みアクセスが拒否された場合、制限付きフィールドは無視されます。
この API を使用してシステムフィールド値を挿入することはできません。指定された値は無視されます。システムフィールドは無視フィールドリストの一部であり、構成可能です。
パラメーター account、 contact、および consumer の値は、 account パラメーターと consumer パラメーターの両方が空でない場合無視されます。
特に指定しない限り、渡されていないすべてのパラメーターのデフォルト値は「null」です。

注:

このエンドポイントは、指定されたパラメーターのみを変更します。現在のリードまたはリード品目レコードに存在するパラメーターがコールで指定されていない場合、その内容は変更されません。

URL 形式

バージョニングされた URL: /api/sn_lead_mgmt_core/{api_version}/lead/{sys_id}

デフォルト URL: /api/sn_lead_mgmt_core/{api_version}/lead/{sys_id}

注:

サポートされている要求パラメーター

表 : 13. パスパラメーター
名前	説明
api_version	オプション。アクセスするエンドポイントのバージョン。たとえば、 `v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列
sys_id	更新するリードレコードのSys_id。データタイプ：文字列テーブル:リード [sn_lead_mgmt_core_lead]

表 : 14. クエリパラメーター
名前	説明
なし

表 : 15. 要求本文のパラメーター
名前	説明
アカウント	見込み客に関連付けられているアカウントの詳細。データタイプ: オブジェクト `"account": { "sys_id": "String" }`
account.sys_id	関連付けられたアカウントレコードのSys_id。データタイプ：文字列テーブル:アカウント [customer_account]
会社_電話番号	リードの勤務先電話番号。データタイプ：文字列
city	リードが所在する市区町村。データタイプ：文字列
会社	リードの会社名。データタイプ：文字列
consumer	見込み客に関連付けられているコンシューマー。データタイプ: オブジェクト `"consumer": { "sys_id": "String" }`
consumer.sys_id	関連付けられたコンシューマーレコードのSys_id。データタイプ：文字列テーブル:コンシューマー [csm_consumer]
連絡先	リードアカウントに関連付けられている連絡先。データタイプ: オブジェクト `"contact": { "sys_id": "String" }`
contact.sys_id	関連付けられた連絡先レコードのSys_id。データタイプ：文字列テーブル:連絡先 [customer_contact]
country	リードが所在する国。データタイプ：文字列
do_not_call	通信モードが電話であるかどうかを示すフラグ。有効な値： true:連絡先に電話をかけることができます。 false:連絡先に電話をかけません。データタイプ：ブーリアン
do_not_email	通信モードがメールかどうかを示すフラグ。有効な値： true:メールで連絡できます。 false:メールで連絡しません。データタイプ：ブーリアン
do_not_share	リードの詳細を共有できるかどうかを示すフラグ。有効な値： true:リードの詳細を共有できます。 false:リードの詳細を共有できません。データタイプ：ブーリアン
email	リードのメールアドレス。データタイプ：文字列
external_id	関連するシステム内のリードを識別するために、リードを生成したシステムによって使用された ID。データタイプ：文字列
external_system	HubSpot や pipedrive など、見込み客に関連付けられた外部システムの名前。データタイプ：文字列
first_name	見込み客に関連付けられた連絡先の名。データタイプ：文字列
業種	リードが属する業界。データタイプ：文字列テーブル:アカウント [customer_account] テーブルの industry フィールドにあります。
last_name	必須です。見込み客に関連付けられた連絡先の名前 (姓)。データタイプ：文字列
lead_group	見込み客が属するグループ。データタイプ: オブジェクト `"lead_group": { "sys_id": "String" }`
lead_group.sys_id	リードグループレコードのSys_id。データタイプ：文字列テーブル： Group [sys_user_group]
lead_line_items	リードに関連付けられるリード品目のリスト。見込み客が属するグループ。データタイプ: オブジェクト `"lead_line_items": [ { "external_id": "String", "external_system": "String", "product_offering": {Object}, "quantity": Number, "work_notes": [Array], "unit_of_measurement": {Object} } ]` 最大品目数:100 - 無視されるオーバーアイテム
lead_line_items。external_id	関連システム内の品目を識別するために、見込み顧客品目を生成したシステムで使用される ID。データタイプ：文字列
lead_line_items。external_system	HubSpot や pipedrive など、リード品目に関連付けられた外部システムの名前。データタイプ：文字列
lead_line_items.product_offering	必須です。リード品目に関連付けられた製品オファリングに関する情報。データタイプ: オブジェクト `"product_offering": { "sys_id": "String" }`
lead_line_items.product_offering.sys_id	必須です。リード品目に関連付けられた製品オファリングレコードのSys_id。データタイプ：文字列テーブル:製品オファリング [sn_prd_pm_product_offering]
lead_line_items.quantity	関連製品オファリングのうち、リードが購入を希望するアイテムの数量。データタイプ:数値 (整数)
lead_line_items。unit_of_measurement	リード品目の測定単位の詳細。データタイプ: オブジェクト `"unit_of_measurement": { "sys_id": "String" }`
lead_line_items。unit_of_measurement.sys_id	測定単位を説明するレコードのSys_id。データタイプ：文字列テーブル:測定単位 [sn_prd_pm_uom]
lead_line_items.work_notes	リード品目に対して作成された作業メモを説明するリスト。データタイプ：オブジェクトのアレイ `"work_notes": [ "text": "String" } ]`
lead_line_items。work_notes。テキスト	作成者が作成したメモのテキスト。データタイプ：文字列
lead_rating	リードの評価 (100_cold、200_warm、300_hot、400_super_hotなど)。注: これは選択肢フィールドです。リードテーブルの [lead_rating] フィールドで定義されている選択肢アイテムのいずれかが含まれている必要があります。データタイプ：文字列
lead_score	リードのスコア。データタイプ:10 進数範囲:1〜100
lead_source	見込み客のオリジネータ。注: これは選択肢フィールドです。リードテーブルの [lead_source] フィールドで定義されている選択肢アイテムのいずれかが含まれている必要があります。データタイプ：文字列
lead_type	新規ビジネスや既存ビジネスなどのリードのタイプ。注: これは選択肢フィールドです。リードテーブルの [lead_type] フィールドで定義されている選択肢アイテムのいずれかが含まれている必要があります。データタイプ：文字列
middle_name	リードの連絡先のミドルネーム。データタイプ：文字列
mobile_phone	見込み客の連絡先の電話番号。データタイプ：文字列
other_reason	リードを認定解除するその他の理由。データタイプ：文字列最大長:160 文字
owner	リードに関連付けられているユーザーの詳細。データタイプ: オブジェクト `"owner": { "sys_id": "String" }`
owner.sys_id	リードを所有するユーザーのユーザーレコードのSys_id。データタイプ：文字列テーブル：ユーザー [sys_user]
理由	リードを認定解除する理由 (「認定しない」など)。データタイプ：文字列最大長:40 文字
short_description	リードの簡単な説明。データタイプ：文字列最大長:160 文字
similar_lead	類似のリードの詳細。これは、リードを失格する場合に使用します。データタイプ: オブジェクト `"similar_lead": { "sys_id": "String" }`
similar_lead.sys_id	重複している可能性があるリードレコードのSys_id。データタイプ：文字列テーブル:リード [sn_lead_mgmt_core_lead]
ステージ	リードのステージ (100_new など)。注: これは選択肢フィールドです。リードテーブルのステージフィールドで定義された選択肢アイテムのいずれかが含まれている必要があります。データタイプ：文字列
状況	リードが存在する都道府県。データタイプ：文字列
street	見込み客が存在する番地。データタイプ：文字列
タイトル	リードの役職。データタイプ：文字列
Web サイト	リードの Web サイト URL。データタイプ：文字列
work_notes	リードに対して作成された作業メモのリスト。データタイプ：オブジェクトのアレイ `"work_notes": [ { "text": "String" } ]` 注: 要求内の作業メモのアレイが単一のテキストとして挿入されます。このテキストは、要求内のすべての作業メモオブジェクトのコンテンツを、各エントリーをカンマ (,) で区切って組み合わせて生成されます。
work_notes。テキスト	作成者が作成したメモのテキスト。データタイプ：文字列
zip	関連するリードの郵便番号。データタイプ：文字列

ヘッダー

表 : 16. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。
Content-Type	要求本文のデータ形式。application/json のみをサポートします。

表 : 17. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 18. ステータスコード
ステータスコード	説明
200	成功。リードおよびリード品目レコードが正常に更新されました。
400	エラー。考えられる理由: 無効なペイロード:要求本文が無効または空です。無効なペイロード:メール/電話番号フィールドのフィールド値が無効です。無効なペイロード:必須フィールドがないか、その値が空です。無効なペイロード:ステージは「400_closed_won」です。API を使用したリードの認定はサポートされていません。更新するリードのステージが既にクローズ済みステータスになっており、それを更新しようとしている場合。
403	禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。
404	見つかりません。要求されたアイテムが見つかりませんでした。
500	内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

応答本文のパラメーター


名前	説明
アカウント	見込み客にリンクされたアカウント。データタイプ: オブジェクト `"account": { "name": "String", "sys_id": "String" }`
account.name	アカウントの名前。データタイプ：文字列
account.sys_id	関連付けられたアカウントレコードのSys_id。データタイプ：文字列テーブル:アカウント [customer_account]
会社_電話番号	リードの勤務先電話番号。データタイプ：文字列
city	リードが所在する市区町村。データタイプ：文字列
closed_date	リードがクローズされた日時。データタイプ: オブジェクト `"closed_date": { "display_value": "String", "value": "String" }`
closed_date。display_value	UI に表示される日時。データタイプ：文字列形式:ユーザーの形式とタイムゾーン。
closed_date.value	関連レコードで定義されているとおりにリードがクローズした日時。データタイプ：文字列形式:UTC
会社	リードの会社名。データタイプ：文字列
consumer	見込み客に関連付けられているコンシューマー。データタイプ: オブジェクト `"consumer": { "name": "String", "sys_id": "String" }`
consumer.name	関連付けられたコンシューマーの名前。データタイプ：文字列
consumer.sys_id	関連付けられたコンシューマーレコードのSys_id。データタイプ：文字列テーブル:コンシューマー [csm_consumer]
連絡先	リードアカウントに関連付けられている連絡先。データタイプ: オブジェクト `"contact": { "name": "String", "sys_id": "String" }`
contact.name	連絡先の名前。データタイプ：文字列
contact.sys_id	関連付けられた連絡先レコードのSys_id。データタイプ：文字列テーブル:連絡先 [customer_contact]
country	リードが所在する国。データタイプ：文字列
do_not_call	通信モードが電話であるかどうかを示すフラグ。有効な値： true:連絡先に電話をかけることができます。 false:連絡先に電話をかけません。データタイプ：ブーリアン
do_not_email	通信モードがメールかどうかを示すフラグ。有効な値： true:メールで連絡できます。 false:メールで連絡しません。データタイプ：ブーリアン
do_not_share	リードの詳細を共有できるかどうかを示すフラグ。有効な値： true:リードの詳細を共有できます。 false:リードの詳細を共有できません。データタイプ：ブーリアン
email	リードのメールアドレス。データタイプ：文字列
external_id	関連するシステム内のリードを識別するために、リードを生成したシステムによって使用された ID。データタイプ：文字列
external_system	HubSpot や pipedrive など、見込み客に関連付けられた外部システムの名前。データタイプ：文字列
first_name	見込み客に関連付けられた連絡先の名。データタイプ：文字列
業種	リードが属する業界。データタイプ：文字列テーブル:アカウント [customer_account] テーブルの industry フィールドにあります。
last_name	見込み客に関連付けられた連絡先の名前 (姓)。データタイプ：文字列
lead_group	見込み客が属するグループ。データタイプ: オブジェクト `"lead_group": { "name: "String", "sys_id": "String" }`
lead_group.name	リードグループの名前。データタイプ：文字列
lead_group.sys_id	リードグループレコードのSys_id。データタイプ：文字列テーブル： Group [sys_user_group]
lead_line_items	リードに関連付けられたリード品目の詳細。データタイプ：オブジェクトのアレイ `"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。データタイプ：文字列
lead_line_items。external_system	HubSpot や pipedrive など、リード品目に関連付けられた外部システムの名前。データタイプ：文字列
lead_line_items。鉛	品目に関連付けられたリードに関する詳細。データタイプ: オブジェクト `"lead: { "name": "String", "sys_id": "String" }`
lead_line_items。lead.name	関連するリードの名前。データタイプ：文字列
lead_line_items。lead.sys_id	関連するリードレコードのSys_id。データタイプ：文字列
lead_line_items。数	見込み顧客品目レコードの一意のシステム生成番号。データタイプ：文字列
lead_line_items。product_offering	リード品目に関連付けられた製品オファリングに関する情報。データタイプ: オブジェクト `"product_offering": { "code": " String", "name": "String", "sys_id": "String" }`
lead_line_items。product_offering.code	製品オファリングにリンクされたコード。注: これは、製品名に基づいてシステムによって生成された英数字です。システムで生成されますが、コードを編集して SKU またはその他の業界固有の製品コードを表すことができます。データタイプ：文字列
lead_line_items。product_offering.name	製品オファリングの名前。データタイプ：文字列
lead_line_items。product_offering.sys_id	リード品目に関連付けられた製品オファリングレコードのSys_id。データタイプ：文字列テーブル:製品オファリング [sn_prd_pm_product_offering]
lead_line_items。量	関連製品オファリングのうち、リードが購入を希望するアイテムの数量。データタイプ:数値 (整数)
lead_line_items。sys_created_by	リード品目を作成したユーザーの名前。データタイプ：文字列
lead_line_items。sys_created_on	見込み顧客品目が作成されたシステム生成日時。データタイプ: オブジェクト `"sys_created_on": { "display_value": "String", "value": "String" }`
lead_line_items。sys_created_on.display_value	リード品目が作成された日時。データタイプ：文字列形式:デフォルトのインスタンス形式とタイムゾーン
lead_line_items。sys_created_on.value	リード品目が作成された日時。データタイプ：文字列形式:UTC
lead_line_items。sys_domain	リード品目が属するドメインレコードのSys_id。注: このパラメーターは、ドメインセパレーションが有効になっている場合にのみ応答で返されます。データタイプ：文字列
lead_line_items.sys_domain_path	リード品目が属するドメインのパス。注: このパラメーターは、ドメインセパレーションが有効になっている場合にのみ応答で返されます。データタイプ：文字列
lead_line_items。sys_id	リード品目レコードのSys_id。データタイプ：文字列
lead_line_items。sys_mod_count	関連するリード品目レコードが変更された回数。データタイプ:数値 (整数)
lead_line_items。sys_tags	リード品目に関連付けられたシステムタグのリスト。データタイプ：アレイ
lead_line_items。sys_updated_by	関連するリード品目を最後に更新したユーザーの名前。データタイプ：文字列
lead_line_items。sys_updated_on	リード品目が最後に更新されたシステム生成日時。データタイプ: オブジェクト `"sys_created_on": { "display_value": "String", "value": "String" }`
lead_line_items。sys_updated_on。display_value	リード品目が最後に更新された日時。データタイプ：文字列形式:デフォルトのインスタンス形式とタイムゾーン
lead_line_items。sys_updated_on。価値	リード品目が最後に更新された日時。データタイプ：文字列形式:UTC
lead_line_items。unit_of_measurement	リード品目の測定単位の詳細。データタイプ: オブジェクト `"unit_of_measurement": { "name": "String", "sys_id": "String" }`
lead_line_items。unit_of_measurement。名前	各、立方フィートなどの測定単位の名前。データタイプ：文字列
lead_line_items。unit_of_measurement。sys_id	測定単位を説明するレコードのSys_id。データタイプ：文字列テーブル:測定単位 [sn_prd_pm_uom]
lead_line_items。work_notes	リード品目に対して作成された作業メモを説明するリスト。データタイプ：オブジェクトのアレイ `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
lead_line_items。work_notes。著者	関連する作業メモを作成したユーザーのユーザー名。データタイプ：文字列
lead_line_items。work_notes。日付	メモが作成された日付。データタイプ：文字列
lead_line_items。work_notes。テキスト	作成者が作成したメモのテキスト。データタイプ：文字列
lead_rating	リードの評価 (100_cold、200_warm、300_hot、400_super_hotなど)。注: これは選択肢フィールドです。リードテーブルの [lead_rating] フィールドで定義されている選択肢アイテムのいずれかが含まれている必要があります。データタイプ：文字列
lead_score	リードのスコア。データタイプ:10 進数範囲:1〜100
lead_source	見込み客のオリジネータ。注: これは選択肢フィールドです。リードテーブルの [lead_source] フィールドで定義されている選択肢アイテムのいずれかが含まれている必要があります。データタイプ：文字列
lead_type	新規ビジネスや既存ビジネスなどのリードのタイプ。注: これは選択肢フィールドです。リードテーブルの [lead_type] フィールドで定義されている選択肢アイテムのいずれかが含まれている必要があります。データタイプ：文字列
middle_name	リードの連絡先のミドルネーム。データタイプ：文字列
mobile_phone	見込み客の連絡先の電話番号。データタイプ：文字列
number	システムによって生成されたリードレコードの一意の番号。データタイプ：文字列
other_reason	リードを認定解除するその他の理由。データタイプ：文字列最大長:160 文字
owner	リードに関連付けられているユーザーの詳細。データタイプ: オブジェクト `"owner": { "name": "String", "sys_id": "String" }`
owner.name	リードを所有するユーザーの名前。データタイプ：文字列
owner.sys_id	リードを所有するユーザーのユーザーレコードのSys_id。データタイプ：文字列テーブル：ユーザー [sys_user]
理由	リードを認定解除する理由 (「認定しない」など)。データタイプ：文字列最大長:40 文字
short_description	リードの簡単な説明。データタイプ：文字列最大長:160 文字
similar_lead	類似のリードの詳細。これは、リードを失格する場合に使用します。データタイプ: オブジェクト `"similar_lead": { "name": "String", "sys_id": "String" }`
similar_lead.name	重複リードの名前。データタイプ：文字列
similar_lead.sys_id	重複している可能性があるリードレコードのSys_id。データタイプ：文字列テーブル:リード [sn_lead_mgmt_core_lead]
ステージ	リードのステージ (100_new など)。注: これは選択肢フィールドです。リードテーブルのステージフィールドで定義された選択肢アイテムのいずれかが含まれている必要があります。データタイプ：文字列
状況	リードが存在する都道府県。データタイプ：文字列
street	見込み客が存在する番地。データタイプ：文字列
sys_class_name	リードテーブルのシステム生成クラス名。データタイプ：文字列
sys_created_by	リードを作成したユーザーのユーザー名。データタイプ：文字列
sys_created_on	見込み客が作成されたシステム生成の日時。データタイプ: オブジェクト `"sys_created_on": { "display_value": "String", "value": "String" }`
sys_created_on。display_value	見込み客が作成された日時。データタイプ：文字列形式:デフォルトのインスタンス形式とタイムゾーン
sys_created_on。価値	見込み客が作成された日時。データタイプ：文字列形式:UTC
sys_domain	見込み客が属するドメインレコードのSys_id。注: このパラメーターは、ドメインセパレーションが有効になっている場合にのみ応答で返されます。データタイプ：文字列
sys_domain_path	リードが属するドメインのパス。注: このパラメーターは、ドメインセパレーションが有効になっている場合にのみ応答で返されます。データタイプ：文字列
sys_id	リードレコードのSys_id。データタイプ：文字列テーブル:リード [sn_lead_mgmt_core_lead]
sys_mod_count	関連するリードレコードが変更された回数。データタイプ:数値 (整数)
sys_tags	見込み客に関連付けられているシステムタグのリスト。これらのタグを使用して、リードを分類できます。データタイプ：アレイ
sys_updated_by	リードレコードを最後に更新したユーザーの名前。データタイプ：文字列
sys_updated_on	リードが最後に更新されたシステム生成日時。データタイプ: オブジェクト `"sys_created_on": { "display_value": "String", "value": "String" }`
sys_updated_on。display_value	リードが最後に更新された日時。データタイプ：文字列形式:インスタンスのデフォルトの形式とタイムゾーン
sys_updated_on。価値	リードが最後に更新された日時。データタイプ：文字列形式:UTC
タイトル	リードの役職。データタイプ：文字列
Web サイト	リードの Web サイト URL。データタイプ：文字列
work_notes	リードに対して作成された作業メモのリスト。データタイプ：オブジェクトのアレイ `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
work_notes。著者	関連する作業メモを作成したユーザーのユーザー名。データタイプ：文字列
work_notes。日付	メモが作成された日付。データタイプ：文字列
work_notes。テキスト	作成者が作成したメモのテキスト。データタイプ：文字列
zip	関連するリードの郵便番号。データタイプ：文字列

cURL 要求

次のコード例は、リードレコードを sys_id 856b6a95ffde8210b85dffffffffffd7 で更新する方法を示しています。

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

応答には、すべてのリードレコードフィールドが含まれます。

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

リード:投稿 /sn_lead_mgmt_core/リード

指定されたパラメーターを使用して、リードレコードとそれに関連するリード品目を作成します。

処理が完了すると、次のテーブルにレコードが作成されます。

リード [sn_lead_mgmt_core_lead]
リード品目 [sn_lead_mgmt_core_lead_line_item]

渡されたパラメーターのルール:

無効なパラメーター名は無視されます。
必須ではない選択肢フィールドと参照フィールドの無効な値は無視されます。
1 つ以上のフィールドでフィールド書き込みアクセスが拒否された場合、制限付きフィールドは無視されます。
この API を使用してシステムフィールド値を挿入することはできません。指定された値は無視されます。システムフィールドは無視フィールドリストの一部であり、構成可能です。
パラメーター account、 contact、および consumer の値は、 account パラメーターと consumer パラメーターの両方が空でない場合無視されます。
特に指定しない限り、渡されていないすべてのパラメーターのデフォルト値は「null」です。

URL 形式

バージョニングされた URL: /api/sn_lead_mgmt_core/{api_version}/lead

デフォルト URL: /api/sn_lead_mgmt_core/{api_version}/lead

注:

サポートされている要求パラメーター

表 : 19. パスパラメーター
名前	説明
api_version	オプション。アクセスするエンドポイントのバージョン。たとえば、 `v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列

表 : 20. クエリパラメーター
名前	説明
なし

表 : 21. 要求本文のパラメーター
名前	説明
アカウント	見込み客に関連付けられているアカウントの詳細。データタイプ: オブジェクト `"account": { "sys_id": "String" }`
account.sys_id	関連付けられたアカウントレコードのSys_id。データタイプ：文字列テーブル:アカウント [customer_account]
会社_電話番号	リードの勤務先電話番号。データタイプ：文字列
city	リードが所在する市区町村。データタイプ：文字列
会社	リードの会社名。データタイプ：文字列
consumer	見込み客に関連付けられているコンシューマー。データタイプ: オブジェクト `"consumer": { "sys_id": "String" }`
consumer.sys_id	関連付けられたコンシューマーレコードのSys_id。データタイプ：文字列テーブル:コンシューマー [csm_consumer]
連絡先	リードアカウントに関連付けられている連絡先。データタイプ: オブジェクト `"contact": { "sys_id": "String" }`
contact.sys_id	関連付けられた連絡先レコードのSys_id。データタイプ：文字列テーブル:連絡先 [customer_contact]
country	リードが所在する国。データタイプ：文字列
do_not_call	通信モードが電話であるかどうかを示すフラグ。有効な値： true:連絡先に電話をかけることができます。 false:連絡先に電話をかけません。データタイプ：ブーリアンデフォルト値：false
do_not_email	通信モードがメールかどうかを示すフラグ。有効な値： true:メールで連絡できます。 false:メールで連絡しません。データタイプ：ブーリアンデフォルト値：false
do_not_share	リードの詳細を共有できるかどうかを示すフラグ。有効な値： true:リードの詳細を共有できます。 false:リードの詳細を共有できません。データタイプ：ブーリアンデフォルト値：false
email	リードのメールアドレス。データタイプ：文字列
external_id	関連するシステム内のリードを識別するために、リードを生成したシステムによって使用された ID。データタイプ：文字列
external_system	HubSpot や pipedrive など、見込み客に関連付けられた外部システムの名前。データタイプ：文字列
first_name	見込み客に関連付けられた連絡先の名。データタイプ：文字列
業種	リードが属する業界。データタイプ：文字列テーブル:アカウント [customer_account] テーブルの industry フィールドにあります。
last_name	必須です。見込み客に関連付けられた連絡先の名前 (姓)。データタイプ：文字列
lead_group	見込み客が属するグループ。データタイプ: オブジェクト `"lead_group": { "sys_id": "String" }`
lead_group.sys_id	リードグループレコードのSys_id。データタイプ：文字列テーブル： Group [sys_user_group]
lead_line_items	リードに関連付けられるリード品目のリスト。見込み客が属するグループ。データタイプ: オブジェクト `"lead_line_items": [ { "external_id": "String", "external_system": "String", "product_offering": {Object}, "quantity": Number, "work_notes": [Array], "unit_of_measurement": {Object} } ]` 最大品目数:100 - 無視されるオーバーアイテム
lead_line_items。external_id	関連システム内の品目を識別するために、見込み顧客品目を生成したシステムで使用される ID。データタイプ：文字列
lead_line_items。external_system	HubSpot や pipedrive など、リード品目に関連付けられた外部システムの名前。データタイプ：文字列
lead_line_items.product_offering	必須です。リード品目に関連付けられた製品オファリングに関する情報。データタイプ: オブジェクト `"product_offering": { "sys_id": "String" }`
lead_line_items.product_offering.sys_id	必須です。リード品目に関連付けられた製品オファリングレコードのSys_id。データタイプ：文字列テーブル:製品オファリング [sn_prd_pm_product_offering]
lead_line_items.quantity	関連製品オファリングのうち、リードが購入を希望するアイテムの数量。データタイプ:数値 (整数) デフォルト値：1
lead_line_items.unit_of_measurement	リード品目の測定単位の詳細。データタイプ: オブジェクト `"unit_of_measurement": { "sys_id": "String" }`
lead_line_items。unit_of_measurement。sys_id	測定単位を説明するレコードのSys_id。データタイプ：文字列テーブル:測定単位 [sn_prd_pm_uom]
lead_line_items.work_notes	リード品目に対して作成された作業メモを説明するリスト。データタイプ：オブジェクトのアレイ `"work_notes": [ "text": "String" } ]` デフォルト:空のアレイ
lead_line_items。work_notes。テキスト	作成者が作成したメモのテキスト。データタイプ：文字列
lead_rating	リードの評価 (100_cold、200_warm、300_hot、400_super_hotなど)。注: これは選択肢フィールドです。リードテーブルの [lead_rating] フィールドで定義されている選択肢アイテムのいずれかが含まれている必要があります。データタイプ：文字列
lead_score	リードのスコア。データタイプ:10 進数範囲:1〜100
lead_source	見込み客のオリジネータ。注: これは選択肢フィールドです。リードテーブルの [lead_source] フィールドで定義されている選択肢アイテムのいずれかが含まれている必要があります。データタイプ：文字列
lead_type	新規ビジネスや既存ビジネスなどのリードのタイプ。注: これは選択肢フィールドです。リードテーブルの [lead_type] フィールドで定義されている選択肢アイテムのいずれかが含まれている必要があります。データタイプ：文字列
middle_name	リードの連絡先のミドルネーム。データタイプ：文字列
mobile_phone	見込み客の連絡先の電話番号。データタイプ：文字列
other_reason	リードを認定解除するその他の理由。データタイプ：文字列最大長:160 文字
owner	リードに関連付けられているユーザーの詳細。データタイプ: オブジェクト `"owner": { "sys_id": "String" }`
owner.sys_id	リードを所有するユーザーのユーザーレコードのSys_id。データタイプ：文字列テーブル：ユーザー [sys_user]
理由	リードを認定解除する理由 (「認定しない」など)。データタイプ：文字列最大長:40 文字
short_description	リードの簡単な説明。データタイプ：文字列最大長:160 文字
similar_lead	類似のリードの詳細。これは、リードを失格する場合に使用します。データタイプ: オブジェクト `"similar_lead": { "sys_id": "String" }`
similar_lead.sys_id	重複している可能性があるリードレコードのSys_id。データタイプ：文字列テーブル:リード [sn_lead_mgmt_core_lead]
ステージ	リードのステージ (100_new など)。注: これは選択肢フィールドです。リードテーブルのステージフィールドで定義された選択肢アイテムのいずれかが含まれている必要があります。データタイプ：文字列デフォルト値:100_new
状況	リードが存在する都道府県。データタイプ：文字列
street	見込み客が存在する番地。データタイプ：文字列
タイトル	リードの役職。データタイプ：文字列
Web サイト	リードの Web サイト URL。データタイプ：文字列
work_notes	リードに対して作成された作業メモのリスト。データタイプ：オブジェクトのアレイ `"work_notes": [ { "text": "String" } ]` 注: 要求内の作業メモのアレイが単一のテキストとして挿入されます。このテキストは、要求内のすべての作業メモオブジェクトのコンテンツを、各エントリーをカンマ (,) で区切って組み合わせて生成されます。デフォルト:空のアレイ
work_notes。テキスト	作成者が作成したメモのテキスト。データタイプ：文字列
zip	関連するリードの郵便番号。データタイプ：文字列

ヘッダー

表 : 22. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 23. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 24. ステータスコード
ステータスコード	説明
201	成功。リードとそれに関連する品目が正常に挿入されました。
400	エラー。考えられる理由: 無効なペイロード:要求本文が無効または空です。無効なペイロード:メール/電話番号フィールドのフィールド値が無効です。無効なペイロード:必須フィールドがないか、その値が空です。ビジネスルール/データポリシー違反。
403	禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。
500	内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

応答本文のパラメーター


名前	説明
アカウント	見込み客にリンクされたアカウント。データタイプ: オブジェクト `"account": { "name": "String", "sys_id": "String" }`
account.name	アカウントの名前。データタイプ：文字列
account.sys_id	関連付けられたアカウントレコードのSys_id。データタイプ：文字列テーブル:アカウント [customer_account]
会社_電話番号	リードの勤務先電話番号。データタイプ：文字列
city	リードが所在する市区町村。データタイプ：文字列
closed_date	リードがクローズされた日時。データタイプ: オブジェクト `"closed_date": { "display_value": "String", "value": "String" }`
closed_date。display_value	UI に表示される日時。データタイプ：文字列形式:ユーザーの形式とタイムゾーン。
closed_date.value	関連レコードで定義されているとおりにリードがクローズした日時。データタイプ：文字列形式:UTC
会社	リードの会社名。データタイプ：文字列
consumer	見込み客に関連付けられているコンシューマー。データタイプ: オブジェクト `"consumer": { "name": "String", "sys_id": "String" }`
consumer.name	関連付けられたコンシューマーの名前。データタイプ：文字列
consumer.sys_id	関連付けられたコンシューマーレコードのSys_id。データタイプ：文字列テーブル:コンシューマー [csm_consumer]
連絡先	リードアカウントに関連付けられている連絡先。データタイプ: オブジェクト `"contact": { "name": "String", "sys_id": "String" }`
contact.name	連絡先の名前。データタイプ：文字列
contact.sys_id	関連付けられた連絡先レコードのSys_id。データタイプ：文字列テーブル:連絡先 [customer_contact]
country	リードが所在する国。データタイプ：文字列
do_not_call	通信モードが電話であるかどうかを示すフラグ。有効な値： true:連絡先に電話をかけることができます。 false:連絡先に電話をかけません。データタイプ：ブーリアン
do_not_email	通信モードがメールかどうかを示すフラグ。有効な値： true:メールで連絡できます。 false:メールで連絡しません。データタイプ：ブーリアン
do_not_share	リードの詳細を共有できるかどうかを示すフラグ。有効な値： true:リードの詳細を共有できます。 false:リードの詳細を共有できません。データタイプ：ブーリアン
email	リードのメールアドレス。データタイプ：文字列
external_id	関連するシステム内のリードを識別するために、リードを生成したシステムによって使用された ID。データタイプ：文字列
external_system	HubSpot や pipedrive など、見込み客に関連付けられた外部システムの名前。データタイプ：文字列
first_name	見込み客に関連付けられた連絡先の名。データタイプ：文字列
業種	リードが属する業界。データタイプ：文字列テーブル:アカウント [customer_account] テーブルの industry フィールドにあります。
last_name	見込み客に関連付けられた連絡先の名前 (姓)。データタイプ：文字列
lead_group	見込み客が属するグループ。データタイプ: オブジェクト `"lead_group": { "name: "String", "sys_id": "String" }`
lead_group.name	リードグループの名前。データタイプ：文字列
lead_group.sys_id	リードグループレコードのSys_id。データタイプ：文字列テーブル： Group [sys_user_group]
lead_line_items	リードに関連付けられたリード品目の詳細。データタイプ：オブジェクトのアレイ `"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。データタイプ：文字列
lead_line_items。external_system	HubSpot や pipedrive など、リード品目に関連付けられた外部システムの名前。データタイプ：文字列
lead_line_items。鉛	品目に関連付けられたリードに関する詳細。データタイプ: オブジェクト `"lead: { "name": "String", "sys_id": "String" }`
lead_line_items。lead.name	関連するリードの名前。データタイプ：文字列
lead_line_items。lead.sys_id	関連するリードレコードのSys_id。データタイプ：文字列
lead_line_items。数	見込み顧客品目レコードの一意のシステム生成番号。データタイプ：文字列
lead_line_items。product_offering	リード品目に関連付けられた製品オファリングに関する情報。データタイプ: オブジェクト `"product_offering": { "code": " String", "name": "String", "sys_id": "String" }`
lead_line_items。product_offering.code	製品オファリングにリンクされたコード。注: これは、製品名に基づいてシステムによって生成された英数字です。システムで生成されますが、コードを編集して SKU またはその他の業界固有の製品コードを表すことができます。データタイプ：文字列
lead_line_items。product_offering.name	製品オファリングの名前。データタイプ：文字列
lead_line_items。product_offering.sys_id	リード品目に関連付けられた製品オファリングレコードのSys_id。データタイプ：文字列テーブル:製品オファリング [sn_prd_pm_product_offering]
lead_line_items。量	関連製品オファリングのうち、リードが購入を希望するアイテムの数量。データタイプ:数値 (整数)
lead_line_items。sys_created_by	リード品目を作成したユーザーの名前。データタイプ：文字列
lead_line_items。sys_created_on	見込み顧客品目が作成されたシステム生成日時。データタイプ: オブジェクト `"sys_created_on": { "display_value": "String", "value": "String" }`
lead_line_items。sys_created_on.display_value	リード品目が作成された日時。データタイプ：文字列形式:デフォルトのインスタンス形式とタイムゾーン
lead_line_items。sys_created_on.value	リード品目が作成された日時。データタイプ：文字列形式:UTC
lead_line_items。sys_domain	リード品目が属するドメインレコードのSys_id。注: このパラメーターは、ドメインセパレーションが有効になっている場合にのみ応答で返されます。データタイプ：文字列
lead_line_items.sys_domain_path	リード品目が属するドメインのパス。注: このパラメーターは、ドメインセパレーションが有効になっている場合にのみ応答で返されます。データタイプ：文字列
lead_line_items。sys_id	リード品目レコードのSys_id。データタイプ：文字列
lead_line_items。sys_mod_count	関連するリード品目レコードが変更された回数。データタイプ:数値 (整数)
lead_line_items。sys_tags	リード品目に関連付けられたシステムタグのリスト。データタイプ：アレイ
lead_line_items。sys_updated_by	関連するリード品目を最後に更新したユーザーの名前。データタイプ：文字列
lead_line_items。sys_updated_on	リード品目が最後に更新されたシステム生成日時。データタイプ: オブジェクト `"sys_created_on": { "display_value": "String", "value": "String" }`
lead_line_items。sys_updated_on。display_value	リード品目が最後に更新された日時。データタイプ：文字列形式:デフォルトのインスタンス形式とタイムゾーン
lead_line_items。sys_updated_on。価値	リード品目が最後に更新された日時。データタイプ：文字列形式:UTC
lead_line_items。unit_of_measurement	リード品目の測定単位の詳細。データタイプ: オブジェクト `"unit_of_measurement": { "name": "String", "sys_id": "String" }`
lead_line_items。unit_of_measurement。名前	各、立方フィートなどの測定単位の名前。データタイプ：文字列
lead_line_items。unit_of_measurement。sys_id	測定単位を説明するレコードのSys_id。データタイプ：文字列テーブル:測定単位 [sn_prd_pm_uom]
lead_line_items。work_notes	リード品目に対して作成された作業メモを説明するリスト。データタイプ：オブジェクトのアレイ `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
lead_line_items。work_notes。著者	関連する作業メモを作成したユーザーのユーザー名。データタイプ：文字列
lead_line_items。work_notes。日付	メモが作成された日付。データタイプ：文字列
lead_line_items。work_notes。テキスト	作成者が作成したメモのテキスト。データタイプ：文字列
lead_rating	リードの評価 (100_cold、200_warm、300_hot、400_super_hotなど)。注: これは選択肢フィールドです。リードテーブルの [lead_rating] フィールドで定義されている選択肢アイテムのいずれかが含まれている必要があります。データタイプ：文字列
lead_score	リードのスコア。データタイプ:10 進数範囲:1〜100
lead_source	見込み客のオリジネータ。注: これは選択肢フィールドです。リードテーブルの [lead_source] フィールドで定義されている選択肢アイテムのいずれかが含まれている必要があります。データタイプ：文字列
lead_type	新規ビジネスや既存ビジネスなどのリードのタイプ。注: これは選択肢フィールドです。リードテーブルの [lead_type] フィールドで定義されている選択肢アイテムのいずれかが含まれている必要があります。データタイプ：文字列
middle_name	リードの連絡先のミドルネーム。データタイプ：文字列
mobile_phone	見込み客の連絡先の電話番号。データタイプ：文字列
number	システムによって生成されたリードレコードの一意の番号。データタイプ：文字列
other_reason	リードを認定解除するその他の理由。データタイプ：文字列最大長:160 文字
owner	リードに関連付けられているユーザーの詳細。データタイプ: オブジェクト `"owner": { "name": "String", "sys_id": "String" }`
owner.name	リードを所有するユーザーの名前。データタイプ：文字列
owner.sys_id	リードを所有するユーザーのユーザーレコードのSys_id。データタイプ：文字列テーブル：ユーザー [sys_user]
理由	リードを認定解除する理由 (「認定しない」など)。データタイプ：文字列最大長:40 文字
short_description	リードの簡単な説明。データタイプ：文字列最大長:160 文字
similar_lead	類似のリードの詳細。これは、リードを失格する場合に使用します。データタイプ: オブジェクト `"similar_lead": { "name": "String", "sys_id": "String" }`
similar_lead.name	重複リードの名前。データタイプ：文字列
similar_lead.sys_id	重複している可能性があるリードレコードのSys_id。データタイプ：文字列テーブル:リード [sn_lead_mgmt_core_lead]
ステージ	リードのステージ (100_new など)。注: これは選択肢フィールドです。リードテーブルのステージフィールドで定義された選択肢アイテムのいずれかが含まれている必要があります。データタイプ：文字列
状況	リードが存在する都道府県。データタイプ：文字列
street	見込み客が存在する番地。データタイプ：文字列
sys_class_name	リードテーブルのシステム生成クラス名。データタイプ：文字列
sys_created_by	リードを作成したユーザーのユーザー名。データタイプ：文字列
sys_created_on	見込み客が作成されたシステム生成の日時。データタイプ: オブジェクト `"sys_created_on": { "display_value": "String", "value": "String" }`
sys_created_on。display_value	見込み客が作成された日時。データタイプ：文字列形式:デフォルトのインスタンス形式とタイムゾーン
sys_created_on。価値	見込み客が作成された日時。データタイプ：文字列形式:UTC
sys_domain	見込み客が属するドメインレコードのSys_id。注: このパラメーターは、ドメインセパレーションが有効になっている場合にのみ応答で返されます。データタイプ：文字列
sys_domain_path	リードが属するドメインのパス。注: このパラメーターは、ドメインセパレーションが有効になっている場合にのみ応答で返されます。データタイプ：文字列
sys_id	リードレコードのSys_id。データタイプ：文字列テーブル:リード [sn_lead_mgmt_core_lead]
sys_mod_count	関連するリードレコードが変更された回数。データタイプ:数値 (整数)
sys_tags	見込み客に関連付けられているシステムタグのリスト。これらのタグを使用して、リードを分類できます。データタイプ：アレイ
sys_updated_by	リードレコードを最後に更新したユーザーの名前。データタイプ：文字列
sys_updated_on	リードが最後に更新されたシステム生成日時。データタイプ: オブジェクト `"sys_created_on": { "display_value": "String", "value": "String" }`
sys_updated_on。display_value	リードが最後に更新された日時。データタイプ：文字列形式:インスタンスのデフォルトの形式とタイムゾーン
sys_updated_on。価値	リードが最後に更新された日時。データタイプ：文字列形式:UTC
タイトル	リードの役職。データタイプ：文字列
Web サイト	リードの Web サイト URL。データタイプ：文字列
work_notes	リードに対して作成された作業メモのリスト。データタイプ：オブジェクトのアレイ `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
work_notes。著者	関連する作業メモを作成したユーザーのユーザー名。データタイプ：文字列
work_notes。日付	メモが作成された日付。データタイプ：文字列
work_notes。テキスト	作成者が作成したメモのテキスト。データタイプ：文字列
zip	関連するリードの郵便番号。データタイプ：文字列

cURL 要求

次のコード例は、1 つのリード品目で新しいリードレコードを作成する方法を示しています。

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

応答には、リードおよびリード品目レコードのフィールドが含まれています。

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