updateRelatedRecordsメソッド
目的
updateRelatedRecordsメソッドを使用すると、別のデータに関連付けられているデータを更新できます。
サポート対象タブ
タブ | 関連タブ |
キャンペーン | 見込み客 |
商品 | 見込み客 |
注:
- 関連タブを親タブにしたまま、キャンペーンまたは商品を更新することもできます。
リクエストURL
キャンペーンに関連付けられている連絡先のメンバーステータスを更新する
XML形式:
https://crm.zoho.com/crm/private/xml/Campaigns/updateRelatedRecords?authtoken=Auth Token&scope=crmapi
&relatedModule=Contacts&xmlData=<Contacts><row no="1"><FL val="CONTACTID">9999999999</FL><FL val="member_status">Sent</FL></row></Contacts>&id=99999999999
JSON形式:
https://crm.zoho.com/crm/private/json/Campaigns/updateRelatedRecords?authtoken=Auth Token&scope=crmapi&relatedModule=Contacts&xmlData=<Contacts><row no="1"><FL val="CONTACTID">9999999999</FL><FL val="member_status">Sent</FL></row></Contacts>&id=99999999999
リクエストパラメーター
パラメーター | データ型 | 説明 |
authtoken* | 文字列 | Zoho認証情報の認証に使用する、暗号化された英数字文字列。 |
scope* | 文字列 | 値をcrmapiと指定してください。 |
relatedModule* | 文字列 | データが関連付けられているタブ。 たとえば、キャンペーンに関連する見込み客を更新する必要がある場合、このパラメーターの値はLeadsになります。 |
id* | 整数 | 更新するデータのID。 |
xmlData* | XML | 渡すXML値。 |
* - 必須パラメーター
注:
- API実装で行われた強化の詳細については、リリースノートページを参照してください。
その他の注意事項
- 最大100件のデータを更新できます。
- Zoho CRMアカウントからデータを取得する際、役職に応じたセキュリティ(役職、権限、項目単位のセキュリティとデータ共有ルール)が適用されます。役職に応じたセキュリティ設定については、セキュリティ管理を参照してください。
例
価格表に関連する商品の表示価格を更新する
https://crm.zoho.com/crm/private/xml/PriceBooks/updateRelatedRecords?authtoken=Your Authenticaton Token&scope=crmapi&id=Price Book ID&relatedModule=Products&xmlData=<Products><row no="1"><FL val="PRODUCTID">508020000000061987</FL><FL val="list_price">100.00</FL></row></Products>
レスポンス形式
<response uri="/crm/private/xml/PriceBooks/updateRelatedRecords">
<result>
<status>
<code>200</code>
</status>
<success>
<code>4800</code>
</success>
<updated-ids>[508020000000061987]</updated-ids>
</result>
</response>