Zoho CRM
Zoho CRM 連携に関するアクション一覧です。
ZohoCRMGetRecords
概要
ZohoCRMGetRecords は、Zoho CRM に登録されているレコードを一括取得する機能です。
パラメーター
*は、必須パラメーター\ ** は、条件付きの必須パラメーター
名前 | 型 | 概要 | 例 |
---|---|---|---|
provider* | 文字列 | Zoho CRM 連携に必要なプロバイダー | zohocrm_f435491dac2157351234 |
tab* | 文字列 | 取得したいタブの API 名を指定します | Accounts |
customViewId** | 数値 | 取得したいレコードリストを示すカスタムビュー IDを指定します。ID はカスタムビュー選択時の URL に表示され、例えば /custom-view/10970000000081000/ の場合は 10970000000081000 が ID です。※ fields パラメーターを指定しない場合はこのパラメーターの入力が必須になります。 |
10970000000081000 |
fields** | 文字列 | 取得したいフィールドの API 名を最大 50 個までカンマ区切りで指定します。フィールドの API 名は API 名のページから取得したいタブのリンクを開くことで確認できます。customViewId パラメーターと fields パラメーターを併用するとそれらを合わせたフィールドを取得します。 ※ customViewId パラメーターを指定しない場合はこのパラメーターの入力が必須になります。 |
id,Phone |
アウトプット
タイプ | 型 | 概要 | 例 |
---|---|---|---|
Array | 配列 | 取得したレコード。最大 2000 レコードまで取得します。レコードを特定する id は fields パラメータ等で指定がない場合も必ず出力されます。 | *使用例を参照 |
使用例
# レコードを一括取得する
+zoho_c_r_m_get_records_1:
action>: ZohoCRMGetRecords
provider: zohocrm_f435491dac2157351234
tab: Accounts
customViewId: 10970000000081000
# [
# {
# "Phone": "000-000-0010",
# "Website": null,
# "Account_Name": "鉄日建設株式会社",
# "id": "10970000000085933"
# },
# {
# "Phone": "000-000-0009",
# "Website": null,
# "Account_Name": "レクト・プロバイダー株式会社",
# "id": "10970000000085932"
# },
# {
# "Phone": "000-000-0008",
# "Website": null,
# "Account_Name": "ザスカー株式会社",
# "id": "10970000000085931"
# },
# {
# "Phone": "000-000-0007",
# "Website": null,
# "Account_Name": "株式会社アーガス",
# "id": "10970000000085930"
# },
# {
# "Phone": "000-000-0006",
# "Website": null,
# "Account_Name": "株式会社東西新聞社",
# "id": "10970000000085929"
# },
# {
# "Phone": "000-000-0005",
# "Website": null,
# "Account_Name": "株式会社ストアユナイテッド",
# "id": "10970000000085928"
# }
# ]
ZohoCRMUpdateRecords
概要
ZohoCRMUpdateRecords は、Zoho CRM のレコードを一括更新する機能です。
パラメーター
* は、必須パラメーター
名前 | 型 | 概要 | 例 |
---|---|---|---|
provider* | 文字列 | Zoho CRM 連携に必要なプロバイダー | zohocrm_f435491dac2157351234 |
tab* | 文字列 | 更新したいタブの API 名を指定します | Accounts |
records* | 文字列 | 更新したいレコードのリストを指定します。各レコードはオブジェクト形式で作成し、各フィールドの値を指定します。このアクションで最大 100 レコードまで一度に更新できます。レコードを特定するため id の指定は必須です。各フィールドの形式の詳細はこちらのページの Sample Attributes をご確認ください。 | *使用例を参照 |
アウトプット
タイプ | 型 | 概要 | 例 |
---|---|---|---|
Object | オブジェクト | 結果のステータスとエラー詳細をまとめたオブジェクト | *使用例を参照 |
使用例
全てのレコードの更新が完了した場合
"status": "success"
を含む結果が得られます。
エラーは発生しないので errors 配列は空になります。
# レコードを一括更新する
+zoho_c_r_m_update_records_1:
action>: ZohoCRMUpdateRecords
provider: zohocrm_f435491dac2157351234
tab: Accounts
records: [{"id":"10970000000085931","Date":"2022-09-20"},{"id":"10970000000085932","Date":"2022-09-16"}]
# {
# "status": "success",
# "errors": []
# }
レコードの指定に問題があり更新が完了しなかった場合
設定したレコードのどれか一つでも更新が完了しなかった場合は"status": "error"
を含む結果が得られます。
結果の errors 配列内にはエラーの詳細が表示され、message はエラーの内容、param はエラー対象パラメータ、record は対象レコードを表します。
例では、アクションの records パラメータに設定したレコードのうち、2番目のレコードに必須パラメータである id が指定されていないことでエラーになるケースを示しています。
このとき、1番目のレコードは問題なく更新が完了するため、errors 配列内には2番目のレコードに関する内容しか含まれません。
+zoho_c_r_m_update_records_1:
action>: ZohoCRMUpdateRecords
provider: zohocrm_f435491dac2157351234
tab: Accounts
records: [{"id":"10970000000085931","Date":"2022-09-21"},{"Date":"2022-09-20"}]
# {
# "status": "error",
# "errors": [
# {
# "message": "MANDATORY_NOT_FOUND. required field not found.",
# "param": "id",
# "record": {
# "Date": "2022-09-20",
# }
# }
# ]
# }