APIリファレンス

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

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

ドキュメント化された操作 63件リソースグループ 8個OpenAPI 3.1の機械可読な仕様

認証の境界

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

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

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

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

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

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

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

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

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"
}