리드 API

릴리스 버전: Australia

업데이트 날짜 2026년 03월 12일

소요 시간: 110분

리드 API는 인스턴스에서 마케팅 리드 및 연결된 리드 라인 항목을 생성, 업데이트 및 쿼리/검색할 수 있는 엔드포인트를 제공합니다.

이 API를 사용하여 인스턴스를 외부 웹 사이트 및 시스템(예: 자동화된 리드 캡처 시스템)과 통합하거나 외부 보고 시스템에 리드 정보를 제공합니다.

이 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 엔드포인트에서 무시되는 필드 목록도 포함됩니다.

리드 - 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)` 인코딩된 쿼리는 정렬 기준을 지원합니다. 특정 필드를 기준으로 응답을 정렬하려면 에서 ORDERBY 및 ORDERBYDESC 절 sysparm_query을 사용합니다. 예를 들어, `sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory` 는 모든 활성 기록을 필터링하고 결과를 번호순으로 먼저 오름차순으로 정렬한 다음 범주별로 내림차순으로 정렬합니다. 잘못된 필드 이름을 지정하는 것과 같이 쿼리의 일부가 잘못된 경우 인스턴스는 잘못된 부분을 무시합니다. 그런 다음 쿼리의 유효한 부분만 사용하여 행을 반환합니다. 속성을 사용하여 glide.invalid_query.returns_no_rows이 동작을 제어할 수 있습니다. 잘못된 쿼리에 행을 반환하지 않으려면 이 속성을 예로 설정합니다. 주: 이 glide.invalid_query.returns_no_rows 속성은 목록, 스크립트(GlideRecord.query()) 및 웹 서비스 API와 같은 인스턴스 전체에서 모든 쿼리의 동작을 제어합니다. 데이터 유형: 문자열

표 3. 요청 본문 매개변수
이름	설명
안 함

헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하십시오.

표 4. 요청 헤더
머리글	설명
콘텐츠-형식	요청 본문의 데이터 형식입니다. application/json만 지원합니다.

표 5. 응답 헤더
머리글	설명
수용	응답 본문의 데이터 형식입니다. application/json만 지원합니다.
컨텐츠-범위	페이지 매김된 호출에서 반환되는 콘텐츠의 범위입니다. 예를 들어 offset=2 및 limit=3인 경우 Content-Range 헤더의 값은 항목 3-5입니다.
링크	쿼리 결과를 탐색하는 링크: 첫 번째 마지막 다음 이전 자체
총 수	필터링된 총 기록 수입니다.

상태 코드

이 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]
business_phone	리드의 직장 전화번호입니다. 데이터 유형: 문자열
구/군/시	잠재 고객이 거주하는 도시입니다. 데이터 유형: 문자열
closed_date	리드가 종결된 날짜 및 시간입니다. 데이터 유형: 객체 `"closed_date": { "display_value": "String", "value": "String" }`
closed_date.display_value	UI에 표시된 날짜 및 시간입니다. 데이터 유형: 문자열 형식: 사용자의 형식 및 시간대입니다.
closed_date.value	연결된 기록에 정의된 대로 리드가 종결된 날짜 및 시간입니다. 데이터 유형: 문자열 형식: UTC
회사	잠재 고객의 회사 이름입니다. 데이터 유형: 문자열
소비자	리드와 연결된 소비자입니다. 데이터 유형: 객체 `"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]
국가	잠재 고객이 거주하는 국가입니다. 데이터 유형: 문자열
do_not_call	통신 모드가 전화인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 연락처에 전화할 수 있습니다. 아니오: 연락처에 전화하지 않습니다. 데이터 유형: 부울
do_not_email	통신 모드가 이메일인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 연락할 수 있습니다. 아니오: 연락처에 이메일을 보내지 않습니다. 데이터 유형: 부울
do_not_share	리드 상세 정보를 공유할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 리드 상세 정보를 공유할 수 있습니다. false: 리드 상세 정보를 공유할 수 없습니다. 데이터 유형: 부울
이메일	잠재 고객의 이메일 주소입니다. 데이터 유형: 문자열
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입니다. 데이터 유형: 문자열 테이블: 그룹 [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.코드	제품 오퍼링에 연결된 코드입니다. 주: 제품 이름을 기준으로 시스템에서 생성된 영숫자 번호입니다. 시스템에서 생성되지만 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.값	리드 라인 항목이 생성된 날짜 및 시간입니다. 데이터 유형: 문자열 형식: 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	잠재 고객 연락처의 전화 번호입니다. 데이터 유형: 문자열
번호	시스템에서 생성된 고유 리드 기록 번호입니다. 데이터 유형: 문자열
other_reason	리드 실격의 추가 이유입니다. 데이터 유형: 문자열 최대 길이: 160자
소유자	잠재 고객과 연결된 사람의 세부 정보입니다. 데이터 유형: 객체 `"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와 같은 리드의 스테이지입니다. 주: 선택 필드입니다. 리드 테이블의 스테이지 필드에 정의된 선택 항목 중 하나를 포함해야 합니다. 데이터 유형: 문자열
상태	잠재 고객이 상주하는 주입니다. 데이터 유형: 문자열
주소	잠재 고객이 거주하는 거리입니다. 데이터 유형: 문자열
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
직위	잠재 고객의 직함입니다. 데이터 유형: 문자열
웹 사이트	잠재 고객의 웹 사이트 URL입니다. 데이터 유형: 문자열
work_notes	리드에 대해 생성된 작업 메모 목록입니다. 데이터 유형: 객체 배열 `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
work_notes.저자	관련 작업 메모를 작성한 사람의 사용자 이름입니다. 데이터 유형: 문자열
work_notes.날짜	메모가 생성된 날짜입니다. 데이터 유형: 문자열
work_notes.문자 메시지	작성자가 작성한 메모의 텍스트입니다. 데이터 유형: 문자열
우편번호	연결된 잠재 고객의 우편 번호입니다. 데이터 유형: 문자열

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

리드 - 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}

주:

사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 7. 경로 매개변수
이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 `v1` 또는 `v2`입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하도록 이 값만 지정하십시오. 데이터 유형: 문자열
sys_id	검색할 리드의 Sys_id입니다. 데이터 유형: 문자열 테이블: 리드 [sn_lead_mgmt_core_lead]

표 8. 쿼리 매개변수
이름	설명
안 함

표 9. 요청 본문 매개변수(XML 또는 JSON)
이름	설명
안 함

헤더

표 10. 요청 헤더
머리글	설명
수용	응답 본문의 데이터 형식입니다. application/json만 지원합니다.

표 11. 응답 헤더
머리글	설명
안 함

상태 코드

이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하십시오.

표 12. 상태 코드
상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
403	금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다.
404	찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수


이름	설명
계정	잠재 고객에 연결된 계정입니다. 데이터 유형: 객체 `"account": { "name": "String", "sys_id": "String" }`
account.name	계정의 이름입니다. 데이터 유형: 문자열
account.sys_id	연결된 계정 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 계정 [customer_account]
business_phone	리드의 직장 전화번호입니다. 데이터 유형: 문자열
구/군/시	잠재 고객이 거주하는 도시입니다. 데이터 유형: 문자열
closed_date	리드가 종결된 날짜 및 시간입니다. 데이터 유형: 객체 `"closed_date": { "display_value": "String", "value": "String" }`
closed_date.display_value	UI에 표시된 날짜 및 시간입니다. 데이터 유형: 문자열 형식: 사용자의 형식 및 시간대입니다.
closed_date.value	연결된 기록에 정의된 대로 리드가 종결된 날짜 및 시간입니다. 데이터 유형: 문자열 형식: UTC
회사	잠재 고객의 회사 이름입니다. 데이터 유형: 문자열
소비자	리드와 연결된 소비자입니다. 데이터 유형: 객체 `"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]
국가	잠재 고객이 거주하는 국가입니다. 데이터 유형: 문자열
do_not_call	통신 모드가 전화인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 연락처에 전화할 수 있습니다. 아니오: 연락처에 전화하지 않습니다. 데이터 유형: 부울
do_not_email	통신 모드가 이메일인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 연락할 수 있습니다. 아니오: 연락처에 이메일을 보내지 않습니다. 데이터 유형: 부울
do_not_share	리드 상세 정보를 공유할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 리드 상세 정보를 공유할 수 있습니다. false: 리드 상세 정보를 공유할 수 없습니다. 데이터 유형: 부울
이메일	잠재 고객의 이메일 주소입니다. 데이터 유형: 문자열
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입니다. 데이터 유형: 문자열 테이블: 그룹 [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.코드	제품 오퍼링에 연결된 코드입니다. 주: 제품 이름을 기준으로 시스템에서 생성된 영숫자 번호입니다. 시스템에서 생성되지만 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.값	리드 라인 항목이 생성된 날짜 및 시간입니다. 데이터 유형: 문자열 형식: 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	잠재 고객 연락처의 전화 번호입니다. 데이터 유형: 문자열
번호	시스템에서 생성된 고유 리드 기록 번호입니다. 데이터 유형: 문자열
other_reason	리드 실격의 추가 이유입니다. 데이터 유형: 문자열 최대 길이: 160자
소유자	잠재 고객과 연결된 사람의 세부 정보입니다. 데이터 유형: 객체 `"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와 같은 리드의 스테이지입니다. 주: 선택 필드입니다. 리드 테이블의 스테이지 필드에 정의된 선택 항목 중 하나를 포함해야 합니다. 데이터 유형: 문자열
상태	잠재 고객이 상주하는 주입니다. 데이터 유형: 문자열
주소	잠재 고객이 거주하는 거리입니다. 데이터 유형: 문자열
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
직위	잠재 고객의 직함입니다. 데이터 유형: 문자열
웹 사이트	잠재 고객의 웹 사이트 URL입니다. 데이터 유형: 문자열
work_notes	리드에 대해 생성된 작업 메모 목록입니다. 데이터 유형: 객체 배열 `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
work_notes.저자	관련 작업 메모를 작성한 사람의 사용자 이름입니다. 데이터 유형: 문자열
work_notes.날짜	메모가 생성된 날짜입니다. 데이터 유형: 문자열
work_notes.문자 메시지	작성자가 작성한 메모의 텍스트입니다. 데이터 유형: 문자열
우편번호	연결된 잠재 고객의 우편 번호입니다. 데이터 유형: 문자열

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

lead - PATCH /sn_lead_mgmt_core/lead/{sys_id}

지정된 리드 기록과 연결된 리드 라인 항목을 업데이트합니다. 이 엔드포인트를 사용하여 새 리드 라인 항목을 지정된 리드에 연결할 수도 있습니다.

이 엔드포인트는 다음 테이블의 정보를 업데이트합니다.

리드 [sn_lead_mgmt_core_lead]
리드 라인 항목 [sn_lead_mgmt_core_lead_line_item]

전달된 매개변수에 대한 규칙:

잘못된 매개변수 이름은 무시됩니다.
필수가 아닌 선택 및 참조 필드에 대한 값이 잘못되면 무시됩니다.
하나 이상의 필드에 대해 필드 쓰기 액세스가 거부되면 제한된 필드가 무시됩니다.
이 API를 사용하여 시스템 필드 값을 삽입할 수 없습니다. 제공된 값은 무시됩니다. 시스템 필드는 구성 가능한 무시된 필드 목록의 일부입니다.
매개변수 , 및 consumer 매개변수가 모두 비어 있지 않으면 매개변수 account값이 contact무 accountconsumer 시됩니다.
달리 지정하지 않는 한 전달되지 않은 모든 매개변수의 기본값은 "null"입니다.

주:

이 엔드포인트는 지정된 매개변수만 수정합니다. 현재 리드 또는 리드 라인 항목 기록에 있는 매개변수가 호출에 지정되지 않은 경우 해당 내용은 변경되지 않습니다.

URL 형식

버전이 지정된 URL: /api/sn_lead_mgmt_core/{api_version}/lead/{sys_id}

기본 URL: /api/sn_lead_mgmt_core/{api_version}/lead/{sys_id}

주:

사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 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]
business_phone	리드의 직장 전화번호입니다. 데이터 유형: 문자열
구/군/시	잠재 고객이 거주하는 도시입니다. 데이터 유형: 문자열
회사	잠재 고객의 회사 이름입니다. 데이터 유형: 문자열
소비자	리드와 연결된 소비자입니다. 데이터 유형: 객체 `"consumer": { "sys_id": "String" }`
consumer.sys_id	연결된 소비자 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 소비자 [csm_consumer]
연락처	잠재 고객 계정과 연결된 접촉 창구입니다. 데이터 유형: 객체 `"contact": { "sys_id": "String" }`
contact.sys_id	연결된 접촉 창구 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 연락처 [customer_contact]
국가	잠재 고객이 거주하는 국가입니다. 데이터 유형: 문자열
do_not_call	통신 모드가 전화인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 연락처에 전화할 수 있습니다. 아니오: 연락처에 전화하지 않습니다. 데이터 유형: 부울
do_not_email	통신 모드가 이메일인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 연락할 수 있습니다. 아니오: 연락처에 이메일을 보내지 않습니다. 데이터 유형: 부울
do_not_share	리드 상세 정보를 공유할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 리드 상세 정보를 공유할 수 있습니다. false: 리드 상세 정보를 공유할 수 없습니다. 데이터 유형: 부울
이메일	잠재 고객의 이메일 주소입니다. 데이터 유형: 문자열
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입니다. 데이터 유형: 문자열 테이블: 그룹 [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.수량	리드가 연결된 제품 오퍼링 중에서 구매하려는 항목의 수량입니다. 데이터 유형: 숫자(정수)
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": { "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와 같은 리드의 스테이지입니다. 주: 선택 필드입니다. 리드 테이블의 스테이지 필드에 정의된 선택 항목 중 하나를 포함해야 합니다. 데이터 유형: 문자열
상태	잠재 고객이 상주하는 주입니다. 데이터 유형: 문자열
주소	잠재 고객이 거주하는 거리입니다. 데이터 유형: 문자열
직위	잠재 고객의 직함입니다. 데이터 유형: 문자열
웹 사이트	잠재 고객의 웹 사이트 URL입니다. 데이터 유형: 문자열
work_notes	리드에 대해 생성된 작업 메모 목록입니다. 데이터 유형: 객체 배열 `"work_notes": [ { "text": "String" } ]` 주: 요청의 작업 메모 배열이 단일 텍스트로 삽입됩니다. 이 텍스트는 요청에 있는 모든 작업 메모 객체의 콘텐츠를 결합하여 생성되며, 각 항목은 쉼표(,)로 구분됩니다.
work_notes.문자 메시지	작성자가 작성한 메모의 텍스트입니다. 데이터 유형: 문자열
우편번호	연결된 잠재 고객의 우편 번호입니다. 데이터 유형: 문자열

헤더

표 16. 요청 헤더
머리글	설명
수용	응답 본문의 데이터 형식입니다. application/json만 지원합니다.
콘텐츠-형식	요청 본문의 데이터 형식입니다. application/json만 지원합니다.

표 17. 응답 헤더
머리글	설명
안 함

상태 코드

이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하십시오.

표 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]
business_phone	리드의 직장 전화번호입니다. 데이터 유형: 문자열
구/군/시	잠재 고객이 거주하는 도시입니다. 데이터 유형: 문자열
closed_date	리드가 종결된 날짜 및 시간입니다. 데이터 유형: 객체 `"closed_date": { "display_value": "String", "value": "String" }`
closed_date.display_value	UI에 표시된 날짜 및 시간입니다. 데이터 유형: 문자열 형식: 사용자의 형식 및 시간대입니다.
closed_date.value	연결된 기록에 정의된 대로 리드가 종결된 날짜 및 시간입니다. 데이터 유형: 문자열 형식: UTC
회사	잠재 고객의 회사 이름입니다. 데이터 유형: 문자열
소비자	리드와 연결된 소비자입니다. 데이터 유형: 객체 `"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]
국가	잠재 고객이 거주하는 국가입니다. 데이터 유형: 문자열
do_not_call	통신 모드가 전화인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 연락처에 전화할 수 있습니다. 아니오: 연락처에 전화하지 않습니다. 데이터 유형: 부울
do_not_email	통신 모드가 이메일인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 연락할 수 있습니다. 아니오: 연락처에 이메일을 보내지 않습니다. 데이터 유형: 부울
do_not_share	리드 상세 정보를 공유할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 리드 상세 정보를 공유할 수 있습니다. false: 리드 상세 정보를 공유할 수 없습니다. 데이터 유형: 부울
이메일	잠재 고객의 이메일 주소입니다. 데이터 유형: 문자열
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입니다. 데이터 유형: 문자열 테이블: 그룹 [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.코드	제품 오퍼링에 연결된 코드입니다. 주: 제품 이름을 기준으로 시스템에서 생성된 영숫자 번호입니다. 시스템에서 생성되지만 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.값	리드 라인 항목이 생성된 날짜 및 시간입니다. 데이터 유형: 문자열 형식: 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	잠재 고객 연락처의 전화 번호입니다. 데이터 유형: 문자열
번호	시스템에서 생성된 고유 리드 기록 번호입니다. 데이터 유형: 문자열
other_reason	리드 실격의 추가 이유입니다. 데이터 유형: 문자열 최대 길이: 160자
소유자	잠재 고객과 연결된 사람의 세부 정보입니다. 데이터 유형: 객체 `"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와 같은 리드의 스테이지입니다. 주: 선택 필드입니다. 리드 테이블의 스테이지 필드에 정의된 선택 항목 중 하나를 포함해야 합니다. 데이터 유형: 문자열
상태	잠재 고객이 상주하는 주입니다. 데이터 유형: 문자열
주소	잠재 고객이 거주하는 거리입니다. 데이터 유형: 문자열
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
직위	잠재 고객의 직함입니다. 데이터 유형: 문자열
웹 사이트	잠재 고객의 웹 사이트 URL입니다. 데이터 유형: 문자열
work_notes	리드에 대해 생성된 작업 메모 목록입니다. 데이터 유형: 객체 배열 `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
work_notes.저자	관련 작업 메모를 작성한 사람의 사용자 이름입니다. 데이터 유형: 문자열
work_notes.날짜	메모가 생성된 날짜입니다. 데이터 유형: 문자열
work_notes.문자 메시지	작성자가 작성한 메모의 텍스트입니다. 데이터 유형: 문자열
우편번호	연결된 잠재 고객의 우편 번호입니다. 데이터 유형: 문자열

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

리드 - POST /sn_lead_mgmt_core/lead

지정된 매개변수를 사용하여 리드 기록 및 연결된 리드 라인 항목을 생성합니다.

처리가 완료되면 다음 테이블에 기록이 생성됩니다.

리드 [sn_lead_mgmt_core_lead]
리드 라인 항목 [sn_lead_mgmt_core_lead_line_item]

전달된 매개변수에 대한 규칙:

잘못된 매개변수 이름은 무시됩니다.
필수가 아닌 선택 및 참조 필드에 대한 값이 잘못되면 무시됩니다.
하나 이상의 필드에 대해 필드 쓰기 액세스가 거부되면 제한된 필드가 무시됩니다.
이 API를 사용하여 시스템 필드 값을 삽입할 수 없습니다. 제공된 값은 무시됩니다. 시스템 필드는 구성 가능한 무시된 필드 목록의 일부입니다.
매개변수 , 및 consumer 매개변수가 모두 비어 있지 않으면 매개변수 account값이 contact무 accountconsumer 시됩니다.
달리 지정하지 않는 한 전달되지 않은 모든 매개변수의 기본값은 "null"입니다.

URL 형식

버전 관리된 URL: /api/sn_lead_mgmt_core/{api_version}/lead

기본 URL: /api/sn_lead_mgmt_core/{api_version}/lead

주:

사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 19. 경로 매개변수
이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 `v1` 또는 `v2`입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하도록 이 값만 지정하십시오. 데이터 유형: 문자열

표 20. 쿼리 매개변수
이름	설명
없음

표 21. 요청 본문 매개변수
이름	설명
계정	잠재 고객과 연결된 계정에 대한 상세 정보입니다. 데이터 유형: 객체 `"account": { "sys_id": "String" }`
account.sys_id	연결된 계정 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 계정 [customer_account]
business_phone	리드의 직장 전화번호입니다. 데이터 유형: 문자열
구/군/시	잠재 고객이 거주하는 도시입니다. 데이터 유형: 문자열
회사	잠재 고객의 회사 이름입니다. 데이터 유형: 문자열
소비자	리드와 연결된 소비자입니다. 데이터 유형: 객체 `"consumer": { "sys_id": "String" }`
consumer.sys_id	연결된 소비자 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 소비자 [csm_consumer]
연락처	잠재 고객 계정과 연결된 접촉 창구입니다. 데이터 유형: 객체 `"contact": { "sys_id": "String" }`
contact.sys_id	연결된 접촉 창구 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 연락처 [customer_contact]
국가	잠재 고객이 거주하는 국가입니다. 데이터 유형: 문자열
do_not_call	통신 모드가 전화인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 연락처에 전화할 수 있습니다. 아니오: 연락처에 전화하지 않습니다. 데이터 유형: 부울 기본값: false
do_not_email	통신 모드가 이메일인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 연락할 수 있습니다. 아니오: 연락처에 이메일을 보내지 않습니다. 데이터 유형: 부울 기본값: false
do_not_share	리드 상세 정보를 공유할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 리드 상세 정보를 공유할 수 있습니다. false: 리드 상세 정보를 공유할 수 없습니다. 데이터 유형: 부울 기본값: false
이메일	잠재 고객의 이메일 주소입니다. 데이터 유형: 문자열
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입니다. 데이터 유형: 문자열 테이블: 그룹 [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.수량	리드가 연결된 제품 오퍼링 중에서 구매하려는 항목의 수량입니다. 데이터 유형: 숫자(정수) 기본값: 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": { "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
상태	잠재 고객이 상주하는 주입니다. 데이터 유형: 문자열
주소	잠재 고객이 거주하는 거리입니다. 데이터 유형: 문자열
직위	잠재 고객의 직함입니다. 데이터 유형: 문자열
웹 사이트	잠재 고객의 웹 사이트 URL입니다. 데이터 유형: 문자열
work_notes	리드에 대해 생성된 작업 메모 목록입니다. 데이터 유형: 객체 배열 `"work_notes": [ { "text": "String" } ]` 주: 요청의 작업 메모 배열이 단일 텍스트로 삽입됩니다. 이 텍스트는 요청에 있는 모든 작업 메모 객체의 콘텐츠를 결합하여 생성되며, 각 항목은 쉼표(,)로 구분됩니다. 기본값: 빈 배열
work_notes.문자 메시지	작성자가 작성한 메모의 텍스트입니다. 데이터 유형: 문자열
우편번호	연결된 잠재 고객의 우편 번호입니다. 데이터 유형: 문자열

헤더

표 22. 요청 헤더
머리글	설명
수용	응답 본문의 데이터 형식입니다. application/json만 지원합니다.

표 23. 응답 헤더
머리글	설명
안 함

상태 코드

이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하십시오.

표 24. 상태 코드
상태 코드	설명
201	성공입니다. 리드 및 연결된 라인 항목이 성공적으로 삽입되었습니다.
400	오류. 가능한 이유: 잘못된 페이로드: 잘못된/빈 요청 본문입니다. 잘못된 페이로드: 이메일/전화번호 필드의 필드 값이 잘못되었습니다. 잘못된 페이로드: 필수 필드가 없거나 해당 값이 비어 있습니다. 비즈니스 규칙/데이터 정책 위반.
403	금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수


이름	설명
계정	잠재 고객에 연결된 계정입니다. 데이터 유형: 객체 `"account": { "name": "String", "sys_id": "String" }`
account.name	계정의 이름입니다. 데이터 유형: 문자열
account.sys_id	연결된 계정 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 계정 [customer_account]
business_phone	리드의 직장 전화번호입니다. 데이터 유형: 문자열
구/군/시	잠재 고객이 거주하는 도시입니다. 데이터 유형: 문자열
closed_date	리드가 종결된 날짜 및 시간입니다. 데이터 유형: 객체 `"closed_date": { "display_value": "String", "value": "String" }`
closed_date.display_value	UI에 표시된 날짜 및 시간입니다. 데이터 유형: 문자열 형식: 사용자의 형식 및 시간대입니다.
closed_date.value	연결된 기록에 정의된 대로 리드가 종결된 날짜 및 시간입니다. 데이터 유형: 문자열 형식: UTC
회사	잠재 고객의 회사 이름입니다. 데이터 유형: 문자열
소비자	리드와 연결된 소비자입니다. 데이터 유형: 객체 `"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]
국가	잠재 고객이 거주하는 국가입니다. 데이터 유형: 문자열
do_not_call	통신 모드가 전화인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 연락처에 전화할 수 있습니다. 아니오: 연락처에 전화하지 않습니다. 데이터 유형: 부울
do_not_email	통신 모드가 이메일인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 연락할 수 있습니다. 아니오: 연락처에 이메일을 보내지 않습니다. 데이터 유형: 부울
do_not_share	리드 상세 정보를 공유할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 리드 상세 정보를 공유할 수 있습니다. false: 리드 상세 정보를 공유할 수 없습니다. 데이터 유형: 부울
이메일	잠재 고객의 이메일 주소입니다. 데이터 유형: 문자열
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입니다. 데이터 유형: 문자열 테이블: 그룹 [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.코드	제품 오퍼링에 연결된 코드입니다. 주: 제품 이름을 기준으로 시스템에서 생성된 영숫자 번호입니다. 시스템에서 생성되지만 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.값	리드 라인 항목이 생성된 날짜 및 시간입니다. 데이터 유형: 문자열 형식: 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	잠재 고객 연락처의 전화 번호입니다. 데이터 유형: 문자열
번호	시스템에서 생성된 고유 리드 기록 번호입니다. 데이터 유형: 문자열
other_reason	리드 실격의 추가 이유입니다. 데이터 유형: 문자열 최대 길이: 160자
소유자	잠재 고객과 연결된 사람의 세부 정보입니다. 데이터 유형: 객체 `"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와 같은 리드의 스테이지입니다. 주: 선택 필드입니다. 리드 테이블의 스테이지 필드에 정의된 선택 항목 중 하나를 포함해야 합니다. 데이터 유형: 문자열
상태	잠재 고객이 상주하는 주입니다. 데이터 유형: 문자열
주소	잠재 고객이 거주하는 거리입니다. 데이터 유형: 문자열
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
직위	잠재 고객의 직함입니다. 데이터 유형: 문자열
웹 사이트	잠재 고객의 웹 사이트 URL입니다. 데이터 유형: 문자열
work_notes	리드에 대해 생성된 작업 메모 목록입니다. 데이터 유형: 객체 배열 `"work_notes": [ { "author": "String", "date": "String", "text": "String" } ]`
work_notes.저자	관련 작업 메모를 작성한 사람의 사용자 이름입니다. 데이터 유형: 문자열
work_notes.날짜	메모가 생성된 날짜입니다. 데이터 유형: 문자열
work_notes.문자 메시지	작성자가 작성한 메모의 텍스트입니다. 데이터 유형: 문자열
우편번호	연결된 잠재 고객의 우편 번호입니다. 데이터 유형: 문자열

cURL 요청

다음 코드 예제에서는 하나의 리드 라인 항목으로 새 리드 기록을 만드는 방법을 보여줍니다.

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