Files
Jens Nylander 72ba4eead0 release 0.2.0
A security release: tenant isolation on every path-tenant handler, the
platform:admin scope, globally unique SMTP usernames, the fail-closed
bootstrap gate, and seven RUSTSEC advisories closed. Three of those break
an existing deployment and the changelog marks each one, the object store
swap included - an upgrade keeps the old minio_data volume while Sentio
talks to an empty store.

cargo update took every compatible bump; all 61 direct dependencies were
already on their latest major line.

Gate 7/7 with 752 tests, e2e 19/19.
2026-10-17 12:25:27 +02:00

11369 lines
265 KiB
JSON

{
"openapi": "3.1.0",
"info": {
"title": "Sentio SMTP API",
"description": "Multi-tenant SMTP platform API",
"contact": {
"name": "Truespar Team"
},
"license": {
"name": "MIT OR Apache-2.0",
"identifier": "MIT OR Apache-2.0"
},
"version": "0.2.0"
},
"paths": {
"/health/live": {
"get": {
"tags": [
"Health"
],
"operationId": "liveness",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthResponse"
}
}
}
}
}
}
},
"/health/ready": {
"get": {
"tags": [
"Health"
],
"operationId": "readiness",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReadyResponse"
}
}
}
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReadyResponse"
}
}
}
}
}
}
},
"/track/click/{token}": {
"get": {
"tags": [
"Tracking"
],
"operationId": "track_click",
"parameters": [
{
"name": "token",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"302": {}
}
}
},
"/track/open/{token}": {
"get": {
"tags": [
"Tracking"
],
"operationId": "track_open",
"parameters": [
{
"name": "token",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"image/gif": {}
}
}
}
}
},
"/v1/admin/abuse/bans": {
"get": {
"tags": [
"Abuse"
],
"summary": "GET /v1/admin/abuse/bans -- list currently banned IPs.",
"operationId": "list_bans",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_BanEntry"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"post": {
"tags": [
"Abuse"
],
"summary": "POST /v1/admin/abuse/bans -- ban an IP.",
"operationId": "create_ban",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BanRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "IP banned"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/admin/abuse/bans/{ip}": {
"delete": {
"tags": [
"Abuse"
],
"summary": "DELETE /v1/admin/abuse/bans/{ip} -- unban an IP.",
"operationId": "delete_ban",
"parameters": [
{
"name": "ip",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "IP unbanned"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/admin/abuse/reputation/{ip}": {
"get": {
"tags": [
"Abuse"
],
"summary": "GET /v1/admin/abuse/reputation/{ip} -- get reputation score (with decay).",
"operationId": "get_reputation",
"parameters": [
{
"name": "ip",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_ReputationResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/admin/abuse/reputation/{ip}/reset": {
"post": {
"tags": [
"Abuse"
],
"summary": "POST /v1/admin/abuse/reputation/{ip}/reset -- reset reputation score to zero.",
"operationId": "reset_reputation",
"parameters": [
{
"name": "ip",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Reputation score reset"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/admin/abuse/whitelist": {
"get": {
"tags": [
"Abuse"
],
"summary": "GET /v1/admin/abuse/whitelist -- list dynamically whitelisted IPs.",
"operationId": "list_whitelist",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_WhitelistEntry"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"post": {
"tags": [
"Abuse"
],
"summary": "POST /v1/admin/abuse/whitelist -- add an IP to the dynamic whitelist.",
"operationId": "create_whitelist",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WhitelistRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "IP whitelisted"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/admin/abuse/whitelist/{ip}": {
"delete": {
"tags": [
"Abuse"
],
"summary": "DELETE /v1/admin/abuse/whitelist/{ip} -- remove an IP from the dynamic whitelist.",
"operationId": "delete_whitelist",
"parameters": [
{
"name": "ip",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "IP removed from whitelist"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/admin/errors": {
"get": {
"tags": [
"Errors"
],
"summary": "GET /v1/admin/errors -- list error events.",
"operationId": "list_errors",
"parameters": [
{
"name": "severity",
"in": "path",
"required": true,
"schema": {
"type": [
"string",
"null"
]
}
},
{
"name": "component",
"in": "path",
"required": true,
"schema": {
"type": [
"string",
"null"
]
}
},
{
"name": "error_type",
"in": "path",
"required": true,
"schema": {
"type": [
"string",
"null"
]
}
},
{
"name": "from",
"in": "path",
"required": true,
"schema": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
{
"name": "to",
"in": "path",
"required": true,
"schema": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
{
"name": "limit",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "offset",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_ErrorEventResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/admin/errors/summary": {
"get": {
"tags": [
"Errors"
],
"summary": "GET /v1/admin/errors/summary -- error event summary grouped by component and severity.",
"operationId": "error_summary",
"parameters": [
{
"name": "from",
"in": "path",
"required": true,
"schema": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
{
"name": "to",
"in": "path",
"required": true,
"schema": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_ErrorSummaryResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/admin/errors/{id}": {
"get": {
"tags": [
"Errors"
],
"summary": "GET /v1/admin/errors/{id} -- get a single error event.",
"operationId": "get_error",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_ErrorEventResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/analytics/bounces": {
"get": {
"tags": [
"Analytics"
],
"operationId": "bounces",
"parameters": [
{
"name": "from",
"in": "path",
"required": true,
"schema": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
{
"name": "to",
"in": "path",
"required": true,
"schema": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_BounceStatsResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/analytics/delivery": {
"get": {
"tags": [
"Analytics"
],
"operationId": "delivery",
"parameters": [
{
"name": "from",
"in": "path",
"required": true,
"schema": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
{
"name": "to",
"in": "path",
"required": true,
"schema": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_DeliveryStatsResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/analytics/engagement": {
"get": {
"tags": [
"Analytics"
],
"operationId": "engagement",
"parameters": [
{
"name": "from",
"in": "path",
"required": true,
"schema": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
{
"name": "to",
"in": "path",
"required": true,
"schema": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_EngagementStatsResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/analytics/overview": {
"get": {
"tags": [
"Analytics"
],
"operationId": "overview",
"parameters": [
{
"name": "from",
"in": "path",
"required": true,
"schema": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
{
"name": "to",
"in": "path",
"required": true,
"schema": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_OverviewResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/domains": {
"get": {
"tags": [
"Domains"
],
"operationId": "list_domains",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_DomainResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"post": {
"tags": [
"Domains"
],
"operationId": "create_domain",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDomainRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_DomainResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/domains/{domain_id}/dkim-keys": {
"get": {
"tags": [
"DKIM Keys"
],
"operationId": "list_dkim_keys",
"parameters": [
{
"name": "domain_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_DkimKeyResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"post": {
"tags": [
"DKIM Keys"
],
"operationId": "create_dkim_key",
"parameters": [
{
"name": "domain_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDkimKeyRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_DkimKeyResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/domains/{domain_id}/dkim-keys/rotate": {
"post": {
"tags": [
"DKIM Keys"
],
"operationId": "rotate_dkim_key",
"parameters": [
{
"name": "domain_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RotateDkimKeyRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_DkimKeyResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/domains/{domain_id}/dkim-keys/{id}": {
"delete": {
"tags": [
"DKIM Keys"
],
"operationId": "retire_dkim_key",
"parameters": [
{
"name": "domain_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/domains/{domain_id}/dkim-keys/{id}/dns-record": {
"get": {
"tags": [
"DKIM Keys"
],
"operationId": "get_dkim_dns_record",
"parameters": [
{
"name": "domain_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_DnsRecordResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/domains/{domain_id}/mailboxes": {
"get": {
"tags": [
"Mailboxes"
],
"operationId": "list_mailboxes",
"parameters": [
{
"name": "domain_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_MailboxResponse"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"post": {
"tags": [
"Mailboxes"
],
"operationId": "create_mailbox",
"parameters": [
{
"name": "domain_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateMailboxRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_MailboxResponse"
}
}
}
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/domains/{domain_id}/mailboxes/{id}": {
"get": {
"tags": [
"Mailboxes"
],
"operationId": "get_mailbox",
"parameters": [
{
"name": "domain_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_MailboxResponse"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"put": {
"tags": [
"Mailboxes"
],
"operationId": "update_mailbox",
"parameters": [
{
"name": "domain_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateMailboxRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_MailboxResponse"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"delete": {
"tags": [
"Mailboxes"
],
"operationId": "delete_mailbox",
"parameters": [
{
"name": "domain_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/domains/{id}": {
"get": {
"tags": [
"Domains"
],
"operationId": "get_domain",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_DomainResponse"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"put": {
"tags": [
"Domains"
],
"operationId": "update_domain",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDomainRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_DomainResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"delete": {
"tags": [
"Domains"
],
"operationId": "delete_domain",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/domains/{id}/dns-check": {
"post": {
"tags": [
"Domains"
],
"operationId": "run_dns_check",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_DomainResponse"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/domains/{id}/dns-records": {
"get": {
"tags": [
"Domains"
],
"operationId": "get_dns_records",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_DnsRecordEntry"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/domains/{id}/verify": {
"post": {
"tags": [
"Domains"
],
"operationId": "verify_domain",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyDomainRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_DomainResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/ip-pools": {
"get": {
"tags": [
"IP Pools"
],
"operationId": "list_ip_pools",
"parameters": [
{
"name": "status",
"in": "path",
"required": true,
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/IpPoolStatus"
},
{
"type": "null"
}
]
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_IpPoolResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"post": {
"tags": [
"IP Pools"
],
"operationId": "create_ip_pool",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateIpPoolRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_IpPoolResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/ip-pools/{id}": {
"get": {
"tags": [
"IP Pools"
],
"operationId": "get_ip_pool",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_IpPoolResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"delete": {
"tags": [
"IP Pools"
],
"operationId": "delete_ip_pool",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/ip-pools/{id}/ips": {
"post": {
"tags": [
"IP Pools"
],
"operationId": "add_ips",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IpListRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_IpPoolResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"delete": {
"tags": [
"IP Pools"
],
"operationId": "remove_ips",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IpListRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_IpPoolResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/ip-pools/{id}/status": {
"put": {
"tags": [
"IP Pools"
],
"operationId": "update_ip_pool_status",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateIpPoolStatusRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_IpPoolResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/ip-pools/{id}/tenants": {
"get": {
"tags": [
"IP Pools"
],
"operationId": "list_pool_tenants",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_TenantIpAssignmentResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/messages": {
"get": {
"tags": [
"Messages"
],
"operationId": "list_messages",
"parameters": [
{
"name": "status",
"in": "path",
"required": true,
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/MessageStatus"
},
{
"type": "null"
}
]
}
},
{
"name": "direction",
"in": "path",
"required": true,
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/MessageDirection"
},
{
"type": "null"
}
]
}
},
{
"name": "from",
"in": "path",
"required": true,
"schema": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
{
"name": "to",
"in": "path",
"required": true,
"schema": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
{
"name": "limit",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "offset",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_MessageResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/messages/send": {
"post": {
"tags": [
"Messages"
],
"operationId": "send_message",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SendMessageRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_SendResponse"
}
}
}
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/messages/send-batch": {
"post": {
"tags": [
"Messages"
],
"operationId": "send_batch",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SendMessageRequest"
}
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_BatchResultItem"
}
}
}
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/messages/send-multipart": {
"post": {
"tags": [
"Messages"
],
"operationId": "send_multipart",
"requestBody": {
"description": "A part named `message` holding SendMessageMultipartRequest as JSON, plus zero or more file parts. Each file part may carry X-Sentio-Disposition (attachment|inline) and X-Sentio-Content-Id, the latter required for inline images.",
"content": {
"multipart/form-data": {}
}
},
"responses": {
"200": {
"description": "Accepted for delivery",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_SendResponse"
}
}
}
},
"400": {
"description": "Malformed multipart body or message part",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Missing or invalid credentials",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Sender domain not verified, or all recipients suppressed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/messages/send-raw": {
"post": {
"tags": [
"Messages"
],
"operationId": "send_raw",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SendRawRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_SendResponse"
}
}
}
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/messages/{id}": {
"get": {
"tags": [
"Messages"
],
"operationId": "get_message",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_MessageResponse"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/messages/{id}/attachments": {
"get": {
"tags": [
"Messages"
],
"operationId": "list_attachments",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Message ID",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_AttachmentResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/messages/{id}/events": {
"get": {
"tags": [
"Messages"
],
"operationId": "get_message_events",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_EventResponse"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/messages/{id}/raw": {
"get": {
"tags": [
"Messages"
],
"operationId": "get_message_raw",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"message/rfc822": {}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/messages/{message_id}/attachments/{attachment_id}": {
"get": {
"tags": [
"Messages"
],
"operationId": "download_attachment",
"parameters": [
{
"name": "message_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "attachment_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/octet-stream": {}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/oauth/clients": {
"get": {
"tags": [
"OAuth"
],
"operationId": "list_oauth_clients",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_OAuthClientResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"post": {
"tags": [
"OAuth"
],
"operationId": "create_oauth_client",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateOAuthClientRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_OAuthClientCreatedResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/oauth/clients/{id}": {
"get": {
"tags": [
"OAuth"
],
"operationId": "get_oauth_client",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_OAuthClientResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"delete": {
"tags": [
"OAuth"
],
"operationId": "delete_oauth_client",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "OAuth client deleted"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/oauth/clients/{id}/revoke": {
"post": {
"tags": [
"OAuth"
],
"operationId": "revoke_oauth_client",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_OAuthClientResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/queues/deferred": {
"get": {
"tags": [
"Queues"
],
"operationId": "list_deferred",
"parameters": [
{
"name": "limit",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "offset",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_DeferredMessageResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/queues/pause": {
"post": {
"tags": [
"Queues"
],
"operationId": "pause_queue",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_PauseResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/queues/resume": {
"post": {
"tags": [
"Queues"
],
"operationId": "resume_queue",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_PauseResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/queues/stats": {
"get": {
"tags": [
"Queues"
],
"operationId": "queue_stats",
"parameters": [
{
"name": "from",
"in": "path",
"required": true,
"schema": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
{
"name": "to",
"in": "path",
"required": true,
"schema": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_QueueStatsResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/reports/dmarc": {
"get": {
"tags": [
"Reports"
],
"operationId": "list_dmarc_reports",
"parameters": [
{
"name": "limit",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "offset",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_DmarcReportResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/reports/dmarc/{id}": {
"get": {
"tags": [
"Reports"
],
"operationId": "get_dmarc_report",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_DmarcReportResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/reports/fbl": {
"get": {
"tags": [
"Reports"
],
"operationId": "list_fbl_reports",
"parameters": [
{
"name": "limit",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "offset",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_FblReportResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/reports/fbl/{id}": {
"get": {
"tags": [
"Reports"
],
"operationId": "get_fbl_report",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_FblReportResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/reports/fbl/{id}/process": {
"post": {
"tags": [
"Reports"
],
"operationId": "process_fbl_report",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_FblReportResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/reports/tlsrpt": {
"get": {
"tags": [
"Reports"
],
"operationId": "list_tlsrpt_reports",
"parameters": [
{
"name": "limit",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "offset",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_TlsrptReportResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/reports/tlsrpt/{id}": {
"get": {
"tags": [
"Reports"
],
"operationId": "get_tlsrpt_report",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_TlsrptReportResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/reputation/domains": {
"get": {
"tags": [
"Reputation"
],
"operationId": "list_domain_reputations",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_DomainReputationSummary"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/reputation/domains/{id}": {
"get": {
"tags": [
"Reputation"
],
"operationId": "get_domain_reputation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_DomainReputationSummary"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/reputation/ips/{ip}": {
"get": {
"tags": [
"Reputation"
],
"operationId": "get_ip_reputation",
"parameters": [
{
"name": "ip",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_IpReputationResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/spam/train/ham": {
"post": {
"tags": [
"Spam Training"
],
"operationId": "train_ham",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrainRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Message learned as ham"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/spam/train/spam": {
"post": {
"tags": [
"Spam Training"
],
"operationId": "train_spam",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrainRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Message learned as spam"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/suppressions": {
"get": {
"tags": [
"Suppressions"
],
"operationId": "list_suppressions",
"parameters": [
{
"name": "limit",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "offset",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_SuppressionResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"post": {
"tags": [
"Suppressions"
],
"operationId": "add_suppression",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddSuppressionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_SuppressionResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/suppressions/check": {
"post": {
"tags": [
"Suppressions"
],
"operationId": "check_suppression",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CheckSuppressionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_CheckResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/suppressions/{email}": {
"get": {
"tags": [
"Suppressions"
],
"operationId": "get_suppression",
"parameters": [
{
"name": "email",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_SuppressionResponse"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"delete": {
"tags": [
"Suppressions"
],
"operationId": "remove_suppression",
"parameters": [
{
"name": "email",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/tenants": {
"get": {
"tags": [
"Tenants"
],
"operationId": "list_tenants",
"parameters": [
{
"name": "status",
"in": "path",
"required": true,
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/TenantStatus"
},
{
"type": "null"
}
]
}
},
{
"name": "limit",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "offset",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_TenantResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"post": {
"tags": [
"Tenants"
],
"operationId": "create_tenant",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTenantRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_TenantResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/tenants/{id}": {
"get": {
"tags": [
"Tenants"
],
"operationId": "get_tenant",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_TenantResponse"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"put": {
"tags": [
"Tenants"
],
"operationId": "update_tenant",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTenantRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_TenantResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"delete": {
"tags": [
"Tenants"
],
"operationId": "delete_tenant",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/tenants/{id}/status": {
"put": {
"tags": [
"Tenants"
],
"operationId": "update_tenant_status",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTenantStatusRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_TenantResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/tenants/{tenant_id}/api-keys": {
"get": {
"tags": [
"API Keys"
],
"operationId": "list_api_keys",
"parameters": [
{
"name": "tenant_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_ApiKeyResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"post": {
"tags": [
"API Keys"
],
"operationId": "create_api_key",
"parameters": [
{
"name": "tenant_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateApiKeyRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_ApiKeyCreatedResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/tenants/{tenant_id}/api-keys/{id}": {
"delete": {
"tags": [
"API Keys"
],
"operationId": "revoke_api_key",
"parameters": [
{
"name": "tenant_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/tenants/{tenant_id}/inbound-routes": {
"get": {
"tags": [
"Inbound Routes"
],
"operationId": "list_inbound_routes",
"parameters": [
{
"name": "tenant_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_InboundRouteResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"post": {
"tags": [
"Inbound Routes"
],
"operationId": "create_inbound_route",
"parameters": [
{
"name": "tenant_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateInboundRouteRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_InboundRouteResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/tenants/{tenant_id}/inbound-routes/{id}": {
"put": {
"tags": [
"Inbound Routes"
],
"operationId": "update_inbound_route",
"parameters": [
{
"name": "tenant_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateInboundRouteRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_InboundRouteResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"delete": {
"tags": [
"Inbound Routes"
],
"operationId": "delete_inbound_route",
"parameters": [
{
"name": "tenant_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/tenants/{tenant_id}/ip-pools": {
"get": {
"tags": [
"IP Pools"
],
"operationId": "list_tenant_pools",
"parameters": [
{
"name": "tenant_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_TenantIpAssignmentResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"post": {
"tags": [
"IP Pools"
],
"operationId": "assign_ip_pool",
"parameters": [
{
"name": "tenant_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssignIpPoolRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_TenantIpAssignmentResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/tenants/{tenant_id}/ip-pools/{pool_id}": {
"put": {
"tags": [
"IP Pools"
],
"operationId": "update_assignment_priority",
"parameters": [
{
"name": "tenant_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "pool_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAssignmentPriorityRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_TenantIpAssignmentResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"delete": {
"tags": [
"IP Pools"
],
"operationId": "unassign_ip_pool",
"parameters": [
{
"name": "tenant_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "pool_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/tenants/{tenant_id}/smtp-credentials": {
"get": {
"tags": [
"SMTP Credentials"
],
"operationId": "list_smtp_credentials",
"parameters": [
{
"name": "tenant_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_SmtpCredentialResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"post": {
"tags": [
"SMTP Credentials"
],
"operationId": "create_smtp_credential",
"parameters": [
{
"name": "tenant_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateSmtpCredentialRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_SmtpCredentialResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/tenants/{tenant_id}/smtp-credentials/{id}": {
"delete": {
"tags": [
"SMTP Credentials"
],
"operationId": "delete_smtp_credential",
"parameters": [
{
"name": "tenant_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/tenants/{tenant_id}/smtp-credentials/{id}/enabled": {
"put": {
"tags": [
"SMTP Credentials"
],
"operationId": "update_smtp_credential_enabled",
"parameters": [
{
"name": "tenant_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateEnabledRequest"
}
}
},
"required": true
},
"responses": {
"204": {},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/tracking-domains": {
"get": {
"tags": [
"Tracking Domains"
],
"operationId": "list_tracking_domains",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_TrackingDomainResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"post": {
"tags": [
"Tracking Domains"
],
"operationId": "create_tracking_domain",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTrackingDomainRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_TrackingDomainResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/tracking-domains/{id}": {
"get": {
"tags": [
"Tracking Domains"
],
"operationId": "get_tracking_domain",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_TrackingDomainResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"delete": {
"tags": [
"Tracking Domains"
],
"operationId": "delete_tracking_domain",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "Tracking domain deleted"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/tracking-domains/{id}/certificate": {
"get": {
"tags": [
"Tracking Domains"
],
"operationId": "get_certificate",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_TrackingCertificateResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"post": {
"tags": [
"Tracking Domains"
],
"operationId": "upload_certificate",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCertificateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_TrackingCertificateResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/tracking-domains/{id}/verify": {
"post": {
"tags": [
"Tracking Domains"
],
"operationId": "verify_tracking_domain",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_TrackingDomainResponse"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/webhooks": {
"get": {
"tags": [
"Webhooks"
],
"operationId": "list_webhooks",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_WebhookResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"post": {
"tags": [
"Webhooks"
],
"operationId": "create_webhook",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateWebhookRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_WebhookResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/webhooks/{id}": {
"get": {
"tags": [
"Webhooks"
],
"operationId": "get_webhook",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_WebhookResponse"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"put": {
"tags": [
"Webhooks"
],
"operationId": "update_webhook",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateWebhookRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_WebhookResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
},
"delete": {
"tags": [
"Webhooks"
],
"operationId": "delete_webhook",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/webhooks/{id}/deliveries": {
"get": {
"tags": [
"Webhooks"
],
"operationId": "list_deliveries",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "limit",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "offset",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_Vec_DeliveryLogResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/v1/webhooks/{id}/test": {
"post": {
"tags": [
"Webhooks"
],
"operationId": "test_webhook",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataResponse_TestWebhookResponse"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
}
},
"components": {
"schemas": {
"AddSuppressionRequest": {
"type": "object",
"required": [
"email",
"reason"
],
"properties": {
"email": {
"type": "string"
},
"reason": {
"$ref": "#/components/schemas/SuppressionReason"
}
}
},
"ApiKeyCreatedResponse": {
"type": "object",
"required": [
"id",
"raw_key"
],
"properties": {
"id": {
"$ref": "#/components/schemas/ApiKeyId"
},
"raw_key": {
"type": "string"
}
}
},
"ApiKeyId": {
"type": "string",
"format": "uuid"
},
"ApiKeyResponse": {
"type": "object",
"required": [
"id",
"key_prefix",
"name",
"scopes",
"created_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"id": {
"$ref": "#/components/schemas/ApiKeyId"
},
"key_prefix": {
"type": "string"
},
"name": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"AssignIpPoolRequest": {
"type": "object",
"required": [
"ip_pool_id"
],
"properties": {
"ip_pool_id": {
"type": "string",
"format": "uuid"
},
"priority": {
"type": "integer",
"format": "int32"
}
}
},
"AttachmentDisposition": {
"type": "string",
"enum": [
"attachment",
"inline"
]
},
"AttachmentId": {
"type": "string",
"format": "uuid"
},
"AttachmentInput": {
"type": "object",
"required": [
"filename",
"content_type",
"data"
],
"properties": {
"content_id": {
"type": [
"string",
"null"
],
"description": "Content-ID for inline attachments (e.g. `<img001>`)."
},
"content_type": {
"type": "string"
},
"data": {
"type": "string",
"description": "Base64-encoded binary content."
},
"disposition": {
"type": "string",
"description": "\"attachment\" (default) or \"inline\"."
},
"filename": {
"type": "string"
}
}
},
"AttachmentResponse": {
"type": "object",
"required": [
"id",
"message_id",
"filename",
"content_type",
"size",
"disposition",
"scan_status",
"created_at"
],
"properties": {
"content_id": {
"type": [
"string",
"null"
]
},
"content_type": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"disposition": {
"$ref": "#/components/schemas/AttachmentDisposition"
},
"filename": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/AttachmentId"
},
"message_id": {
"$ref": "#/components/schemas/MessageId"
},
"scan_result": {
"type": [
"string",
"null"
]
},
"scan_status": {
"$ref": "#/components/schemas/ScanStatus"
},
"size": {
"type": "integer",
"format": "int64"
}
}
},
"BanEntry": {
"type": "object",
"required": [
"ip"
],
"properties": {
"ip": {
"type": "string"
}
}
},
"BanRequest": {
"type": "object",
"required": [
"ip"
],
"properties": {
"duration_secs": {
"type": [
"integer",
"null"
],
"format": "int64",
"minimum": 0
},
"ip": {
"type": "string"
}
}
},
"BatchResultItem": {
"type": "object",
"required": [
"status"
],
"properties": {
"error": {
"type": [
"string",
"null"
]
},
"id": {
"oneOf": [
{
"$ref": "#/components/schemas/MessageId"
},
{
"type": "null"
}
]
},
"status": {
"type": "string"
}
}
},
"BounceClass": {
"type": "string",
"enum": [
"hard",
"soft",
"block"
]
},
"BounceStatsResponse": {
"type": "object",
"required": [
"hard",
"soft",
"block",
"total"
],
"properties": {
"block": {
"type": "integer",
"format": "int64"
},
"hard": {
"type": "integer",
"format": "int64"
},
"soft": {
"type": "integer",
"format": "int64"
},
"total": {
"type": "integer",
"format": "int64"
}
}
},
"CheckResponse": {
"type": "object",
"required": [
"email",
"suppressed"
],
"properties": {
"email": {
"type": "string"
},
"suppressed": {
"type": "boolean"
}
}
},
"CheckSuppressionRequest": {
"type": "object",
"required": [
"email"
],
"properties": {
"email": {
"type": "string"
}
}
},
"ComplaintType": {
"type": "string",
"enum": [
"abuse",
"fraud",
"virus",
"other",
"not-spam"
]
},
"CreateApiKeyRequest": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"CreateCertificateRequest": {
"type": "object",
"required": [
"certificate",
"private_key",
"expires_at",
"renew_after"
],
"properties": {
"certificate": {
"type": "string"
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"intermediaries": {
"type": [
"string",
"null"
]
},
"private_key": {
"type": "string"
},
"renew_after": {
"type": "string",
"format": "date-time"
}
}
},
"CreateDkimKeyRequest": {
"type": "object",
"required": [
"selector"
],
"properties": {
"algorithm": {
"$ref": "#/components/schemas/DkimAlgorithm"
},
"key_size": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "RSA key size (only for RSA). Defaults to 2048."
},
"selector": {
"type": "string"
}
}
},
"CreateDomainRequest": {
"type": "object",
"required": [
"domain_name"
],
"properties": {
"domain_name": {
"type": "string"
},
"use_for_receiving": {
"type": "boolean"
},
"use_for_sending": {
"type": "boolean"
}
}
},
"CreateInboundRouteRequest": {
"type": "object",
"required": [
"pattern",
"match_type",
"webhook_url"
],
"properties": {
"auto_respond": {
"type": "boolean"
},
"auto_respond_config": {
"type": [
"object",
"null"
]
},
"llm_classify": {
"type": "boolean"
},
"match_type": {
"$ref": "#/components/schemas/InboundRouteMatchType"
},
"pattern": {
"type": "string"
},
"priority": {
"type": "integer",
"format": "int32"
},
"webhook_url": {
"type": "string"
}
}
},
"CreateIpPoolRequest": {
"type": "object",
"required": [
"name",
"pool_type"
],
"properties": {
"ips": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"pool_type": {
"$ref": "#/components/schemas/IpPoolType"
}
}
},
"CreateMailboxRequest": {
"type": "object",
"required": [
"address"
],
"properties": {
"address": {
"type": "string"
},
"auto_reply": {
"type": "boolean"
},
"auto_reply_body": {
"type": [
"string",
"null"
]
},
"auto_reply_subject": {
"type": [
"string",
"null"
]
},
"display_name": {
"type": [
"string",
"null"
]
},
"forward_to": {
"type": "array",
"items": {
"type": "string"
}
},
"metadata": {
"type": "object"
}
}
},
"CreateOAuthClientRequest": {
"type": "object",
"required": [
"name"
],
"properties": {
"grant_types": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"redirect_uris": {
"type": "array",
"items": {
"type": "string"
}
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"CreateSmtpCredentialRequest": {
"type": "object",
"required": [
"username",
"password"
],
"properties": {
"password": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"CreateTenantRequest": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"tier": {
"$ref": "#/components/schemas/TenantTier"
}
}
},
"CreateTrackingDomainRequest": {
"type": "object",
"required": [
"domain_name",
"cname_target"
],
"properties": {
"cname_target": {
"type": "string"
},
"domain_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"domain_name": {
"type": "string"
},
"ssl_enabled": {
"type": "boolean"
},
"track_clicks": {
"type": "boolean"
},
"track_opens": {
"type": "boolean"
}
}
},
"CreateWebhookRequest": {
"type": "object",
"required": [
"url",
"event_types"
],
"properties": {
"event_types": {
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"type": "string"
}
}
},
"DataResponse_ApiKeyCreatedResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"raw_key"
],
"properties": {
"id": {
"$ref": "#/components/schemas/ApiKeyId"
},
"raw_key": {
"type": "string"
}
}
}
}
},
"DataResponse_BounceStatsResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"hard",
"soft",
"block",
"total"
],
"properties": {
"block": {
"type": "integer",
"format": "int64"
},
"hard": {
"type": "integer",
"format": "int64"
},
"soft": {
"type": "integer",
"format": "int64"
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
}
},
"DataResponse_CheckResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"email",
"suppressed"
],
"properties": {
"email": {
"type": "string"
},
"suppressed": {
"type": "boolean"
}
}
}
}
},
"DataResponse_DeliveryStatsResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"status_counts"
],
"properties": {
"status_counts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusCountResponse"
}
}
}
}
}
},
"DataResponse_DkimKeyResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"domain_id",
"selector",
"algorithm",
"public_key",
"status",
"created_at"
],
"properties": {
"activated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"algorithm": {
"$ref": "#/components/schemas/DkimAlgorithm"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"domain_id": {
"$ref": "#/components/schemas/DomainId"
},
"id": {
"$ref": "#/components/schemas/DkimKeyId"
},
"key_size": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"public_key": {
"type": "string"
},
"retired_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"selector": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/DkimKeyStatus"
}
}
}
}
},
"DataResponse_DmarcReportResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"domain_id",
"direction",
"report_id",
"date_begin",
"date_end",
"total_count",
"dkim_pass",
"dkim_fail",
"spf_pass",
"spf_fail",
"dmarc_pass",
"dmarc_fail",
"created_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"date_begin": {
"type": "string",
"format": "date-time"
},
"date_end": {
"type": "string",
"format": "date-time"
},
"direction": {
"$ref": "#/components/schemas/MessageDirection"
},
"dkim_fail": {
"type": "integer",
"format": "int32"
},
"dkim_pass": {
"type": "integer",
"format": "int32"
},
"dmarc_fail": {
"type": "integer",
"format": "int32"
},
"dmarc_pass": {
"type": "integer",
"format": "int32"
},
"domain_id": {
"$ref": "#/components/schemas/DomainId"
},
"id": {
"$ref": "#/components/schemas/DmarcReportId"
},
"org_name": {
"type": [
"string",
"null"
]
},
"report_id": {
"type": "string"
},
"source_ip": {
"type": [
"string",
"null"
]
},
"spf_fail": {
"type": "integer",
"format": "int32"
},
"spf_pass": {
"type": "integer",
"format": "int32"
},
"total_count": {
"type": "integer",
"format": "int32"
}
}
}
}
},
"DataResponse_DnsRecordResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"record_type",
"host",
"value"
],
"properties": {
"host": {
"type": "string"
},
"record_type": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"DataResponse_DomainReputationSummary": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"domain_id",
"domain_name",
"dmarc_pass",
"dmarc_fail",
"dmarc_pass_rate",
"fbl_complaints"
],
"properties": {
"dmarc_fail": {
"type": "integer",
"format": "int64"
},
"dmarc_pass": {
"type": "integer",
"format": "int64"
},
"dmarc_pass_rate": {
"type": "number",
"format": "double"
},
"domain_id": {
"$ref": "#/components/schemas/DomainId"
},
"domain_name": {
"type": "string"
},
"fbl_complaints": {
"type": "integer",
"format": "int64"
}
}
}
}
},
"DataResponse_DomainResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"domain_name",
"use_for_sending",
"use_for_receiving",
"status",
"spf_status",
"dkim_status",
"dmarc_status",
"mx_status",
"return_path_status",
"verification_token",
"reject_unknown_recipients",
"created_at",
"updated_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"dkim_error": {
"type": [
"string",
"null"
]
},
"dkim_status": {
"$ref": "#/components/schemas/DnsCheckStatus"
},
"dmarc_error": {
"type": [
"string",
"null"
]
},
"dmarc_status": {
"$ref": "#/components/schemas/DnsCheckStatus"
},
"dns_checked_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"domain_name": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/DomainId"
},
"mx_error": {
"type": [
"string",
"null"
]
},
"mx_status": {
"$ref": "#/components/schemas/DnsCheckStatus"
},
"reject_unknown_recipients": {
"type": "boolean"
},
"return_path_error": {
"type": [
"string",
"null"
]
},
"return_path_status": {
"$ref": "#/components/schemas/DnsCheckStatus"
},
"spf_error": {
"type": [
"string",
"null"
]
},
"spf_status": {
"$ref": "#/components/schemas/DnsCheckStatus"
},
"status": {
"$ref": "#/components/schemas/DomainStatus"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"use_for_receiving": {
"type": "boolean"
},
"use_for_sending": {
"type": "boolean"
},
"verification_token": {
"type": "string"
},
"verified_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
}
}
},
"DataResponse_EngagementStatsResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"opens",
"clicks",
"unsubscribes"
],
"properties": {
"clicks": {
"type": "integer",
"format": "int64"
},
"opens": {
"type": "integer",
"format": "int64"
},
"unsubscribes": {
"type": "integer",
"format": "int64"
}
}
}
}
},
"DataResponse_ErrorEventResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"tenant_id",
"severity",
"component",
"error_type",
"message",
"metadata",
"created_at"
],
"properties": {
"component": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"error_type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"message": {
"type": "string"
},
"message_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"metadata": {},
"request_id": {
"type": [
"string",
"null"
]
},
"severity": {
"type": "string"
},
"stack_trace": {
"type": [
"string",
"null"
]
},
"tenant_id": {
"type": "string",
"format": "uuid"
}
}
}
}
},
"DataResponse_FblReportResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"complained_recipient",
"complaint_type",
"auto_suppressed",
"created_at"
],
"properties": {
"arrival_date": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"auto_suppressed": {
"type": "boolean"
},
"complained_recipient": {
"type": "string"
},
"complaint_type": {
"$ref": "#/components/schemas/ComplaintType"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"feedback_type": {
"type": [
"string",
"null"
]
},
"id": {
"$ref": "#/components/schemas/FblReportId"
},
"processed_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"source_ip": {
"type": [
"string",
"null"
]
}
}
}
}
},
"DataResponse_InboundRouteResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"tenant_id",
"pattern",
"match_type",
"webhook_url",
"priority",
"llm_classify",
"auto_respond",
"created_at"
],
"properties": {
"auto_respond": {
"type": "boolean"
},
"auto_respond_config": {
"type": [
"object",
"null"
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"id": {
"$ref": "#/components/schemas/InboundRouteId"
},
"llm_classify": {
"type": "boolean"
},
"match_type": {
"$ref": "#/components/schemas/InboundRouteMatchType"
},
"pattern": {
"type": "string"
},
"priority": {
"type": "integer",
"format": "int32"
},
"tenant_id": {
"$ref": "#/components/schemas/TenantId"
},
"webhook_url": {
"type": "string"
}
}
}
}
},
"DataResponse_IpPoolResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"name",
"pool_type",
"ips",
"status",
"created_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"id": {
"$ref": "#/components/schemas/IpPoolId"
},
"ips": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"pool_type": {
"$ref": "#/components/schemas/IpPoolType"
},
"status": {
"$ref": "#/components/schemas/IpPoolStatus"
}
}
}
}
},
"DataResponse_IpReputationResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"ip",
"score"
],
"properties": {
"ip": {
"type": "string"
},
"score": {
"type": "number",
"format": "double"
}
}
}
}
},
"DataResponse_MailboxResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"domain_id",
"address",
"status",
"forward_to",
"auto_reply",
"metadata",
"created_at",
"updated_at"
],
"properties": {
"address": {
"type": "string"
},
"auto_reply": {
"type": "boolean"
},
"auto_reply_body": {
"type": [
"string",
"null"
]
},
"auto_reply_subject": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"display_name": {
"type": [
"string",
"null"
]
},
"domain_id": {
"$ref": "#/components/schemas/DomainId"
},
"forward_to": {
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"$ref": "#/components/schemas/MailboxId"
},
"metadata": {
"type": "object"
},
"status": {
"$ref": "#/components/schemas/MailboxStatus"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
}
}
},
"DataResponse_MessageResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"direction",
"envelope_from",
"envelope_to",
"header_to",
"header_cc",
"status",
"tags",
"metadata",
"created_at"
],
"properties": {
"bounced_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"delivered_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"direction": {
"$ref": "#/components/schemas/MessageDirection"
},
"envelope_from": {
"type": "string"
},
"envelope_to": {
"type": "array",
"items": {
"type": "string"
}
},
"header_cc": {
"type": "array",
"items": {
"type": "string"
}
},
"header_from": {
"type": [
"string",
"null"
]
},
"header_reply_to": {
"type": [
"string",
"null"
]
},
"header_to": {
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"$ref": "#/components/schemas/MessageId"
},
"llm_category": {
"type": [
"string",
"null"
]
},
"llm_classified_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"llm_summary": {
"type": [
"string",
"null"
]
},
"message_id_header": {
"type": [
"string",
"null"
]
},
"message_size": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"metadata": {
"type": "object"
},
"send_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"spam_action": {
"type": [
"string",
"null"
]
},
"spam_score": {
"type": [
"number",
"null"
],
"format": "double"
},
"status": {
"$ref": "#/components/schemas/MessageStatus"
},
"subject": {
"type": [
"string",
"null"
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"DataResponse_OAuthClientCreatedResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"description": "Returned only on creation - includes the plaintext client secret.",
"required": [
"id",
"client_id",
"client_secret",
"name",
"redirect_uris",
"grant_types",
"scopes",
"status",
"created_at"
],
"properties": {
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"grant_types": {
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"$ref": "#/components/schemas/OAuthClientId"
},
"name": {
"type": "string"
},
"redirect_uris": {
"type": "array",
"items": {
"type": "string"
}
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"$ref": "#/components/schemas/OAuthClientStatus"
}
}
}
}
},
"DataResponse_OAuthClientResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"client_id",
"name",
"redirect_uris",
"grant_types",
"scopes",
"status",
"created_at",
"updated_at"
],
"properties": {
"client_id": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"grant_types": {
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"$ref": "#/components/schemas/OAuthClientId"
},
"name": {
"type": "string"
},
"redirect_uris": {
"type": "array",
"items": {
"type": "string"
}
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"$ref": "#/components/schemas/OAuthClientStatus"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
}
}
},
"DataResponse_OverviewResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"total_sent",
"delivered",
"bounced",
"deferred",
"dropped",
"delivery_rate",
"bounce_rate"
],
"properties": {
"bounce_rate": {
"type": "number",
"format": "double"
},
"bounced": {
"type": "integer",
"format": "int64"
},
"deferred": {
"type": "integer",
"format": "int64"
},
"delivered": {
"type": "integer",
"format": "int64"
},
"delivery_rate": {
"type": "number",
"format": "double"
},
"dropped": {
"type": "integer",
"format": "int64"
},
"total_sent": {
"type": "integer",
"format": "int64"
}
}
}
}
},
"DataResponse_PauseResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"paused"
],
"properties": {
"paused": {
"type": "boolean"
}
}
}
}
},
"DataResponse_QueueStatsResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"counts",
"paused"
],
"properties": {
"counts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusCountResponse"
}
},
"paused": {
"type": "boolean"
}
}
}
}
},
"DataResponse_ReputationResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"ip",
"score",
"action"
],
"properties": {
"action": {
"type": "string"
},
"ip": {
"type": "string"
},
"score": {
"type": "number",
"format": "double"
}
}
}
}
},
"DataResponse_SendResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"status"
],
"properties": {
"id": {
"$ref": "#/components/schemas/MessageId"
},
"message_id_header": {
"type": [
"string",
"null"
],
"description": "The RFC 5322 Message-ID stamped on the outbound message (bare\n`id@host`, no angle brackets). Lets the sender thread inbound\nreplies against this id. Omitted when unknown."
},
"status": {
"type": "string"
}
}
}
}
},
"DataResponse_SmtpCredentialResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"username",
"mechanisms",
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
},
"id": {
"$ref": "#/components/schemas/SmtpCredentialId"
},
"mechanisms": {
"type": "array",
"items": {
"type": "string"
}
},
"username": {
"type": "string"
}
}
}
}
},
"DataResponse_SuppressionResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"email",
"reason",
"created_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"email": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/SuppressionId"
},
"reason": {
"$ref": "#/components/schemas/SuppressionReason"
}
}
}
}
},
"DataResponse_TenantResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"name",
"tier",
"status",
"verp_enabled"
],
"properties": {
"id": {
"$ref": "#/components/schemas/TenantId"
},
"name": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/TenantStatus"
},
"tier": {
"$ref": "#/components/schemas/TenantTier"
},
"verp_enabled": {
"type": "boolean",
"description": "When `true`, outbound MAIL FROM is rewritten to a VERP bounce return\npath so DSN bounces route back to the message that generated them."
}
}
}
}
},
"DataResponse_TestWebhookResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"success"
],
"properties": {
"error": {
"type": [
"string",
"null"
]
},
"http_status": {
"type": [
"integer",
"null"
],
"format": "int32",
"minimum": 0
},
"response_body": {
"type": [
"string",
"null"
]
},
"success": {
"type": "boolean"
}
}
}
}
},
"DataResponse_TlsrptReportResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"domain_id",
"direction",
"report_id",
"date_begin",
"date_end",
"policy_type",
"total_success",
"total_failure",
"created_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"date_begin": {
"type": "string",
"format": "date-time"
},
"date_end": {
"type": "string",
"format": "date-time"
},
"direction": {
"$ref": "#/components/schemas/MessageDirection"
},
"domain_id": {
"$ref": "#/components/schemas/DomainId"
},
"failure_details": {
"type": [
"object",
"null"
]
},
"id": {
"$ref": "#/components/schemas/TlsrptReportId"
},
"org_name": {
"type": [
"string",
"null"
]
},
"policy_domain": {
"type": [
"string",
"null"
]
},
"policy_type": {
"$ref": "#/components/schemas/TlsrptPolicyType"
},
"report_id": {
"type": "string"
},
"total_failure": {
"type": "integer",
"format": "int32"
},
"total_success": {
"type": "integer",
"format": "int32"
}
}
}
}
},
"DataResponse_TrackingCertificateResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"tracking_domain_id",
"expires_at",
"renew_after",
"created_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"id": {
"$ref": "#/components/schemas/TrackingCertificateId"
},
"renew_after": {
"type": "string",
"format": "date-time"
},
"tracking_domain_id": {
"$ref": "#/components/schemas/TrackingDomainId"
}
}
}
}
},
"DataResponse_TrackingDomainResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"domain_name",
"cname_target",
"dns_status",
"ssl_enabled",
"track_opens",
"track_clicks",
"created_at",
"updated_at"
],
"properties": {
"cname_target": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"dns_checked_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"dns_error": {
"type": [
"string",
"null"
]
},
"dns_status": {
"$ref": "#/components/schemas/DomainStatus"
},
"domain_id": {
"oneOf": [
{
"$ref": "#/components/schemas/DomainId"
},
{
"type": "null"
}
]
},
"domain_name": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/TrackingDomainId"
},
"ssl_enabled": {
"type": "boolean"
},
"track_clicks": {
"type": "boolean"
},
"track_opens": {
"type": "boolean"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
}
}
},
"DataResponse_Vec_ApiKeyResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"key_prefix",
"name",
"scopes",
"created_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"id": {
"$ref": "#/components/schemas/ApiKeyId"
},
"key_prefix": {
"type": "string"
},
"name": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"DataResponse_Vec_AttachmentResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"message_id",
"filename",
"content_type",
"size",
"disposition",
"scan_status",
"created_at"
],
"properties": {
"content_id": {
"type": [
"string",
"null"
]
},
"content_type": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"disposition": {
"$ref": "#/components/schemas/AttachmentDisposition"
},
"filename": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/AttachmentId"
},
"message_id": {
"$ref": "#/components/schemas/MessageId"
},
"scan_result": {
"type": [
"string",
"null"
]
},
"scan_status": {
"$ref": "#/components/schemas/ScanStatus"
},
"size": {
"type": "integer",
"format": "int64"
}
}
}
}
}
},
"DataResponse_Vec_BanEntry": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"ip"
],
"properties": {
"ip": {
"type": "string"
}
}
}
}
}
},
"DataResponse_Vec_BatchResultItem": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"status"
],
"properties": {
"error": {
"type": [
"string",
"null"
]
},
"id": {
"oneOf": [
{
"$ref": "#/components/schemas/MessageId"
},
{
"type": "null"
}
]
},
"status": {
"type": "string"
}
}
}
}
}
},
"DataResponse_Vec_DeferredMessageResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"envelope_from",
"envelope_to",
"status",
"created_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"envelope_from": {
"type": "string"
},
"envelope_to": {
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"$ref": "#/components/schemas/MessageId"
},
"status": {
"$ref": "#/components/schemas/MessageStatus"
},
"subject": {
"type": [
"string",
"null"
]
}
}
}
}
}
},
"DataResponse_Vec_DeliveryLogResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"webhook_id",
"event_type",
"attempt_number",
"created_at"
],
"properties": {
"attempt_number": {
"type": "integer",
"format": "int32"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"delivered_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"error_message": {
"type": [
"string",
"null"
]
},
"event_type": {
"type": "string"
},
"failed_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"http_status": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"id": {
"$ref": "#/components/schemas/WebhookDeliveryLogId"
},
"response_body": {
"type": [
"string",
"null"
]
},
"webhook_id": {
"$ref": "#/components/schemas/WebhookId"
}
}
}
}
}
},
"DataResponse_Vec_DkimKeyResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"domain_id",
"selector",
"algorithm",
"public_key",
"status",
"created_at"
],
"properties": {
"activated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"algorithm": {
"$ref": "#/components/schemas/DkimAlgorithm"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"domain_id": {
"$ref": "#/components/schemas/DomainId"
},
"id": {
"$ref": "#/components/schemas/DkimKeyId"
},
"key_size": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"public_key": {
"type": "string"
},
"retired_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"selector": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/DkimKeyStatus"
}
}
}
}
}
},
"DataResponse_Vec_DmarcReportResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"domain_id",
"direction",
"report_id",
"date_begin",
"date_end",
"total_count",
"dkim_pass",
"dkim_fail",
"spf_pass",
"spf_fail",
"dmarc_pass",
"dmarc_fail",
"created_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"date_begin": {
"type": "string",
"format": "date-time"
},
"date_end": {
"type": "string",
"format": "date-time"
},
"direction": {
"$ref": "#/components/schemas/MessageDirection"
},
"dkim_fail": {
"type": "integer",
"format": "int32"
},
"dkim_pass": {
"type": "integer",
"format": "int32"
},
"dmarc_fail": {
"type": "integer",
"format": "int32"
},
"dmarc_pass": {
"type": "integer",
"format": "int32"
},
"domain_id": {
"$ref": "#/components/schemas/DomainId"
},
"id": {
"$ref": "#/components/schemas/DmarcReportId"
},
"org_name": {
"type": [
"string",
"null"
]
},
"report_id": {
"type": "string"
},
"source_ip": {
"type": [
"string",
"null"
]
},
"spf_fail": {
"type": "integer",
"format": "int32"
},
"spf_pass": {
"type": "integer",
"format": "int32"
},
"total_count": {
"type": "integer",
"format": "int32"
}
}
}
}
}
},
"DataResponse_Vec_DnsRecordEntry": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"record_type",
"host",
"value"
],
"properties": {
"host": {
"type": "string"
},
"record_type": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
},
"DataResponse_Vec_DomainReputationSummary": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"domain_id",
"domain_name",
"dmarc_pass",
"dmarc_fail",
"dmarc_pass_rate",
"fbl_complaints"
],
"properties": {
"dmarc_fail": {
"type": "integer",
"format": "int64"
},
"dmarc_pass": {
"type": "integer",
"format": "int64"
},
"dmarc_pass_rate": {
"type": "number",
"format": "double"
},
"domain_id": {
"$ref": "#/components/schemas/DomainId"
},
"domain_name": {
"type": "string"
},
"fbl_complaints": {
"type": "integer",
"format": "int64"
}
}
}
}
}
},
"DataResponse_Vec_DomainResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"domain_name",
"use_for_sending",
"use_for_receiving",
"status",
"spf_status",
"dkim_status",
"dmarc_status",
"mx_status",
"return_path_status",
"verification_token",
"reject_unknown_recipients",
"created_at",
"updated_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"dkim_error": {
"type": [
"string",
"null"
]
},
"dkim_status": {
"$ref": "#/components/schemas/DnsCheckStatus"
},
"dmarc_error": {
"type": [
"string",
"null"
]
},
"dmarc_status": {
"$ref": "#/components/schemas/DnsCheckStatus"
},
"dns_checked_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"domain_name": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/DomainId"
},
"mx_error": {
"type": [
"string",
"null"
]
},
"mx_status": {
"$ref": "#/components/schemas/DnsCheckStatus"
},
"reject_unknown_recipients": {
"type": "boolean"
},
"return_path_error": {
"type": [
"string",
"null"
]
},
"return_path_status": {
"$ref": "#/components/schemas/DnsCheckStatus"
},
"spf_error": {
"type": [
"string",
"null"
]
},
"spf_status": {
"$ref": "#/components/schemas/DnsCheckStatus"
},
"status": {
"$ref": "#/components/schemas/DomainStatus"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"use_for_receiving": {
"type": "boolean"
},
"use_for_sending": {
"type": "boolean"
},
"verification_token": {
"type": "string"
},
"verified_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
}
}
}
},
"DataResponse_Vec_ErrorEventResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"tenant_id",
"severity",
"component",
"error_type",
"message",
"metadata",
"created_at"
],
"properties": {
"component": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"error_type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"message": {
"type": "string"
},
"message_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"metadata": {},
"request_id": {
"type": [
"string",
"null"
]
},
"severity": {
"type": "string"
},
"stack_trace": {
"type": [
"string",
"null"
]
},
"tenant_id": {
"type": "string",
"format": "uuid"
}
}
}
}
}
},
"DataResponse_Vec_ErrorSummaryResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"component",
"severity",
"count"
],
"properties": {
"component": {
"type": "string"
},
"count": {
"type": "integer",
"format": "int64"
},
"severity": {
"type": "string"
}
}
}
}
}
},
"DataResponse_Vec_EventResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"message_id",
"event_type",
"created_at"
],
"properties": {
"bounce_class": {
"oneOf": [
{
"$ref": "#/components/schemas/BounceClass"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"diagnostic_code": {
"type": [
"string",
"null"
]
},
"event_type": {
"$ref": "#/components/schemas/EventType"
},
"id": {
"$ref": "#/components/schemas/MessageEventId"
},
"message_id": {
"$ref": "#/components/schemas/MessageId"
},
"next_retry_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"remote_mta": {
"type": [
"string",
"null"
]
},
"retry_count": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"smtp_response": {
"type": [
"string",
"null"
]
}
}
}
}
}
},
"DataResponse_Vec_FblReportResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"complained_recipient",
"complaint_type",
"auto_suppressed",
"created_at"
],
"properties": {
"arrival_date": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"auto_suppressed": {
"type": "boolean"
},
"complained_recipient": {
"type": "string"
},
"complaint_type": {
"$ref": "#/components/schemas/ComplaintType"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"feedback_type": {
"type": [
"string",
"null"
]
},
"id": {
"$ref": "#/components/schemas/FblReportId"
},
"processed_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"source_ip": {
"type": [
"string",
"null"
]
}
}
}
}
}
},
"DataResponse_Vec_InboundRouteResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"tenant_id",
"pattern",
"match_type",
"webhook_url",
"priority",
"llm_classify",
"auto_respond",
"created_at"
],
"properties": {
"auto_respond": {
"type": "boolean"
},
"auto_respond_config": {
"type": [
"object",
"null"
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"id": {
"$ref": "#/components/schemas/InboundRouteId"
},
"llm_classify": {
"type": "boolean"
},
"match_type": {
"$ref": "#/components/schemas/InboundRouteMatchType"
},
"pattern": {
"type": "string"
},
"priority": {
"type": "integer",
"format": "int32"
},
"tenant_id": {
"$ref": "#/components/schemas/TenantId"
},
"webhook_url": {
"type": "string"
}
}
}
}
}
},
"DataResponse_Vec_IpPoolResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"pool_type",
"ips",
"status",
"created_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"id": {
"$ref": "#/components/schemas/IpPoolId"
},
"ips": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"pool_type": {
"$ref": "#/components/schemas/IpPoolType"
},
"status": {
"$ref": "#/components/schemas/IpPoolStatus"
}
}
}
}
}
},
"DataResponse_Vec_MailboxResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"domain_id",
"address",
"status",
"forward_to",
"auto_reply",
"metadata",
"created_at",
"updated_at"
],
"properties": {
"address": {
"type": "string"
},
"auto_reply": {
"type": "boolean"
},
"auto_reply_body": {
"type": [
"string",
"null"
]
},
"auto_reply_subject": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"display_name": {
"type": [
"string",
"null"
]
},
"domain_id": {
"$ref": "#/components/schemas/DomainId"
},
"forward_to": {
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"$ref": "#/components/schemas/MailboxId"
},
"metadata": {
"type": "object"
},
"status": {
"$ref": "#/components/schemas/MailboxStatus"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
}
}
}
},
"DataResponse_Vec_MessageResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"direction",
"envelope_from",
"envelope_to",
"header_to",
"header_cc",
"status",
"tags",
"metadata",
"created_at"
],
"properties": {
"bounced_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"delivered_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"direction": {
"$ref": "#/components/schemas/MessageDirection"
},
"envelope_from": {
"type": "string"
},
"envelope_to": {
"type": "array",
"items": {
"type": "string"
}
},
"header_cc": {
"type": "array",
"items": {
"type": "string"
}
},
"header_from": {
"type": [
"string",
"null"
]
},
"header_reply_to": {
"type": [
"string",
"null"
]
},
"header_to": {
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"$ref": "#/components/schemas/MessageId"
},
"llm_category": {
"type": [
"string",
"null"
]
},
"llm_classified_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"llm_summary": {
"type": [
"string",
"null"
]
},
"message_id_header": {
"type": [
"string",
"null"
]
},
"message_size": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"metadata": {
"type": "object"
},
"send_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"spam_action": {
"type": [
"string",
"null"
]
},
"spam_score": {
"type": [
"number",
"null"
],
"format": "double"
},
"status": {
"$ref": "#/components/schemas/MessageStatus"
},
"subject": {
"type": [
"string",
"null"
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"DataResponse_Vec_OAuthClientResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"client_id",
"name",
"redirect_uris",
"grant_types",
"scopes",
"status",
"created_at",
"updated_at"
],
"properties": {
"client_id": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"grant_types": {
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"$ref": "#/components/schemas/OAuthClientId"
},
"name": {
"type": "string"
},
"redirect_uris": {
"type": "array",
"items": {
"type": "string"
}
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"$ref": "#/components/schemas/OAuthClientStatus"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
}
}
}
},
"DataResponse_Vec_SmtpCredentialResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"username",
"mechanisms",
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
},
"id": {
"$ref": "#/components/schemas/SmtpCredentialId"
},
"mechanisms": {
"type": "array",
"items": {
"type": "string"
}
},
"username": {
"type": "string"
}
}
}
}
}
},
"DataResponse_Vec_SuppressionResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"email",
"reason",
"created_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"email": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/SuppressionId"
},
"reason": {
"$ref": "#/components/schemas/SuppressionReason"
}
}
}
}
}
},
"DataResponse_Vec_TenantIpAssignmentResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"tenant_id",
"ip_pool_id",
"priority",
"created_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"ip_pool_id": {
"$ref": "#/components/schemas/IpPoolId"
},
"priority": {
"type": "integer",
"format": "int32"
},
"tenant_id": {
"$ref": "#/components/schemas/TenantId"
}
}
}
}
}
},
"DataResponse_Vec_TenantResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"tier",
"status",
"verp_enabled"
],
"properties": {
"id": {
"$ref": "#/components/schemas/TenantId"
},
"name": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/TenantStatus"
},
"tier": {
"$ref": "#/components/schemas/TenantTier"
},
"verp_enabled": {
"type": "boolean",
"description": "When `true`, outbound MAIL FROM is rewritten to a VERP bounce return\npath so DSN bounces route back to the message that generated them."
}
}
}
}
}
},
"DataResponse_Vec_TlsrptReportResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"domain_id",
"direction",
"report_id",
"date_begin",
"date_end",
"policy_type",
"total_success",
"total_failure",
"created_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"date_begin": {
"type": "string",
"format": "date-time"
},
"date_end": {
"type": "string",
"format": "date-time"
},
"direction": {
"$ref": "#/components/schemas/MessageDirection"
},
"domain_id": {
"$ref": "#/components/schemas/DomainId"
},
"failure_details": {
"type": [
"object",
"null"
]
},
"id": {
"$ref": "#/components/schemas/TlsrptReportId"
},
"org_name": {
"type": [
"string",
"null"
]
},
"policy_domain": {
"type": [
"string",
"null"
]
},
"policy_type": {
"$ref": "#/components/schemas/TlsrptPolicyType"
},
"report_id": {
"type": "string"
},
"total_failure": {
"type": "integer",
"format": "int32"
},
"total_success": {
"type": "integer",
"format": "int32"
}
}
}
}
}
},
"DataResponse_Vec_TrackingDomainResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"domain_name",
"cname_target",
"dns_status",
"ssl_enabled",
"track_opens",
"track_clicks",
"created_at",
"updated_at"
],
"properties": {
"cname_target": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"dns_checked_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"dns_error": {
"type": [
"string",
"null"
]
},
"dns_status": {
"$ref": "#/components/schemas/DomainStatus"
},
"domain_id": {
"oneOf": [
{
"$ref": "#/components/schemas/DomainId"
},
{
"type": "null"
}
]
},
"domain_name": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/TrackingDomainId"
},
"ssl_enabled": {
"type": "boolean"
},
"track_clicks": {
"type": "boolean"
},
"track_opens": {
"type": "boolean"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
}
}
}
},
"DataResponse_Vec_WebhookResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"url",
"event_types",
"signing_secret",
"status",
"failure_count",
"created_at",
"updated_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"event_types": {
"type": "array",
"items": {
"type": "string"
}
},
"failure_count": {
"type": "integer",
"format": "int32"
},
"id": {
"$ref": "#/components/schemas/WebhookId"
},
"last_failure_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"last_success_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"signing_secret": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/WebhookStatus"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"url": {
"type": "string"
}
}
}
}
}
},
"DataResponse_Vec_WhitelistEntry": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"ip"
],
"properties": {
"ip": {
"type": "string"
}
}
}
}
}
},
"DataResponse_WebhookResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"url",
"event_types",
"signing_secret",
"status",
"failure_count",
"created_at",
"updated_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"event_types": {
"type": "array",
"items": {
"type": "string"
}
},
"failure_count": {
"type": "integer",
"format": "int32"
},
"id": {
"$ref": "#/components/schemas/WebhookId"
},
"last_failure_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"last_success_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"signing_secret": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/WebhookStatus"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"url": {
"type": "string"
}
}
}
}
},
"DeferredMessageResponse": {
"type": "object",
"required": [
"id",
"envelope_from",
"envelope_to",
"status",
"created_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"envelope_from": {
"type": "string"
},
"envelope_to": {
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"$ref": "#/components/schemas/MessageId"
},
"status": {
"$ref": "#/components/schemas/MessageStatus"
},
"subject": {
"type": [
"string",
"null"
]
}
}
},
"DeliveryLogResponse": {
"type": "object",
"required": [
"id",
"webhook_id",
"event_type",
"attempt_number",
"created_at"
],
"properties": {
"attempt_number": {
"type": "integer",
"format": "int32"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"delivered_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"error_message": {
"type": [
"string",
"null"
]
},
"event_type": {
"type": "string"
},
"failed_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"http_status": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"id": {
"$ref": "#/components/schemas/WebhookDeliveryLogId"
},
"response_body": {
"type": [
"string",
"null"
]
},
"webhook_id": {
"$ref": "#/components/schemas/WebhookId"
}
}
},
"DeliveryStatsResponse": {
"type": "object",
"required": [
"status_counts"
],
"properties": {
"status_counts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusCountResponse"
}
}
}
},
"DkimAlgorithm": {
"type": "string",
"enum": [
"ed25519",
"rsa"
]
},
"DkimKeyId": {
"type": "string",
"format": "uuid"
},
"DkimKeyResponse": {
"type": "object",
"required": [
"id",
"domain_id",
"selector",
"algorithm",
"public_key",
"status",
"created_at"
],
"properties": {
"activated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"algorithm": {
"$ref": "#/components/schemas/DkimAlgorithm"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"domain_id": {
"$ref": "#/components/schemas/DomainId"
},
"id": {
"$ref": "#/components/schemas/DkimKeyId"
},
"key_size": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"public_key": {
"type": "string"
},
"retired_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"selector": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/DkimKeyStatus"
}
}
},
"DkimKeyStatus": {
"type": "string",
"enum": [
"active",
"rotating",
"retired"
]
},
"DmarcReportId": {
"type": "string",
"format": "uuid"
},
"DmarcReportResponse": {
"type": "object",
"required": [
"id",
"domain_id",
"direction",
"report_id",
"date_begin",
"date_end",
"total_count",
"dkim_pass",
"dkim_fail",
"spf_pass",
"spf_fail",
"dmarc_pass",
"dmarc_fail",
"created_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"date_begin": {
"type": "string",
"format": "date-time"
},
"date_end": {
"type": "string",
"format": "date-time"
},
"direction": {
"$ref": "#/components/schemas/MessageDirection"
},
"dkim_fail": {
"type": "integer",
"format": "int32"
},
"dkim_pass": {
"type": "integer",
"format": "int32"
},
"dmarc_fail": {
"type": "integer",
"format": "int32"
},
"dmarc_pass": {
"type": "integer",
"format": "int32"
},
"domain_id": {
"$ref": "#/components/schemas/DomainId"
},
"id": {
"$ref": "#/components/schemas/DmarcReportId"
},
"org_name": {
"type": [
"string",
"null"
]
},
"report_id": {
"type": "string"
},
"source_ip": {
"type": [
"string",
"null"
]
},
"spf_fail": {
"type": "integer",
"format": "int32"
},
"spf_pass": {
"type": "integer",
"format": "int32"
},
"total_count": {
"type": "integer",
"format": "int32"
}
}
},
"DnsCheckStatus": {
"type": "string",
"enum": [
"pending",
"verified",
"failed",
"not_applicable"
]
},
"DnsRecordEntry": {
"type": "object",
"required": [
"record_type",
"host",
"value"
],
"properties": {
"host": {
"type": "string"
},
"record_type": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"DnsRecordResponse": {
"type": "object",
"required": [
"record_type",
"host",
"value"
],
"properties": {
"host": {
"type": "string"
},
"record_type": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"DomainId": {
"type": "string",
"format": "uuid"
},
"DomainReputationSummary": {
"type": "object",
"required": [
"domain_id",
"domain_name",
"dmarc_pass",
"dmarc_fail",
"dmarc_pass_rate",
"fbl_complaints"
],
"properties": {
"dmarc_fail": {
"type": "integer",
"format": "int64"
},
"dmarc_pass": {
"type": "integer",
"format": "int64"
},
"dmarc_pass_rate": {
"type": "number",
"format": "double"
},
"domain_id": {
"$ref": "#/components/schemas/DomainId"
},
"domain_name": {
"type": "string"
},
"fbl_complaints": {
"type": "integer",
"format": "int64"
}
}
},
"DomainResponse": {
"type": "object",
"required": [
"id",
"domain_name",
"use_for_sending",
"use_for_receiving",
"status",
"spf_status",
"dkim_status",
"dmarc_status",
"mx_status",
"return_path_status",
"verification_token",
"reject_unknown_recipients",
"created_at",
"updated_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"dkim_error": {
"type": [
"string",
"null"
]
},
"dkim_status": {
"$ref": "#/components/schemas/DnsCheckStatus"
},
"dmarc_error": {
"type": [
"string",
"null"
]
},
"dmarc_status": {
"$ref": "#/components/schemas/DnsCheckStatus"
},
"dns_checked_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"domain_name": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/DomainId"
},
"mx_error": {
"type": [
"string",
"null"
]
},
"mx_status": {
"$ref": "#/components/schemas/DnsCheckStatus"
},
"reject_unknown_recipients": {
"type": "boolean"
},
"return_path_error": {
"type": [
"string",
"null"
]
},
"return_path_status": {
"$ref": "#/components/schemas/DnsCheckStatus"
},
"spf_error": {
"type": [
"string",
"null"
]
},
"spf_status": {
"$ref": "#/components/schemas/DnsCheckStatus"
},
"status": {
"$ref": "#/components/schemas/DomainStatus"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"use_for_receiving": {
"type": "boolean"
},
"use_for_sending": {
"type": "boolean"
},
"verification_token": {
"type": "string"
},
"verified_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
},
"DomainStatus": {
"type": "string",
"enum": [
"pending",
"verified",
"failed"
]
},
"EngagementStatsResponse": {
"type": "object",
"required": [
"opens",
"clicks",
"unsubscribes"
],
"properties": {
"clicks": {
"type": "integer",
"format": "int64"
},
"opens": {
"type": "integer",
"format": "int64"
},
"unsubscribes": {
"type": "integer",
"format": "int64"
}
}
},
"ErrorBody": {
"type": "object",
"required": [
"type",
"message"
],
"properties": {
"message": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"ErrorEventResponse": {
"type": "object",
"required": [
"id",
"tenant_id",
"severity",
"component",
"error_type",
"message",
"metadata",
"created_at"
],
"properties": {
"component": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"error_type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"message": {
"type": "string"
},
"message_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"metadata": {},
"request_id": {
"type": [
"string",
"null"
]
},
"severity": {
"type": "string"
},
"stack_trace": {
"type": [
"string",
"null"
]
},
"tenant_id": {
"type": "string",
"format": "uuid"
}
}
},
"ErrorResponse": {
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"$ref": "#/components/schemas/ErrorBody"
}
}
},
"ErrorSummaryResponse": {
"type": "object",
"required": [
"component",
"severity",
"count"
],
"properties": {
"component": {
"type": "string"
},
"count": {
"type": "integer",
"format": "int64"
},
"severity": {
"type": "string"
}
}
},
"EventResponse": {
"type": "object",
"required": [
"id",
"message_id",
"event_type",
"created_at"
],
"properties": {
"bounce_class": {
"oneOf": [
{
"$ref": "#/components/schemas/BounceClass"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"diagnostic_code": {
"type": [
"string",
"null"
]
},
"event_type": {
"$ref": "#/components/schemas/EventType"
},
"id": {
"$ref": "#/components/schemas/MessageEventId"
},
"message_id": {
"$ref": "#/components/schemas/MessageId"
},
"next_retry_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"remote_mta": {
"type": [
"string",
"null"
]
},
"retry_count": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"smtp_response": {
"type": [
"string",
"null"
]
}
}
},
"EventType": {
"type": "string",
"enum": [
"queued",
"processed",
"delivered",
"deferred",
"bounced",
"dropped",
"held",
"released"
]
},
"FblReportId": {
"type": "string",
"format": "uuid"
},
"FblReportResponse": {
"type": "object",
"required": [
"id",
"complained_recipient",
"complaint_type",
"auto_suppressed",
"created_at"
],
"properties": {
"arrival_date": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"auto_suppressed": {
"type": "boolean"
},
"complained_recipient": {
"type": "string"
},
"complaint_type": {
"$ref": "#/components/schemas/ComplaintType"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"feedback_type": {
"type": [
"string",
"null"
]
},
"id": {
"$ref": "#/components/schemas/FblReportId"
},
"processed_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"source_ip": {
"type": [
"string",
"null"
]
}
}
},
"HealthResponse": {
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"type": "string"
}
}
},
"InboundRouteId": {
"type": "string",
"format": "uuid"
},
"InboundRouteMatchType": {
"type": "string",
"enum": [
"exact",
"regex",
"domain",
"catch_all"
]
},
"InboundRouteResponse": {
"type": "object",
"required": [
"id",
"tenant_id",
"pattern",
"match_type",
"webhook_url",
"priority",
"llm_classify",
"auto_respond",
"created_at"
],
"properties": {
"auto_respond": {
"type": "boolean"
},
"auto_respond_config": {
"type": [
"object",
"null"
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"id": {
"$ref": "#/components/schemas/InboundRouteId"
},
"llm_classify": {
"type": "boolean"
},
"match_type": {
"$ref": "#/components/schemas/InboundRouteMatchType"
},
"pattern": {
"type": "string"
},
"priority": {
"type": "integer",
"format": "int32"
},
"tenant_id": {
"$ref": "#/components/schemas/TenantId"
},
"webhook_url": {
"type": "string"
}
}
},
"IpListRequest": {
"type": "object",
"required": [
"ips"
],
"properties": {
"ips": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"IpPoolId": {
"type": "string",
"format": "uuid"
},
"IpPoolResponse": {
"type": "object",
"required": [
"id",
"name",
"pool_type",
"ips",
"status",
"created_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"id": {
"$ref": "#/components/schemas/IpPoolId"
},
"ips": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"pool_type": {
"$ref": "#/components/schemas/IpPoolType"
},
"status": {
"$ref": "#/components/schemas/IpPoolStatus"
}
}
},
"IpPoolStatus": {
"type": "string",
"enum": [
"active",
"draining",
"inactive"
]
},
"IpPoolType": {
"type": "string",
"enum": [
"shared",
"dedicated"
]
},
"IpReputationResponse": {
"type": "object",
"required": [
"ip",
"score"
],
"properties": {
"ip": {
"type": "string"
},
"score": {
"type": "number",
"format": "double"
}
}
},
"MailboxId": {
"type": "string",
"format": "uuid"
},
"MailboxResponse": {
"type": "object",
"required": [
"id",
"domain_id",
"address",
"status",
"forward_to",
"auto_reply",
"metadata",
"created_at",
"updated_at"
],
"properties": {
"address": {
"type": "string"
},
"auto_reply": {
"type": "boolean"
},
"auto_reply_body": {
"type": [
"string",
"null"
]
},
"auto_reply_subject": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"display_name": {
"type": [
"string",
"null"
]
},
"domain_id": {
"$ref": "#/components/schemas/DomainId"
},
"forward_to": {
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"$ref": "#/components/schemas/MailboxId"
},
"metadata": {
"type": "object"
},
"status": {
"$ref": "#/components/schemas/MailboxStatus"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
},
"MailboxStatus": {
"type": "string",
"enum": [
"active",
"disabled"
]
},
"MessageDirection": {
"type": "string",
"enum": [
"inbound",
"outbound"
]
},
"MessageEventId": {
"type": "string",
"format": "uuid"
},
"MessageId": {
"type": "string",
"format": "uuid"
},
"MessageResponse": {
"type": "object",
"required": [
"id",
"direction",
"envelope_from",
"envelope_to",
"header_to",
"header_cc",
"status",
"tags",
"metadata",
"created_at"
],
"properties": {
"bounced_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"delivered_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"direction": {
"$ref": "#/components/schemas/MessageDirection"
},
"envelope_from": {
"type": "string"
},
"envelope_to": {
"type": "array",
"items": {
"type": "string"
}
},
"header_cc": {
"type": "array",
"items": {
"type": "string"
}
},
"header_from": {
"type": [
"string",
"null"
]
},
"header_reply_to": {
"type": [
"string",
"null"
]
},
"header_to": {
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"$ref": "#/components/schemas/MessageId"
},
"llm_category": {
"type": [
"string",
"null"
]
},
"llm_classified_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"llm_summary": {
"type": [
"string",
"null"
]
},
"message_id_header": {
"type": [
"string",
"null"
]
},
"message_size": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"metadata": {
"type": "object"
},
"send_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"spam_action": {
"type": [
"string",
"null"
]
},
"spam_score": {
"type": [
"number",
"null"
],
"format": "double"
},
"status": {
"$ref": "#/components/schemas/MessageStatus"
},
"subject": {
"type": [
"string",
"null"
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MessageStatus": {
"type": "string",
"enum": [
"queued",
"processing",
"delivered",
"deferred",
"bounced",
"dropped",
"scheduled",
"held"
]
},
"OAuthClientCreatedResponse": {
"type": "object",
"description": "Returned only on creation - includes the plaintext client secret.",
"required": [
"id",
"client_id",
"client_secret",
"name",
"redirect_uris",
"grant_types",
"scopes",
"status",
"created_at"
],
"properties": {
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"grant_types": {
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"$ref": "#/components/schemas/OAuthClientId"
},
"name": {
"type": "string"
},
"redirect_uris": {
"type": "array",
"items": {
"type": "string"
}
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"$ref": "#/components/schemas/OAuthClientStatus"
}
}
},
"OAuthClientId": {
"type": "string",
"format": "uuid"
},
"OAuthClientResponse": {
"type": "object",
"required": [
"id",
"client_id",
"name",
"redirect_uris",
"grant_types",
"scopes",
"status",
"created_at",
"updated_at"
],
"properties": {
"client_id": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"grant_types": {
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"$ref": "#/components/schemas/OAuthClientId"
},
"name": {
"type": "string"
},
"redirect_uris": {
"type": "array",
"items": {
"type": "string"
}
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"$ref": "#/components/schemas/OAuthClientStatus"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
},
"OAuthClientStatus": {
"type": "string",
"enum": [
"active",
"revoked"
]
},
"OverviewResponse": {
"type": "object",
"required": [
"total_sent",
"delivered",
"bounced",
"deferred",
"dropped",
"delivery_rate",
"bounce_rate"
],
"properties": {
"bounce_rate": {
"type": "number",
"format": "double"
},
"bounced": {
"type": "integer",
"format": "int64"
},
"deferred": {
"type": "integer",
"format": "int64"
},
"delivered": {
"type": "integer",
"format": "int64"
},
"delivery_rate": {
"type": "number",
"format": "double"
},
"dropped": {
"type": "integer",
"format": "int64"
},
"total_sent": {
"type": "integer",
"format": "int64"
}
}
},
"PauseResponse": {
"type": "object",
"required": [
"paused"
],
"properties": {
"paused": {
"type": "boolean"
}
}
},
"QueueStatsResponse": {
"type": "object",
"required": [
"counts",
"paused"
],
"properties": {
"counts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusCountResponse"
}
},
"paused": {
"type": "boolean"
}
}
},
"ReadyResponse": {
"type": "object",
"required": [
"status",
"database",
"kv"
],
"properties": {
"database": {
"type": "string"
},
"kv": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"ReputationResponse": {
"type": "object",
"required": [
"ip",
"score",
"action"
],
"properties": {
"action": {
"type": "string"
},
"ip": {
"type": "string"
},
"score": {
"type": "number",
"format": "double"
}
}
},
"RotateDkimKeyRequest": {
"type": "object",
"required": [
"selector"
],
"properties": {
"algorithm": {
"$ref": "#/components/schemas/DkimAlgorithm"
},
"key_size": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"selector": {
"type": "string"
}
}
},
"ScanStatus": {
"type": "string",
"enum": [
"pending",
"clean",
"infected",
"error"
]
},
"SendMessageRequest": {
"type": "object",
"required": [
"from",
"to",
"metadata"
],
"properties": {
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttachmentInput"
}
},
"bcc": {
"type": "array",
"items": {
"type": "string"
}
},
"cc": {
"type": "array",
"items": {
"type": "string"
}
},
"from": {
"type": "string"
},
"html": {
"type": [
"string",
"null"
]
},
"in_reply_to": {
"type": [
"string",
"null"
],
"description": "RFC 5322 In-Reply-To - Message-ID this reply is responding to.\nBare value or angle-bracketed; either way the builder normalises.\nRequired for the reply to thread correctly in mail clients\n(Gmail, Apple Mail, Outlook all key threads off In-Reply-To)."
},
"metadata": {
"type": "object"
},
"references": {
"type": "array",
"items": {
"type": "string"
},
"description": "RFC 5322 References - full chain of ancestor Message-IDs ordered\noldest → newest. Standard reply-construction algorithm: take\nparent's References + append parent's Message-ID."
},
"reply_to": {
"type": [
"string",
"null"
]
},
"send_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"subject": {
"type": [
"string",
"null"
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"text": {
"type": [
"string",
"null"
]
},
"to": {
"type": "array",
"items": {
"type": "string"
}
},
"track_clicks": {
"type": "boolean"
},
"track_opens": {
"type": "boolean"
}
}
},
"SendRawRequest": {
"type": "object",
"required": [
"from",
"to",
"raw_eml"
],
"properties": {
"from": {
"type": "string"
},
"raw_eml": {
"type": "string"
},
"to": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"SendResponse": {
"type": "object",
"required": [
"id",
"status"
],
"properties": {
"id": {
"$ref": "#/components/schemas/MessageId"
},
"message_id_header": {
"type": [
"string",
"null"
],
"description": "The RFC 5322 Message-ID stamped on the outbound message (bare\n`id@host`, no angle brackets). Lets the sender thread inbound\nreplies against this id. Omitted when unknown."
},
"status": {
"type": "string"
}
}
},
"SmtpCredentialId": {
"type": "string",
"format": "uuid"
},
"SmtpCredentialResponse": {
"type": "object",
"required": [
"id",
"username",
"mechanisms",
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
},
"id": {
"$ref": "#/components/schemas/SmtpCredentialId"
},
"mechanisms": {
"type": "array",
"items": {
"type": "string"
}
},
"username": {
"type": "string"
}
}
},
"StatusCountResponse": {
"type": "object",
"required": [
"status",
"count"
],
"properties": {
"count": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string"
}
}
},
"SuppressionId": {
"type": "string",
"format": "uuid"
},
"SuppressionReason": {
"type": "string",
"enum": [
"hard_bounce",
"complaint",
"manual",
"unsubscribe"
]
},
"SuppressionResponse": {
"type": "object",
"required": [
"id",
"email",
"reason",
"created_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"email": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/SuppressionId"
},
"reason": {
"$ref": "#/components/schemas/SuppressionReason"
}
}
},
"TenantId": {
"type": "string",
"format": "uuid"
},
"TenantIpAssignmentResponse": {
"type": "object",
"required": [
"tenant_id",
"ip_pool_id",
"priority",
"created_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"ip_pool_id": {
"$ref": "#/components/schemas/IpPoolId"
},
"priority": {
"type": "integer",
"format": "int32"
},
"tenant_id": {
"$ref": "#/components/schemas/TenantId"
}
}
},
"TenantResponse": {
"type": "object",
"required": [
"id",
"name",
"tier",
"status",
"verp_enabled"
],
"properties": {
"id": {
"$ref": "#/components/schemas/TenantId"
},
"name": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/TenantStatus"
},
"tier": {
"$ref": "#/components/schemas/TenantTier"
},
"verp_enabled": {
"type": "boolean",
"description": "When `true`, outbound MAIL FROM is rewritten to a VERP bounce return\npath so DSN bounces route back to the message that generated them."
}
}
},
"TenantStatus": {
"type": "string",
"enum": [
"active",
"suspended",
"deleted"
]
},
"TenantTier": {
"type": "string",
"enum": [
"dedicated",
"shared_premium",
"shared_standard"
]
},
"TestWebhookResponse": {
"type": "object",
"required": [
"success"
],
"properties": {
"error": {
"type": [
"string",
"null"
]
},
"http_status": {
"type": [
"integer",
"null"
],
"format": "int32",
"minimum": 0
},
"response_body": {
"type": [
"string",
"null"
]
},
"success": {
"type": "boolean"
}
}
},
"TlsrptPolicyType": {
"type": "string",
"enum": [
"tlsa",
"sts",
"no-policy-found"
]
},
"TlsrptReportId": {
"type": "string",
"format": "uuid"
},
"TlsrptReportResponse": {
"type": "object",
"required": [
"id",
"domain_id",
"direction",
"report_id",
"date_begin",
"date_end",
"policy_type",
"total_success",
"total_failure",
"created_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"date_begin": {
"type": "string",
"format": "date-time"
},
"date_end": {
"type": "string",
"format": "date-time"
},
"direction": {
"$ref": "#/components/schemas/MessageDirection"
},
"domain_id": {
"$ref": "#/components/schemas/DomainId"
},
"failure_details": {
"type": [
"object",
"null"
]
},
"id": {
"$ref": "#/components/schemas/TlsrptReportId"
},
"org_name": {
"type": [
"string",
"null"
]
},
"policy_domain": {
"type": [
"string",
"null"
]
},
"policy_type": {
"$ref": "#/components/schemas/TlsrptPolicyType"
},
"report_id": {
"type": "string"
},
"total_failure": {
"type": "integer",
"format": "int32"
},
"total_success": {
"type": "integer",
"format": "int32"
}
}
},
"TrackingCertificateId": {
"type": "string",
"format": "uuid"
},
"TrackingCertificateResponse": {
"type": "object",
"required": [
"id",
"tracking_domain_id",
"expires_at",
"renew_after",
"created_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"id": {
"$ref": "#/components/schemas/TrackingCertificateId"
},
"renew_after": {
"type": "string",
"format": "date-time"
},
"tracking_domain_id": {
"$ref": "#/components/schemas/TrackingDomainId"
}
}
},
"TrackingDomainId": {
"type": "string",
"format": "uuid"
},
"TrackingDomainResponse": {
"type": "object",
"required": [
"id",
"domain_name",
"cname_target",
"dns_status",
"ssl_enabled",
"track_opens",
"track_clicks",
"created_at",
"updated_at"
],
"properties": {
"cname_target": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"dns_checked_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"dns_error": {
"type": [
"string",
"null"
]
},
"dns_status": {
"$ref": "#/components/schemas/DomainStatus"
},
"domain_id": {
"oneOf": [
{
"$ref": "#/components/schemas/DomainId"
},
{
"type": "null"
}
]
},
"domain_name": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/TrackingDomainId"
},
"ssl_enabled": {
"type": "boolean"
},
"track_clicks": {
"type": "boolean"
},
"track_opens": {
"type": "boolean"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
},
"TrainRequest": {
"type": "object",
"required": [
"raw_message"
],
"properties": {
"raw_message": {
"type": "string"
}
}
},
"UpdateAssignmentPriorityRequest": {
"type": "object",
"required": [
"priority"
],
"properties": {
"priority": {
"type": "integer",
"format": "int32"
}
}
},
"UpdateDomainRequest": {
"type": "object",
"required": [
"use_for_sending",
"use_for_receiving"
],
"properties": {
"reject_unknown_recipients": {
"type": "boolean"
},
"use_for_receiving": {
"type": "boolean"
},
"use_for_sending": {
"type": "boolean"
}
}
},
"UpdateEnabledRequest": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
}
},
"UpdateInboundRouteRequest": {
"type": "object",
"required": [
"pattern",
"match_type",
"webhook_url"
],
"properties": {
"auto_respond": {
"type": "boolean"
},
"auto_respond_config": {
"type": [
"object",
"null"
]
},
"llm_classify": {
"type": "boolean"
},
"match_type": {
"$ref": "#/components/schemas/InboundRouteMatchType"
},
"pattern": {
"type": "string"
},
"priority": {
"type": "integer",
"format": "int32"
},
"webhook_url": {
"type": "string"
}
}
},
"UpdateIpPoolStatusRequest": {
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"$ref": "#/components/schemas/IpPoolStatus"
}
}
},
"UpdateMailboxRequest": {
"type": "object",
"required": [
"status"
],
"properties": {
"auto_reply": {
"type": "boolean"
},
"auto_reply_body": {
"type": [
"string",
"null"
]
},
"auto_reply_subject": {
"type": [
"string",
"null"
]
},
"display_name": {
"type": [
"string",
"null"
]
},
"forward_to": {
"type": "array",
"items": {
"type": "string"
}
},
"metadata": {
"type": "object"
},
"status": {
"$ref": "#/components/schemas/MailboxStatus"
}
}
},
"UpdateTenantRequest": {
"type": "object",
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"tier": {
"oneOf": [
{
"$ref": "#/components/schemas/TenantTier"
},
{
"type": "null"
}
]
},
"verp_enabled": {
"type": [
"boolean",
"null"
],
"description": "Opt this tenant in/out of VERP bounce return-path rewriting.\nWhen `Some(true)`, the tenant must also publish `bounce.{domain}`\nMX/CNAME records pointing at this server - see the DNS-records API."
}
}
},
"UpdateTenantStatusRequest": {
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"$ref": "#/components/schemas/TenantStatus"
}
}
},
"UpdateWebhookRequest": {
"type": "object",
"required": [
"url",
"event_types",
"status"
],
"properties": {
"event_types": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"$ref": "#/components/schemas/WebhookStatus"
},
"url": {
"type": "string"
}
}
},
"VerifyDomainRequest": {
"type": "object",
"required": [
"token"
],
"properties": {
"token": {
"type": "string"
}
}
},
"WebhookDeliveryLogId": {
"type": "string",
"format": "uuid"
},
"WebhookId": {
"type": "string",
"format": "uuid"
},
"WebhookResponse": {
"type": "object",
"required": [
"id",
"url",
"event_types",
"signing_secret",
"status",
"failure_count",
"created_at",
"updated_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"event_types": {
"type": "array",
"items": {
"type": "string"
}
},
"failure_count": {
"type": "integer",
"format": "int32"
},
"id": {
"$ref": "#/components/schemas/WebhookId"
},
"last_failure_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"last_success_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"signing_secret": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/WebhookStatus"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"url": {
"type": "string"
}
}
},
"WebhookStatus": {
"type": "string",
"enum": [
"active",
"paused",
"disabled"
]
},
"WhitelistEntry": {
"type": "object",
"required": [
"ip"
],
"properties": {
"ip": {
"type": "string"
}
}
},
"WhitelistRequest": {
"type": "object",
"required": [
"ip"
],
"properties": {
"ip": {
"type": "string"
}
}
}
},
"securitySchemes": {
"bearer": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "API Key"
}
}
},
"tags": [
{
"name": "Messages",
"description": "Send and retrieve email messages"
},
{
"name": "Domains",
"description": "Domain management and verification"
},
{
"name": "Mailboxes",
"description": "Mailbox management"
},
{
"name": "DKIM Keys",
"description": "DKIM key management"
},
{
"name": "Webhooks",
"description": "Webhook configuration and delivery logs"
},
{
"name": "Suppressions",
"description": "Email suppression list management"
},
{
"name": "Tenants",
"description": "Tenant management"
},
{
"name": "API Keys",
"description": "API key management"
},
{
"name": "SMTP Credentials",
"description": "SMTP credential management"
},
{
"name": "Inbound Routes",
"description": "Inbound email routing configuration"
},
{
"name": "IP Pools",
"description": "IP pool management and assignment"
},
{
"name": "Queues",
"description": "Queue management and monitoring"
},
{
"name": "Analytics",
"description": "Email analytics and statistics"
},
{
"name": "Reputation",
"description": "Domain and IP reputation monitoring"
},
{
"name": "Spam Training",
"description": "Spam filter training"
},
{
"name": "Reports",
"description": "DMARC, FBL, and TLS-RPT reports"
},
{
"name": "OAuth",
"description": "OAuth client management"
},
{
"name": "Errors",
"description": "Error event tracking and monitoring"
},
{
"name": "Abuse",
"description": "Abuse management: bans, whitelist, reputation"
},
{
"name": "Tracking",
"description": "Open and click tracking endpoints"
},
{
"name": "Tracking Domains",
"description": "Custom tracking domain management"
},
{
"name": "Health",
"description": "Health check endpoints"
}
]
}