FAQ 【2023年2月】Re:lation API変更について

（2023年2月17日 作成）

この度Re:lation APIの仕様変更を行う運びとなりました。

Re:lation APIの「アドレス帳の登録や更新にかかわる」エンドポイントを変更いたします。
変更内容は以下の通りです。

アドレス帳の登録と更新において、<message_box_id>（受信箱id）の指定を廃止し、今後は<customer_group_id>（アドレス帳id）を指定するエンドポイントに移行をいたします。
　Re:lation API 仕様書：https://developer.ingage.jp/

１．登録
POST
https://<subdomain>.relationapp.jp/api/v2/customer_groups/<customer_group_id>/customers/create
コンタクトを1件新たに登録します

２．更新（system_id1 をキーに）
PUT
https://<subdomain>.relationapp.jp/api/v2/customer_groups/<customer_group_id>/customers/system_id1/<system_id1>
system_id1（顧客コード）をキーにしてコンタクトを1件更新します

３．更新（email をキーに）
PUT
https://<subdomain>.relationapp.jp/api/v2/customer_groups/<customer_group_id>/customers/email/<email>
メールアドレスをキーにしてコンタクトを1件更新します

４．取得（system_id1 をキーに）
GET
https://<subdomain>.relationapp.jp/api/v2/customer_groups/<customer_group_id>/customers/system_id1/<system_id1>
system_id1（顧客コード）をキーにしてコンタクトを1件取得します

５．取得（email をキーに）
GET
https://<subdomain>.relationapp.jp/api/v2/customer_groups/<customer_group_id>/customers/email/<email>
メールアドレスをキーにしてコンタクトを1件取得します

６．削除（system_id1 をキーに）
DELETE
https://<subdomain>.relationapp.jp/api/v2/customer_groups/<customer_group_id>/customers/system_id1<system_id1>
system_id1（顧客コード）をキーにしてコンタクトを1件削除します

７．削除（email をキーに）
DELETE
https://<subdomain>.relationapp.jp/api/v2/customer_groups/<customer_group_id>/customers/email/<email>
メールアドレスをキーにしてコンタクトを1件削除します

８．バッジ一覧取得
GET
https://<subdomain>.relationapp.jp/api/v2/customer_groups/<customer_group_id>/badges
指定したアドレス帳に登録されているバッジ一覧を取得します

１．登録
POST
https://<subdomain>.relationapp.jp/api/v2/<message_box_id>/customers/create
コンタクトを1件新たに登録します

２．更新（system_id1 をキーに）
PUT
https://<subdomain>.relationapp.jp/api/v2/<message_box_id>/customers/system_id1/<system_id1>
system_id1（顧客コード）をキーにしてコンタクトを1件更新します

３．更新（email をキーに）
PUT
https://<subdomain>.relationapp.jp/api/v2/<message_box_id>/customers/email/<email>
メールアドレスをキーにしてコンタクトを1件更新します

４．取得（system_id1 をキーに）
GET https://<subdomain>.relationapp.jp/api/v2/<message_box_id>/customers/system_id1/<system_id1>
system_id1（顧客コード）をキーにしてコンタクトを1件取得します

５．取得（email をキーに）
GET
https://<subdomain>.relationapp.jp/api/v2/<message_box_id>/customers/email/<email>
メールアドレスをキーにしてコンタクトを1件取得します

６．削除（system_id1 をキーに）
DELETE
https://<subdomain>.relationapp.jp/api/v2/<message_box_id>/customers/system_id1/<system_id1>
system_id1（顧客コード）をキーにしてコンタクトを1件削除します

７．削除（email をキーに）
DELETE
https://<subdomain>.relationapp.jp/api/v2/<message_box_id>/customers/email/<email>
メールアドレスをキーにしてコンタクトを1件削除します

８．バッジ一覧取得
GET
https://<subdomain>.relationapp.jp/api/v2/<message_box_id>/badges
指定したアドレス帳に登録されているバッジ一覧を取得します

※アカウントオーナーのみ確認可能です。
画面右上のユーザアイコン＞［システム設定］＞アドレス帳に表示されている、各アドレス帳のidが<customer_group_id>です。

なお、今後アドレス帳一覧取得のAPIをリリースする予定です。

今後以下のスケジュールで変更を予定しております。

▼日程
・2023年2月16日（木） 22時頃　：新エンドポイントの利用が可能となります。
・2023年8月31日（木） 22時頃　：新エンドポイントのみ利用可能となります。
　※2023年2月時点での予定となり、変更の可能性がございます。

なお、2月16日?8月31日までの期間は、並行期間として、旧エンドポイントと新エンドポイントどちらの利用も可能です。

これまでアドレス帳は一つの受信箱にのみ紐づいていましたが（受信箱の中にアドレス帳が存在した）、
Anaheim UIリリースに伴い、受信箱とアドレス帳をそれぞれ独立させました。
これにより、複数の受信箱にアドレス帳の紐づけが可能となり、必ずしも受信箱とアドレス帳は対ではなくなったため、APIでも受信箱ではなくアドレス帳を指定し、登録・更新可能としました。

本件に関してのご不明点は株式会社インゲージ サポート担当までお問い合わせください。
お問い合わせは、Re:lation画面左下の[？]アイコンよりサポートチャット
または「support@ingage.jp」までメールにてご連絡ください。