商談ロール
中間のopportunityRole オブジェクトは商談にリンクします。
商談役割APIは、ネイティブ CRM同期が有効になっていないサブスクリプションでのみ使用できます。
説明
商談と同様に、APIは商談ロールに対して記述呼び出しとCRUD操作を提供します。
GET /rest/v1/opportunities/roles/describe.json
{
"requestId":"185d6#14b51985ff0",
"success":true,
"result":[
{
"name":"opportunityRole",
"displayName":"Opportunity Role",
"createdAt":"2015-02-03T22:36:23Z",
"updatedAt":"2015-02-03T22:36:24Z",
"idField":"marketoGUID",
"dedupeFields":[
"externalOpportunityId",
"leadId",
"role"
],
"searchableFields":[
[
"externalOpportunityId",
"leadId",
"role"
],
[
"marketoGUID"
],
[
"leadId"
],
[
"externalOpportunityId"
]
],
"fields":[
{
"name":"marketoGUID",
"displayName":"Marketo GUID",
"dataType":"string",
"length":36,
"updateable":false
},
{
"name":"externalOpportunityId",
"displayName":"External Opportunity Id",
"dataType":"string",
"length":50,
"updateable":false
},
{
"name":"leadId",
"displayName":"Lead Id",
"dataType":"integer",
"updateable":false
},
{
"name":"role",
"displayName":"Role",
"dataType":"string",
"length":50,
"updateable":false
},
{
"name":"isPrimary",
"displayName":"Is Primary",
"dataType":"boolean",
"updateable":true
},
{
"name":"externalCreatedDate",
"displayName":"External Created Date",
"dataType":"datetime",
"updateable":true
}
]
}
]
}
クエリ
dedupeFieldsとsearchableFieldsの値が商談と異なります。 dedupeFieldsは、externalOpportunityId、leadIdおよびroleを必要とする複合キーを提供します。 レコードの作成を成功させるには、ID フィールドで参照される商談とリードが宛先インスタンスに存在する必要があります。
searchableFields値marketoGUID、leadIdおよびexternalOpportunityIdは、商談と同じパターンを使用する個々のクエリに対して有効です。 複合キーを使用してクエリすることもできます。 このクエリには、_method=GET クエリパラメーターを使用してPOSTを通じて送信されたJSON オブジェクトが必要です。
POST /rest/v1/opportunities/roles.json?_method=GET
{
"filterType": "dedupeFields",
"fields": [
"marketoGuid",
"externalOpportunityId",
"leadId",
"role"
],
"input": [
{
"externalOpportunityId": "Opportunity1",
"leadId": 1,
"role": "Captain"
},
{
"externalOpportunityId": "Opportunity2",
"leadId": 1872,
"role": "Commander"
},
{
"externalOpportunityId": "Opportunity3",
"leadId": 273891,
"role": "Lieutenant Commander"
}
]
}
このリクエストは、標準のGET クエリと同じ応答タイプを生成しますが、異なるリクエストインターフェイスを使用します。
作成と更新
商談と同じインターフェイスを使用して、商談の役割を作成および更新できます。
POST /rest/v1/opportunities/roles.json
{
"action": "createOrUpdate",
"dedupeBy": "dedupeFields",
"input": [
{
"externalOpportunityId": "19UYA31581L000000",
"leadId": 456783,
"role": "Technical Buyer",
"isPrimary": false
},
{
"externalOpportunityId": "19UYA31581L000000",
"leadId": 456784,
"role": "Technical Buyer",
"isPrimary": false
}
]
}
{
"requestId": "e42b#14272d07d78",
"success": true,
"result":[
{
"seq": 0,
"status": "updated",
"marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb"
},
{
"seq": 1,
"status": "created",
"marketoGUID": "cff23271-f996-47d7-984f-f2676861b5fb"
}
]
}
削除
重複排除フィールドまたはID フィールドで商談ロールを削除します。 deleteBy パラメーターをdedupeFieldsまたはidFieldのいずれかに設定します。 デフォルトはdedupeFieldsです。
リクエスト本体には、削除する商談ロールの入力配列が含まれます。 各呼び出しでは、最大300個の商談ロールを使用できます。
POST /rest/v1/opportunities/roles/delete.json
{
"deleteBy": "dedupeFields",
"input": [
{
"externalOpportunityId": "19UYA31581L000000",
"leadId": 456783,
"role": "Technical Buyer"
}
]
}
{
"requestId": "10f7c#173264db42d",
"result": [
{
"seq": 0,
"marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb"
"status": "deleted"
}
]
"success": true
}
タイムアウト
- 特に明記されていない限り、商談ロールエンドポイントのタイムアウトは30秒です。
- 同期商談ロールのタイムアウトは60秒です。
- 商談ロールの削除のタイムアウトは60秒です。
recommendation-more-help
marketo-developer-help