{ "openapi": "3.1.1", "info": { "title": "Waymail customer API", "version": "0.2.0", "description": "Regional authenticated customer API. US is prepared but unavailable. Zod-derived schemas describe structural validation; cross-field and business constraints are enforced by the API. See x-waymail-contract-coverage for explicit schema limits and omitted routes." }, "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema", "servers": [ { "url": "https://eu.api.waymail.app", "description": "EU ยท Frankfurt (available)" } ], "x-waymail-regions": [ { "code": "eu", "url": "https://eu.api.waymail.app", "available": true }, { "code": "us", "url": "https://us.api.waymail.app", "available": false } ], "x-waymail-contract-coverage": { "offered_operations": 152, "typed_request_bodies": 56, "typed_success_responses": 152, "generation": "Generation fails if any offered operation lacks a shared request or response schema.", "omitted_routes": { "GET /health": "liveness, for load balancers", "/operator*": "Waymail's cross-workspace operator surface, which no customer credential can reach", "GET /me": "who the connection is; this server already knows", "/account*": "the signed-in person's own account and workspaces, which belong in the console", "/segments*": "Resend's name for /audiences, which is offered", "POST /events/send": "Resend's name for POST /events, which is offered", "GET /receiving/download/:token": "an expiring received-content download, authorized by its capability token", "GET /contacts/imports": "Resend's import jobs, which Waymail does not have; it answers a 404 naming POST /contacts/import", "POST /emails/:id/share": "a public link to a message's contents is for a person to hand out, from the console", "GET /c/:token": "a link inside delivered mail, authorised by its token", "GET /o/:token": "a link inside delivered mail, authorised by its token", "GET /u/:token": "a link inside delivered mail, authorised by its token", "POST /u/:token": "a link inside delivered mail, authorised by its token", "GET /share/:token": "a public link, authorised by its token", "POST /webhooks/clerk": "the identity provider's own webhook", "POST /webhooks/stripe": "the payment provider's own webhook", "/billing*": "spending a workspace's money needs a signed-in owner, and a connection holding an API key is not one; the console is where a plan is bought", "POST /waitlist": "the marketing site's waiting-list form, unauthenticated by design; an agent with a key already has a seat" }, "aliases": "Canonical paths are shown; /v1 aliases and documented Resend aliases use the same runtime handlers." }, "paths": { "/forwarding/destinations": { "get": { "operationId": "get_forwarding_destinations", "summary": "List verified or pending external forwarding destinations in the selected project.", "tags": [ "send" ], "security": [ { "bearerAuth": [] } ], "x-waymail-required-scopes": [ "inbox:read" ], "x-waymail-owner-session": false, "x-waymail-workspace-session": false, "parameters": [ { "name": "limit", "in": "query", "description": "1โ€“100 per page", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "description": "next_cursor from the previous page", "schema": { "type": "string" } }, { "name": "x-waymail-workspace", "in": "header", "description": "Workspace context for session credentials. API keys already belong to a workspace.", "schema": { "type": "string" } }, { "name": "x-waymail-project", "in": "header", "description": "Optional project context; cannot widen credential access.", "schema": { "type": "string" } } ], "responses": { "2XX": { "description": "Successful response. Queued or submitted does not mean delivered. Some deletion operations return an empty 204 response.", "headers": { "x-waymail-request-id": { "description": "Request identifier to quote to support.", "schema": { "type": "string" } }, "retry-after": { "description": "On throttling or quota failures, seconds before retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^fwd_(eu_|us_)?[0-9A-HJKMNP-TV-Z]{26}$" }, "workspace_id": { "type": "string", "pattern": "^ws_(eu_|us_)?[0-9A-HJKMNP-TV-Z]{26}$" }, "project_id": { "type": "string", "pattern": "^prj_(eu_|us_)?[0-9A-HJKMNP-TV-Z]{26}$" }, "address": {}, "status": { "type": "string", "enum": [ "pending", "verified", "deleted" ] }, "verified_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "workspace_id", "project_id", "address", "status", "verified_at", "created_at", "updated_at", "revision" ], "additionalProperties": true } }, "has_more": { "type": "boolean" }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "data", "has_more", "next_cursor" ], "additionalProperties": true } } } }, "default": { "description": "API refusal or service failure; retry only when safe for this operation.", "headers": { "x-waymail-request-id": { "description": "Request identifier to quote to support.", "schema": { "type": "string" } }, "retry-after": { "description": "On throttling or quota failures, seconds before retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "post": { "operationId": "post_forwarding_destinations", "summary": "Add a forwarding destination and email a verification code. Also requires email:send. Check verification_email_sent; no inbox is created.", "tags": [ "send" ], "security": [ { "bearerAuth": [] } ], "x-waymail-required-scopes": [ "inbox:write", "email:send" ], "x-waymail-owner-session": false, "x-waymail-workspace-session": false, "parameters": [ { "name": "x-waymail-workspace", "in": "header", "description": "Workspace context for session credentials. API keys already belong to a workspace.", "schema": { "type": "string" } }, { "name": "x-waymail-project", "in": "header", "description": "Optional project context; cannot widen credential access.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "maxLength": 320, "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } }, "required": [ "address" ], "additionalProperties": false } } } }, "responses": { "2XX": { "description": "Successful response. Queued or submitted does not mean delivered. Some deletion operations return an empty 204 response.", "headers": { "x-waymail-request-id": { "description": "Request identifier to quote to support.", "schema": { "type": "string" } }, "retry-after": { "description": "On throttling or quota failures, seconds before retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^fwd_(eu_|us_)?[0-9A-HJKMNP-TV-Z]{26}$" }, "workspace_id": { "type": "string", "pattern": "^ws_(eu_|us_)?[0-9A-HJKMNP-TV-Z]{26}$" }, "project_id": { "type": "string", "pattern": "^prj_(eu_|us_)?[0-9A-HJKMNP-TV-Z]{26}$" }, "address": {}, "status": { "type": "string", "enum": [ "pending", "verified", "deleted" ] }, "verified_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "verification_email_sent": { "type": "boolean" } }, "required": [ "id", "workspace_id", "project_id", "address", "status", "verified_at", "created_at", "updated_at", "revision", "verification_email_sent" ], "additionalProperties": true } } } }, "default": { "description": "API refusal or service failure; retry only when safe for this operation.", "headers": { "x-waymail-request-id": { "description": "Request identifier to quote to support.", "schema": { "type": "string" } }, "retry-after": { "description": "On throttling or quota failures, seconds before retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/forwarding/destinations/{destination}": { "get": { "operationId": "get_forwarding_destinations_by_destination", "summary": "Read a forwarding destination's verification state.", "tags": [ "send" ], "security": [ { "bearerAuth": [] } ], "x-waymail-required-scopes": [ "inbox:read" ], "x-waymail-owner-session": false, "x-waymail-workspace-session": false, "parameters": [ { "name": "destination", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "x-waymail-workspace", "in": "header", "description": "Workspace context for session credentials. API keys already belong to a workspace.", "schema": { "type": "string" } }, { "name": "x-waymail-project", "in": "header", "description": "Optional project context; cannot widen credential access.", "schema": { "type": "string" } } ], "responses": { "2XX": { "description": "Successful response. Queued or submitted does not mean delivered. Some deletion operations return an empty 204 response.", "headers": { "x-waymail-request-id": { "description": "Request identifier to quote to support.", "schema": { "type": "string" } }, "retry-after": { "description": "On throttling or quota failures, seconds before retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^fwd_(eu_|us_)?[0-9A-HJKMNP-TV-Z]{26}$" }, "workspace_id": { "type": "string", "pattern": "^ws_(eu_|us_)?[0-9A-HJKMNP-TV-Z]{26}$" }, "project_id": { "type": "string", "pattern": "^prj_(eu_|us_)?[0-9A-HJKMNP-TV-Z]{26}$" }, "address": {}, "status": { "type": "string", "enum": [ "pending", "verified", "deleted" ] }, "verified_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "workspace_id", "project_id", "address", "status", "verified_at", "created_at", "updated_at", "revision" ], "additionalProperties": true } } } }, "default": { "description": "API refusal or service failure; retry only when safe for this operation.", "headers": { "x-waymail-request-id": { "description": "Request identifier to quote to support.", "schema": { "type": "string" } }, "retry-after": { "description": "On throttling or quota failures, seconds before retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "delete": { "operationId": "delete_forwarding_destinations_by_destination", "summary": "Remove a forwarding destination and revoke verification. Delete its forwarding rules first.", "tags": [ "send" ], "security": [ { "bearerAuth": [] } ], "x-waymail-required-scopes": [ "inbox:delete" ], "x-waymail-owner-session": false, "x-waymail-workspace-session": false, "parameters": [ { "name": "destination", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "x-waymail-workspace", "in": "header", "description": "Workspace context for session credentials. API keys already belong to a workspace.", "schema": { "type": "string" } }, { "name": "x-waymail-project", "in": "header", "description": "Optional project context; cannot widen credential access.", "schema": { "type": "string" } } ], "responses": { "2XX": { "description": "Successful response. Queued or submitted does not mean delivered. Some deletion operations return an empty 204 response.", "headers": { "x-waymail-request-id": { "description": "Request identifier to quote to support.", "schema": { "type": "string" } }, "retry-after": { "description": "On throttling or quota failures, seconds before retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean", "const": true } }, "required": [ "deleted" ], "additionalProperties": true } } } }, "default": { "description": "API refusal or service failure; retry only when safe for this operation.", "headers": { "x-waymail-request-id": { "description": "Request identifier to quote to support.", "schema": { "type": "string" } }, "retry-after": { "description": "On throttling or quota failures, seconds before retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/forwarding/destinations/{destination}/verification": { "post": { "operationId": "post_forwarding_destinations_by_destination_verification", "summary": "Resend a destination verification email. Also requires email:send. At least 60 seconds between requests; check verification_email_sent.", "tags": [ "send" ], "security": [ { "bearerAuth": [] } ], "x-waymail-required-scopes": [ "inbox:write", "email:send" ], "x-waymail-owner-session": false, "x-waymail-workspace-session": false, "parameters": [ { "name": "destination", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "x-waymail-workspace", "in": "header", "description": "Workspace context for session credentials. API keys already belong to a workspace.", "schema": { "type": "string" } }, { "name": "x-waymail-project", "in": "header", "description": "Optional project context; cannot widen credential access.", "schema": { "type": "string" } } ], "responses": { "2XX": { "description": "Successful response. Queued or submitted does not mean delivered. Some deletion operations return an empty 204 response.", "headers": { "x-waymail-request-id": { "description": "Request identifier to quote to support.", "schema": { "type": "string" } }, "retry-after": { "description": "On throttling or quota failures, seconds before retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^fwd_(eu_|us_)?[0-9A-HJKMNP-TV-Z]{26}$" }, "workspace_id": { "type": "string", "pattern": "^ws_(eu_|us_)?[0-9A-HJKMNP-TV-Z]{26}$" }, "project_id": { "type": "string", "pattern": "^prj_(eu_|us_)?[0-9A-HJKMNP-TV-Z]{26}$" }, "address": {}, "status": { "type": "string", "enum": [ "pending", "verified", "deleted" ] }, "verified_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "verification_email_sent": { "type": "boolean" } }, "required": [ "id", "workspace_id", "project_id", "address", "status", "verified_at", "created_at", "updated_at", "revision", "verification_email_sent" ], "additionalProperties": true } } } }, "default": { "description": "API refusal or service failure; retry only when safe for this operation.", "headers": { "x-waymail-request-id": { "description": "Request identifier to quote to support.", "schema": { "type": "string" } }, "retry-after": { "description": "On throttling or quota failures, seconds before retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/forwarding/destinations/{destination}/verify": { "post": { "operationId": "post_forwarding_destinations_by_destination_verify", "summary": "Verify a destination with the code delivered to its mailbox. Code expires in 30 minutes and is never included in API responses.", "tags": [ "send" ], "security": [ { "bearerAuth": [] } ], "x-waymail-required-scopes": [ "inbox:write" ], "x-waymail-owner-session": false, "x-waymail-workspace-session": false, "parameters": [ { "name": "destination", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "x-waymail-workspace", "in": "header", "description": "Workspace context for session credentials. API keys already belong to a workspace.", "schema": { "type": "string" } }, { "name": "x-waymail-project", "in": "header", "description": "Optional project context; cannot widen credential access.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "minLength": 6, "maxLength": 128 } }, "required": [ "token" ], "additionalProperties": false } } } }, "responses": { "2XX": { "description": "Successful response. Queued or submitted does not mean delivered. Some deletion operations return an empty 204 response.", "headers": { "x-waymail-request-id": { "description": "Request identifier to quote to support.", "schema": { "type": "string" } }, "retry-after": { "description": "On throttling or quota failures, seconds before retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^fwd_(eu_|us_)?[0-9A-HJKMNP-TV-Z]{26}$" }, "workspace_id": { "type": "string", "pattern": "^ws_(eu_|us_)?[0-9A-HJKMNP-TV-Z]{26}$" }, "project_id": { "type": "string", "pattern": "^prj_(eu_|us_)?[0-9A-HJKMNP-TV-Z]{26}$" }, "address": {}, "status": { "type": "string", "enum": [ "pending", "verified", "deleted" ] }, "verified_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "workspace_id", "project_id", "address", "status", "verified_at", "created_at", "updated_at", "revision" ], "additionalProperties": true } } } }, "default": { "description": "API refusal or service failure; retry only when safe for this operation.", "headers": { "x-waymail-request-id": { "description": "Request identifier to quote to support.", "schema": { "type": "string" } }, "retry-after": { "description": "On throttling or quota failures, seconds before retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/forwarding/rules": { "get": { "operationId": "get_forwarding_rules", "summary": "List standalone exact-address or catch-all domain forwarding rules. Rules do not consume mailbox capacity.", "tags": [ "send" ], "security": [ { "bearerAuth": [] } ], "x-waymail-required-scopes": [ "inbox:read" ], "x-waymail-owner-session": false, "x-waymail-workspace-session": false, "parameters": [ { "name": "limit", "in": "query", "description": "1โ€“100 per page", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "description": "next_cursor from the previous page", "schema": { "type": "string" } }, { "name": "x-waymail-workspace", "in": "header", "description": "Workspace context for session credentials. API keys already belong to a workspace.", "schema": { "type": "string" } }, { "name": "x-waymail-project", "in": "header", "description": "Optional project context; cannot widen credential access.", "schema": { "type": "string" } } ], "responses": { "2XX": { "description": "Successful response. Queued or submitted does not mean delivered. Some deletion operations return an empty 204 response.", "headers": { "x-waymail-request-id": { "description": "Request identifier to quote to support.", "schema": { "type": "string" } }, "retry-after": { "description": "On throttling or quota failures, seconds before retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^fwr_(eu_|us_)?[0-9A-HJKMNP-TV-Z]{26}$" }, "workspace_id": { "type": "string", "pattern": "^ws_(eu_|us_)?[0-9A-HJKMNP-TV-Z]{26}$" }, "project_id": { "type": "string", "pattern": "^prj_(eu_|us_)?[0-9A-HJKMNP-TV-Z]{26}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "domain_ids": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "pattern": "^dom_(eu_|us_)?[0-9A-HJKMNP-TV-Z]{26}$" } }, "domain_names": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 4, "maxLength": 253, "pattern": "^(?!-)[a-z0-9-]{1,63}(?