外部 API・APIキー
Reloura One の機能を、外部のサイト・ツール・自作プログラムから操作するための REST API です。Zapier / Make / n8n などの自動化ツールや、自社のダウンロードページからの連携に使えます。 Claude 連携(MCP)も同じ API キーを使います。
できること
- コンタクトの登録・一覧取得・削除、タグの解除、メール配信停止
- LINE・メール一斉配信の作成・送信・予約(Claude 連携と同じ操作)
- シナリオとステップの作成、有効化・無効化
- 公開フォームの作成・更新・削除、登録フォーム設定(プライバシーポリシー URL・利用規約 URL・メルマガ説明など)の確認・更新
- メール設定(送信者情報(正式名称・住所・問い合わせ先)・送信元・UTM・開封/クリック計測)の確認・更新
- コンタクトへのタグ付与・メモ追加・スコアのリセット、タグ・テンプレート・セグメントの作成・更新・削除
- シナリオ登録の一時停止・再開・キャンセル、送信失敗の対応済み/再送、メール配信停止の解除
- 状況の確認(読み取り専用): 活動履歴・HOT リード・シナリオの登録状況と成績・配信ログ・送信失敗・配信停止アドレス・売上やダッシュボードの数字・フォームの成績
APIキーを発行する
「設定」→「APIキー」→「新しいAPIキーを作成」
用途がわかるキー名(例: Zapier 連携用)と、必要なら有効期限を設定します。テナントあたり有効なキーは 5 件までです。
権限を選ぶ
そのキーで実行できる操作をチェックボックスで選びます(下の「権限の一覧」を参照)。必要最小限にしてください。権限は発行後に変更できません。変更したいときは新しいキーを作成し、古いキーを無効化します。
Claude 連携用のキーなら「Claude 連携(MCP)のおすすめ設定を選ぶ」ボタンで、参照・作成・更新の権限をまとめて選べます(送信と削除は含まれないので、必要なら個別に追加してください)。
表示されたキーをコピーして保管
rl_ で始まるキーはこの画面でしか表示されません。安全な場所に保存してください。
画面イメージ(権限の選択)
権限
赤字の権限は影響が大きい操作です。既定ではオフになっています。
権限の一覧
| 権限 | できること | 既定 |
|---|---|---|
| contacts:read | コンタクトの一覧・詳細を取得 | オフ |
| contacts:create | メールアドレスでコンタクトを登録し、タグを付与 | オン |
| contacts:update | タグの付与・解除、メモの追加、スコアのリセット、メール配信停止 | オフ |
| contacts:delete | コンタクトを物理削除(取り消し不可) | オフ |
| broadcasts:read | 配信の一覧・詳細・対象者数を取得 | オン |
| broadcasts:write | 配信下書きの作成・編集、予約のキャンセル | オン |
| broadcasts:send | 即時送信・予約送信(実際にメッセージが送られます) | オフ |
| scenarios:read | シナリオとステップ、タグ付けリンクを取得 | オフ |
| scenarios:write | シナリオの作成(JSON の一括取り込みを含む。取り込みでは名前で指定したタグが無ければ作る)・更新(有効化/無効化)、ステップの追加・更新・並び替え、タグ付けリンクの作成、登録の一時停止・再開・キャンセル | オフ |
| scenarios:delete | シナリオやステップ、タグ付けリンクを物理削除(送信履歴・開封/クリック履歴も消える。取り消し不可) | オフ |
| scenarios:test_send | 実際に送る権限です。指定したコンタクトに、ステップを 1 通だけ試し送りします(実際にメッセージが届きます。件名・本文の先頭に「【テスト送信】」が付きます)。画面の表示は「シナリオ・ステップの試し送り」。scenarios:write だけでは送れません | オフ |
| forms:read | 公開フォームの一覧と登録フォーム設定を取得 | オフ |
| forms:write | 公開フォームを作成・更新、登録フォーム設定(規約 URL・メルマガ説明・登録特典など)を更新 | オフ |
| forms:delete | 公開フォームを削除(ダウンロード履歴も消える。取り消し不可) | オフ |
| resources:read | タグ・セグメント・テンプレート・ファイルの一覧を取得 | オン |
| resources:write | タグ・テキストテンプレート・セグメントの作成・更新、ファイル(PDF)のアップロード | オフ |
| resources:delete | タグ・テンプレート・セグメント・ファイルを削除(取り消し不可) | オフ |
| analytics:read | 売上サマリー・シナリオ成績・ダッシュボード指標・フォーム統計の取得 | オフ |
| delivery:read | 送信失敗と配信停止アドレスの一覧・詳細を取得 | オフ |
| delivery:write | 送信失敗の解決・再送、配信停止の解除(再送は実際にメッセージが送られ、解除はバウンス・苦情の保護を外します) | オフ |
| files:share | ファイル(PDF)の期限付きダウンロード URL の発行(URL を知っている人は期限まで誰でもダウンロードできます。発行後は取り消せません) | オフ |
| settings:read | メール設定(送信元・送信者情報(正式名称・住所・問い合わせ先)・UTM・開封/クリック計測・送信ドメインと DNS レコード)と屋号・会社名を取得 | オフ |
| settings:write | メール設定(送信元・送信者情報(正式名称・住所・問い合わせ先)・UTM・開封/クリック計測)と屋号・会社名を更新、送信ドメインを登録(認証後、送信元アドレスがそのドメインのときに使われます) | オフ |
赤字の権限(送信・試し送り・再送・停止解除・削除)は、キー作成画面でも「影響の大きい権限」として警告表示されます。いずれも既定ではオフです。
運営からのお知らせの取得と既読(announcements:read)は、選ばなくてもすべてのキーで使えます(運営からのお知らせ)。
API の応答には、そのキーの未読のお知らせの数が X-Reloura-Unread-Announcements ヘッダで付きます。
以前に発行したキーについて
権限機能の導入前に発行したキーには、当時できた操作(コンタクト登録・配信の参照/作成/送信・補助リソースの参照)だけが付いています。コンタクトの一覧・更新・削除やシナリオ・フォームの作成を API から使うには、必要な権限を付けた新しいキーを発行してください。
API の使い方
すべてのリクエストに Authorization: Bearer あなたのAPIキー ヘッダーを付けます。URL は https://あなたのドメイン/api/v1/... です。
送受信は JSON、ID はすべて管理画面には表示されない公開 ID(UUID)です。
例: コンタクトを登録してタグを付ける
curl -X POST https://あなたのドメイン/api/v1/contacts \
-H "Authorization: Bearer rl_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"email": "user@example.com", "name": "山田太郎", "tags": ["資料請求"]}'
例: シナリオを作ってステップを追加し、有効化する
# 1. タグ ID を調べる(resources:read)
curl https://あなたのドメイン/api/v1/tags -H "Authorization: Bearer rl_xxxxxxxx"
# 2. シナリオを作成(scenarios:write)— 作成直後は無効
curl -X POST https://あなたのドメイン/api/v1/scenarios \
-H "Authorization: Bearer rl_xxxxxxxx" -H "Content-Type: application/json" \
-d '{"name": "ウェルカム", "channel": "email", "trigger_tag_ids": ["タグのID"]}'
# 3. ステップを追加(末尾に追加される)
curl -X POST https://あなたのドメイン/api/v1/scenarios/シナリオのID/steps \
-H "Authorization: Bearer rl_xxxxxxxx" -H "Content-Type: application/json" \
-d '{"subject": "ご登録ありがとうございます", "body": "本文…", "send_after_days": 0, "send_at_time": "09:00"}'
# 4. 有効化(ステップが 1 件以上必要)
curl -X PUT https://あなたのドメイン/api/v1/scenarios/シナリオのID \
-H "Authorization: Bearer rl_xxxxxxxx" -H "Content-Type: application/json" \
-d '{"is_enabled": true}'
主なエンドポイント
| 操作 | メソッドとパス | 必要な権限 |
|---|---|---|
| コンタクト登録 | POST /contacts | contacts:create |
コンタクト一覧・詳細(一覧は最初の登録の UTM(first_utm_source・first_utm_medium・first_utm_campaign・first_utm_content)で絞れます。詳細の first_touch に最初の登録の経路) | GET /contacts、GET /contacts/{id} | contacts:read |
| タグを外す | DELETE /contacts/{id}/tags/{tagId} | contacts:update |
| メール配信停止 | POST /contacts/{id}/email-unsubscribe | contacts:update |
| コンタクト削除 | DELETE /contacts/{id} | contacts:delete |
| LINE 配信 | /broadcasts…(一覧・作成・送信・予約・キャンセル) | broadcasts:* |
| メール配信 | /email-broadcasts…(同上) | broadcasts:* |
| シナリオ | GET/POST /scenarios、GET/PUT /scenarios/{id} | scenarios:read / write |
| シナリオの一括取り込み(管理画面の JSON インポートと同じ JSON を本文に) | POST /scenarios/import | scenarios:write |
| タグ付けリンクの一覧・作成 | GET /tagging-links、POST /tagging-links | scenarios:read / write |
| ステップ追加・更新・並び替え | POST /scenarios/{id}/steps、PUT /scenarios/{id}/steps/{stepId}、POST /scenarios/{id}/steps/reorder | scenarios:write |
| ステップ削除・シナリオ削除 | DELETE /scenarios/{id}/steps/{stepId}、DELETE /scenarios/{id} | scenarios:delete |
| タグ付けリンクの削除 | DELETE /tagging-links/{id} | scenarios:delete |
ステップの試し送り(指定したコンタクトに 1 通だけ実際に送る。本文に contact_id) | POST /scenarios/{id}/steps/{stepId}/test-send | scenarios:test_send |
| 公開フォーム | GET/POST /optin-forms | forms:read / write |
| 登録フォーム設定 | GET/PUT /form-settings | forms:read / write |
| メール設定 | GET/PUT /mail-settings | settings:read / write |
| 送信ドメインの一覧(状態・DNS レコード)・登録 | GET/POST /mail-settings/sending-domains | settings:read / write |
| タグ・セグメント・テンプレート・ファイル一覧 | GET /tags、/segments、/message-templates、/files | resources:read |
| 操作(コンタクト・タグ・シナリオ登録・送信失敗・テンプレート・フォーム・セグメント) | ||
| タグを付ける・メモを追加・スコアをリセット | POST /contacts/{id}/tags、POST /contacts/{id}/notes、POST /contacts/{id}/score/reset | contacts:update |
| タグの作成・更新 | POST /tags、PUT /tags/{id} | resources:write |
| タグ削除の影響確認 | GET /tags/{id}/impact | resources:read |
| タグ削除 | DELETE /tags/{id} | resources:delete |
| シナリオ登録の一時停止・再開・キャンセル | POST /scenarios/{id}/enrollments/{eid}/pause、…/resume、…/cancel | scenarios:write |
| 送信失敗を対応済みにする・未対応に戻す・再送 | POST /delivery-failures/{id}/resolve、…/unresolve、…/retry | delivery:write |
| メール配信停止の解除 | POST /email-suppressions/{id}/unsuppress | delivery:write |
| テンプレートの作成・更新(テキストのみ) | POST /message-templates、PUT /message-templates/{id} | resources:write |
| テンプレート削除 | DELETE /message-templates/{id} | resources:delete |
| 公開フォームの更新 | PUT /optin-forms/{id} | forms:write |
| 公開フォーム削除 | DELETE /optin-forms/{id} | forms:delete |
| セグメントの詳細(条件と該当数) | GET /segments/{id} | resources:read |
| セグメントの作成・更新・該当数の試算 | POST /segments、PUT /segments/{id}、POST /segments/preview | resources:write |
| セグメント削除 | DELETE /segments/{id} | resources:delete |
| ファイル(PDF)のアップロード | POST /files(multipart/form-data の file) | resources:write |
| ファイルの期限付きダウンロード URL の発行 | POST /files/{id}/download-url | files:share |
| ファイル削除 | DELETE /files/{id} | resources:delete |
| 状況の確認(読み取り専用) | ||
| コンタクトの活動履歴 | GET /contacts/{id}/activities | contacts:read |
| HOT リード一覧 | GET /hot-leads | contacts:read |
| シナリオの登録状況 | GET /scenarios/{id}/enrollments | scenarios:read |
| シナリオの成績(CVR・ステップ別) | GET /scenarios/{id}/stats | analytics:read |
| 配信ログ(LINE・メール) | GET /broadcasts/{id}/logs、GET /email-broadcasts/{id}/logs | broadcasts:read |
| 送信失敗の一覧・詳細 | GET /delivery-failures、GET /delivery-failures/{id} | delivery:read |
| 配信停止アドレス一覧 | GET /email-suppressions | delivery:read |
| 売上サマリー・ダッシュボード指標 | GET /analytics/revenue、GET /analytics/dashboard | analytics:read |
公開フォームの成績(utm_by で UTM の内訳を分ける項目を選べます。例: utm_by=content で記事ごと) | GET /optin-forms/{id}/stats | analytics:read |
パラメータやレスポンスの詳細は OpenAPI 仕様書(docs/openapi-v1.yaml)にまとめています。必要な場合はサポートまでお問い合わせください。
知っておきたい動作
- コンタクト登録は重複しません。同じメールアドレスを再送してもタグが追加されるだけです。
- 登録したアドレスには確認メールが届き、確認されるまでメールを送りません(2026 年 11 月に変更)。
POST /contactsで登録したアドレスは「確認待ち」(応答のemail_statusがunconfirmed、email_verified_atは null)になり、そのアドレスに確認メールを送ります。確認メールを送るのは、opt_in_request(本人がこの事業者からの広告・宣伝を含むメールの受信を申し込んだことの申告)を付けたときだけです(2026 年 11 月から)。opt_in_requestには、申し込みを受けた日時(received_at。タイムゾーン付き・今より先は不可)・経路(channel)・証跡をたどる参照(detail。フォーム名・イベント名・受付番号など)を入れます。名刺の交換や問い合わせでアドレスを伝えられただけのときは付けないでください。付けないと、コンタクトの作成・タグの付与は行いますが確認メールは送らず、応答のemail_confirmation_skipped_reasonがopt_in_request_missingになります。申告は呼び出し元の責任で記録され、確認メールと確認ページには「(送信者名)から、お知らせや商品・サービスのご案内など、広告・宣伝を含むメールを受け取ります。」と表示されます。本人が確認メールのリンクを開き、確認ページの「受け取る」を押すとverifiedになり、一斉配信・ステップメールの対象になります。タグの付与・シナリオへの登録はすぐ行われますが、ステップメールは確認されるまで保留されます(コンタクトの作成・タグ付与は配信の許可を意味しません)。以前は登録したアドレスを確認済みとして扱っていました。確認されたかはGET /contacts/{id}のemail_statusで確かめてください(grandfatheredは変更前に登録された未確認のアドレスで、従来どおり送ります)。確認メールは非同期で、応答のemail_confirmation_requestedは送信を依頼したかを表します。確認リンクが有効(24 時間)な間は再登録しても重ねて送らず、期限切れの後の再登録で送り直します。テナントごとに 1 時間 200 通までで、共有ドメインの 1 日の送信上限にも数えます。 - 共有ドメインからの送信には 1 日の上限と自動停止があります。独自ドメインを設定していないテナントのメールは共有ドメインから送られ、1 日 2,000 通まで(確認メールを含む)です。対象数が本日の残りを超えるメール一斉配信は送信できず(
POST /email-broadcasts/{id}/sendが422 platform_send_limit_exceeded)、バウンス・苦情が多く自動停止されている間は422 platform_sending_suspendedになります。本日の送信数と状態はGET /mail-settingsのplatform_sendingで確かめられます。 - シナリオは無効の状態で作られます。ステップを追加してから有効化してください。有効化はその後にタグが付いたコンタクトから登録を始めます(すでにタグを持つ人は遡って登録されません)。無効化すると進行中の登録はすべてキャンセルされます。
- 一括取り込み(
POST /scenarios/import)は管理画面の JSON インポートと同じです。本文に画面と同じ JSON を送ると、無効の状態でシナリオとステップを作ります。タグは名前で指定し、無い名前のタグは新しく作られます(名前を誤ると新しいタグができるので、先にGET /tagsで確かめてください)。どこかで失敗すると何も作られません。同じ新しいタグ名を含む取り込みは、同時に送らず順に送ってください。 - 配信の対象は
target_modeで明示します(2026 年 11 月に変更)。全コンタクトに送るときはtarget_mode=all、タグで絞るときはtarget_mode=tagsとtag_ids(1 件以上必須)、セグメントはtarget_mode=segmentとsegment_idです。以前はtagsでタグを省くと全コンタクトへの下書きになっていましたが、エラー(422)になりました。更新でタグを外して全コンタクトにするときもtarget_mode=allを指定します。応答のtarget_modeで確定した対象が分かるので、送信前に対象者数(GET /broadcasts/{id}/target-count)と合わせて確かめてください。管理画面の配信作成は今までどおり、タグを選ばなければ全コンタクトに送ります。 - タグ付けリンク(
POST /tagging-links)が残っている間は、そのタグを削除できません。要るものだけ作り、不要になったらDELETE /tagging-links/{id}(scenarios:delete)か、管理画面のタグ管理の「ステップに結び付いていないタグ付けリンク」から削除してください。削除すると、すでに送ったメールのそのリンクは開いても 404 になり、タグも付かなくなります(クリック履歴も消えます)。メールの本文で使っている間は削除できません(409)。応答のvariableをステップの本文に書くと、送信時にその人専用の URL になります(メールのシナリオだけ。一斉配信と LINE では展開されません)。作るときにrequires_confirmation: trueを付けると、開いた人が確認の画面のボタンを押したときにタグを付けるリンクになります(会社のメールのセキュリティの仕組みが先に開いてもタグが付きません。作った後には変えられません)。 - ステップの編集・削除・並び替え。更新は送ったキーだけ反映されます(LINE はテンプレートと本文を切り替え可能。Flex や画像のステップは管理画面でのみ編集できます)。削除するとそのステップの送信・開封・クリック履歴も消え、残りの番号は 1 から詰め直されます。並び替えで待機時間を過ぎた未送信ステップを前に移すと、進行中の登録に対して次回の処理ですぐ送信されます。
- シナリオ削除は取り消せません。有効なシナリオは削除できないので、先に無効化してください(無効化で進行中の登録はキャンセルされます)。登録・送信・開封/クリックの履歴がすべて消えます。タグやコンタクトは残ります。
- 公開フォームは非公開の状態で作られます。公開(有効化)には登録フォーム設定でプライバシーポリシー URL と利用規約 URL の登録が必要です(API では
PUT /form-settings)。作成・更新では、名前の欄(name_field・name_label)とメール受信の同意文(consent_text)も設定できます。一覧のembed_codeは、自分のサイトに貼る埋め込みコードです(公開フォームを参照)。 - 登録フォーム設定・メール設定は送った項目だけが変わります。プライバシーポリシー URL・利用規約 URL・送信者情報(住所
footer_address・正式名称sender_legal_name・問い合わせ先inquiry_contact)は、公開フォームやメール配信に欠かせないため API からは空にできません(外す場合は管理画面から)。問い合わせ先は電話番号・メールアドレス・URL のどれか 1 つだけを指定します(説明文付きは 422)。応答のsender_disclosureで、足りない項目(missing)・今送信と受付を止めている項目(blocking)・期限日(required_from)を確認できます。期限日の後に足りないと、メール配信の送信・予約は 422、確認メールを送るコンタクトの登録は422 sender_disclosure_incompleteになります。ロゴ・特典画像は管理画面で行います。メール設定のtenant_nameで屋号・会社名(確認メールの件名などに使われます)も確認・変更できます(空にはできず、他のテナントと同じ名前や、「Reloura」「リローラ」・「@」・見えない文字・URL(「://」「www.」)を含む名前は使えません)。送信元アドレスは認証済みの送信ドメインのアドレスのときだけ実際に使われ、応答のeffective_from_addressで確認できます(null はシステム既定の送信元)。 - 停止タグと配信時間帯(2026 年 11 月から)。シナリオの作成・更新で
stop_tag_ids(停止タグ。メール・LINE)、メールはsend_hour_start/send_hour_end(配信時間帯。0〜23 の時。両方を一緒に指定)、メールのステップの追加・更新でstop_if_tag_id(停止条件)を指定できます。停止タグが付いた人は、どのステップにいても以降を送らずに登録がcompletedになり(完了時タグと完了の加点は付きません)、登録一覧のstop_tag_nameにタグ名が入ります。トリガータグと同じタグは停止タグにできません(422)。シナリオの取り込みでもstop_tags(タグ名)・配信時間帯・メールのステップのadvance_on_open/advance_on_click/resend_if_no_open_days/stop_if_tagを指定できます。停止タグに使っているタグは削除できません。 - 配列の入力には件数の上限があります(2026 年 11 月から)。配信の
tag_ids・シナリオの取り込みのtrigger_tags/completion_tags/stop_tagsは 50 件まで、セグメントのconditionsは 10 件まで、ステップの並べ替えのorderは 500 件までです。超えると 422 になります。 - コンタクトの登録は、同じメールアドレスでは 1 件にまとまります。前後の空白を除き小文字にして比べ、既にあればそのコンタクトを更新します(200)。同時に同じアドレスを登録しても 2 件にはなりません。
- 送信ドメインは一覧で状態・認証されていない理由・DNS に追加するレコード(DKIM の CNAME 3 件は必須、SPF の TXT は推奨)を確認でき、
POST /mail-settings/sending-domainsで登録できます(管理画面の「追加」と同じ検査。1 日 3 件まで、1 キーあたり 1 分 6 回まで。混み合っているときは 503 になるので時間をおいて再試行してください)。削除と認証チェック(認証失敗からの再確認)は管理画面で行います。登録から 7 日たっても認証されていないドメインは自動で削除されます。 - メール設定の権限(settings:read / settings:write)は 2026 年 10 月に追加しました。それより前に発行したキーには付いていないので、使う場合は新しいキーを発行してください(キーの権限は後から変更できません)。
- メール配信停止は管理画面の「配信停止アドレスに追加」と同じで、一斉配信とステップメールの両方が止まります。LINE には影響しません。解除は管理画面の「配信停止アドレス」か、API の
POST /email-suppressions/{id}/unsuppress(delivery:write)から行います。 - ファイルのアップロードは multipart/form-data で送ります(PDF・5MB まで、1 キーあたり 1 分 10 回まで)。例:
curl -H "Authorization: Bearer <APIキー>" -F file=@資料.pdf https://reloura.one/api/v1/files。テナントあたり 200 件・合計 500MB が上限です。8MB を超える送信はサーバーが受け付けず 413 になります。 - ファイルのダウンロード URLは期限(1〜7 日、既定 7 日)付きで、URL を知っている人はログインなしでダウンロードできます。発行後は取り消せないので、共有先に注意してください。発行には専用の権限 files:share が必要です(既定ではオフ)。
- ファイル削除は取り消せません。ステップメールの添付・公開フォームの配布ファイルとして使用中、または配布済みで期限内のダウンロードリンクがあるファイルは削除できず、理由の一覧付きで 409 になります。削除するとそのファイルの特典ダウンロード履歴も消えます。
- コンタクト削除は取り消せません。タグ・シナリオ登録・配信履歴ごと消えます。送信中の配信に含まれている間は削除できず、エラー(409)になります。配信完了後にやり直してください。行を残す記録からも個人情報を消します(LINE のメッセージ・キーワード応答の本文、売上の購入者メール、LINE の受信イベント)。公開フォームの同意の記録(確認済み)は法定の保存のため、アドレス・フォーム・同意文・日時だけ 3 年間残します。配信停止・バウンス・苦情の記録は残り、同じアドレスを登録し直してもメールは送られません。
- 売上などの金額は「最小通貨単位」で返ります。日本円なら円そのまま、米ドルならセント単位です(売上サマリーの
amount_unitは常にminor)。通貨が混在する場合は通貨別の内訳(by_currency)を見てください。 - HOT リードは「30 日以内」が対象です。管理画面の HOT リード一覧と同じく、直近 30 日以内に HOT と判定され、今も HOT タグが付いている人だけが返ります。既定では「未対応」(HOT になってからメモの追加や案内の送信をしていない人)だけで、
filter=allで対応済みも含められます。送信失敗の一覧も既定は「未解決・7 日以内」です。 - API 経由の操作は「API キー」が行った操作として記録されます。
- 活動履歴: メモの追加・スコアのリセット・シナリオ登録の一時停止/再開/キャンセル・タグ付与・配信停止と解除・コンタクト登録は、要約に「API経由:」(登録・配信停止は「API経由で…」)が付き、活動履歴 API の
actorに{"type":"api_key","name":"キーの名前"}が入ります。タグ付与から続けて起きた加点・HOT 判定・シナリオ登録にも「API経由:」が付きます(actorは空です)。 - 実行者の記録: 送信失敗の対応・再送、登録の一時停止、配信停止の解除は、実行者として API キーが記録されます(送信失敗の詳細画面には「API キー「キーの名前」」と表示されます。送信失敗の対応・再送は活動履歴には出ません)。
- HOT リードの「対応済み」にはメモの追加だけが数えられます(スコアのリセット・登録の一時停止/再開/キャンセル・配信停止の解除・タグ付与は数えられません)。
- 活動履歴: メモの追加・スコアのリセット・シナリオ登録の一時停止/再開/キャンセル・タグ付与・配信停止と解除・コンタクト登録は、要約に「API経由:」(登録・配信停止は「API経由で…」)が付き、活動履歴 API の
- API キーは削除できず、無効化(失効)だけができます。無効化したキーも、過去に行った操作の実行者として記録・表示され続けます。
- 書き込み操作は監査ログに残ります。API キーで行った作成・更新・削除・送信などは、成功・失敗(権限不足・入力エラーなど)にかかわらず「いつ・どのキーで・何に対して・結果」を 400 日間記録しています(本文やメールアドレスは記録しません)。キーが無効な場合・契約が停止中の場合・回数制限を超えた場合は記録されません。API の応答にはリクエスト ID(
X-Request-Idヘッダ)が付くので、お問い合わせの際はこの値をお知らせください。 - タグの削除は参照があるとエラー(409)になります。シナリオ・配信(一時停止中を含む)・キーワード応答・LINE フォロー時の自動タグ・公開フォーム・メール追跡リンク・セグメントの条件などが使っている間は削除できず、理由がすべて返ります。削除すると付いているコンタクトからタグが外れるので、事前に
GET /tags/{id}/impactで人数と影響を確認してください。HOT タグは削除も名前の変更もできません。 - セグメントの条件は、予約中・送信中・一時停止中の配信が参照している間は変更できません。配信は送信するときにその時点の条件で宛先を決めるためです(名前・説明は変更できます)。下書き・予約中・送信中・一時停止中の配信が参照しているセグメントは削除もできません。
- 公開フォームは公開中は削除できません。先に非公開にしてください。確認待ちのメール確認リンクや有効なダウンロードリンクが残っている間も削除できません(期限切れまで待ちます)。削除するとダウンロード履歴は消えますが、登録済みのコンタクトやタグは残ります。
- シナリオ登録をキャンセル・一時停止しても、すでに送信待ちに入ったステップは送られることがあります。ステップの送信タイミング直前に操作した場合は、次のステップが届く可能性があることを踏まえてください。キャンセルした登録は再開できません。
- ステップの試し送り(
POST /scenarios/{id}/steps/{stepId}/test-send)は実際に送ります(2026 年 11 月から)。保存してあるステップを、本文のcontact_idのコンタクト 1 人に 1 通だけその場で送ります(文面を直すときは先にステップを更新してください)。件名の先頭・メール本文の一番上・LINE の本文の先頭に「【テスト送信】」が付きます。送信の記録・活動履歴・開封とクリックの計測・タグ(タグ付けリンクは移り先の URL のまま入ります。送信時のタグも付きません)は残りません。配信停止のリンクは本物で、押されるとその人は配信停止になります。配信時間帯・停止タグ・シナリオの有効/無効・登録の有無は見ません。- 送らないとき(422): メールはアドレスが無い・未確認・本人が配信停止・配信停止中、メール設定や送信者情報の欠け、送信元の独自ドメインの停止、共有ドメインの停止・1 日の上限。LINE は友だちでない・LINE チャネルの設定が無い・本文が空・「【テスト送信】」を含めて 5,000 文字を超える。リッチメッセージ形式のステップは 409。
errorに理由のコード、messageに説明が入ります - 回数の上限: 1 時間に API キーごと 20 通・アカウントごと 50 通・同じコンタクトへ 5 通(超えると 429 で送りません)。共有ドメインから送るメールは 1 日の上限を 1 通分使います(送信に失敗しても戻りません)
- 送れたか分からないとき(502
send_result_unknown)は、受け取った人に確かめてから送り直してください(同じリクエストを繰り返すと 2 通目が届くことがあります)。LINE が断ったときは 502send_failed - 権限 scenarios:test_send は 2026 年 11 月に追加しました。それより前に発行したキーには付いていないので、使う場合は新しいキーを発行してください。監査ログには宛先のコンタクトの ID も残ります
- 送らないとき(422): メールはアドレスが無い・未確認・本人が配信停止・配信停止中、メール設定や送信者情報の欠け、送信元の独自ドメインの停止、共有ドメインの停止・1 日の上限。LINE は友だちでない・LINE チャネルの設定が無い・本文が空・「【テスト送信】」を含めて 5,000 文字を超える。リッチメッセージ形式のステップは 409。
- 送信失敗の再送と配信停止の解除は影響が大きい操作です。再送は実際に LINE メッセージが送られ、配信停止の解除はバウンス・苦情による保護を外します。対応済みの失敗は再送できず、対応済み/未対応の切り替えも「すでにその状態」のときはエラー(409)になります。
エラーの見方
| ステータス / error | 意味と対処 |
|---|---|
| 401 unauthorized | キーが無効・期限切れ・無効化済み、または未指定。キーを確認してください |
| 403 insufficient_scope | キーに権限がありません。required_scope に必要な権限名が入ります。その権限を付けたキーを発行してください |
| 403 subscription_inactive | 契約が停止中です。請求状況を確認してください |
| 404 not_found | 指定した ID のデータがありません(他のテナントのデータも「見つからない」扱いになります) |
| 409 conflict | 状態が競合しています(送信中のコンタクト削除、下書き以外の配信の編集、参照があるタグ・セグメント・テンプレートの削除など)。message に理由が入ります(タグ削除は blocking_reasons に全理由)。参照を外すか、少し待って再実行してください |
| 422 validation_error | 入力値の誤り。details に項目ごとのメッセージが入ります |
| 429 too_many_requests | 1 分あたり 60 回の上限を超えました。間隔を空けてください(ステップの試し送り・送信ドメインの登録などは別に回数の上限があり、message に理由が入ります) |
ヒント
用途ごとにキーを分けると、不要になったときにそのキーだけ無効化できます。「APIキー」一覧の「最終使用」で、使われていないキーも確認できます。
Reloura One マニュアル