다음을 통해 공유


Marketo MA(미리 보기)

Marketo Marketing Automation. 이 API는 캠페인, 프로그램, 잠재 고객, 목록(정적 및 스마트)과 같은 Marketo 개체뿐만 아니라 파일 및 폴더와 같은 파일 시스템 자산에 대한 액세스를 제공합니다.

이 커넥터는 다음 제품 및 지역에서 사용할 수 있습니다.

서비스 클래스 Regions
Copilot Studio 스탠다드 다음을 제외한 모든 Power Automate 지역 :
     - 미국 정부(GCC High)
     - 21Vianet에서 운영하는 중국 클라우드
     - 미국 국방부(DoD)
논리 앱 스탠다드 다음을 제외한 모든 Logic Apps 지역 :
     - Azure 중국 지역
     - 미국 국방부(DoD)
Power Apps 스탠다드 다음을 제외한 모든 Power Apps 지역 :
     - 미국 정부(GCC High)
     - 21Vianet에서 운영하는 중국 클라우드
     - 미국 국방부(DoD)
Power Automate 스탠다드 다음을 제외한 모든 Power Automate 지역 :
     - 미국 정부(GCC High)
     - 21Vianet에서 운영하는 중국 클라우드
     - 미국 국방부(DoD)
연락처
이름 Marketo 개발자 관계
URL http://developers.marketo.com
전자 메일 developerfeedback@marketo.com
커넥터 메타데이터
게시자 Microsoft Inc.
웹 사이트 https://www.marketo.com/
개인 정보 보호 정책 https://documents.marketo.com/legal/privacy/
서비스 약관 https://go.microsoft.com/fwlink/?linkid=2237005
카테고리 마케팅; 판매 및 CRM

연결을 만드는 중

커넥터는 다음 인증 유형을 지원합니다.

기본값 연결을 만들기 위한 매개 변수입니다. 모든 지역 공유할 수 없음

기본값

적용 가능: 모든 지역

연결을 만들기 위한 매개 변수입니다.

공유 가능한 연결이 아닙니다. 전원 앱이 다른 사용자와 공유되면 다른 사용자에게 새 연결을 명시적으로 만들라는 메시지가 표시됩니다.

이름 유형 Description 필수
MunchkinID 문자열 Marketo MunchkinID(관리자 페이지 참조) 진실
클라이언트 ID 문자열 클라이언트 ID 진실
클라이언트 암호 시큐어스트링 (보안 문자열) 클라이언트 암호 진실

제한 한도

Name 호출 갱신 기간
연결당 API 호출 100 60초

동작

ID로 파일 가져오기

지정된 ID의 파일 레코드를 반환합니다. 필요한 사용 권한: Read-Only 자산, Read-Write 자산

ID별 목록 가져오기

ID로 목록 레코드를 반환합니다. 필요한 사용 권한: Read-Only 잠재 고객, Read-Write 잠재 고객

ID별 스마트 목록 가져오기

ID로 스마트 목록 레코드를 검색합니다. 필요한 권한: Read-Asset 또는 Read-Write 자산

ID별 잠재 고객 가져오기

Marketo ID를 통해 단일 잠재 고객 레코드를 검색합니다. 필요한 권한: Read-Only 잠재 고객, Read-Write 잠재 고객

ID별 정적 목록 가져오기

ID로 정적 목록 레코드를 검색합니다. 필요한 권한: Read-Asset 또는 Read-Write 자산

ID별 캠페인 가져오기

ID로 캠페인 레코드를 반환합니다. 필수 사용 권한: Read-Only 캠페인, Read-Write 캠페인

참고: 이 엔드포인트는 대체되었습니다. 대신 Id별 스마트 캠페인 엔드포인트 가져오기를 사용합니다.

ID별 폴더 가져오기

지정된 ID를 사용하여 폴더 레코드를 반환합니다. 필요한 사용 권한: Read-Only 자산, Read-Write Assets

ID별 프로그램 가져오기

지정된 ID에 대한 프로그램 레코드를 검색합니다. 필요한 권한: Read-Only 자산, Read-Write 자산

Lead2 설명

대상 인스턴스의 잠재 고객 개체에서 검색 가능한 필드 목록을 반환합니다. 필수 권한: 잠재 고객 Read-Only Read-Write 잠재 고객

Marketo로 잠재 고객 푸시

잠재 고객에 대한 Upserts 및 Marketo 활동에 대한 푸시 리드를 생성합니다. 필수 권한: Read-Write 잠재 고객

가져오기 잠재 고객 경고 가져오기

일괄 작업 가져오기에 대한 경고 목록을 반환합니다. 필수 권한: Read-Write 잠재 고객

가져오기 잠재 고객 실패 가져오기

일괄 작업 가져오기에 대한 오류 목록을 반환합니다. 필수 권한: Read-Write 잠재 고객

가져오기 프로그램 멤버 경고 가져오기

일괄 작업 가져오기에 대한 경고 목록을 반환합니다. 필수 권한: Read-Write 잠재 고객

가져오기 프로그램 멤버 상태 가져오기

가져오기 일괄 처리 작업의 상태를 반환합니다. 필수 권한: Read-Write 잠재 고객

가져오기 프로그램 멤버 오류 가져오기

일괄 작업 가져오기에 대한 오류 목록을 반환합니다. 필수 권한: Read-Write 잠재 고객

내보내기 잠재 고객 작업 상태 가져오기

내보내기 작업의 상태를 반환합니다. 작업 상태는 완료 또는 실패 상태에 도달한 후 30일 동안 사용할 수 있습니다. 필수 권한: Read-Only 잠재 고객

내보내기 프로그램 멤버 작업 가져오기

지난 7일 동안 생성된 내보내기 작업 목록을 반환합니다. 필수 권한: Read-Only 잠재 고객

내보내기 프로그램 멤버 작업 만들기

"filter" 매개 변수를 통해 정의된 검색 조건에 대한 내보내기 작업을 만듭니다. 요청은 대량 내보내기 프로그램 멤버 엔드포인트에 대한 후속 호출에서 매개 변수로 전달되는 "exportId"를 반환합니다.

내보내기 프로그램 멤버 작업 상태 가져오기

내보내기 작업의 상태를 반환합니다. 작업 상태는 완료 또는 실패 상태에 도달한 후 30일 동안 사용할 수 있습니다. 필수 권한: Read-Only 잠재 고객

내보내기 프로그램 멤버 작업 큐에 넣기

내보내기 작업을 큐에 넣기 이렇게 하면 내보내기 작업이 큐에 배치되고 컴퓨팅 리소스를 사용할 수 있게 되면 작업이 시작됩니다. 내보내기 작업은 "만든" 상태여야 합니다.

내보내기 프로그램 멤버 파일 가져오기

내보내기 작업의 파일 콘텐츠를 반환합니다. 내보내기 작업은 "완료" 상태여야 합니다. 내보내기 프로그램 멤버 작업 상태 가져오기 엔드포인트를 사용하여 내보내기 작업의 상태를 검색합니다. 필수 권한: Read-Only 잠재 고객

파일 형식은 내보내기 프로그램 멤버 만들기 작업 엔드포인트를 호출하여 지정됩니다. 다음은 기본 파일 형식("CSV")의 예입니다.

firstName,lastName,email
Marvin,Gaye,marvin.gaye@motown.com

목록 ID로 잠재 고객 가져오기

지정된 정적 목록의 멤버인 사람 레코드를 검색합니다. 필수 권한: 잠재 고객 Read-Only Read-Write 잠재 고객

목록 ID로 잠재 고객 가져오기

지정된 정적 목록의 멤버인 사람 레코드를 검색합니다. 필수 권한: 잠재 고객 Read-Only Read-Write 잠재 고객

목록 가져오기

지정된 필터 매개 변수를 기반으로 정적 목록 레코드 집합을 반환합니다. 필수 권한: 잠재 고객 Read-Only Read-Write 잠재 고객

목록에 추가

지정된 개인 레코드 집합을 대상 정적 목록에 추가합니다. 요청당 300개의 잠재 고객 ID로 제한됩니다. 필수 권한: Read-Write 잠재 고객

목록에서 제거

대상 정적 목록에서 지정된 사용자 레코드 집합을 제거합니다. 필수 권한: Read-Write 잠재 고객

목록의 구성원

잠재 고객이 지정된 정적 목록의 멤버인지 확인합니다. 필수 권한: Read-Write 잠재 고객

스마트 목록 가져오기

사용자가 만든 스마트 목록 레코드 목록을 검색합니다. 필요한 권한: Read-Asset 또는 Read-Write 자산

스마트 목록 복제

지정된 스마트 목록을 복제합니다. 필수 권한: Read-Write 자산

스마트 목록 삭제

지정된 스마트 목록을 삭제합니다. 필수 권한: Read-Write 자산

승인 취소 프로그램

대상 프로그램의 승인이 취소됩니다. 승인된 전자 메일 프로그램에만 유효합니다. 필수 권한: Read-Write 자산

아이덴티티

Marketo에서 액세스 토큰을 검색합니다. 이 엔드포인트에 대한 호출은 API 호출 제한에 포함되지 않습니다.

아이덴티티

Marketo에서 액세스 토큰을 검색합니다. 이 엔드포인트에 대한 호출은 API 호출 제한에 포함되지 않습니다.

이름으로 스마트 목록 가져오기

스마트 목록 레코드를 이름으로 검색합니다. 필요한 권한: Read-Asset 또는 Read-Write 자산

이름으로 잠재 고객 필드 가져오기

단일 잠재 고객 필드에 대한 메타데이터를 검색합니다. 필수 사용 권한: 스키마 표준 필드 Read-Write 스키마 사용자 정의 필드 Read-Write

이름으로 정적 목록 가져오기

해당 이름으로 정적 목록 레코드를 검색합니다. 필요한 권한: Read-Asset 또는 Read-Write 자산

이름으로 파일 가져오기

지정된 이름의 파일 레코드를 반환합니다. 필수 권한: 자산 Read-Only, Read-Write 자산

이름으로 폴더 가져오기

지정된 이름의 폴더 레코드를 반환합니다. 필수 권한: 자산 Read-Only, Read-Write 자산

이름으로 프로그램 가져오기

지정된 이름의 프로그램 레코드를 검색합니다. 필수 권한: 자산 Read-Only, Read-Write 자산

이름으로 프로그램 멤버 필드 가져오기

단일 프로그램 멤버 필드에 대한 메타데이터를 검색합니다. 필수 사용 권한: 스키마 표준 필드 Read-Write 스키마 사용자 정의 필드 Read-Write

잠재 고객 가져오기

데이터 레코드가 포함된 파일을 대상 인스턴스로 가져옵니다. 필수 권한: Read-Write 잠재 고객

잠재 고객 가져오기 상태 가져오기

가져오기 일괄 처리 작업의 상태를 반환합니다. 필수 권한: Read-Write 잠재 고객

잠재 고객 내보내기 작업 가져오기

지난 7일 동안 생성된 내보내기 작업 목록을 반환합니다. 필수 권한: Read-Only 잠재 고객

잠재 고객 내보내기 작업 만들기

"filter" 매개 변수를 통해 정의된 검색 조건에 대한 내보내기 작업을 만듭니다. 요청은 대량 내보내기 리드 엔드포인트에 대한 후속 호출에서 매개 변수로 전달되는 "exportId"를 반환합니다. 큐에 넣기 내보내기 리드 작업 엔드포인트를 사용하여 처리를 위해 내보내기 작업을 큐에 대기합니다. 내보내기 리드 작업 상태 가져오기 엔드포인트를 사용하여 내보내기 작업의 상태를 검색합니다. 필수 권한: Read-Only 잠재 고객

잠재 고객 내보내기 작업 취소

내보내기 작업을 취소합니다. 필수 권한: Read-Only 잠재 고객

잠재 고객 내보내기 작업 큐에 넣기

내보내기 작업을 큐에 넣기 이렇게 하면 내보내기 작업이 큐에 배치되고 컴퓨팅 리소스를 사용할 수 있게 되면 작업이 시작됩니다. 내보내기 작업은 "만든" 상태여야 합니다. 내보내기 리드 작업 상태 가져오기 엔드포인트를 사용하여 내보내기 작업의 상태를 검색합니다. 필수 권한: Read-Only 잠재 고객

잠재 고객 내보내기 파일 가져오기

내보내기 작업의 파일 콘텐츠를 반환합니다. 내보내기 작업은 "완료" 상태여야 합니다. 내보내기 리드 작업 상태 가져오기 엔드포인트를 사용하여 내보내기 작업의 상태를 검색합니다. 필수 권한: Read-Only 잠재 고객

파일 형식은 잠재 고객 내보내기 작업 만들기 엔드포인트를 호출하여 지정됩니다. 다음은 기본 파일 형식("CSV")의 예입니다.

firstName,lastName,email
Marvin,Gaye,marvin.gaye@motown.com

잠재 고객 동기화

잠재 고객 목록을 대상 인스턴스에 동기화합니다. 필수 권한: Read-Write 잠재 고객

잠재 고객 삭제

대상 인스턴스에서 잠재 고객 목록을 삭제합니다. 필수 권한: Read-Write 잠재 고객

잠재 고객 설명

API를 통한 상호 작용에 사용할 수 있는 모든 필드 목록을 포함하여 대상 인스턴스의 잠재 고객 개체에 대한 메타데이터를 반환합니다. 필수 권한: 잠재 고객 Read-Only Read-Write 잠재 고객

참고: 이 엔드포인트는 대체되었습니다. 대신 Lead2 엔드포인트 설명 사용

잠재 고객 필드 업데이트

대상 인스턴스의 잠재 고객 필드에 대한 메타데이터를 업데이트합니다. 여기에서 업데이트 규칙을 참조 하세요. 필수 사용 권한: 스키마 표준 필드 Read-Write 스키마 사용자 정의 필드 Read-Write

정적 목록 가져오기

정적 목록 레코드 목록을 검색합니다. 필요한 권한: Read-Asset 또는 Read-Write 자산

정적 목록 만들기

새 정적 목록을 만듭니다. 필수 권한: Read-Write 자산

정적 목록 메타데이터 업데이트

정적 목록 자산의 메타데이터를 업데이트합니다. 필수 권한: Read-Write 자산

정적 목록 삭제

지정된 정적 목록을 삭제합니다. 필수 권한: Read-Write 자산

캠페인 가져오기

캠페인 레코드 목록을 반환합니다. 필수 사용 권한: Read-Only 캠페인, Read-Write 캠페인

참고: 이 엔드포인트는 대체되었습니다. 대신 스마트 캠페인 엔드포인트 가져오기를 사용합니다.

캠페인 예약

지정된 시간에 실행되도록 일괄 처리 캠페인을 원격으로 예약합니다. 캠페인의 부모 프로그램에 로컬인 내 토큰을 재정의하여 콘텐츠를 사용자 지정할 수 있습니다. 아래에 설명된 "cloneToProgramName" 매개 변수를 사용하는 경우 이 엔드포인트는 하루에 20회 호출로 제한됩니다. 필수 권한: 캠페인 실행

캠페인 요청

일련의 잠재 고객을 트리거 캠페인에 전달하여 캠페인 흐름을 실행합니다. 지정된 캠페인에는 요청됨: 웹 서비스 API 트리거가 있어야 하며 활성 상태여야 합니다. 캠페인의 부모 프로그램에 로컬인 내 토큰을 재정의하여 콘텐츠를 사용자 지정할 수 있습니다. 호출당 최대 100명의 잠재 고객이 허용됩니다. 필수 권한: 캠페인 실행

태그로 프로그램 가져오기

지정된 태그 형식 및 태그 값과 일치하는 프로그램 목록을 검색합니다. 필수 권한: 자산 Read-Only, Read-Write 자산

파일 가져오기

지정된 폴더에서 파일을 반환합니다. 필수 권한: 자산 Read-Only, Read-Write 자산

파일 만들기

포함된 페이로드에서 새 파일을 만듭니다. 필수 권한: Read-Write 자산

파일 콘텐츠 업데이트

파일의 현재 콘텐츠를 포함된 페이로드로 바꿉니다. 필수 권한: Read-Write 자산

폴더 가져오기

지정된 루트 폴더 내에서 자식 폴더를 검색합니다. 필수 권한: 자산 Read-Only, Read-Write 자산

폴더 내용 가져오기

지정된 폴더의 내용에 대한 레코드를 반환합니다. 필수 권한: 자산 Read-Only, Read-Write 자산

폴더 만들기

새 폴더를 만듭니다. 필수 권한: Read-Write 자산

폴더 메타데이터 업데이트

지정된 폴더에 대한 메타데이터를 업데이트합니다. 필수 권한: Read-Write 자산

폴더 삭제

지정된 폴더를 삭제합니다. 폴더에 콘텐츠가 있는 경우 삭제가 실패합니다. 필수 권한: Read-Write 자산

프로그램 ID로 잠재 고객 가져오기

지정된 프로그램의 멤버인 잠재 고객 목록을 검색합니다. 필수 권한: 잠재 고객 Read-Only Read-Write 잠재 고객

프로그램 ID별 스마트 목록 가져오기

전자 메일 프로그램 ID로 스마트 목록 레코드를 검색합니다. 필요한 권한: Read-Asset 또는 Read-Write 자산

프로그램 가져오기

대상 인스턴스에서 액세스 가능한 프로그램 목록을 검색합니다. 필수 권한: 자산 Read-Only, Read-Write 자산

프로그램 구성원 가져오기

특정 필드의 값 목록에 있는 최대 300명의 프로그램 멤버 목록을 반환합니다. 사용자 지정 필드인 filterType을 지정하는 경우 사용자 지정 필드의 dataType은 "string" 또는 "integer"여야 합니다. "leadId" 이외의 filterType을 지정하는 경우 요청에 의해 최대 100,000개의 프로그램 멤버 레코드를 처리할 수 있습니다. 필수 권한: 잠재 고객 Read-Only Read-Write 잠재 고객

프로그램 구성원 가져오기

데이터 레코드가 포함된 파일을 대상 인스턴스로 가져옵니다. 필수 권한: Read-Write 잠재 고객

프로그램 구성원 내보내기 작업 취소

내보내기 작업을 취소합니다. 필수 권한: Read-Only 잠재 고객

프로그램 구성원 삭제

대상 인스턴스에서 멤버 목록을 삭제합니다. 필수 권한: Read-Write 잠재 고객

프로그램 만들기

새 프로그램을 만듭니다. 필수 권한: Read-Write 자산

프로그램 메타데이터 업데이트

대상 프로그램의 메타데이터를 업데이트합니다. 필수 권한: Read-Write 자산

프로그램 멤버 데이터 동기화

대상 프로그램에서 잠재 고객 목록의 프로그램 멤버 데이터를 변경합니다. 이 API를 사용하여 프로그램의 기존 멤버만 해당 데이터를 변경할 수 있습니다. 필수 권한: Read-Write 잠재 고객

프로그램 멤버 상태 동기화

대상 프로그램의 잠재 고객 목록의 프로그램 멤버 상태를 변경합니다. 멤버가 프로그램에 속하지 않으면 멤버가 프로그램에 추가됩니다. 필수 권한: Read-Write 잠재 고객

프로그램 멤버 설명

API를 통한 상호 작용에 사용할 수 있는 모든 필드 목록을 포함하여 대상 인스턴스의 프로그램 멤버 개체에 대한 메타데이터를 반환합니다. 필수 권한: 잠재 고객 Read-Only Read-Write 잠재 고객

참고: 이 엔드포인트는 대체되었습니다. 대신 프로그램 멤버 엔드포인트에 대해 설명 합니다.

프로그램 멤버 설명

API를 통한 상호 작용에 사용할 수 있는 모든 필드 목록을 포함하여 대상 인스턴스의 프로그램 멤버 개체에 대한 메타데이터를 반환합니다. 필수 권한: 잠재 고객 Read-Only Read-Write 잠재 고객

프로그램 복제

대상 프로그램을 복제합니다. 필수 권한: Read-Write 자산

프로그램 삭제

대상 프로그램을 삭제합니다. 프로그램에는 프로그램 외부에서 사용 중인 자산이 포함될 수 없습니다. 필수 권한: Read-Write 자산

프로그램 승인

대상 프로그램을 승인합니다. 승인되지 않은 전자 메일 프로그램에만 유효합니다. 필수 권한: Read-Write 자산

프로그램 태그 삭제

필수가 아닌 프로그램 태그를 삭제합니다. 필수 권한: Read-Write 자산

프로그램 태그 업데이트

프로그램 태그를 업데이트합니다. 필수 권한: Read-Write 자산

필터 유형별 잠재 고객 가져오기

특정 필드의 값 목록을 기반으로 최대 300개 잠재 고객 목록을 반환합니다. 필수 권한: 잠재 고객 Read-Only Read-Write 잠재 고객

ID로 파일 가져오기

지정된 ID의 파일 레코드를 반환합니다. 필요한 사용 권한: Read-Only 자산, Read-Write 자산

매개 변수

Name 필수 형식 Description
파일의 ID입니다.
id True integer

데이터베이스의 파일 ID

반환

ID별 목록 가져오기

ID로 목록 레코드를 반환합니다. 필요한 사용 권한: Read-Only 잠재 고객, Read-Write 잠재 고객

매개 변수

Name 필수 형식 Description
레코드를 검색할 정적 목록의 ID입니다.
listId True integer

레코드를 검색할 정적 목록의 ID입니다.

반환

ID별 스마트 목록 가져오기

ID로 스마트 목록 레코드를 검색합니다. 필요한 권한: Read-Asset 또는 Read-Write 자산

매개 변수

Name 필수 형식 Description
검색할 스마트 목록의 ID
id True integer

검색할 스마트 목록의 ID

true를 설정하여 스마트 목록 규칙을 채웁다. 기본값 false
includeRules boolean

true를 설정하여 스마트 목록 규칙을 채웁다. 기본값 false

반환

ID별 잠재 고객 가져오기

Marketo ID를 통해 단일 잠재 고객 레코드를 검색합니다. 필요한 권한: Read-Only 잠재 고객, Read-Write 잠재 고객

매개 변수

Name 필수 형식 Description
Marketo 잠재 고객 ID
leadId True integer

Marketo 잠재 고객 ID

필드 이름의 쉼표로 구분된 목록입니다.
fields array

필드 이름의 쉼표로 구분된 목록입니다. 생략하면 email, updatedAt, createdAt, lastName, firstName 및 ID와 같은 기본 필드가 반환됩니다.

반환

ID별 정적 목록 가져오기

ID로 정적 목록 레코드를 검색합니다. 필요한 권한: Read-Asset 또는 Read-Write 자산

매개 변수

Name 필수 형식 Description
검색할 정적 목록의 ID
id True integer

검색할 정적 목록의 ID

반환

ID별 캠페인 가져오기

ID로 캠페인 레코드를 반환합니다. 필수 사용 권한: Read-Only 캠페인, Read-Write 캠페인

참고: 이 엔드포인트는 대체되었습니다. 대신 Id별 스마트 캠페인 엔드포인트 가져오기를 사용합니다.

매개 변수

Name 필수 형식 Description
campaignId
campaignId True integer

campaignId

반환

ID별 폴더 가져오기

지정된 ID를 사용하여 폴더 레코드를 반환합니다. 필요한 사용 권한: Read-Only 자산, Read-Write Assets

매개 변수

Name 필수 형식 Description
검색할 폴더의 ID입니다.
id True integer

검색할 폴더의 ID

폴더의 형식(프로그램 또는 폴더)
type True string

폴더의 유형입니다. 'Folder' 또는 'Program'

반환

ID별 프로그램 가져오기

지정된 ID에 대한 프로그램 레코드를 검색합니다. 필요한 권한: Read-Only 자산, Read-Write 자산

매개 변수

Name 필수 형식 Description
프로그램 ID
id True integer

아이디

반환

Lead2 설명

대상 인스턴스의 잠재 고객 개체에서 검색 가능한 필드 목록을 반환합니다. 필수 권한: 잠재 고객 Read-Only Read-Write 잠재 고객

반환

Marketo로 잠재 고객 푸시

잠재 고객에 대한 Upserts 및 Marketo 활동에 대한 푸시 리드를 생성합니다. 필수 권한: Read-Write 잠재 고객

매개 변수

Name 필수 형식 Description
아이디
id integer

잠재 고객 레코드의 고유 정수 ID

코드
code True string

이유의 정수 코드

message
message True string

작업 상태에 대한 이유를 설명하는 메시지

status
status string

레코드에서 수행된 작업의 상태

lookupField
lookupField string
partitionName
partitionName string
programName
programName string
programStatus
programStatus string
이유
reason string
source
source string

반환

가져오기 잠재 고객 경고 가져오기

일괄 작업 가져오기에 대한 경고 목록을 반환합니다. 필수 권한: Read-Write 잠재 고객

매개 변수

Name 필수 형식 Description
일괄 처리 가져오기 작업의 ID입니다.
batchId True integer

일괄 처리 가져오기 작업의 ID입니다.

반환

response
object

가져오기 잠재 고객 실패 가져오기

일괄 작업 가져오기에 대한 오류 목록을 반환합니다. 필수 권한: Read-Write 잠재 고객

매개 변수

Name 필수 형식 Description
일괄 처리 가져오기 작업의 ID입니다.
batchId True integer

일괄 처리 가져오기 작업의 ID입니다.

반환

response
object

가져오기 프로그램 멤버 경고 가져오기

일괄 작업 가져오기에 대한 경고 목록을 반환합니다. 필수 권한: Read-Write 잠재 고객

매개 변수

Name 필수 형식 Description
일괄 처리 가져오기 작업의 ID입니다.
batchId True integer

일괄 처리 가져오기 작업의 ID입니다.

반환

response
object

가져오기 프로그램 멤버 상태 가져오기

가져오기 일괄 처리 작업의 상태를 반환합니다. 필수 권한: Read-Write 잠재 고객

매개 변수

Name 필수 형식 Description
일괄 처리 가져오기 작업의 ID입니다.
batchId True integer

일괄 처리 가져오기 작업의 ID입니다.

반환

가져오기 프로그램 멤버 오류 가져오기

일괄 작업 가져오기에 대한 오류 목록을 반환합니다. 필수 권한: Read-Write 잠재 고객

매개 변수

Name 필수 형식 Description
일괄 처리 가져오기 작업의 ID입니다.
batchId True integer

일괄 처리 가져오기 작업의 ID입니다.

반환

response
object

내보내기 잠재 고객 작업 상태 가져오기

내보내기 작업의 상태를 반환합니다. 작업 상태는 완료 또는 실패 상태에 도달한 후 30일 동안 사용할 수 있습니다. 필수 권한: Read-Only 잠재 고객

매개 변수

Name 필수 형식 Description
일괄 처리 내보내기 작업의 ID입니다.
exportId True string

일괄 처리 내보내기 작업의 ID입니다.

반환

내보내기 프로그램 멤버 작업 가져오기

지난 7일 동안 생성된 내보내기 작업 목록을 반환합니다. 필수 권한: Read-Only 잠재 고객

매개 변수

Name 필수 형식 Description
필터링할 쉼표로 구분된 상태 목록입니다.
status array

필터링할 쉼표로 구분된 상태 목록입니다.

반환할 일괄 처리 크기입니다. 최대값과 기본값은 300입니다.
batchSize integer

반환할 일괄 처리 크기입니다. 최대값과 기본값은 300입니다.

결과 집합이 일괄 처리 크기보다 큰 경우 이 엔드포인트에서 반환됩니다.
nextPageToken string

결과 집합이 일괄 처리 크기보다 크고 이 매개 변수를 통해 후속 호출에서 전달될 수 있는 경우 이 엔드포인트에서 토큰이 반환됩니다. 자세한 내용은 페이징 토큰을 참조하세요.

반환

내보내기 프로그램 멤버 작업 만들기

"filter" 매개 변수를 통해 정의된 검색 조건에 대한 내보내기 작업을 만듭니다. 요청은 대량 내보내기 프로그램 멤버 엔드포인트에 대한 후속 호출에서 매개 변수로 전달되는 "exportId"를 반환합니다.

매개 변수

Name 필수 형식 Description
이름
name True string

헤더 필드의 REST API 이름

value
value True string

머리글 필드의 값

fields
fields True array of string

파일에 포함할 필드의 쉼표로 구분된 목록

programId
programId True integer

멤버를 검색할 프로그램의 ID입니다. "programIds" 필터와 함께 사용할 수 없습니다.

programIds
programIds True array of integer

멤버를 검색할 프로그램 ID의 배열입니다. "programId" 필터와 함께 사용할 수 없습니다.

isExhausted
isExhausted boolean

콘텐츠가 소진된 사용자에 대한 프로그램 멤버 자격 레코드 필터링

nurtureCadence
nurtureCadence string

지정된 육성 주기에 대한 프로그램 멤버 자격 레코드 필터링

statusNames
statusNames array of string

프로그램 멤버 상태 이름의 배열입니다. 기본값 및/또는 사용자 정의일 수 있습니다. 여러 상태 이름이 함께 ORed됩니다.

endAt
endAt string

날짜 범위 필터 종료(ISO 8601 형식)

startAt
startAt string

날짜 범위 필터 시작(ISO-8601 형식)

format
format string

만들 파일 형식("CSV", "TSV", "SSV"). 기본값은 "CSV"입니다.

반환

내보내기 프로그램 멤버 작업 상태 가져오기

내보내기 작업의 상태를 반환합니다. 작업 상태는 완료 또는 실패 상태에 도달한 후 30일 동안 사용할 수 있습니다. 필수 권한: Read-Only 잠재 고객

매개 변수

Name 필수 형식 Description
일괄 처리 내보내기 작업의 ID입니다.
exportId True string

일괄 처리 내보내기 작업의 ID입니다.

반환

내보내기 프로그램 멤버 작업 큐에 넣기

내보내기 작업을 큐에 넣기 이렇게 하면 내보내기 작업이 큐에 배치되고 컴퓨팅 리소스를 사용할 수 있게 되면 작업이 시작됩니다. 내보내기 작업은 "만든" 상태여야 합니다.

매개 변수

Name 필수 형식 Description
일괄 처리 작업의 ID입니다.
exportId True string

일괄 처리 내보내기 작업의 ID입니다.

반환

내보내기 프로그램 멤버 파일 가져오기

내보내기 작업의 파일 콘텐츠를 반환합니다. 내보내기 작업은 "완료" 상태여야 합니다. 내보내기 프로그램 멤버 작업 상태 가져오기 엔드포인트를 사용하여 내보내기 작업의 상태를 검색합니다. 필수 권한: Read-Only 잠재 고객

파일 형식은 내보내기 프로그램 멤버 만들기 작업 엔드포인트를 호출하여 지정됩니다. 다음은 기본 파일 형식("CSV")의 예입니다.

firstName,lastName,email
Marvin,Gaye,marvin.gaye@motown.com

매개 변수

Name 필수 형식 Description
일괄 처리 내보내기 작업의 ID입니다.
exportId True string

일괄 처리 내보내기 작업의 ID입니다.

추출된 데이터의 부분 검색을 지원합니다.
Range string

추출된 데이터의 부분 검색을 지원하기 위해 "바이트" 형식의 HTTP 헤더 "Range"를 지정할 수 있습니다. 자세한 내용은 RFC 2616 "범위 검색 요청"을 참조하세요. 헤더가 설정되지 않으면 전체 내용이 반환됩니다.

반환

response
object

목록 ID로 잠재 고객 가져오기

지정된 정적 목록의 멤버인 사람 레코드를 검색합니다. 필수 권한: 잠재 고객 Read-Only Read-Write 잠재 고객

매개 변수

Name 필수 형식 Description
레코드를 검색할 정적 목록의 ID입니다.
listId True integer

레코드를 검색할 정적 목록의 ID입니다.

각 레코드에 대해 반환할 잠재 고객 필드의 쉼표로 구분된 목록입니다.
fields array

각 레코드에 대해 반환할 잠재 고객 필드의 쉼표로 구분된 목록입니다. unset이 email, updatedAt, createdAt, lastName, firstName 및 id를 반환하는 경우

반환할 일괄 처리 크기입니다. 최대값과 기본값은 300입니다.
batchSize integer

반환할 일괄 처리 크기입니다. 최대값과 기본값은 300입니다.

토큰은 이 엔드포인트에서 반환됩니다. 자세한 내용은 페이징 토큰을 참조하세요.
nextPageToken string

결과 집합이 일괄 처리 크기보다 크고 이 매개 변수를 통해 후속 호출에서 전달될 수 있는 경우 이 엔드포인트에서 토큰이 반환됩니다. 자세한 내용은 페이징 토큰을 참조하세요.

반환

목록 ID로 잠재 고객 가져오기

지정된 정적 목록의 멤버인 사람 레코드를 검색합니다. 필수 권한: 잠재 고객 Read-Only Read-Write 잠재 고객

매개 변수

Name 필수 형식 Description
레코드를 검색할 정적 목록의 ID입니다.
listId True integer

레코드를 검색할 정적 목록의 ID입니다.

각 레코드에 대해 반환할 잠재 고객 필드의 쉼표로 구분된 목록입니다.
fields array

각 레코드에 대해 반환할 잠재 고객 필드의 쉼표로 구분된 목록입니다. unset이 email, updatedAt, createdAt, lastName, firstName 및 id를 반환하는 경우

반환할 일괄 처리 크기입니다. 최대값과 기본값은 300입니다.
batchSize integer

반환할 일괄 처리 크기입니다. 최대값과 기본값은 300입니다.

토큰은 이 엔드포인트에서 반환됩니다. 자세한 내용은 페이징 토큰을 참조하세요.
nextPageToken string

결과 집합이 일괄 처리 크기보다 크고 이 매개 변수를 통해 후속 호출에서 전달될 수 있는 경우 이 엔드포인트에서 토큰이 반환됩니다. 자세한 내용은 페이징 토큰을 참조하세요.

반환

목록 가져오기

지정된 필터 매개 변수를 기반으로 정적 목록 레코드 집합을 반환합니다. 필수 권한: 잠재 고객 Read-Only Read-Write 잠재 고객

매개 변수

Name 필수 형식 Description
반환할 정적 목록 ID의 쉼표로 구분된 목록
id array

반환할 정적 목록 ID의 쉼표로 구분된 목록

반환할 정적 목록 이름의 쉼표로 구분된 목록
name array

반환할 정적 목록 이름의 쉼표로 구분된 목록

프로그램 이름의 쉼표로 구분된 목록입니다.
programName array

프로그램 이름의 쉼표로 구분된 목록입니다. set이 지정된 프로그램의 자식인 모든 정적 목록을 반환하는 경우

작업 영역 이름의 쉼표로 구분된 목록입니다.
workspaceName array

작업 영역 이름의 쉼표로 구분된 목록입니다. set이 지정된 작업 영역의 자식인 모든 정적 목록을 반환하는 경우

반환할 일괄 처리 크기입니다. 최대값과 기본값은 300입니다.
batchSize integer

반환할 일괄 처리 크기입니다. 최대값과 기본값은 300입니다.

토큰은 이 엔드포인트에서 반환됩니다. 자세한 내용은 페이징 토큰을 참조하세요.
nextPageToken string

결과 집합이 일괄 처리 크기보다 크고 이 매개 변수를 통해 후속 호출에서 전달될 수 있는 경우 이 엔드포인트에서 토큰이 반환됩니다. 자세한 내용은 페이징 토큰을 참조하세요.

반환

목록에 추가

지정된 개인 레코드 집합을 대상 정적 목록에 추가합니다. 요청당 300개의 잠재 고객 ID로 제한됩니다. 필수 권한: Read-Write 잠재 고객

매개 변수

Name 필수 형식 Description
대상 목록의 ID
listId True integer

대상 목록의 ID

아이디
id True integer

잠재 고객 레코드의 고유 정수 ID

목록에 추가할 잠재 고객 ID의 쉼표로 구분된 목록
id array

목록에 추가할 잠재 고객 ID의 쉼표로 구분된 목록

반환

목록에서 제거

대상 정적 목록에서 지정된 사용자 레코드 집합을 제거합니다. 필수 권한: Read-Write 잠재 고객

매개 변수

Name 필수 형식 Description
잠재 고객을 제거할 정적 목록의 ID
listId True integer

잠재 고객을 제거할 정적 목록의 ID

아이디
id True integer

잠재 고객 레코드의 고유 정수 ID

아이디
id True array

아이디

반환

목록의 구성원

잠재 고객이 지정된 정적 목록의 멤버인지 확인합니다. 필수 권한: Read-Write 잠재 고객

매개 변수

Name 필수 형식 Description
확인할 정적 목록의 ID
listId True integer

확인할 정적 목록의 ID

아이디
id True integer

잠재 고객 레코드의 고유 정수 ID

확인할 잠재 고객 ID의 쉼표로 구분된 목록
id array

확인할 잠재 고객 ID의 쉼표로 구분된 목록

반환

스마트 목록 가져오기

사용자가 만든 스마트 목록 레코드 목록을 검색합니다. 필요한 권한: Read-Asset 또는 Read-Write 자산

매개 변수

Name 필수 형식 Description
부모 폴더의 JSON 표현
folder string

멤버가 'id'이고 'type'이 'Folder' 또는 'Program'일 수 있는 부모 폴더의 JSON 표현

페이징에 대한 정수 오프셋
offset integer

페이징에 대한 정수 오프셋

반환할 스마트 목록의 최대 수입니다. 최대 200, 기본값 20.
maxReturn integer

반환할 스마트 목록의 최대 수입니다. 최대 200, 기본값 20.

이 날짜 이전에 스마트 목록을 제외합니다. 날짜/시간 필드 형식 설명을 참조하세요.
earliestUpdatedAt string

이 날짜 이전에 스마트 목록을 제외합니다. 유효한 ISO-8601 문자열이어야 합니다. 날짜/시간 필드 형식 설명을 참조하세요.

이 날짜 이후에 스마트 목록을 제외합니다. 날짜/시간 필드 형식 설명을 참조하세요.
latestUpdatedAt string

이 날짜 이후에 스마트 목록을 제외합니다. 유효한 ISO-8601 문자열이어야 합니다. 날짜/시간 필드 형식 설명을 참조하세요.

반환

스마트 목록 복제

지정된 스마트 목록을 복제합니다. 필수 권한: Read-Write 자산

매개 변수

Name 필수 형식 Description
복제할 스마트 목록의 ID
id True integer

복제할 스마트 목록의 ID

이름
name True string

복제된 스마트 목록의 이름

아이디
id True integer

폴더의 ID

type
type True string

폴더 유형

description
description string

복제된 스마트 목록에 대한 설명

반환

스마트 목록 삭제

지정된 스마트 목록을 삭제합니다. 필수 권한: Read-Write 자산

매개 변수

Name 필수 형식 Description
삭제할 스마트 목록의 ID
id True integer

삭제할 스마트 목록의 ID

반환

승인 취소 프로그램

대상 프로그램의 승인이 취소됩니다. 승인된 전자 메일 프로그램에만 유효합니다. 필수 권한: Read-Write 자산

매개 변수

Name 필수 형식 Description
프로그램 ID
id True integer

아이디

반환

아이덴티티

Marketo에서 액세스 토큰을 검색합니다. 이 엔드포인트에 대한 호출은 API 호출 제한에 포함되지 않습니다.

매개 변수

Name 필수 형식 Description
Marketo REST API에 대한 clientID
client_id True string

관리자 > 통합 > 시작점 메뉴의 클라이언트 ID입니다.

Marketo REST API에 대한 클라이언트 암호
client_secret True string

관리자 > 통합 > 시작점 메뉴의 클라이언트 암호입니다.

부여 유형입니다. 사례 클라이언트 자격 증명
grant_type True string

부여 유형

반환

아이덴티티

Marketo에서 액세스 토큰을 검색합니다. 이 엔드포인트에 대한 호출은 API 호출 제한에 포함되지 않습니다.

매개 변수

Name 필수 형식 Description
Marketo REST API에 대한 clientID
client_id True string

관리자 > 통합 > 시작점 메뉴의 클라이언트 ID입니다.

Marketo REST API에 대한 클라이언트 암호
client_secret True string

관리자 > 통합 > 시작점 메뉴의 클라이언트 암호입니다.

부여 유형입니다. 사례 클라이언트 자격 증명
grant_type True string

부여 유형

반환

이름으로 스마트 목록 가져오기

스마트 목록 레코드를 이름으로 검색합니다. 필요한 권한: Read-Asset 또는 Read-Write 자산

매개 변수

Name 필수 형식 Description
검색할 스마트 목록의 이름
name True string

검색할 스마트 목록의 이름

반환

이름으로 잠재 고객 필드 가져오기

단일 잠재 고객 필드에 대한 메타데이터를 검색합니다. 필수 사용 권한: 스키마 표준 필드 Read-Write 스키마 사용자 정의 필드 Read-Write

매개 변수

Name 필수 형식 Description
잠재 고객 필드의 API 이름
fieldApiName True string

잠재 고객 필드의 API 이름

반환

이름으로 정적 목록 가져오기

해당 이름으로 정적 목록 레코드를 검색합니다. 필요한 권한: Read-Asset 또는 Read-Write 자산

매개 변수

Name 필수 형식 Description
검색할 정적 목록의 이름
name True string

검색할 정적 목록의 이름

반환

이름으로 파일 가져오기

지정된 이름의 파일 레코드를 반환합니다. 필수 권한: 자산 Read-Only, Read-Write 자산

매개 변수

Name 필수 형식 Description
파일의 이름입니다.
name True string

파일의 이름

반환

이름으로 폴더 가져오기

지정된 이름의 폴더 레코드를 반환합니다. 필수 권한: 자산 Read-Only, Read-Write 자산

매개 변수

Name 필수 형식 Description
폴더의 이름
name True string

폴더의 이름입니다. 프로그램에는 적용되지 않습니다.

폴더의 형식(프로그램 또는 폴더)
type string

폴더의 유형입니다. 'Folder' 또는 'Program'

부모 폴더 참조
root string

부모 폴더 참조

작업 영역의 이름
workSpace string

작업 영역의 이름

반환

이름으로 프로그램 가져오기

지정된 이름의 프로그램 레코드를 검색합니다. 필수 권한: 자산 Read-Only, Read-Write 자산

매개 변수

Name 필수 형식 Description
프로그램 이름
name True string

프로그램 이름

true를 설정하여 프로그램 태그 채우기
includeTags boolean

true를 설정하여 프로그램 태그 채우기

true를 설정하여 프로그램 비용 채우기
includeCosts boolean

true를 설정하여 프로그램 비용 채우기

반환

이름으로 프로그램 멤버 필드 가져오기

단일 프로그램 멤버 필드에 대한 메타데이터를 검색합니다. 필수 사용 권한: 스키마 표준 필드 Read-Write 스키마 사용자 정의 필드 Read-Write

매개 변수

Name 필수 형식 Description
프로그램 멤버 필드의 API 이름
fieldApiName True string

프로그램 멤버 필드의 API 이름

반환

잠재 고객 가져오기

데이터 레코드가 포함된 파일을 대상 인스턴스로 가져옵니다. 필수 권한: Read-Write 잠재 고객

매개 변수

Name 필수 형식 Description
파일 형식을 가져옵니다.
format True string

파일 형식을 가져옵니다.

중복 제거에 사용할 필드입니다. 사용자 지정 필드(문자열, 전자 메일, 정수)
lookupField string

중복 제거에 사용할 필드입니다. 사용자 지정 필드(문자열, 전자 메일, 정수) 및 다음 필드 유형이 지원됩니다. id, 쿠키, 이메일, twitterId, facebookId, linkedInId, sfdcAccountId, sfdcContactId, sfdcLeadId, sfdcLeadOwnerId, sfdcOpptyId. 기본값은 전자 메일입니다.
참고: 업데이트 작업에만 ID를 사용할 수 있습니다.

가져올 잠재 고객 파티션의 이름입니다.
partitionName string

가져올 잠재 고객 파티션의 이름입니다.

가져올 정적 목록의 ID입니다.
listId integer

가져올 정적 목록의 ID입니다.

가져올 데이터 레코드가 포함된 파일입니다.
file True file

가져올 데이터 레코드가 포함된 파일입니다.

반환

잠재 고객 가져오기 상태 가져오기

가져오기 일괄 처리 작업의 상태를 반환합니다. 필수 권한: Read-Write 잠재 고객

매개 변수

Name 필수 형식 Description
일괄 처리 가져오기 작업의 ID입니다.
batchId True integer

일괄 처리 가져오기 작업의 ID입니다.

반환

잠재 고객 내보내기 작업 가져오기

지난 7일 동안 생성된 내보내기 작업 목록을 반환합니다. 필수 권한: Read-Only 잠재 고객

매개 변수

Name 필수 형식 Description
필터링할 쉼표로 구분된 상태 목록입니다.
status array

필터링할 쉼표로 구분된 상태 목록입니다.

반환할 일괄 처리 크기입니다. 최대값과 기본값은 300입니다.
batchSize integer

반환할 일괄 처리 크기입니다. 최대값과 기본값은 300입니다.

다음 페이지 토큰
nextPageToken string

결과 집합이 일괄 처리 크기보다 크고 이 매개 변수를 통해 후속 호출에서 전달될 수 있는 경우 이 엔드포인트에서 토큰이 반환됩니다. 자세한 내용은 페이징 토큰을 참조하세요.

반환

잠재 고객 내보내기 작업 만들기

"filter" 매개 변수를 통해 정의된 검색 조건에 대한 내보내기 작업을 만듭니다. 요청은 대량 내보내기 리드 엔드포인트에 대한 후속 호출에서 매개 변수로 전달되는 "exportId"를 반환합니다. 큐에 넣기 내보내기 리드 작업 엔드포인트를 사용하여 처리를 위해 내보내기 작업을 큐에 대기합니다. 내보내기 리드 작업 상태 가져오기 엔드포인트를 사용하여 내보내기 작업의 상태를 검색합니다. 필수 권한: Read-Only 잠재 고객

매개 변수

Name 필수 형식 Description
이름
name True string

헤더 필드의 REST API 이름

value
value True string

머리글 필드의 값

fields
fields True array of string

파일에 포함할 필드의 쉼표로 구분된 목록

endAt
endAt string

날짜 범위 필터 종료(ISO 8601 형식)

startAt
startAt string

날짜 범위 필터 시작(ISO-8601 형식)

smartListId
smartListId True integer

잠재 고객을 검색할 스마트 목록의 ID

smartListName
smartListName True string

잠재 고객을 검색할 스마트 목록의 이름

staticListId
staticListId True integer

잠재 고객을 검색할 정적 목록의 ID

staticListName
staticListName True string

잠재 고객을 검색할 정적 목록의 이름

format
format string

만들 파일 형식("CSV", "TSV", "SSV"). 기본값은 "CSV"입니다.

반환

잠재 고객 내보내기 작업 취소

내보내기 작업을 취소합니다. 필수 권한: Read-Only 잠재 고객

매개 변수

Name 필수 형식 Description
일괄 처리 내보내기 작업의 ID입니다.
exportId True string

일괄 처리 내보내기 작업의 ID입니다.

반환

잠재 고객 내보내기 작업 큐에 넣기

내보내기 작업을 큐에 넣기 이렇게 하면 내보내기 작업이 큐에 배치되고 컴퓨팅 리소스를 사용할 수 있게 되면 작업이 시작됩니다. 내보내기 작업은 "만든" 상태여야 합니다. 내보내기 리드 작업 상태 가져오기 엔드포인트를 사용하여 내보내기 작업의 상태를 검색합니다. 필수 권한: Read-Only 잠재 고객

매개 변수

Name 필수 형식 Description
일괄 처리 내보내기 작업의 ID입니다.
exportId True string

일괄 처리 내보내기 작업의 ID입니다.

반환

잠재 고객 내보내기 파일 가져오기

내보내기 작업의 파일 콘텐츠를 반환합니다. 내보내기 작업은 "완료" 상태여야 합니다. 내보내기 리드 작업 상태 가져오기 엔드포인트를 사용하여 내보내기 작업의 상태를 검색합니다. 필수 권한: Read-Only 잠재 고객

파일 형식은 잠재 고객 내보내기 작업 만들기 엔드포인트를 호출하여 지정됩니다. 다음은 기본 파일 형식("CSV")의 예입니다.

firstName,lastName,email
Marvin,Gaye,marvin.gaye@motown.com

매개 변수

Name 필수 형식 Description
일괄 처리 내보내기 작업의 ID입니다.
exportId True string

일괄 처리 내보내기 작업의 ID입니다.

추출된 데이터의 부분 검색을 지원하려면
Range string

추출된 데이터의 부분 검색을 지원하기 위해 "바이트" 형식의 HTTP 헤더 "Range"를 지정할 수 있습니다. 자세한 내용은 RFC 2616 "범위 검색 요청"을 참조하세요. 헤더가 설정되지 않으면 전체 내용이 반환됩니다.

반환

response
object

잠재 고객 동기화

잠재 고객 목록을 대상 인스턴스에 동기화합니다. 필수 권한: Read-Write 잠재 고객

매개 변수

Name 필수 형식 Description
조치
action string

수행할 동기화 작업의 유형입니다. 설정되지 않은 경우 기본값으로 createOrUpdate

asyncProcessing
asyncProcessing boolean

true로 설정하면 호출이 즉시 반환됩니다.

아이디
id integer

잠재 고객 레코드의 고유 정수 ID

acquiredBy
acquiredBy boolean

부모 프로그램에서 잠재 고객 확보 여부

isExhausted
isExhausted boolean

현재 스트림에서 잠재 고객 사용 여부(해당하는 경우)

membershipDate
membershipDate True string

리더가 프로그램의 멤버가 된 날짜

nurtureCadence
nurtureCadence string

해당하는 경우 부모 스트림의 주기

progressionStatus
progressionStatus True string

부모 프로그램에서 잠재 고객에 대한 프로그램 상태

reachedSuccess
reachedSuccess boolean

잠재 고객에 부모 프로그램의 성공 상태인지 여부

스트림
stream string

부모 프로그램이 참여 프로그램인 경우 리드가 멤버임을 스트리밍합니다.

코드
code True string

이유의 정수 코드

message
message True string

작업 상태에 대한 이유를 설명하는 메시지

status
status string

레코드에서 수행된 작업의 상태

lookupField
lookupField string

중복 제거할 필드입니다. 입력의 각 잠재 고객 레코드에 필드가 있어야 합니다. 설정되지 않은 경우 기본값으로 전자 메일로 설정

partitionName
partitionName string

해당하는 경우 작동할 파티션의 이름입니다. 파티션을 사용하는 인스턴스와 상호 작용할 때는 가능할 때마다 설정해야 합니다.

반환

잠재 고객 삭제

대상 인스턴스에서 잠재 고객 목록을 삭제합니다. 필수 권한: Read-Write 잠재 고객

매개 변수

Name 필수 형식 Description
아이디
id True integer

잠재 고객 레코드의 고유 정수 ID

요청 본문이 비어 있으면 매개 변수를 지정할 수 있습니다.
id array

요청 본문이 비어 있으면 매개 변수를 지정할 수 있습니다. 여러 잠재 고객 ID를 지정할 수 있습니다. 예: id=1,2,3,2342

반환

잠재 고객 설명

API를 통한 상호 작용에 사용할 수 있는 모든 필드 목록을 포함하여 대상 인스턴스의 잠재 고객 개체에 대한 메타데이터를 반환합니다. 필수 권한: 잠재 고객 Read-Only Read-Write 잠재 고객

참고: 이 엔드포인트는 대체되었습니다. 대신 Lead2 엔드포인트 설명 사용

반환

잠재 고객 필드 업데이트

대상 인스턴스의 잠재 고객 필드에 대한 메타데이터를 업데이트합니다. 여기에서 업데이트 규칙을 참조 하세요. 필수 사용 권한: 스키마 표준 필드 Read-Write 스키마 사용자 정의 필드 Read-Write

매개 변수

Name 필수 형식 Description
잠재 고객 필드의 API 이름
fieldApiName True string

잠재 고객 필드의 API 이름

표시 이름
displayName string

필드의 UI 표시 이름

description
description string

필드에 대한 설명

isHidden
isHidden boolean

true로 설정하면 필드가 숨겨집니다. 기본값은 false입니다.

isHtmlEncodingInEmail
isHtmlEncodingInEmail boolean

true로 설정하면 필드가 전자 메일에서 HTML로 인코딩됩니다. 기본값은 true입니다.

isSensitive
isSensitive boolean

true로 설정하면 필드가 중요한 것으로 표시됩니다. 기본값은 false입니다.

반환

정적 목록 가져오기

정적 목록 레코드 목록을 검색합니다. 필요한 권한: Read-Asset 또는 Read-Write 자산

매개 변수

Name 필수 형식 Description
부모 폴더의 JSON 표현
folder string

멤버가 'id'이고 'type'이 'Folder' 또는 'Program'일 수 있는 부모 폴더의 JSON 표현

페이징에 대한 정수 오프셋
offset integer

페이징에 대한 정수 오프셋

반환할 정적 목록의 최대 수입니다. 최대 200, 기본값 20.
maxReturn integer

반환할 정적 목록의 최대 수입니다. 최대 200, 기본값 20.

이 날짜 이전의 정적 목록을 제외합니다. 날짜/시간 필드 형식 설명을 참조하세요.
earliestUpdatedAt string

이 날짜 이전의 정적 목록을 제외합니다. 유효한 ISO-8601 문자열이어야 합니다. 날짜/시간 필드 형식 설명을 참조하세요.

이 날짜 이후에 정적 목록을 제외합니다. 날짜/시간 필드 형식 설명을 참조하세요.
latestUpdatedAt string

이 날짜 이후에 정적 목록을 제외합니다. 유효한 ISO-8601 문자열이어야 합니다. 날짜/시간 필드 형식 설명을 참조하세요.

반환

정적 목록 만들기

새 정적 목록을 만듭니다. 필수 권한: Read-Write 자산

매개 변수

Name 필수 형식 Description
description
description string

정적 목록에 대한 설명

이름
name True string

정적 목록의 이름

아이디
id True integer

폴더의 ID

type
type True string

폴더 유형

반환

정적 목록 메타데이터 업데이트

정적 목록 자산의 메타데이터를 업데이트합니다. 필수 권한: Read-Write 자산

매개 변수

Name 필수 형식 Description
업데이트할 정적 목록의 ID
id True integer

업데이트할 정적 목록의 ID

description
description string

정적 목록에 대한 설명

이름
name string

정적 목록의 이름

반환

정적 목록 삭제

지정된 정적 목록을 삭제합니다. 필수 권한: Read-Write 자산

매개 변수

Name 필수 형식 Description
삭제할 정적 목록의 ID
id True integer

삭제할 정적 목록의 ID

반환

캠페인 가져오기

캠페인 레코드 목록을 반환합니다. 필수 사용 권한: Read-Only 캠페인, Read-Write 캠페인

참고: 이 엔드포인트는 대체되었습니다. 대신 스마트 캠페인 엔드포인트 가져오기를 사용합니다.

매개 변수

Name 필수 형식 Description
에 대한 레코드를 반환할 캠페인 ID의 쉼표로 구분된 목록
id array

에 대한 레코드를 반환할 캠페인 ID의 쉼표로 구분된 목록

필터링할 쉼표로 구분된 이름 목록
name array

필터링할 쉼표로 구분된 이름 목록

필터링할 프로그램 이름의 쉼표로 구분된 목록입니다.
programName array

필터링할 프로그램 이름의 쉼표로 구분된 목록입니다. 설정된 경우 지정된 프로그램의 자식인 캠페인만 필터링합니다.

필터링할 작업 영역 이름의 쉼표로 구분된 목록입니다.
workspaceName array

필터링할 작업 영역 이름의 쉼표로 구분된 목록입니다. 설정된 경우 지정된 작업 영역의 캠페인만 반환합니다.

반환할 최대 레코드 수입니다. 최대값과 기본값은 300입니다.
batchSize integer

반환할 최대 레코드 수입니다. 최대값과 기본값은 300입니다.

토큰은 이 엔드포인트에서 반환됩니다. 자세한 내용은 페이징 토큰을 참조하세요.
nextPageToken string

결과 집합이 일괄 처리 크기보다 크고 이 매개 변수를 통해 후속 호출에서 전달될 수 있는 경우 이 엔드포인트에서 토큰이 반환됩니다. 자세한 내용은 페이징 토큰을 참조하세요.

요청된 트리거이고 원본이 웹 서비스 API인 경우
isTriggerable boolean

캠페인이 요청된 트리거이고 원본이 Web Service API인 활성 캠페인을 반환하려면 true로 설정합니다.

반환

캠페인 예약

지정된 시간에 실행되도록 일괄 처리 캠페인을 원격으로 예약합니다. 캠페인의 부모 프로그램에 로컬인 내 토큰을 재정의하여 콘텐츠를 사용자 지정할 수 있습니다. 아래에 설명된 "cloneToProgramName" 매개 변수를 사용하는 경우 이 엔드포인트는 하루에 20회 호출로 제한됩니다. 필수 권한: 캠페인 실행

매개 변수

Name 필수 형식 Description
예약할 일괄 처리 캠페인의 ID입니다.
campaignId True integer

예약할 일괄 처리 캠페인의 ID입니다.

cloneToProgramName
cloneToProgramName string

결과 프로그램의 이름입니다. 설정하면 이 특성으로 인해 캠페인, 부모 프로그램 및 모든 자산이 결과 새 이름으로 만들어집니다. 부모 프로그램이 복제되고 새로 만든 캠페인이 예약됩니다. 결과 프로그램은 부모 아래에 만들어집니다. 코드 조각, 푸시 알림, 앱 내 메시지, 정적 목록, 보고서 및 소셜 자산이 있는 프로그램은 이러한 방식으로 복제되지 않을 수 있습니다.

runAt
runAt date-time

캠페인을 실행할 날짜/시간입니다. 설정되지 않은 경우 호출이 수행된 후 5분 후에 캠페인이 실행됩니다.

이름
name True string

토큰의 이름입니다. "{{my.name}}"로 서식을 지정해야 합니다.

value
value True string

토큰의 값

반환

캠페인 요청

일련의 잠재 고객을 트리거 캠페인에 전달하여 캠페인 흐름을 실행합니다. 지정된 캠페인에는 요청됨: 웹 서비스 API 트리거가 있어야 하며 활성 상태여야 합니다. 캠페인의 부모 프로그램에 로컬인 내 토큰을 재정의하여 콘텐츠를 사용자 지정할 수 있습니다. 호출당 최대 100명의 잠재 고객이 허용됩니다. 필수 권한: 캠페인 실행

매개 변수

Name 필수 형식 Description
트리거할 캠페인의 ID입니다.
campaignId True integer

트리거할 캠페인의 ID입니다.

아이디
id True integer

잠재 고객 레코드의 고유 정수 ID

이름
name True string

토큰의 이름입니다. "{{my.name}}"로 서식을 지정해야 합니다.

value
value True string

토큰의 값

반환

태그로 프로그램 가져오기

지정된 태그 형식 및 태그 값과 일치하는 프로그램 목록을 검색합니다. 필수 권한: 자산 Read-Only, Read-Write 자산

매개 변수

Name 필수 형식 Description
프로그램 태그 유형
tagType True string

프로그램 태그 유형

태그 값
tagValue True string

태그 값

반환할 최대 채널 수입니다. 최대 200, 기본값 20
maxReturn integer

반환할 최대 채널 수입니다. 최대 200, 기본값 20

페이징에 대한 정수 오프셋
offset integer

페이징에 대한 정수 오프셋

반환

파일 가져오기

지정된 폴더에서 파일을 반환합니다. 필수 권한: 자산 Read-Only, Read-Write 자산

매개 변수

Name 필수 형식 Description
아이디
id True integer

폴더의 ID

type
type True string

폴더 유형

맥스리턴
maxReturn integer

반환할 최대 채널 수입니다. 최대 200, 기본값 20

offset
offset integer

페이징에 대한 정수 오프셋

파일을 넣을 폴더입니다.
folder string

멤버가 'id'이고 'type'이 'Folder' 또는 'Program'일 수 있는 부모 폴더의 JSON 표현

반환

파일 만들기

포함된 페이로드에서 새 파일을 만듭니다. 필수 권한: Read-Write 자산

매개 변수

Name 필수 형식 Description
description
description string

자산에 대한 설명

file
file True string

다중 파트 파일입니다. 파일의 내용입니다.

아이디
id True integer

폴더의 ID

type
type True string

폴더 유형

insertOnly
insertOnly boolean

이름이 같은 기존 파일이 이미 있는 경우 호출 hould가 실패하는지 여부

이름
name True string

파일의 이름

반환

파일 콘텐츠 업데이트

파일의 현재 콘텐츠를 포함된 페이로드로 바꿉니다. 필수 권한: Read-Write 자산

매개 변수

Name 필수 형식 Description
파일의 ID입니다.
id True integer

데이터베이스의 파일 ID

file
file True string

다중 파트 파일입니다. 파일의 내용입니다.

아이디
id True integer

파일의 ID

반환

폴더 가져오기

지정된 루트 폴더 내에서 자식 폴더를 검색합니다. 필수 권한: 자산 Read-Only, Read-Write 자산

매개 변수

Name 필수 형식 Description
부모 폴더 참조
root string

부모 폴더 참조

트래버스할 최대 폴더 깊이, 기본값 2
maxDepth integer

트래버스할 최대 폴더 깊이, 기본값 2

반환할 폴더의 최대 수입니다. 기본값 20, 최대 200
maxReturn integer

반환할 폴더의 최대 수입니다. 기본값 20, 최대 200

페이징에 대한 정수 오프셋입니다. 기본값 0
offset integer

페이징에 대한 정수 오프셋입니다. 기본값 0

작업 영역의 이름
workSpace string

작업 영역의 이름

반환

폴더 내용 가져오기

지정된 폴더의 내용에 대한 레코드를 반환합니다. 필수 권한: 자산 Read-Only, Read-Write 자산

매개 변수

Name 필수 형식 Description
검색할 폴더의 ID
id True integer

검색할 폴더의 ID

반환할 최대 채널 수입니다. 최대 200, 기본값 20
maxReturn integer

반환할 최대 채널 수입니다. 최대 200, 기본값 20

페이징에 대한 정수 오프셋
offset integer

페이징에 대한 정수 오프셋

폴더의 유형입니다. 'Folder' 또는 'Program'. 기본값은 '폴더'입니다.
type True string

폴더의 유형입니다. 'Folder' 또는 'Program'. 기본값은 '폴더'입니다.

반환

폴더 만들기

새 폴더를 만듭니다. 필수 권한: Read-Write 자산

매개 변수

Name 필수 형식 Description
description
description string

자산에 대한 설명

이름
name True string

폴더의 이름

아이디
id True integer

폴더의 ID

type
type True string

폴더 유형

반환

폴더 메타데이터 업데이트

지정된 폴더에 대한 메타데이터를 업데이트합니다. 필수 권한: Read-Write 자산

매개 변수

Name 필수 형식 Description
업데이트할 폴더의 ID입니다.
id True integer

업데이트할 폴더의 ID

description
description string

자산에 대한 설명

isArchive
isArchive boolean

폴더가 보관되었는지 여부입니다. 이 값을 전환하면 폴더의 보관 상태가 변경됩니다.

이름
name string

폴더의 이름

type
type True string

폴더의 유형입니다. 'Folder' 또는 'Program'

반환

폴더 삭제

지정된 폴더를 삭제합니다. 폴더에 콘텐츠가 있는 경우 삭제가 실패합니다. 필수 권한: Read-Write 자산

매개 변수

Name 필수 형식 Description
삭제할 폴더의 ID
id True integer

삭제할 폴더의 ID

폴더 유형
type True string

type

반환

프로그램 ID로 잠재 고객 가져오기

지정된 프로그램의 멤버인 잠재 고객 목록을 검색합니다. 필수 권한: 잠재 고객 Read-Only Read-Write 잠재 고객

매개 변수

Name 필수 형식 Description
검색할 프로그램의 ID입니다.
programId True integer

검색할 프로그램의 ID입니다.

각 레코드에 대해 반환할 필드의 쉼표로 구분된 목록
fields array

각 레코드에 대해 반환할 필드의 쉼표로 구분된 목록

반환할 일괄 처리 크기입니다. 최대값과 기본값은 300입니다.
batchSize integer

반환할 일괄 처리 크기입니다. 최대값과 기본값은 300입니다.

토큰은 이 엔드포인트에서 반환됩니다. 자세한 내용은 페이징 토큰을 참조하세요.
nextPageToken string

결과 집합이 일괄 처리 크기보다 크고 이 매개 변수를 통해 후속 호출에서 전달될 수 있는 경우 이 엔드포인트에서 토큰이 반환됩니다. 자세한 내용은 페이징 토큰을 참조하세요.

반환

프로그램 ID별 스마트 목록 가져오기

전자 메일 프로그램 ID로 스마트 목록 레코드를 검색합니다. 필요한 권한: Read-Asset 또는 Read-Write 자산

매개 변수

Name 필수 형식 Description
검색할 스마트 목록이 포함된 전자 메일 프로그램의 ID
programId True integer

검색할 스마트 목록이 포함된 전자 메일 프로그램의 ID

true를 설정하여 스마트 목록 규칙을 채웁다. 기본값 false
includeRules boolean

true를 설정하여 스마트 목록 규칙을 채웁다. 기본값 false

반환

프로그램 가져오기

대상 인스턴스에서 액세스 가능한 프로그램 목록을 검색합니다. 필수 권한: 자산 Read-Only, Read-Write 자산

매개 변수

Name 필수 형식 Description
반환할 최대 채널 수입니다. 최대 200, 기본값 20
maxReturn integer

반환할 최대 채널 수입니다. 최대 200, 기본값 20

페이징에 대한 정수 오프셋
offset integer

페이징에 대한 정수 오프셋

선택적 필터입니다. filterValues 필요
filterType string

선택적 필터입니다. filterValues 필요

이 날짜 이전의 프로그램을 제외합니다. 날짜/시간 필드 형식 설명을 참조하세요.
earliestUpdatedAt string

이 날짜 이전의 프로그램을 제외합니다. 유효한 ISO-8601 문자열이어야 합니다. 날짜/시간 필드 형식 설명을 참조하세요.

이 날짜 이후의 프로그램을 제외합니다. 날짜/시간 필드 형식 설명을 참조하세요.
latestUpdatedAt string

이 날짜 이후의 프로그램을 제외합니다. 유효한 ISO-8601 문자열이어야 합니다. 날짜/시간 필드 형식 설명을 참조하세요.

반환

프로그램 구성원 가져오기

특정 필드의 값 목록에 있는 최대 300명의 프로그램 멤버 목록을 반환합니다. 사용자 지정 필드인 filterType을 지정하는 경우 사용자 지정 필드의 dataType은 "string" 또는 "integer"여야 합니다. "leadId" 이외의 filterType을 지정하는 경우 요청에 의해 최대 100,000개의 프로그램 멤버 레코드를 처리할 수 있습니다. 필수 권한: 잠재 고객 Read-Only Read-Write 잠재 고객

매개 변수

Name 필수 형식 Description
대상 프로그램의 ID입니다.
programId True integer

대상 프로그램의 ID입니다.

필터링할 프로그램 멤버 필드입니다.
filterType True string

필터링할 프로그램 멤버 필드입니다. 모든 사용자 지정 필드(문자열 또는 정수 형식만 해당), "updatedAt" 또는 검색 가능한 필드입니다. 프로그램 멤버 설명 엔드포인트를 통해 검색 가능한 필드를 가져올 수 있습니다.

지정된 필드에서 필터링할 값의 쉼표로 구분된 목록입니다.
filterValues True array

지정된 필드에서 필터링할 값의 쉼표로 구분된 목록입니다.

filterType=updatedAt를 사용하는 경우 날짜 범위 필터의 시작
startAt string

filterType=updatedAt를 사용하는 경우 날짜 범위 필터의 시작(ISO 8601 형식)

filterType=updatedAt를 사용하는 경우 날짜 범위 필터의 끝
endAt string

filterType=updatedAt를 사용하는 경우 날짜 범위 필터의 끝(ISO 8601 형식)

각 레코드에 대해 반환할 잠재 고객 필드의 쉼표로 구분된 목록입니다.
fields array

각 레코드에 대해 반환할 잠재 고객 필드의 쉼표로 구분된 목록입니다.

반환할 일괄 처리 크기입니다. 최대값과 기본값은 300입니다.
batchSize integer

반환할 일괄 처리 크기입니다. 최대값과 기본값은 300입니다.

결과 집합이 일괄 처리 크기보다 큰 경우 토큰이 반환됩니다.
nextPageToken string

결과 집합이 일괄 처리 크기보다 크고 이 매개 변수를 통해 후속 호출에서 전달될 수 있는 경우 이 엔드포인트에서 토큰이 반환됩니다. 자세한 내용은 페이징 토큰을 참조하세요.

반환

프로그램 구성원 가져오기

데이터 레코드가 포함된 파일을 대상 인스턴스로 가져옵니다. 필수 권한: Read-Write 잠재 고객

매개 변수

Name 필수 형식 Description
멤버를 추가할 프로그램의 ID입니다.
programId True string

멤버를 추가할 프로그램의 ID입니다.

추가되는 멤버의 프로그램 멤버 상태입니다.
programMemberStatus True string

추가되는 멤버의 프로그램 멤버 상태입니다.

파일 형식을 가져옵니다.
format True string

파일 형식을 가져옵니다.

가져올 데이터 레코드가 포함된 파일입니다.
file True file

가져올 데이터 레코드가 포함된 파일입니다.

반환

프로그램 구성원 내보내기 작업 취소

내보내기 작업을 취소합니다. 필수 권한: Read-Only 잠재 고객

매개 변수

Name 필수 형식 Description
일괄 처리 내보내기 작업의 ID입니다.
exportId True string

일괄 처리 내보내기 작업의 ID입니다.

반환

프로그램 구성원 삭제

대상 인스턴스에서 멤버 목록을 삭제합니다. 필수 권한: Read-Write 잠재 고객

매개 변수

Name 필수 형식 Description
대상 프로그램의 ID입니다.
programId True integer

대상 프로그램의 ID입니다.

leadId
leadId True integer

잠재 고객 레코드의 고유 정수 ID

반환

프로그램 만들기

새 프로그램을 만듭니다. 필수 권한: Read-Write 자산

매개 변수

Name 필수 형식 Description
채널
channel True string

프로그램의 채널

비용
cost True integer

비용의 양

메모
note string

비용에 대한 참고 사항

startDate
startDate True date-time

기간 비용의 시작 날짜

description
description string
아이디
id True integer

폴더의 ID

type
type True string

폴더 유형

이름
name True string

프로그램 이름

tagType
tagType string

프로그램 태그 유형

태그 값
tagValue string

태그 값

type
type True string

프로그램 유형

반환

프로그램 메타데이터 업데이트

대상 프로그램의 메타데이터를 업데이트합니다. 필수 권한: Read-Write 자산

매개 변수

Name 필수 형식 Description
프로그램 ID
id True integer

아이디

비용
cost True integer

비용의 양

메모
note string

비용에 대한 참고 사항

startDate
startDate True date-time

기간 비용의 시작 날짜

costDestructiveUpdate
costsDestructiveUpdate boolean

기존 비용을 삭제하고 지정된 비용으로 바꾸려면 true를 설정합니다.

description
description string

프로그램에 대한 설명이 업데이트됨

종료일
endDate string

프로그램의 종료 날짜입니다. 이벤트, 전자 메일 및 웨비나 유형 프로그램에 적용 가능

이름
name string

프로그램 이름

startDate
startDate string

프로그램의 시작 날짜입니다. 이벤트, 전자 메일 및 웨비나 유형 프로그램에 적용 가능

tagType
tagType string

프로그램 태그 유형

태그 값
tagValue string

태그 값

반환

프로그램 멤버 데이터 동기화

대상 프로그램에서 잠재 고객 목록의 프로그램 멤버 데이터를 변경합니다. 이 API를 사용하여 프로그램의 기존 멤버만 해당 데이터를 변경할 수 있습니다. 필수 권한: Read-Write 잠재 고객

매개 변수

Name 필수 형식 Description
대상 프로그램의 ID입니다.
programId True integer

대상 프로그램의 ID입니다.

leadId
leadId True integer

잠재 고객 레코드의 고유 정수 ID

{fieldApiName}
{fieldApiName} True string

업데이트할 필드의 API 이름입니다. 프로그램 멤버 엔드포인트 설명에 설명된 대로 업데이트할 수 있어야 합니다.

{fieldApiName2}
{fieldApiName2} string

업데이트할 다른 필드의 API 이름(등)입니다. 프로그램 멤버 엔드포인트 설명에 설명된 대로 업데이트할 수 있어야 합니다.

반환

프로그램 멤버 상태 동기화

대상 프로그램의 잠재 고객 목록의 프로그램 멤버 상태를 변경합니다. 멤버가 프로그램에 속하지 않으면 멤버가 프로그램에 추가됩니다. 필수 권한: Read-Write 잠재 고객

매개 변수

Name 필수 형식 Description
대상 프로그램의 ID입니다.
programId True integer

대상 프로그램의 ID입니다.

statusName
statusName True string

프로그램 멤버 상태

leadId
leadId True integer

잠재 고객 레코드의 고유 정수 ID

반환

프로그램 멤버 설명

API를 통한 상호 작용에 사용할 수 있는 모든 필드 목록을 포함하여 대상 인스턴스의 프로그램 멤버 개체에 대한 메타데이터를 반환합니다. 필수 권한: 잠재 고객 Read-Only Read-Write 잠재 고객

참고: 이 엔드포인트는 대체되었습니다. 대신 프로그램 멤버 엔드포인트에 대해 설명 합니다.

반환

프로그램 멤버 설명

API를 통한 상호 작용에 사용할 수 있는 모든 필드 목록을 포함하여 대상 인스턴스의 프로그램 멤버 개체에 대한 메타데이터를 반환합니다. 필수 권한: 잠재 고객 Read-Only Read-Write 잠재 고객

반환

프로그램 복제

대상 프로그램을 복제합니다. 필수 권한: Read-Write 자산

매개 변수

Name 필수 형식 Description
프로그램 ID
id True integer

아이디

description
description string
아이디
id True integer

폴더의 ID

type
type True string

폴더 유형

이름
name True string

프로그램의 이름입니다. 최대 255자

반환

프로그램 삭제

대상 프로그램을 삭제합니다. 프로그램에는 프로그램 외부에서 사용 중인 자산이 포함될 수 없습니다. 필수 권한: Read-Write 자산

매개 변수

Name 필수 형식 Description
프로그램 ID
id True integer

아이디

반환

프로그램 승인

대상 프로그램을 승인합니다. 승인되지 않은 전자 메일 프로그램에만 유효합니다. 필수 권한: Read-Write 자산

매개 변수

Name 필수 형식 Description
프로그램 ID
id True integer

아이디

반환

프로그램 태그 삭제

필수가 아닌 프로그램 태그를 삭제합니다. 필수 권한: Read-Write 자산

매개 변수

Name 필수 형식 Description
프로그램 ID
id True integer

아이디

프로그램 태그 유형
tagType True string

프로그램 태그 유형

반환

프로그램 태그 업데이트

프로그램 태그를 업데이트합니다. 필수 권한: Read-Write 자산

매개 변수

Name 필수 형식 Description
프로그램 ID
id True integer

아이디

프로그램 태그 유형
tagType True string

프로그램 태그 유형

프로그램 태그 값
tagValue True string

프로그램 태그 값

반환

필터 유형별 잠재 고객 가져오기

특정 필드의 값 목록을 기반으로 최대 300개 잠재 고객 목록을 반환합니다. 필수 권한: 잠재 고객 Read-Only Read-Write 잠재 고객

매개 변수

Name 필수 형식 Description
필터링할 잠재 고객 필드입니다.
filterType True string

필터링할 잠재 고객 필드입니다. 모든 사용자 지정 필드(문자열, 전자 메일 또는 정수 형식에만 해당) 및 다음 필드 중 하나라도 지원됩니다. 쿠키, 이메일, facebookId, id, leadPartitionId, linkedInId, sfdcAccountId, sfdcContactId, sfdcLeadId, sfdcLeadOwnerId, sfdcOpptyId, twitterId.

Lead2 설명 엔드포인트를 통해 포괄적인 필드 목록을 가져올 수 있습니다.

지정된 필드에서 필터링할 값의 쉼표로 구분된 목록입니다.
filterValues True array

지정된 필드에서 필터링할 값의 쉼표로 구분된 목록입니다.

각 레코드에 대해 반환할 쉼표로 구분된 잠재 고객 필드 목록
fields array

각 레코드에 대해 반환할 쉼표로 구분된 잠재 고객 필드 목록

반환할 일괄 처리 크기입니다. 최대값과 기본값은 300입니다.
batchSize integer

반환할 일괄 처리 크기입니다. 최대값과 기본값은 300입니다.

토큰은 이 엔드포인트에서 반환됩니다. 자세한 내용은 페이징 토큰을 참조하세요.
nextPageToken string

결과 집합이 일괄 처리 크기보다 크고 이 매개 변수를 통해 후속 호출에서 전달될 수 있는 경우 이 엔드포인트에서 토큰이 반환됩니다. 자세한 내용은 페이징 토큰을 참조하세요.

반환

정의

ResponseOfIdentity

Name 경로 형식 Description
access_token
access_token string

대상 인스턴스를 사용하여 인증하기 위해 후속 호출을 통해 전달하는 토큰

scope
scope string

인증에 사용된 사용자 지정 서비스의 소유 API 전용 사용자

expires_in
expires_in integer

현재 토큰의 남은 수명(초)

token_type
token_type string

OAuth 인증 방법

ResponseOfStaticList

Name 경로 형식 Description
오류
errors array of Error

요청이 실패한 경우 발생한 오류의 배열

nextPageToken
nextPageToken string

결과 집합이 허용된 일괄 처리 크기를 초과하는 경우 지정된 페이징 토큰

requestId
requestId string

만들어진 요청의 ID

결과
result array of StaticList

작업의 개별 레코드에 대한 결과 배열이 비어 있을 수 있습니다.

성공
success boolean

요청 성공 여부

경고
warnings array of Warning

작업에 대해 지정된 경고 배열

잠재 고객 레코드입니다. 항상 ID를 포함하지만 대상 인스턴스에서 사용할 수 있는 필드에 따라 다른 필드 수가 있을 수 있습니다.

Name 경로 형식 Description
아이디
id integer

잠재 고객 레코드의 고유 정수 ID

회원 자격
membership ProgramMembership
이유
reason Reason
status
status string

레코드에서 수행된 작업의 상태

리드 필드

잠재 고객 필드 레코드

Name 경로 형식 Description
표시 이름
displayName string

필드의 UI 표시 이름

이름
name string

필드의 API 이름

description
description string

필드에 대한 설명

데이터 타입
dataType string

필드의 데이터 형식

length
length integer

필드의 최대 길이입니다. 텍스트, 문자열 및 텍스트 영역에만 적용됩니다.

isHidden
isHidden boolean

true로 설정하면 필드가 숨겨집니다.

isHtmlEncodingInEmail
isHtmlEncodingInEmail boolean

true로 설정하면 전자 메일에서 필드가 HTML로 인코딩됩니다.

isSensitive
isSensitive boolean

true로 설정하면 필드가 중요한 것으로 표시됩니다.

isCustom
isCustom boolean

true로 설정하면 필드가 사용자 지정입니다.

isApiCreated
isApiCreated boolean

true로 설정된 경우 REST API를 사용하여 필드를 만들었습니다.

LeadFieldStatus

잠재 고객 필드 업데이트 상태

Name 경로 형식 Description
이름
name string

필드의 API 이름

status
status string

레코드에서 수행된 작업의 상태

ListOperationOutputData

Name 경로 형식 Description
아이디
id integer

잠재 고객 레코드의 고유 정수 ID

이유
reasons array of Reason

작업이 성공하지 못한 이유 목록입니다. 이유는 API 응답에만 있으며 제출해서는 안 됩니다.

status
status string

레코드에서 수행된 작업의 상태

LeadAttribute

Name 경로 형식 Description
데이터 타입
dataType string

필드의 데이터 형식

표시 이름
displayName string

필드의 UI 표시 이름

아이디
id integer

필드의 고유 정수 ID

length
length integer

필드의 최대 길이입니다. 텍스트, 문자열 및 텍스트 영역에만 적용됩니다.

쉬다
rest LeadMapAttribute
비누
soap LeadMapAttribute

LeadAttribute2

Name 경로 형식 Description
이름
name string

"API 잠재 고객"

searchableFields
searchableFields array of LeadAttribute2SearchableFields

검색 가능한 필드 목록

fields
fields array of LeadAttribute2Fields

검색 가능한 필드에 대한 설명

LeadAttribute2SearchableFields

검색 가능한 필드 목록

Name 경로 형식 Description
아이템
string

검색 가능한 필드

LeadAttribute2Fields

Name 경로 형식 Description
이름
name string

필드의 REST API 이름

표시 이름
displayName string

필드의 표시 이름(이름)

데이터 타입
dataType string

필드의 데이터 형식

length
length integer

필드 길이

updateable
updateable boolean

필드를 업데이트할 수 있습니까?

crmManaged
crmManaged boolean

CRM에서 관리하는 필드입니다.

LeadAttribute2Fields2

Name 경로 형식 Description
이름
name string

필드의 REST API 이름

표시 이름
displayName string

필드의 표시 이름(이름)

데이터 타입
dataType string

필드의 데이터 형식

length
length integer

필드 길이

updateable
updateable boolean

필드를 업데이트할 수 있습니까?

crmManaged
crmManaged boolean

CRM에서 관리하는 필드입니다.

ProgramMemberAttribute

Name 경로 형식 Description
이름
name string

"API 프로그램 멤버"

fields
fields array of LeadAttribute2Fields

검색 가능한 필드에 대한 설명

ProgramMemberAttribute2

Name 경로 형식 Description
이름
name string

"API 프로그램 멤버"

description
description string

"API 프로그램 멤버 맵"

생성일시
createdAt string

만든 날짜/시간

updatedAt
updatedAt string

업데이트된 날짜/시간

dedupeFields
dedupeFields array of string

중복 제거 필드 목록

searchableFields
searchableFields array of LeadAttribute2SearchableFields

검색 가능한 필드 목록

fields
fields array of LeadAttribute2Fields2

검색 가능한 필드에 대한 설명

ResponseOfImportLeadResponse

Name 경로 형식 Description
오류
errors array of Error

요청이 실패한 경우 발생한 오류의 배열

moreResult
moreResult boolean

후속 페이지에 더 많은 결과가 있는지 여부를 나타내는 부울

nextPageToken
nextPageToken string

결과 집합이 허용된 일괄 처리 크기를 초과하는 경우 지정된 페이징 토큰

requestId
requestId string

만들어진 요청의 ID

결과
result array of ImportLeadResponse

작업의 개별 레코드에 대한 결과 배열이 비어 있을 수 있습니다.

성공
success boolean

요청 성공 여부

경고
warnings array of Warning

작업에 대해 지정된 경고 배열

ImportProgramMemberResponse

가져오기 상태 정보를 포함하는 응답

Name 경로 형식 Description
batchId
batchId integer

가져오기 작업의 고유 정수 ID

importId
importId string

가져오기 작업의 고유 정수 ID

status
status string

가져오기 작업의 상태

ResponseOfImportProgramMemberResponse

Name 경로 형식 Description
오류
errors array of Error

요청이 실패한 경우 발생한 오류의 배열

requestId
requestId string

만들어진 요청의 ID

결과
result array of ImportProgramMemberResponse

작업의 개별 레코드에 대한 결과 배열이 비어 있을 수 있습니다.

성공
success boolean

요청 성공 여부

경고
warnings array of Warning

작업에 대해 지정된 경고 배열

ResponseOfCampaign

Name 경로 형식 Description
오류
errors array of Error

요청이 실패한 경우 발생한 오류의 배열

nextPageToken
nextPageToken string

결과 집합이 허용된 일괄 처리 크기를 초과하는 경우 지정된 페이징 토큰

requestId
requestId string

만들어진 요청의 ID

결과
result array of Campaign

작업의 개별 레코드에 대한 결과 배열이 비어 있을 수 있습니다.

성공
success boolean

요청 성공 여부

경고
warnings array of Warning

작업에 대해 지정된 경고 배열

ResponseOfListOperationOutputData

Name 경로 형식 Description
오류
errors array of Error

요청이 실패한 경우 발생한 오류의 배열

moreResult
moreResult boolean

후속 페이지에 더 많은 결과가 있는지 여부를 나타내는 부울

nextPageToken
nextPageToken string

결과 집합이 허용된 일괄 처리 크기를 초과하는 경우 지정된 페이징 토큰

requestId
requestId string

만들어진 요청의 ID

결과
result array of ListOperationOutputData

작업의 개별 레코드에 대한 결과 배열이 비어 있을 수 있습니다.

성공
success boolean

요청 성공 여부

경고
warnings array of Warning

작업에 대해 지정된 경고 배열

캠페인

Marketo 스마트 캠페인 기록

Name 경로 형식 Description
active
active boolean

캠페인이 활성 상태인지 여부입니다. 캠페인 트리거에만 적용

생성일시
createdAt string

캠페인이 만들어진 날짜/시간

description
description string

스마트 캠페인에 대한 설명

아이디
id integer

스마트 캠페인의 고유 정수 ID

이름
name string

스마트 캠페인의 이름

programId
programId integer

해당하는 경우 부모 프로그램의 ID

programName
programName string

해당하는 경우 부모 프로그램의 이름

type
type string

스마트 캠페인 유형

updatedAt
updatedAt string

캠페인이 가장 최근에 업데이트된 날짜/시간

작업 공간 이름
workspaceName string

해당하는 경우 부모 작업 영역의 이름

ResponseOfLead

Name 경로 형식 Description
오류
errors array of Error

요청이 실패한 경우 발생한 오류의 배열

moreResult
moreResult boolean

후속 페이지에 더 많은 결과가 있는지 여부를 나타내는 부울

nextPageToken
nextPageToken string

결과 집합이 허용된 일괄 처리 크기를 초과하는 경우 지정된 페이징 토큰

requestId
requestId string

만들어진 요청의 ID

결과
result array of Lead

작업의 개별 레코드에 대한 결과 배열이 비어 있을 수 있습니다.

성공
success boolean

요청 성공 여부

경고
warnings array of Warning

작업에 대해 지정된 경고 배열

ResponseOfLeadByListId

Name 경로 형식 Description
오류
errors array of Error

요청이 실패한 경우 발생한 오류의 배열

nextPageToken
nextPageToken string

결과 집합이 허용된 일괄 처리 크기를 초과하는 경우 지정된 페이징 토큰

requestId
requestId string

만들어진 요청의 ID

결과
result array of Lead

작업의 개별 레코드에 대한 결과 배열이 비어 있을 수 있습니다.

성공
success boolean

요청 성공 여부

경고
warnings array of Warning

작업에 대해 지정된 경고 배열

ResponseOfLeadField

Name 경로 형식 Description
오류
errors array of Error

요청이 실패한 경우 발생한 오류의 배열

moreResult
moreResult boolean

후속 페이지에 더 많은 결과가 있는지 여부를 나타내는 부울

nextPageToken
nextPageToken string

결과 집합이 허용된 일괄 처리 크기를 초과하는 경우 지정된 페이징 토큰

requestId
requestId string

만들어진 요청의 ID

결과
result array of LeadField

작업의 개별 레코드에 대한 결과 배열이 비어 있을 수 있습니다.

성공
success boolean

요청 성공 여부

경고
warnings array of Warning

작업에 대해 지정된 경고 배열

ResponseOfUpdateLeadField

Name 경로 형식 Description
오류
errors array of Error

요청이 실패한 경우 발생한 오류의 배열

moreResult
moreResult boolean

후속 페이지에 더 많은 결과가 있는지 여부를 나타내는 부울

nextPageToken
nextPageToken string

결과 집합이 허용된 일괄 처리 크기를 초과하는 경우 지정된 페이징 토큰

requestId
requestId string

만들어진 요청의 ID

결과
result array of LeadFieldStatus

작업의 개별 레코드에 대한 결과 배열이 비어 있을 수 있습니다.

성공
success boolean

요청 성공 여부

경고
warnings array of Warning

작업에 대해 지정된 경고 배열

ResponseOfPushLeadToMarketo

Name 경로 형식 Description
오류
errors array of Error

요청이 실패한 경우 발생한 오류의 배열

requestId
requestId string

만들어진 요청의 ID

결과
result array of Lead

작업의 개별 레코드에 대한 결과 배열이 비어 있을 수 있습니다.

성공
success boolean

요청 성공 여부

경고
warnings array of Warning

작업에 대해 지정된 경고 배열

ResponseOfLeadAttribute

Name 경로 형식 Description
오류
errors array of Error

요청이 실패한 경우 발생한 오류의 배열

moreResult
moreResult boolean

후속 페이지에 더 많은 결과가 있는지 여부를 나타내는 부울

nextPageToken
nextPageToken string

결과 집합이 허용된 일괄 처리 크기를 초과하는 경우 지정된 페이징 토큰

requestId
requestId string

만들어진 요청의 ID

결과
result array of LeadAttribute

작업의 개별 레코드에 대한 결과 배열이 비어 있을 수 있습니다.

성공
success boolean

요청 성공 여부

경고
warnings array of Warning

작업에 대해 지정된 경고 배열

ResponseOfLeadAttribute2

Name 경로 형식 Description
오류
errors array of Error

요청이 실패한 경우 발생한 오류의 배열

moreResult
moreResult boolean

후속 페이지에 더 많은 결과가 있는지 여부를 나타내는 부울

nextPageToken
nextPageToken string

결과 집합이 허용된 일괄 처리 크기를 초과하는 경우 지정된 페이징 토큰

requestId
requestId string

만들어진 요청의 ID

결과
result array of LeadAttribute2

작업의 개별 레코드에 대한 결과 배열이 비어 있을 수 있습니다.

성공
success boolean

요청 성공 여부

경고
warnings array of Warning

작업에 대해 지정된 경고 배열

ResponseOfProgramMemberAttributes

Name 경로 형식 Description
오류
errors array of Error

요청이 실패한 경우 발생한 오류의 배열

moreResult
moreResult boolean

후속 페이지에 더 많은 결과가 있는지 여부를 나타내는 부울

nextPageToken
nextPageToken string

결과 집합이 허용된 일괄 처리 크기를 초과하는 경우 지정된 페이징 토큰

requestId
requestId string

만들어진 요청의 ID

결과
result array of ProgramMemberAttribute

작업의 개별 레코드에 대한 결과 배열이 비어 있을 수 있습니다.

성공
success boolean

요청 성공 여부

경고
warnings array of Warning

작업에 대해 지정된 경고 배열

ResponseOfProgramMemberAttributes2

Name 경로 형식 Description
오류
errors array of Error

요청이 실패한 경우 발생한 오류의 배열

moreResult
moreResult boolean

후속 페이지에 더 많은 결과가 있는지 여부를 나타내는 부울

nextPageToken
nextPageToken string

결과 집합이 허용된 일괄 처리 크기를 초과하는 경우 지정된 페이징 토큰

requestId
requestId string

만들어진 요청의 ID

결과
result array of ProgramMemberAttribute2

작업의 개별 레코드에 대한 결과 배열이 비어 있을 수 있습니다.

성공
success boolean

요청 성공 여부

경고
warnings array of Warning

작업에 대해 지정된 경고 배열

경고

Name 경로 형식 Description
코드
code integer

경고의 정수 코드

message
message string

경고를 설명하는 메시지

ResponseOfExportResponse

Name 경로 형식 Description
오류
errors array of Error

요청이 실패한 경우 발생한 오류의 배열

requestId
requestId string

만들어진 요청의 ID

결과
result array of ExportResponse

작업의 개별 레코드에 대한 결과 배열이 비어 있을 수 있습니다.

성공
success boolean

요청 성공 여부

경고
warnings array of Warning

작업에 대해 지정된 경고 배열

ResponseOfExportResponseWithToken

Name 경로 형식 Description
오류
errors array of Error

요청이 실패한 경우 발생한 오류의 배열

nextPageToken
nextPageToken string

결과 집합이 허용된 일괄 처리 크기를 초과하는 경우 지정된 페이징 토큰

requestId
requestId string

만들어진 요청의 ID

결과
result array of ExportResponse

작업의 개별 레코드에 대한 결과 배열이 비어 있을 수 있습니다.

성공
success boolean

요청 성공 여부

경고
warnings array of Warning

작업에 대해 지정된 경고 배열

ResponseOfProgramMember

Name 경로 형식 Description
오류
errors array of Error

요청이 실패한 경우 발생한 오류의 배열

moreResult
moreResult boolean

후속 페이지에 더 많은 결과가 있는지 여부를 나타내는 부울

nextPageToken
nextPageToken string

결과 집합이 허용된 일괄 처리 크기를 초과하는 경우 지정된 페이징 토큰

requestId
requestId string

만들어진 요청의 ID

결과
result array of ProgramMember

작업의 개별 레코드에 대한 결과 배열이 비어 있을 수 있습니다.

성공
success boolean

요청 성공 여부

경고
warnings array of Warning

작업에 대해 지정된 경고 배열

ProgramMember

프로그램 멤버 레코드입니다. 항상 잠재 고객 ID를 포함하지만 대상 인스턴스에서 사용할 수 있는 필드에 따라 다른 필드 수가 있을 수 있습니다.

Name 경로 형식 Description
seq
seq integer

응답에서 레코드의 시퀀스를 나타내는 정수입니다. 이 값은 요청 입력에 포함된 레코드의 순서와 상관 관계가 있습니다. Seq는 응답의 일부여야 하며 제출해서는 안 됩니다.

leadId
leadId integer

잠재 고객 레코드의 고유 정수 ID

reachedSuccess
reachedSuccess boolean

프로그램 멤버가 프로그램의 성공 기준에 도달했는지 여부를 나타내는 부울

programId
programId integer

프로그램의 고유 정수 ID

acquiredBy
acquiredBy boolean

프로그램에서 프로그램 멤버를 획득했는지 여부를 나타내는 부울

membershipDate
membershipDate string

리더가 프로그램의 멤버가 된 날짜

ResponseOfProgramMemberStatus

Name 경로 형식 Description
오류
errors array of Error

요청이 실패한 경우 발생한 오류의 배열

moreResult
moreResult boolean

후속 페이지에 더 많은 결과가 있는지 여부를 나타내는 부울

nextPageToken
nextPageToken string

결과 집합이 허용된 일괄 처리 크기를 초과하는 경우 지정된 페이징 토큰

requestId
requestId string

만들어진 요청의 ID

결과
result array of ProgramMemberStatusResponse

작업의 개별 레코드에 대한 결과 배열이 비어 있을 수 있습니다.

성공
success boolean

요청 성공 여부

경고
warnings array of Warning

작업에 대해 지정된 경고 배열

ResponseOfProgramMemberData

Name 경로 형식 Description
오류
errors array of Error

요청이 실패한 경우 발생한 오류의 배열

moreResult
moreResult boolean

후속 페이지에 더 많은 결과가 있는지 여부를 나타내는 부울

nextPageToken
nextPageToken string

결과 집합이 허용된 일괄 처리 크기를 초과하는 경우 지정된 페이징 토큰

requestId
requestId string

만들어진 요청의 ID

결과
result array of ProgramMemberStatusResponse

작업의 개별 레코드에 대한 결과 배열이 비어 있을 수 있습니다.

성공
success boolean

요청 성공 여부

경고
warnings array of Warning

작업에 대해 지정된 경고 배열

ResponseOfProgramMemberDelete

Name 경로 형식 Description
오류
errors array of Error

요청이 실패한 경우 발생한 오류의 배열

moreResult
moreResult boolean

후속 페이지에 더 많은 결과가 있는지 여부를 나타내는 부울

nextPageToken
nextPageToken string

결과 집합이 허용된 일괄 처리 크기를 초과하는 경우 지정된 페이징 토큰

requestId
requestId string

만들어진 요청의 ID

결과
result array of ProgramMemberDeleteResponse

작업의 개별 레코드에 대한 결과 배열이 비어 있을 수 있습니다.

성공
success boolean

요청 성공 여부

경고
warnings array of Warning

작업에 대해 지정된 경고 배열

ImportLeadResponse

가져오기 상태 정보를 포함하는 응답

Name 경로 형식 Description
batchId
batchId integer

가져오기 일괄 처리의 고유 정수 ID

importId
importId string
message
message string
numOfLeadsProcessed
numOfLeadsProcessed integer

지금까지 처리된 행 수

numOfRowsFailed
numOfRowsFailed integer

지금까지 실패한 행 수

numOfRowsWithWarning
numOfRowsWithWarning integer

지금까지 경고가 있는 행 수

status
status string

일괄 처리의 상태

ProgramMembership

Name 경로 형식 Description
acquiredBy
acquiredBy boolean

부모 프로그램에서 잠재 고객 확보 여부

isExhausted
isExhausted boolean

현재 스트림에서 잠재 고객 사용 여부(해당하는 경우)

membershipDate
membershipDate string

리더가 프로그램의 멤버가 된 날짜

nurtureCadence
nurtureCadence string

해당하는 경우 부모 스트림의 주기

progressionStatus
progressionStatus string

부모 프로그램에서 잠재 고객에 대한 프로그램 상태

reachedSuccess
reachedSuccess boolean

잠재 고객에 부모 프로그램의 성공 상태인지 여부

스트림
stream string

부모 프로그램이 참여 프로그램인 경우 리드가 멤버임을 스트리밍합니다.

ExportResponse

내보내기 작업 상태 정보를 포함하는 응답

Name 경로 형식 Description
생성일시
createdAt date-time

내보내기 요청이 만들어진 날짜

errorMsg
errorMsg string

"실패" 상태의 오류 메시지

exportId
exportId string

내보내기 작업의 고유 ID

파일 크기
fileSize integer

내보낸 파일의 크기(바이트)입니다. 상태가 "완료됨"인 경우에만 값이 있고, 그렇지 않으면 null입니다.

fileChecksum
fileChecksum string

내보낸 파일의 SHA-256 해시입니다. 상태가 "완료됨"인 경우에만 값이 있고, 그렇지 않으면 null입니다.

finishedAt
finishedAt date-time

내보내기 작업의 완료 시간입니다. 이 값은 상태가 "완료됨" 또는 "실패"인 경우에만 값을 가지며, 그렇지 않으면 null입니다.

format
format string

요청에 지정된 파일 형식("CSV", "TSV", "SSV")

numberOfRecords
numberOfRecords integer

내보내기 파일의 레코드 수입니다. 이 값은 상태가 "완료됨"인 경우에만 값을 가지며, 그렇지 않으면 null입니다.

queuedAt
queuedAt date-time

내보내기 작업의 큐 시간입니다. 이 값은 해당 null 이전의 "대기 중" 상태에 도달할 때 값을 갖습니다.

startedAt
startedAt date-time

내보내기 작업의 시작 시간입니다. 이 값은 null 이전의 "처리" 상태에 도달할 때 값을 갖습니다.

status
status string

내보내기 작업의 상태("Created","Queued","Processing","Canceled","Completed","Failed")

이유

Name 경로 형식 Description
코드
code string

이유의 정수 코드

message
message string

작업 상태에 대한 이유를 설명하는 메시지

LeadMapAttribute

Name 경로 형식 Description
이름
name string

특성의 이름

읽기 전용
readOnly boolean

특성이 읽기 전용인지 여부

오류

Name 경로 형식 Description
코드
code string

오류의 오류 코드입니다. 여기에서 오류 코드의 전체 목록을 참조하세요.

message
message string

오류의 원인을 설명하는 메시지

ProgramMemberStatusResponse

Name 경로 형식 Description
status
status string

레코드에서 수행된 작업의 상태

이유
reasons array of Reason

작업이 성공하지 못한 이유 목록입니다. 이유는 API 응답에만 있으며 제출해서는 안 됩니다.

leadId
leadId integer

프로그램 멤버에 연결된 잠재 고객 ID

seq
seq integer

응답에서 레코드의 시퀀스를 나타내는 정수입니다. 이 값은 요청 입력에 포함된 레코드의 순서와 상관 관계가 있습니다. Seq는 응답의 일부여야 하며 제출해서는 안 됩니다.

ProgramMemberDeleteResponse

Name 경로 형식 Description
status
status string

레코드에서 수행된 작업의 상태

이유
reasons array of Reason

작업이 성공하지 못한 이유 목록입니다. 이유는 API 응답에만 있으며 제출해서는 안 됩니다.

leadId
leadId integer

프로그램 멤버에 연결된 잠재 고객 ID

seq
seq integer

응답에서 레코드의 시퀀스를 나타내는 정수입니다. 이 값은 요청 입력에 포함된 레코드의 순서와 상관 관계가 있습니다. Seq는 응답의 일부여야 하며 제출해서는 안 됩니다.

StaticList

Name 경로 형식 Description
생성일시
createdAt string

목록을 만든 날짜/시간

description
description string

정적 목록에 대한 설명

아이디
id integer

정적 목록의 고유 정수 ID

이름
name string

정적 목록의 이름

programName
programName string

프로그램 이름

updatedAt
updatedAt string

목록이 가장 최근에 업데이트된 날짜/시간

작업 공간 이름
workspaceName string

해당하는 경우 부모 작업 영역의 이름

BrowseAllPrograms

Name 경로 형식 Description
채널
channel string

프로그램의 채널

생성일시
createdAt date-time

자산을 만든 날짜/시간

description
description string

자산에 대한 설명

folder
folder Folder

폴더의 JSON 표현

아이디
id integer

자산의 ID

이름
name string

자산의 이름

sfdcId
sfdcId string

SFDC 캠페인에 연결된 경우 프로그램의 SFDC ID

sfdcName
sfdcName string

해당하는 경우 연결된 SFDC 캠페인의 이름

status
status string

프로그램의 상태입니다. 전자 메일 및 참여 프로그램 유형에만 유효합니다.

type
type string

프로그램 유형

updatedAt
updatedAt date-time

자산이 가장 최근에 업데이트된 날짜/시간

url
url string

Marketo UI에 있는 자산의 URL

workspace
workspace string

작업 영역의 이름

FolderContentResponse

Name 경로 형식 Description
아이디
id integer
type
type string

FileFolder

Name 경로 형식 Description
아이디
id integer
이름
name string
type
type string

ResponseOfProgramResponse

Name 경로 형식 Description
오류
errors array of Error
requestId
requestId string
결과
result array of ProgramResponse
성공
success boolean
경고
warnings array of string

ResponseOfSmartListResponse

Name 경로 형식 Description
오류
errors array of Error
requestId
requestId string
결과
result array of SmartListResponse
성공
success boolean
경고
warnings array of string

ResponseOfSmartListResponseWithRules

Name 경로 형식 Description
오류
errors array of Error
requestId
requestId string
결과
result array of SmartListResponseWithRules
성공
success boolean
경고
warnings array of string

SmartListResponse

Name 경로 형식 Description
아이디
id integer

스마트 목록의 ID

이름
name string

스마트 목록의 이름

description
description string

스마트 목록에 대한 설명

생성일시
createdAt date-time

스마트 목록을 만든 날짜/시간

updatedAt
updatedAt date-time

스마트 목록이 가장 최근에 업데이트된 날짜/시간

url
url string

Marketo UI의 스마트 목록 URL

folder
folder Folder

폴더의 JSON 표현

workspace
workspace string

작업 영역의 이름

SmartListResponseWithRules

Name 경로 형식 Description
아이디
id integer

스마트 목록의 ID

이름
name string

스마트 목록의 이름

description
description string

스마트 목록에 대한 설명

생성일시
createdAt date-time

스마트 목록을 만든 날짜/시간

updatedAt
updatedAt date-time

스마트 목록이 가장 최근에 업데이트된 날짜/시간

url
url string

Marketo UI의 스마트 목록 URL

folder
folder Folder

폴더의 JSON 표현

workspace
workspace string

작업 영역의 이름

규칙
rules SmartListRules

스마트 목록 규칙의 JSON 표현

ResponseOfStaticListResponse

Name 경로 형식 Description
오류
errors array of Error
requestId
requestId string
결과
result array of StaticListResponse
성공
success boolean
경고
warnings array of string

StaticListResponse

Name 경로 형식 Description
아이디
id integer

정적 목록의 ID

이름
name string

정적 목록의 이름

description
description string

정적 목록에 대한 설명

생성일시
createdAt date-time

정적 목록을 만든 날짜/시간

updatedAt
updatedAt date-time

정적 목록이 가장 최근에 업데이트된 날짜/시간

url
url string

Marketo UI의 정적 목록 URL

folder
folder Folder

폴더의 JSON 표현

workspace
workspace string

작업 영역의 이름

computedUrl
computedUrl string

ProgramResponse

Name 경로 형식 Description
채널
channel string

프로그램의 채널

costs
costs array of Costs

관련 기간 비용 목록

생성일시
createdAt date-time

자산을 만든 날짜/시간

description
description string

자산에 대한 설명

종료일
endDate date-time

프로그램의 종료 날짜입니다. 이벤트, 전자 메일 및 웨비나 유형 프로그램에 적용 가능

folder
folder ProgramFolder
아이디
id integer

자산의 ID

이름
name string

자산의 이름

sfdcId
sfdcId string

SFDC 캠페인에 연결된 경우 프로그램의 SFDC ID

sfdcName
sfdcName string

해당하는 경우 연결된 SFDC 캠페인의 이름

startDate
startDate date-time

프로그램의 시작 날짜입니다. 이벤트, 전자 메일 및 웨비나 유형 프로그램에 적용 가능

status
status string

프로그램의 상태입니다. 전자 메일 및 참여 프로그램 유형에만 유효합니다.

tags
tags array of Tags

연결된 프로그램 태그 목록

type
type string

프로그램 유형

updatedAt
updatedAt date-time

자산이 가장 최근에 업데이트된 날짜/시간

url
url string

Marketo UI에 있는 자산의 URL

workspace
workspace string

작업 영역의 이름

marketingProgramProgressionId
marketingProgramProgressionId integer
headStart
headStart boolean

프로그램에 대해 'Head Start' 함수를 사용할 수 있는지 여부

FileResponse

Name 경로 형식 Description
생성일시
createdAt date-time

파일이 만들어진 날짜/시간

description
description string

파일에 대한 설명

folder
folder FileFolder
아이디
id integer

파일의 ID

마임 타입
mimeType string

파일의 MIME 형식

이름
name string

파일의 이름

size
size integer

파일 크기(바이트)

updatedAt
updatedAt date-time

파일이 가장 최근에 업데이트된 날짜/시간

url
url string

파일의 공개적으로 액세스할 수 있는 URL

ResponseOfFileResponse

Name 경로 형식 Description
오류
errors array of Error
requestId
requestId string
결과
result array of FileResponse
성공
success boolean
경고
warnings array of string

FolderResponse

Name 경로 형식 Description
accessZoneId
accessZoneId integer
생성일시
createdAt date-time

폴더가 만들어진 날짜/시간

description
description string

폴더에 대한 설명

folderId
folderId Folder

폴더의 JSON 표현

folderType
folderType string

폴더 유형

아이디
id integer

폴더의 ID

isArchive
isArchive boolean

폴더의 보관 상태

isSystem
isSystem boolean

폴더가 시스템 관리인지 여부

이름
name string

폴더의 이름입니다. 프로그램에는 적용되지 않습니다.

parent
parent Folder

폴더의 JSON 표현

path
path string

폴더의 경로

updatedAt
updatedAt date-time

폴더가 마지막으로 업데이트된 날짜/시간

url
url string

폴더의 URL

workspace
workspace string

작업 영역의 이름

ResponseOfIdResponse

Name 경로 형식 Description
오류
errors array of Error
requestId
requestId string
결과
result array of IdResponse
성공
success boolean
경고
warnings array of string

태그들

Name 경로 형식 Description
tagType
tagType string

태그의 이름

태그 값
tagValue string

태그 값

ResponseOfBrowseAllPrograms

Name 경로 형식 Description
오류
errors array of Error
requestId
requestId string
결과
result array of BrowseAllPrograms
성공
success boolean
경고
warnings array of string

ResponseOfFolderResponse

Name 경로 형식 Description
오류
errors array of Error
requestId
requestId string
결과
result array of FolderResponse
성공
success boolean
경고
warnings array of string

ResponseOfFolderContentResponse

Name 경로 형식 Description
오류
errors array of Error
requestId
requestId string
결과
result array of FolderContentResponse
성공
success boolean
경고
warnings array of string

IdResponse

Name 경로 형식 Description
아이디
id integer

자산의 ID

비용

Name 경로 형식 Description
비용
cost integer

비용의 양

메모
note string

비용에 대한 참고 사항

startDate
startDate date-time

기간 비용의 시작 날짜

ProgramFolder

Name 경로 형식 Description
type
type string

프로그램 폴더의 유형

value
value integer

프로그램 폴더의 ID

folderName
folderName string

프로그램 폴더의 이름

폴더

폴더의 JSON 표현

Name 경로 형식 Description
아이디
id integer

폴더의 ID

type
type string

폴더 유형

SmartListRules

스마트 목록 규칙의 JSON 표현

Name 경로 형식 Description
filterMatchType
filterMatchType string

스마트 목록 필터 일치 유형(규칙 논리)

트리거
triggers array of string

스마트 목록 트리거 목록

filters
filters array of SmartListFilters

스마트 목록 필터 목록

SmartListFilters

스마트 목록 필터의 JSON 표현

Name 경로 형식 Description
아이디
id integer

필터의 ID

이름
name string

필터 이름

ruleTypeId
ruleTypeId integer

규칙 형식의 ID

ruleType
ruleType string

규칙 형식의 이름

operator
operator string

연산자 이름

conditions
conditions array of SmartListConditions

스마트 목록 조건 목록

SmartListConditions

스마트 목록 조건의 JSON 표현

Name 경로 형식 Description
activityAttributeId
activityAttributeId integer

활동 특성의 ID

activityAttributeName
activityAttributeName string

활동 특성의 이름

operator
operator string

연산자 값

values
values array of string

값 목록

기본
isPrimary boolean

조건이 기본 조건인지 여부(스마트 목록의 첫 번째 조건)

객체

'object' 형식입니다.