API 参考

一份约定,覆盖面向客户的全部接口。

面向客户的端点均位于 /api/v1 下。旧的 /api 前缀仍供控制台使用,新的服务端集成应使用带版本号的 base URL。

163 documented operations11 resource groupsOpenAPI 3.1 machine-readable contract

身份验证边界

产品集成使用工作区 API 密钥,该密钥还可以读取账户用量、分析数据和 API 密钥元数据。计费变更以及 API 密钥的创建或吊销需要 HTTP-only 浏览器会话,并已作相应标注。

资源

10 operations

邮件与会话

发送、获取、搜索、回复邮件,并查看投递事件。

8 个操作

标签与归档规则

自动或手动将发出和收到的邮件整理到文件夹中。

9 个操作

草稿与附件

借助私有附件存储构建邮件撰写流程。

10 个操作

托管模板

起草、渲染、测试、版本管理、发布和发送可复用的内容。

7 个操作

域名

开通发信身份,并了解 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 错误使用统一、可预测的封装格式。状态码用于区分无效输入、身份验证、资源不存在、冲突、需要付款、安全拦截和用量限制。

错误响应
{
  "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"
}