APIリファレンス

顧客向け機能のすべてを1つの仕様で。

顧客向けのエンドポイントは/api/v1配下で利用できます。従来の/apiプレフィックスはダッシュボード向けに引き続き利用できますが、新しいサーバー連携ではバージョン付きのベースURLを使用してください。

163 documented operations11 resource groupsOpenAPI 3.1 machine-readable contract

認証の境界

プロダクトとの連携にはワークスペースのAPIキーを使います。このキーでは、アカウントの使用量、分析データ、APIキーのメタデータも読み取れます。請求の変更やAPIキーの作成・無効化にはHTTP-onlyのブラウザセッションが必要で、その旨が明記されています。

リソース

10 operations

メールとスレッド

送信、取得、検索、返信、配信イベントの確認。

8件の操作

ラベルと振り分けルール

送受信したメールを、自動または手動でフォルダに整理します。

9件の操作

下書きと添付ファイル

非公開の添付ファイルストレージを使って、メール作成のフローを構築します。

10件の操作

ホスト型テンプレート

再利用可能なコンテンツの下書き、レンダリング、テスト、バージョン管理、公開、送信。

7件の操作

ドメイン

送信者IDを作成し、DNS検証の状態を把握します。

8件の操作

メール受信

アドレスを作成し、受信した会話を扱います。

9 operations

到達率

イベント、レピュテーションの結果、ブロックされた受信者を確認します。

10 operations

Webhooks

Receive signed, retried email events (sent, delivered, delayed, bounced, complained, failed, received) at your own endpoints.

47 operations

Campaigns

Store contacts with their consent basis, tags, and custom fields, organize them into lists with hosted double opt-in signup forms, welcome emails, and public newsletter sites, target segments, import and export CSV files, and send, test, and schedule broadcasts with merge tags, per-list one-click unsubscribe, pre-send checks, bot-filtered open and click reports, and per-recipient outcomes.

36 operations

Automations

Record what contacts do as events, and run timed sequences of emails that start on an event, stop when the contact converts, and share per-person sending limits. Create and edit automations, their emails and language versions, turn them on and off, and add or remove people. Available to enabled workspaces.

9 operations

アカウントと請求

APIキーでアカウントの使用量、分析データ、キーのメタデータを読み取れます。請求の変更やキーの作成・無効化にはダッシュボードのセッションが必要です。

エラーエンベロープ

JSONのエラーは、予測可能な1つのエンベロープ形式を使います。ステータスコードによって、無効な入力、認証、存在しないリソース、競合、支払いの必要、安全のためのブロック、使用量の上限を区別します。

エラーレスポンス
{
  "error": {
    "message": "The sender domain is not verified",
    "status": 403
  }
}

バージョニング

日付ベースのAPIバージョンがこの仕様を識別します。後方互換性のあるフィールドは、同じバージョン内で追加されることがあります。破壊的変更には、新しいバージョン付きのベースパスと、ドキュメント化された移行手順が必要です。

ディスカバリー
{
  "version": "2026-09-07",
  "baseUrl": "https://sendhq.cc/api/v1",
  "openapi": "https://sendhq.cc/openapi.json"
}