メインコンテンツへ
BlueAI
BlueAIBlueAI API
JAEN
ホーム/メール/連絡先

連絡先（Contacts）

メール配信先の連絡先の管理・インポートを行います。

|

エンドポイント

GET/api/v1/mail/contacts連絡先一覧を取得
POST/api/v1/mail/contacts連絡先を作成
GET/api/v1/mail/contacts/{id}連絡先を取得
PATCH/api/v1/mail/contacts/{id}連絡先を更新
DELETE/api/v1/mail/contacts/{id}連絡先を削除
POST/api/v1/mail/contacts/import連絡先をインポート
GET/api/v1/mail/contacts

連絡先一覧を取得

認証が必要です— セッション Cookie または Bearer トークンを含めてください

クエリパラメータ

名前型必須説明
search
string任意名前・メールアドレスで検索
list_id
string任意リスト ID で絞り込み
status
string任意ステータスで絞り込み（active / unsubscribed / bounced）
limit
integer任意取得件数（デフォルト: 20, 最大: 100）
offset
integer任意取得開始位置（デフォルト: 0）

コード例

curl "https://api.blueai.jp/api/v1/mail/contacts" \
  -H "Cookie: better-auth.session_token=<token>"
POST/api/v1/mail/contacts

連絡先を作成

認証が必要です— セッション Cookie または Bearer トークンを含めてください

リクエストボディ

名前型必須説明
email
string必須メールアドレス
first_name
string任意名
last_name
string任意姓
list_id
string任意追加先リスト ID

コード例

curl -X POST "https://api.blueai.jp/api/v1/mail/contacts" \
  -H "Cookie: better-auth.session_token=<token>"
GET/api/v1/mail/contacts/{id}

連絡先を取得

認証が必要です— セッション Cookie または Bearer トークンを含めてください

パスパラメータ

名前型必須説明
id
string任意連絡先 ID

コード例

curl "https://api.blueai.jp/api/v1/mail/contacts/cont_123e4567e89b12d3a456426614174000" \
  -H "Cookie: better-auth.session_token=<token>"
PATCH/api/v1/mail/contacts/{id}

連絡先を更新

認証が必要です— セッション Cookie または Bearer トークンを含めてください

パスパラメータ

名前型必須説明
id
string任意連絡先 ID

リクエストボディ

名前型必須説明
email
string任意メールアドレス
first_name
string任意名
last_name
string任意姓

コード例

curl -X PATCH "https://api.blueai.jp/api/v1/mail/contacts/cont_123e4567e89b12d3a456426614174000" \
  -H "Cookie: better-auth.session_token=<token>"
DELETE/api/v1/mail/contacts/{id}

連絡先を削除

認証が必要です— セッション Cookie または Bearer トークンを含めてください

パスパラメータ

名前型必須説明
id
string任意連絡先 ID

コード例

curl -X DELETE "https://api.blueai.jp/api/v1/mail/contacts/cont_123e4567e89b12d3a456426614174000" \
  -H "Cookie: better-auth.session_token=<token>"
POST/api/v1/mail/contacts/import

連絡先をインポート

CSV ファイルなどから連絡先を一括インポートします。

認証が必要です— セッション Cookie または Bearer トークンを含めてください

コード例

curl -X POST "https://api.blueai.jp/api/v1/mail/contacts/import" \
  -H "Cookie: better-auth.session_token=<token>"