ZOHO CRM APIを活用したレコードの削除方法

はじめに

皆さん、こんにちは！当ブログで絶賛大好評（？）のZOHO APIシリーズを引き続きお届けします。ZOHO CRMは非常に使いやすいツールですが、APIの日本語文献が少ないため、困っている方も多いと思います。今回は、ZOHO CRM APIを使ってレコードを削除する方法をご紹介します。

ちなみに、当ブログのおかげでZOHO CRM APIの関連ワードをGoogleで検索すると上位に表示されるようになりました！これも皆さんのおかげです。ありがとうございます！

アクセストークンの発行

まずはZOHO CRM APIを使うために必要なアクセストークンを発行する方法についておさらいしましょう。アクセストークンとは、APIを呼び出す際に必要な認証情報のことです。このトークンを取得することで、ZOHO CRMの各種APIにアクセスすることができます。アクセストークンの発行方法については、前回の記事で詳しく説明していますので、そちらを参考にしてください。

ZOHO CRM APIでレコードの削除を行う方法

次に、ZOHO CRM APIを使ってレコードを削除する方法について説明します。方法はいくつかありますが、今回は一番シンプルなREST APIを使います。REST APIは、データの更新時にIDを指定するので誤って他のデータを更新する心配がなく、確実に操作できます。これにより、安全にデータの管理が可能となります。

レコードのIDの取得

まず、削除したいレコードのIDを取得する必要があります。COQL Queryを使用して実行できます。以下のURLに対してPOSTリクエストを送ることで、特定の条件に一致するレコードを取得できます。詳しい内容は下記のブログを参考にしてください。

例えば、姓が「山田」で名が「太郎」の連絡先のIDを取得する場合、以下のようなリクエストを送ります。

curl "https://www.zohoapis.com/crm/v4/coql" \
-H "Authorization: Zoho-oauthtoken [access_token]" \
-d '{ "select_query" : "select id, Last_Name, First_Name from Contacts where ((Last_Name = '山田') AND (First_Name = '太郎'))"}' \
-X POST

このリクエストを送信すると、以下のようなJSON形式のレスポンスが返ってきます。今回は連絡先のIDを取得したいので、Contactsモジュールを使用していますが、他のモジュールを使用したい場合、別のモジュールを選択してください。

{"data":[{"First_Name":"太郎","Last_Name":"山田","id":"**********"}],"info":{"count":1,"more_records":false}}

ここで取得した"id":"**********"のidの値の部分をコピーして、次のステップで使用します。

レコードの削除方法

取得したIDを使って、以下のようなコマンドを実行します。

curl "https://www.zohoapis.com/crm/v6/Contacts/[レコードのIDの取得したID]" \
-X DELETE \
-H "Authorization: Zoho-oauthtoken [access_token]"

このコードを実行して、以下のように表示されれば成功です。

{"data":[{"code":"SUCCESS","details":{"id":"**********"},"message":"record deleted","status":"success"}]}

以上です。これまでにレコードの取得や更新、追加を行ってきた方であれば、同じような流れで比較的容易に実行できたのではないでしょうか？

さいごに

この記事がZOHO CRM APIの使い方を探している方々の参考になれば幸いです。皆様のおかげで、前回書いたZOHO CRM APIの使い方に関する記事のアクセス数が急増しています。皆さんのサポートとフィードバックに心から感謝しています。少しでも皆さんのお役に立ててうれしいです。

最後に、この記事が皆さんの業務改善や新しいアイデアのヒントとなれば幸いです。引き続き、私たちのブログをよろしくお願いいたします。またZOHOに関する興味深いトピックを取り上げる予定ですので、ぜひチェックしてください！

参考文献

Delete Records – APIs | Online Help – Zoho CRM