FAQ 【2023年4月】Re:lation API リクエストパラメータ追加について

（2023年3月30日 作成）

この度「アドレス帳の登録と更新を行うAPI」において、新たなリクエストパラメータおよびレスポンスを追加いたしました。
　Re:lation API 仕様書：https://developer.ingage.jp/

今回以下のAPIにリクエストパラメータおよびレスポンスを追加しました。

１．登録 (アドレス帳ID版)
POST
https://<subdomain>.relationapp.jp/api/v2/customer_groups/<customer_group_id>/customers/create

２．更新 (system_id1 、emailをキーに)(アドレス帳ID版)
PUT
https://<subdomain>.relationapp.jp/api/v2/customer_groups/<customer_group_id>/customers/system_id1/<system_id1>

PUT
https://<subdomain>.relationapp.jp/api/v2/customer_groups/<customer_group_id>/customers/email/<email>

３．取得 (system_id1、emailをキーに)(アドレス帳ID版)
GET
https://<subdomain>.relationapp.jp/api/v2/customer_groups/<customer_group_id>/customers/system_id1/<system_id1>

GET
https://<subdomain>.relationapp.jp/api/v2/customer_groups/<customer_group_id>/customers/email/<email>

リクエストパラメータ、レスポンスの追加のみとなり、上記エンドポイントの変更や削除はありません。
そのためアドレス帳への登録や更新、取得は今まで通りの方法で可能です。

追加となったリクエストパラメータは以下の通りです。（登録、更新で使用可能）

　・archived_emails（アーカイブメールアドレス）
　　- 型： Array[object]
　　- 最大6つまで指定可。
　　- 既に同じメールアドレスを含むコンタクトがアドレス帳に存在した場合は 400 Bad Request が返ります。

　・archived_tels（アーカイブ電話番号）
　　- 型： Array[object]
　　- 最大3つまで指定可。

取得時に追加となったレスポンスは以下の通りです。

　・archived_emails（アーカイブメールアドレス）
　　- 型：Array[object]
　　- 最大6つまで。

　・archived_tels（アーカイブ電話番号）
　　- 型： Array[object]
　　- 最大3つまで。

2023年3月30日のリリースにより、アドレス帳に「アーカイブ」機能が新たに加わりました。
そのためこのアーカイブに対応するリクエストパラメータおよびレスポンスを追加しています。
なお、アーカイブ機能についてはこちらのヘルプページに記載しています。

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