ZOHO CRM APIを活用したレコードの更新と追加

はじめに

皆さん、こんにちは。前回に引き続き、今回もZOHO CRM APIの使い方について解説します。ZOHO CRMは非常に使いやすいツールですが、APIの日本語文献が少なく、困っている方も多いと思います。そこで今回は、ZOHO CRM APIでレコードの更新と追加をする方法を紹介します。

アクセストークンの発行

ZOHO CRM APIを使うには、まずアクセストークンを発行する必要があります。アクセストークンとは、APIを呼び出す際に必要な認証情報のことです。アクセストークンの発行方法は前回書いた

ZOHO CRM APIでレコードを更新と追加を行う方法

今回は、ZOHO CRM APIでレコードを更新と追加を行う方法をご紹介します。方法はいくつかありますが、今回は一番シンプルなREST APIsを使ってみましょう。他にも方法はありますが、データの更新を行うときに、REST APIsは実際に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 = 'Woods') AND (First_Name = 'Joe'))\"}" ^
-X POST

今回は連絡先のIDを取得したいので、Contacts を使用していますが他のものを使用したい場合は他のモジュールを選択してください。返り値は以下の通りです。

{"data":[{"First_Name":"Joe","Last_Name":"Woods","id":"**********"}],"info":{"count":1,"more_records":false}}

“id”:”**********”と書いているので、**********をどこかへコピーして貼り付けるなどして情報を残してください。

次に、情報の更新する方法です。冒頭にお伝えした通りREST APIsを使って更新します。COQL Queryと名前が違うから使い方が大きく変わると思う方が多いかもしれないですが、そこまで変わらないので大丈夫です笑。レコードを更新する方法はいくつかあるのですが、REST APIsを使う方法はIDが必要なので他のレコードが更新される心配がないので個人的にはREST APIsを勧めています。もし連絡先、姓や名以外の情報を取得したい場合は前回書いた

の記事を参考にしてください。さきほど取得したIDの**********を使って下記のコマンドを実行します。

curl -X PUT "https://www.zohoapis.com/crm/v4/Contacts/**********" ^
-H "Authorization: Zoho-oauthtoken [access_token]" ^
-H "Content-Type: application/json; charset=UTF-8" ^
-d "{\"data\":[{\"Last_Name\":\"WoodsWoods\",\"First_Name\":\"JoeJoe\"}]}"

今回は連絡先の更新をしたいので、Contacts を使用していますが他のものを使用したい場合は他のモジュールを選択してください。 実行したら

{"data":[{"code":"SUCCESS","details":{"Modified_Time":"2023-12-12T15:14:55+09:00","Modified_By":{"name":"担当者名","id":"1111111111111111111111"},"Created_Time":"2023-07-03T14:12:31+09:00","id":"22222222222222","Created_By":{"name":"担当者名","id":"1111111111111111111111"}},"message":"record updated","status":"success"}]}

と返ったら成功です。

レコードの追加方法

次にレコードを追加する方法を教えます。アクセストークンは同じものを使います。

curl -X POST "https://www.zohoapis.com/crm/v4/Contacts" ^
-H "Authorization: Zoho-oauthtoken [access_token]" ^
-H "Content-Type: application/json; charset=UTF-8" ^
-d "{\"data\":[{\"Last_Name\":\"McEnroe\",\"First_Name\":\"James\",\"Email\":\"aaaaa@example.com\",\"Phone\":\"11166-645561546-5451145\"}]}" 

今回は連絡先の更新をしたいので、Contacts を使用していますが他のものを使用したい場合は他のモジュールを選択してください。 実行したら

{"data":[{"code":"SUCCESS","details":{"Modified_Time":"2023-12-12T15:32:30+09:00","Modified_By":{"name":"担当者名","id":"1111111111111111111111"},"Created_Time":"2023-12-12T15:32:30+09:00","id":"2222222222222","Created_By":{"name":"担当者名","id":"1111111111111111111111"},"$approval_state":"approved"},"message":"record added","status":"success"}]}

と返ってきたら成功です。

さいごに

この記事がZOHO CRM APIの使い方を探している方々の参考になれば幸いです。皆様のおかげで、前回書いたZOHO CRM APIの使い方についてアクセス数が増えています。少しでもみんなの役に立ててうれしいです。次回もお楽しみに！

参考文献

Zoho CRM V5 APIs