{ "openapi": "3.0.3", "info": { "title": "Sendbound API", "version": "1.0.0", "description": "Generated from controller routes and runtime validators. Secret-key project operations and dashboard-session account operations are explicitly distinguished. See the inbound guide for payload/signature/retry details." }, "servers": [ { "url": "https://api.sendbound.com" } ], "paths": { "/ai/compose": { "post": { "operationId": "ai_compose", "summary": "compose (ai)", "tags": [ "ai" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "AI", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "prompt": {}, "tone": {}, "emailType": {}, "existingHtml": {} }, "additionalProperties": true } } } } } }, "/ai/rewrite": { "post": { "operationId": "ai_rewrite", "summary": "rewrite (ai)", "tags": [ "ai" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "AI", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "html": {}, "mode": {} }, "additionalProperties": true } } } } } }, "/ai/subject-lines": { "post": { "operationId": "ai_subject_lines", "summary": "subject Lines (ai)", "tags": [ "ai" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "AI", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "emailHtml": {}, "campaignName": {} }, "additionalProperties": true } } } } } }, "/ai/preview-text": { "post": { "operationId": "ai_preview_text", "summary": "preview Text (ai)", "tags": [ "ai" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "AI", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "emailHtml": {} }, "additionalProperties": true } } } } } }, "/ai/spam-check": { "post": { "operationId": "ai_spam_check", "summary": "spam Check (ai)", "tags": [ "ai" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "AI", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "subject": {}, "html": {} }, "additionalProperties": true } } } } } }, "/ai/segment-rules": { "post": { "operationId": "ai_segment_rules", "summary": "segment Rules (ai)", "tags": [ "ai" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "AI", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "prompt": {} }, "additionalProperties": true } } } } } }, "/ai/campaign-debrief": { "post": { "operationId": "ai_campaign_debrief", "summary": "campaign Debrief (ai)", "tags": [ "ai" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "AI", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "campaignId": {} }, "additionalProperties": true } } } } } }, "/ai/send-time": { "post": { "operationId": "ai_send_time", "summary": "send Time (ai)", "tags": [ "ai" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "AI", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] } }, "/v1/track": { "post": { "operationId": "actions_track", "summary": "track (v1)", "tags": [ "v1" ], "description": "Browser tracking only; not a private project API. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "PublicTrackingKey": [] } ], "x-access": "public-key", "x-mcp": false, "x-controller": "Actions", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "minLength": 1 }, "email": { "type": "string", "format": "email" }, "subscribed": { "type": "boolean" }, "data": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true }, { "type": "string", "format": "date-time" } ] }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } }, "required": [ "event", "email" ], "additionalProperties": false } } } } } }, "/v1/send": { "post": { "operationId": "send_email", "summary": "send (v1)", "tags": [ "v1" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Actions", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "to": { "anyOf": [ { "type": "string", "format": "email" }, { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^\\r\\n]*$" }, "email": { "type": "string", "format": "email" } }, "required": [ "email" ], "additionalProperties": false }, { "type": "array", "items": { "anyOf": [ { "type": "string", "format": "email" }, { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^\\r\\n]*$" }, "email": { "type": "string", "format": "email" } }, "required": [ "email" ], "additionalProperties": false } ] } } ] }, "subject": { "type": "string", "minLength": 1, "maxLength": 998, "pattern": "^[^\\r\\n]*$" }, "body": { "type": "string", "minLength": 1 }, "template": { "type": "string", "format": "uuid" }, "subscribed": { "type": "boolean" }, "name": { "type": "string" }, "from": { "anyOf": [ { "type": "string", "format": "email" }, { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^\\r\\n]*$" }, "email": { "type": "string", "format": "email" } }, "required": [ "email" ], "additionalProperties": false } ] }, "reply": { "type": "string", "format": "email" }, "cc": { "anyOf": [ { "type": "string", "format": "email" }, { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string", "format": "email" } }, "required": [ "email" ], "additionalProperties": false }, { "type": "array", "items": { "anyOf": [ { "type": "string", "format": "email" }, { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string", "format": "email" } }, "required": [ "email" ], "additionalProperties": false } ] } } ] }, "bcc": { "anyOf": [ { "type": "string", "format": "email" }, { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string", "format": "email" } }, "required": [ "email" ], "additionalProperties": false }, { "type": "array", "items": { "anyOf": [ { "type": "string", "format": "email" }, { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string", "format": "email" } }, "required": [ "email" ], "additionalProperties": false } ] } } ] }, "text": { "type": "string" }, "headers": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 998, "pattern": "^[^\\r\\n]*$" } }, "data": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true }, { "type": "string", "format": "date-time" } ] }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "filename": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[^\\r\\n\"]+$" }, "content": { "type": "string", "minLength": 1 }, "contentType": { "type": "string", "minLength": 1, "maxLength": 255 }, "contentId": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[^<>\\r\\n]+$" }, "disposition": { "type": "string", "enum": [ "attachment", "inline" ], "default": "attachment" } }, "required": [ "filename", "content", "contentType" ], "additionalProperties": false }, "maxItems": 10 } }, "required": [ "to" ], "additionalProperties": false } } } } } }, "/v1/verify": { "post": { "operationId": "actions_verify", "summary": "verify (v1)", "tags": [ "v1" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Actions", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" } }, "required": [ "email" ], "additionalProperties": false } } } } } }, "/activity": { "get": { "operationId": "activity_get_activities", "summary": "get Activities (activity)", "tags": [ "activity" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Activity", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "contactId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "types", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/activity/stats": { "get": { "operationId": "activity_get_stats", "summary": "get Stats (activity)", "tags": [ "activity" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Activity", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/activity/recent-count": { "get": { "operationId": "activity_get_recent_count", "summary": "get Recent Count (activity)", "tags": [ "activity" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Activity", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "minutes", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/activity/types": { "get": { "operationId": "activity_get_types", "summary": "get Types (activity)", "tags": [ "activity" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Activity", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] } }, "/activity/upcoming": { "get": { "operationId": "activity_get_upcoming", "summary": "get Upcoming (activity)", "tags": [ "activity" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Activity", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "daysAhead", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/analytics/timeseries": { "get": { "operationId": "analytics_get_time_series", "summary": "get Time Series (analytics)", "tags": [ "analytics" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Analytics", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/analytics/top-campaigns": { "get": { "operationId": "analytics_get_top_campaigns", "summary": "get Top Campaigns (analytics)", "tags": [ "analytics" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Analytics", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/analytics/campaign-stats": { "get": { "operationId": "analytics_get_campaign_stats", "summary": "get Campaign Stats (analytics)", "tags": [ "analytics" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Analytics", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/analytics/top-events": { "get": { "operationId": "analytics_get_top_events", "summary": "get Top Events (analytics)", "tags": [ "analytics" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Analytics", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/api-keys": { "get": { "operationId": "api_keys_list", "summary": "list (api-keys)", "tags": [ "api-keys" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "ApiKeys", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] }, "post": { "operationId": "api_keys_create", "summary": "create (api-keys)", "tags": [ "api-keys" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "ApiKeys", "responses": { "201": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64 } }, "required": [ "name" ], "additionalProperties": false } } } } } }, "/api-keys/usage": { "get": { "operationId": "api_keys_usage", "summary": "usage (api-keys)", "tags": [ "api-keys" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "ApiKeys", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/api-keys/{id}": { "delete": { "operationId": "api_keys_revoke", "summary": "revoke (api-keys)", "tags": [ "api-keys" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "ApiKeys", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/auth/login": { "post": { "operationId": "auth_login", "summary": "login (auth)", "tags": [ "auth" ], "description": "Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [], "x-access": "public", "x-mcp": false, "x-controller": "Auth", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string", "minLength": 6 } }, "required": [ "email", "password" ], "additionalProperties": false } } } } } }, "/auth/signup": { "post": { "operationId": "auth_signup", "summary": "signup (auth)", "tags": [ "auth" ], "description": "Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [], "x-access": "public", "x-mcp": false, "x-controller": "Auth", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string", "minLength": 6 }, "firstName": { "type": "string", "minLength": 1, "maxLength": 50 }, "lastName": { "type": "string", "minLength": 1, "maxLength": 50 }, "company": { "type": "string", "minLength": 1, "maxLength": 100 }, "cf-turnstile-response": { "type": "string" } }, "required": [ "email", "password", "firstName", "lastName", "company" ], "additionalProperties": false } } } } } }, "/auth/logout": { "get": { "operationId": "auth_logout", "summary": "logout (auth)", "tags": [ "auth" ], "description": "Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [], "x-access": "public", "x-mcp": false, "x-controller": "Auth", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] } }, "/auth/oauth-config": { "get": { "operationId": "auth_oauth_config", "summary": "oauth Config (auth)", "tags": [ "auth" ], "description": "Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [], "x-access": "public", "x-mcp": false, "x-controller": "Auth", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] } }, "/auth/verify-email": { "post": { "operationId": "auth_verify_email", "summary": "verify Email (auth)", "tags": [ "auth" ], "description": "Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [], "x-access": "public", "x-mcp": false, "x-controller": "Auth", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "minLength": 64, "maxLength": 64 }, "code": { "type": "string", "minLength": 6, "maxLength": 6, "pattern": "^\\d{6}$" } }, "additionalProperties": false } } } } } }, "/auth/request-verification": { "post": { "operationId": "auth_request_verification", "summary": "request Verification (auth)", "tags": [ "auth" ], "description": "Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [], "x-access": "public", "x-mcp": false, "x-controller": "Auth", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] } }, "/auth/request-password-reset": { "post": { "operationId": "auth_request_password_reset", "summary": "request Password Reset (auth)", "tags": [ "auth" ], "description": "Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [], "x-access": "public", "x-mcp": false, "x-controller": "Auth", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" } }, "required": [ "email" ], "additionalProperties": false } } } } } }, "/auth/reset-password": { "post": { "operationId": "auth_reset_password", "summary": "reset Password (auth)", "tags": [ "auth" ], "description": "Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [], "x-access": "public", "x-mcp": false, "x-controller": "Auth", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "minLength": 64, "maxLength": 64 }, "newPassword": { "type": "string", "minLength": 6 } }, "required": [ "token", "newPassword" ], "additionalProperties": false } } } } } }, "/auth/magic-link/request": { "post": { "operationId": "auth_request_magic_link", "summary": "request Magic Link (auth)", "tags": [ "auth" ], "description": "Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [], "x-access": "public", "x-mcp": false, "x-controller": "Auth", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" } }, "required": [ "email" ], "additionalProperties": false } } } } } }, "/auth/magic-link/verify": { "post": { "operationId": "auth_verify_magic_link", "summary": "verify Magic Link (auth)", "tags": [ "auth" ], "description": "Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [], "x-access": "public", "x-mcp": false, "x-controller": "Auth", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "minLength": 64, "maxLength": 64 } }, "required": [ "token" ], "additionalProperties": false } } } } } }, "/campaigns": { "post": { "operationId": "create_campaign", "summary": "create (campaigns)", "tags": [ "campaigns" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Campaigns", "responses": { "201": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "description": { "type": "string" }, "subject": { "type": "string", "minLength": 1 }, "body": { "type": "string", "minLength": 1 }, "from": { "type": "string", "format": "email" }, "fromName": { "type": "string", "maxLength": 100, "nullable": true }, "replyTo": { "type": "string", "format": "email", "nullable": true }, "type": { "type": "string", "enum": [ "TRANSACTIONAL", "MARKETING", "HEADLESS" ], "default": "MARKETING" }, "audienceType": { "type": "string", "enum": [ "ALL", "FILTERED", "SEGMENT" ] }, "audienceCondition": { "type": "object", "properties": { "logic": { "type": "string", "enum": [ "AND", "OR" ] }, "groups": { "type": "array", "items": { "type": "object", "properties": { "filters": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "enum": [ "equals", "notEquals", "contains", "notContains", "greaterThan", "lessThan", "greaterThanOrEqual", "lessThanOrEqual", "exists", "notExists", "within", "olderThan", "triggered", "triggeredWithin", "triggeredOlderThan", "notTriggered", "notTriggeredWithin", "memberOfSegment", "notMemberOfSegment" ] }, "value": {}, "unit": { "type": "string", "enum": [ "days", "hours", "minutes" ] } }, "required": [ "field", "operator" ], "additionalProperties": false } }, "conditions": {} }, "required": [ "filters" ], "additionalProperties": false }, "minItems": 1 } }, "required": [ "logic", "groups" ], "additionalProperties": false }, "segmentId": { "type": "string", "format": "uuid" }, "isABTest": { "type": "boolean" }, "abVariantSubject": { "type": "string", "minLength": 1 }, "abVariantBody": { "type": "string", "minLength": 1 }, "abSplitPercent": { "type": "integer", "minimum": 1, "maximum": 99 }, "abTestDuration": { "type": "integer", "minimum": 1, "maximum": 168 } }, "required": [ "name", "subject", "body", "from", "audienceType" ], "additionalProperties": false } } } } }, "get": { "operationId": "list_campaigns", "summary": "list (campaigns)", "tags": [ "campaigns" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Campaigns", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "dir", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/campaigns/bulk-update": { "post": { "operationId": "campaigns_bulk_update", "summary": "bulk Update (campaigns)", "tags": [ "campaigns" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Campaigns", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "maxItems": 1000 }, "delete": { "type": "boolean" } }, "required": [ "ids" ], "additionalProperties": false } } } } } }, "/campaigns/{id}": { "get": { "operationId": "get_campaign", "summary": "get (campaigns)", "tags": [ "campaigns" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Campaigns", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] }, "put": { "operationId": "campaigns_update", "summary": "update (campaigns)", "tags": [ "campaigns" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Campaigns", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "subject": { "type": "string" }, "body": { "type": "string" }, "from": { "type": "string" }, "fromName": { "type": "string", "maxLength": 100, "nullable": true }, "replyTo": { "type": "string", "nullable": true }, "type": { "type": "string", "enum": [ "TRANSACTIONAL", "MARKETING", "HEADLESS" ] }, "audienceType": { "type": "string", "enum": [ "ALL", "FILTERED", "SEGMENT" ] }, "audienceCondition": { "type": "object", "properties": { "logic": { "type": "string", "enum": [ "AND", "OR" ] }, "groups": { "type": "array", "items": { "type": "object", "properties": { "filters": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "enum": [ "equals", "notEquals", "contains", "notContains", "greaterThan", "lessThan", "greaterThanOrEqual", "lessThanOrEqual", "exists", "notExists", "within", "olderThan", "triggered", "triggeredWithin", "triggeredOlderThan", "notTriggered", "notTriggeredWithin", "memberOfSegment", "notMemberOfSegment" ] }, "value": {}, "unit": { "type": "string", "enum": [ "days", "hours", "minutes" ] } }, "required": [ "field", "operator" ], "additionalProperties": false } }, "conditions": {} }, "required": [ "filters" ], "additionalProperties": false }, "minItems": 1 } }, "required": [ "logic", "groups" ], "additionalProperties": false }, "segmentId": { "type": "string" }, "isABTest": { "type": "boolean" }, "abVariantSubject": { "type": "string", "minLength": 1, "nullable": true }, "abVariantBody": { "type": "string", "minLength": 1, "nullable": true }, "abSplitPercent": { "type": "integer", "minimum": 1, "maximum": 99 }, "abTestDuration": { "type": "integer", "minimum": 1, "maximum": 168 } }, "additionalProperties": false } } } } }, "delete": { "operationId": "campaigns_delete", "summary": "delete (campaigns)", "tags": [ "campaigns" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Campaigns", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/campaigns/{id}/duplicate": { "post": { "operationId": "campaigns_duplicate", "summary": "duplicate (campaigns)", "tags": [ "campaigns" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Campaigns", "responses": { "201": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/campaigns/{id}/send": { "post": { "operationId": "send_campaign", "summary": "send (campaigns)", "tags": [ "campaigns" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Campaigns", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "scheduledFor": {} }, "additionalProperties": true } } } } } }, "/campaigns/{id}/cancel": { "post": { "operationId": "cancel_campaign", "summary": "cancel (campaigns)", "tags": [ "campaigns" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Campaigns", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/campaigns/{id}/stats": { "get": { "operationId": "get_campaign_stats", "summary": "stats (campaigns)", "tags": [ "campaigns" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Campaigns", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/campaigns/{id}/pick-winner": { "post": { "operationId": "campaigns_pick_winner", "summary": "pick Winner (campaigns)", "tags": [ "campaigns" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Campaigns", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "variant": { "type": "string", "enum": [ "A", "B" ] } }, "required": [ "variant" ], "additionalProperties": false } } } } } }, "/campaigns/{id}/analytics": { "get": { "operationId": "campaigns_analytics", "summary": "analytics (campaigns)", "tags": [ "campaigns" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Campaigns", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/campaigns/{id}/test": { "post": { "operationId": "campaigns_send_test", "summary": "send Test (campaigns)", "tags": [ "campaigns" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Campaigns", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" } }, "required": [ "email" ], "additionalProperties": false } } } } } }, "/config": { "get": { "operationId": "config_get_config", "summary": "get Config (config)", "tags": [ "config" ], "description": "Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [], "x-access": "public", "x-mcp": false, "x-controller": "Config", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] } }, "/contacts": { "get": { "operationId": "list_contacts", "summary": "list (contacts)", "tags": [ "contacts" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Contacts", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "subscribed", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "dir", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "tagId", "in": "query", "required": false, "schema": { "type": "string" } } ] }, "post": { "operationId": "create_contact", "summary": "create (contacts)", "tags": [ "contacts" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Contacts", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "data": { "type": "object", "additionalProperties": {} }, "subscribed": { "type": "boolean" } }, "required": [ "email" ], "additionalProperties": false } } } } } }, "/contacts/export": { "get": { "operationId": "contacts_export_contacts", "summary": "export Contacts (contacts)", "tags": [ "contacts" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Contacts", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] } }, "/contacts/fields": { "get": { "operationId": "contacts_get_available_fields", "summary": "get Available Fields (contacts)", "tags": [ "contacts" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Contacts", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] } }, "/contacts/suppressions": { "get": { "operationId": "contacts_list_suppressions", "summary": "list Suppressions (contacts)", "tags": [ "contacts" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Contacts", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ] }, "post": { "operationId": "contacts_add_suppression", "summary": "add Suppression (contacts)", "tags": [ "contacts" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Contacts", "responses": { "201": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": {}, "reason": {} }, "additionalProperties": true } } } } } }, "/contacts/suppressions/{contactId}": { "delete": { "operationId": "contacts_remove_suppression", "summary": "remove Suppression (contacts)", "tags": [ "contacts" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Contacts", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/contacts/suppressions/stats": { "get": { "operationId": "contacts_suppression_stats", "summary": "suppression Stats (contacts)", "tags": [ "contacts" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Contacts", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] } }, "/contacts/suppressions/export": { "get": { "operationId": "contacts_export_suppressions", "summary": "export Suppressions (contacts)", "tags": [ "contacts" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Contacts", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] } }, "/contacts/fields/{field}/values": { "get": { "operationId": "contacts_get_field_values", "summary": "get Field Values (contacts)", "tags": [ "contacts" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Contacts", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "field", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/contacts/{id}": { "get": { "operationId": "get_contact", "summary": "get (contacts)", "tags": [ "contacts" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Contacts", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] }, "patch": { "operationId": "update_contact", "summary": "update (contacts)", "tags": [ "contacts" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Contacts", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "data": { "type": "object", "additionalProperties": {} }, "subscribed": { "type": "boolean" } }, "additionalProperties": false } } } } }, "delete": { "operationId": "delete_contact", "summary": "delete (contacts)", "tags": [ "contacts" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Contacts", "responses": { "204": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/contacts/{id}/tags": { "post": { "operationId": "contacts_add_tags", "summary": "add Tags (contacts)", "tags": [ "contacts" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Contacts", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tagIds": {} }, "additionalProperties": true } } } } } }, "/contacts/{id}/tags/{tagId}": { "delete": { "operationId": "contacts_remove_tag", "summary": "remove Tag (contacts)", "tags": [ "contacts" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Contacts", "responses": { "204": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/contacts/{id}/emails": { "get": { "operationId": "contacts_get_emails", "summary": "get Emails (contacts)", "tags": [ "contacts" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Contacts", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/contacts/public/{id}": { "get": { "operationId": "contacts_get_public", "summary": "get Public (contacts)", "tags": [ "contacts" ], "description": "Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [], "x-access": "public", "x-mcp": false, "x-controller": "Contacts", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/contacts/public/{id}/subscribe": { "post": { "operationId": "contacts_subscribe_public", "summary": "subscribe Public (contacts)", "tags": [ "contacts" ], "description": "Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [], "x-access": "public", "x-mcp": false, "x-controller": "Contacts", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/contacts/public/{id}/unsubscribe": { "post": { "operationId": "contacts_unsubscribe_public", "summary": "unsubscribe Public (contacts)", "tags": [ "contacts" ], "description": "Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [], "x-access": "public", "x-mcp": false, "x-controller": "Contacts", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/contacts/lookup": { "post": { "operationId": "contacts_lookup", "summary": "lookup (contacts)", "tags": [ "contacts" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Contacts", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "emails": {} }, "additionalProperties": true } } } } } }, "/contacts/import": { "post": { "operationId": "contacts_import_csv", "summary": "import Csv (contacts)", "tags": [ "contacts" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Contacts", "responses": { "202": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary" } } } } } } } }, "/contacts/import/{jobId}": { "get": { "operationId": "contacts_get_import_status", "summary": "get Import Status (contacts)", "tags": [ "contacts" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Contacts", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/contacts/fields/{field}/usage": { "get": { "operationId": "contacts_get_field_usage", "summary": "get Field Usage (contacts)", "tags": [ "contacts" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Contacts", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "field", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/contacts/fields/{field}": { "delete": { "operationId": "contacts_delete_field", "summary": "delete Field (contacts)", "tags": [ "contacts" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Contacts", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "field", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/contacts/bulk-subscribe": { "post": { "operationId": "contacts_bulk_subscribe", "summary": "bulk Subscribe (contacts)", "tags": [ "contacts" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Contacts", "responses": { "202": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "ids" ] }, "contactIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "maxItems": 1000 } }, "required": [ "mode", "contactIds" ], "additionalProperties": false }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "query" ] }, "filter": { "type": "object", "properties": { "search": { "type": "string", "maxLength": 255 }, "subscribed": { "type": "boolean" }, "tagId": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "default": {} }, "excludeIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 10000 } }, "required": [ "mode" ], "additionalProperties": false } ] } } } } } }, "/contacts/bulk-unsubscribe": { "post": { "operationId": "contacts_bulk_unsubscribe", "summary": "bulk Unsubscribe (contacts)", "tags": [ "contacts" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Contacts", "responses": { "202": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "ids" ] }, "contactIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "maxItems": 1000 } }, "required": [ "mode", "contactIds" ], "additionalProperties": false }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "query" ] }, "filter": { "type": "object", "properties": { "search": { "type": "string", "maxLength": 255 }, "subscribed": { "type": "boolean" }, "tagId": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "default": {} }, "excludeIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 10000 } }, "required": [ "mode" ], "additionalProperties": false } ] } } } } } }, "/contacts/bulk-delete": { "post": { "operationId": "contacts_bulk_delete", "summary": "bulk Delete (contacts)", "tags": [ "contacts" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Contacts", "responses": { "202": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "ids" ] }, "contactIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "maxItems": 1000 } }, "required": [ "mode", "contactIds" ], "additionalProperties": false }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "query" ] }, "filter": { "type": "object", "properties": { "search": { "type": "string", "maxLength": 255 }, "subscribed": { "type": "boolean" }, "tagId": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "default": {} }, "excludeIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 10000 } }, "required": [ "mode" ], "additionalProperties": false } ] } } } } } }, "/contacts/bulk/{jobId}": { "get": { "operationId": "contacts_get_bulk_action_status", "summary": "get Bulk Action Status (contacts)", "tags": [ "contacts" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Contacts", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/dedicated-ips": { "get": { "operationId": "dedicated_ips_list", "summary": "list (dedicated-ips)", "tags": [ "dedicated-ips" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "DedicatedIps", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] }, "post": { "operationId": "dedicated_ips_create", "summary": "create (dedicated-ips)", "tags": [ "dedicated-ips" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "DedicatedIps", "responses": { "201": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ip": {}, "notes": {}, "dailySendCap": {}, "warmupTarget": {} }, "additionalProperties": true } } } } } }, "/dedicated-ips/{id}": { "patch": { "operationId": "dedicated_ips_update", "summary": "update (dedicated-ips)", "tags": [ "dedicated-ips" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "DedicatedIps", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": {}, "notes": {}, "advanceDays": {} }, "additionalProperties": true } } } } }, "delete": { "operationId": "dedicated_ips_remove", "summary": "remove (dedicated-ips)", "tags": [ "dedicated-ips" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "DedicatedIps", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/developer/smtp/test": { "post": { "operationId": "developer_test_smtp_send", "summary": "test Smtp Send (developer)", "tags": [ "developer" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Developer", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "projectId": {} }, "required": [ "projectId" ], "additionalProperties": true } } } } } }, "/v2/domainTemplates/providers/sendbound.com/services/email-sending": { "get": { "operationId": "domain_connect_get_email_template", "summary": "get Email Template (v2/domainTemplates/providers/sendbound.com/services)", "tags": [ "v2/domainTemplates/providers/sendbound.com/services" ], "description": "Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [], "x-access": "public", "x-mcp": false, "x-controller": "DomainConnect", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] } }, "/domains": { "get": { "operationId": "list_domains", "summary": "list Domains (domains)", "tags": [ "domains" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Domains", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] }, "post": { "operationId": "add_domain", "summary": "add Domain (domains)", "tags": [ "domains" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Domains", "responses": { "201": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "minLength": 3, "maxLength": 253 } }, "required": [ "domain" ], "additionalProperties": false } } } } } }, "/domains/project/{projectId}": { "get": { "operationId": "domains_get_project_domains", "summary": "get Project Domains (domains)", "tags": [ "domains" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Domains", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/domains/{id}": { "get": { "operationId": "domains_get_domain", "summary": "get Domain (domains)", "tags": [ "domains" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Domains", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] }, "delete": { "operationId": "domains_remove_domain", "summary": "remove Domain (domains)", "tags": [ "domains" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Domains", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/domains/{id}/verify": { "get": { "operationId": "verify_domain", "summary": "check Verification (domains)", "tags": [ "domains" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Domains", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/domains/{id}/dns-check": { "get": { "operationId": "domains_check_dns", "summary": "check Dns (domains)", "tags": [ "domains" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Domains", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/domains/{id}/toggle": { "patch": { "operationId": "domains_toggle_feature", "summary": "toggle Feature (domains)", "tags": [ "domains" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Domains", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "feature": {}, "enabled": {} }, "additionalProperties": true } } } } } }, "/emails/batch": { "post": { "operationId": "batch_send_email", "summary": "batch Send (emails)", "tags": [ "emails" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Emails", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "emails": { "type": "array", "items": { "type": "object", "properties": { "to": { "anyOf": [ { "type": "string", "format": "email" }, { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string", "format": "email" } }, "required": [ "email" ], "additionalProperties": false }, { "type": "array", "items": { "anyOf": [ { "type": "string", "format": "email" }, { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string", "format": "email" } }, "required": [ "email" ], "additionalProperties": false } ] } } ] }, "from": { "anyOf": [ { "type": "string", "format": "email" }, { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string", "format": "email" } }, "required": [ "email" ], "additionalProperties": false } ] }, "subject": { "type": "string" }, "body": { "type": "string" }, "template": { "type": "string" }, "data": { "type": "object", "additionalProperties": {} }, "reply": { "type": "string", "format": "email" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "filename": { "type": "string" }, "content": { "type": "string" }, "contentType": { "type": "string" } }, "required": [ "filename", "content", "contentType" ], "additionalProperties": false } }, "subscribed": { "type": "boolean" } }, "required": [ "to", "from" ], "additionalProperties": false }, "minItems": 1, "maxItems": 100 } }, "required": [ "emails" ], "additionalProperties": false } } } } } }, "/emails": { "get": { "operationId": "list_emails", "summary": "list (emails)", "tags": [ "emails" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Emails", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/emails/inbound": { "get": { "operationId": "list_inbound_emails", "summary": "list Inbound (emails)", "tags": [ "emails" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Emails", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/emails/{id}/attachments/{attachmentId}": { "get": { "operationId": "download_inbound_attachment", "summary": "download Inbound Attachment (emails)", "tags": [ "emails" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Emails", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "attachmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/emails/{id}": { "get": { "operationId": "get_email", "summary": "get One (emails)", "tags": [ "emails" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Emails", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/events/track": { "post": { "operationId": "events_track", "summary": "track (events)", "tags": [ "events" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Events", "responses": { "201": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": {}, "contactId": {}, "emailId": {}, "data": {} }, "required": [ "name" ], "additionalProperties": true } } } } } }, "/events": { "get": { "operationId": "events_list", "summary": "list (events)", "tags": [ "events" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Events", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "eventName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/events/stats": { "get": { "operationId": "events_stats", "summary": "stats (events)", "tags": [ "events" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Events", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/events/contact/{contactId}": { "get": { "operationId": "events_get_contact_events", "summary": "get Contact Events (events)", "tags": [ "events" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Events", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/events/names": { "get": { "operationId": "events_get_event_names", "summary": "get Event Names (events)", "tags": [ "events" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Events", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] } }, "/events/{eventName}/usage": { "get": { "operationId": "events_get_event_usage", "summary": "get Event Usage (events)", "tags": [ "events" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Events", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "eventName", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/events/{eventName}": { "delete": { "operationId": "events_delete_event", "summary": "delete Event (events)", "tags": [ "events" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Events", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "eventName", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/mailchimp/import": { "post": { "operationId": "integrations_import_mailchimp", "summary": "import Mailchimp (integrations)", "tags": [ "integrations" ], "description": "Third-party credentials: use the authenticated dashboard/API, not AI tool arguments. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": false, "x-controller": "Integrations", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "apiKey": {}, "audienceId": {} }, "additionalProperties": true } } } } } }, "/integrations/klaviyo/import": { "post": { "operationId": "integrations_import_klaviyo", "summary": "import Klaviyo (integrations)", "tags": [ "integrations" ], "description": "Third-party credentials: use the authenticated dashboard/API, not AI tool arguments. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": false, "x-controller": "Integrations", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "apiKey": {}, "listId": {} }, "additionalProperties": true } } } } } }, "/integrations/convertkit/import": { "post": { "operationId": "integrations_import_convert_kit", "summary": "import Convert Kit (integrations)", "tags": [ "integrations" ], "description": "Third-party credentials: use the authenticated dashboard/API, not AI tool arguments. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": false, "x-controller": "Integrations", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "apiKey": {} }, "additionalProperties": true } } } } } }, "/integrations/brevo/import": { "post": { "operationId": "integrations_import_brevo", "summary": "import Brevo (integrations)", "tags": [ "integrations" ], "description": "Third-party credentials: use the authenticated dashboard/API, not AI tool arguments. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": false, "x-controller": "Integrations", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "apiKey": {}, "listId": {} }, "additionalProperties": true } } } } } }, "/integrations/hubspot/import": { "post": { "operationId": "integrations_import_hub_spot", "summary": "import Hub Spot (integrations)", "tags": [ "integrations" ], "description": "Third-party credentials: use the authenticated dashboard/API, not AI tool arguments. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": false, "x-controller": "Integrations", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accessToken": {} }, "additionalProperties": true } } } } } }, "/logs": { "get": { "operationId": "logs_list", "summary": "list (logs)", "tags": [ "logs" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Logs", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "method", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/projects/@me/preference-page": { "get": { "operationId": "preferences_get_preference_page", "summary": "get Preference Page ()", "tags": [ "" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Preferences", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] }, "patch": { "operationId": "preferences_update_preference_page", "summary": "update Preference Page ()", "tags": [ "" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Preferences", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } } } } } }, "/preferences/{contactId}": { "get": { "operationId": "preferences_get", "summary": "get ()", "tags": [ "" ], "description": "Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [], "x-access": "public", "x-mcp": false, "x-controller": "Preferences", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "token", "in": "query", "required": false, "schema": { "type": "string" } } ] }, "post": { "operationId": "preferences_update", "summary": "update ()", "tags": [ "" ], "description": "Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [], "x-access": "public", "x-mcp": false, "x-controller": "Preferences", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": {}, "groupId": {}, "subscribed": {} }, "additionalProperties": true } } } } } }, "/preferences/{contactId}/unsubscribe-all": { "post": { "operationId": "preferences_unsubscribe_all", "summary": "unsubscribe All ()", "tags": [ "" ], "description": "Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [], "x-access": "public", "x-mcp": false, "x-controller": "Preferences", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": {} }, "additionalProperties": true } } } } } }, "/unsubscribe-groups": { "get": { "operationId": "preferences_list_groups", "summary": "list Groups ()", "tags": [ "" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Preferences", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] }, "post": { "operationId": "preferences_create_group", "summary": "create Group ()", "tags": [ "" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Preferences", "responses": { "201": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": {}, "description": {}, "isDefault": {} }, "additionalProperties": true } } } } } }, "/unsubscribe-groups/{id}": { "patch": { "operationId": "preferences_update_group", "summary": "update Group ()", "tags": [ "" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Preferences", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": {}, "description": {}, "isDefault": {} }, "additionalProperties": true } } } } }, "delete": { "operationId": "preferences_delete_group", "summary": "delete Group ()", "tags": [ "" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Preferences", "responses": { "204": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/projects/{projectId}/webhooks": { "get": { "operationId": "project_webhooks_list", "summary": "list (projects/:projectId/webhooks)", "tags": [ "webhooks" ], "description": "Dashboard alias; MCP uses canonical /webhooks. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": false, "x-controller": "ProjectWebhooks", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "deprecated": true }, "post": { "operationId": "project_webhooks_create", "summary": "create (projects/:projectId/webhooks)", "tags": [ "webhooks" ], "description": "Dashboard alias; MCP uses canonical /webhooks. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": false, "x-controller": "ProjectWebhooks", "responses": { "201": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "minLength": 1 }, "description": { "type": "string", "maxLength": 500 }, "events": { "type": "array", "items": { "type": "string", "enum": [ "email.sent", "email.opened", "email.clicked", "email.bounced", "email.complained", "email.unsubscribed", "email.received", "contact.created", "contact.updated", "contact.subscribed", "contact.unsubscribed", "contact.deleted", "campaign.scheduled", "campaign.sent", "campaign.cancelled" ] } }, "inboundDomain": { "type": "string", "maxLength": 253, "nullable": true }, "inboundPattern": { "type": "string", "maxLength": 64, "nullable": true }, "enabled": { "type": "boolean" } }, "required": [ "url" ], "additionalProperties": false } } } } } }, "/projects/{projectId}/webhooks/{id}": { "get": { "operationId": "project_webhooks_get", "summary": "get (projects/:projectId/webhooks)", "tags": [ "webhooks" ], "description": "Dashboard alias; MCP uses canonical /webhooks. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": false, "x-controller": "ProjectWebhooks", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "deprecated": true }, "patch": { "operationId": "project_webhooks_update", "summary": "update (projects/:projectId/webhooks)", "tags": [ "webhooks" ], "description": "Dashboard alias; MCP uses canonical /webhooks. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": false, "x-controller": "ProjectWebhooks", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "minLength": 1 }, "description": { "type": "string", "maxLength": 500 }, "events": { "type": "array", "items": { "type": "string", "enum": [ "email.sent", "email.opened", "email.clicked", "email.bounced", "email.complained", "email.unsubscribed", "email.received", "contact.created", "contact.updated", "contact.subscribed", "contact.unsubscribed", "contact.deleted", "campaign.scheduled", "campaign.sent", "campaign.cancelled" ] } }, "inboundDomain": { "type": "string", "maxLength": 253, "nullable": true }, "inboundPattern": { "type": "string", "maxLength": 64, "nullable": true }, "enabled": { "type": "boolean" }, "rotateSecret": { "type": "boolean" } }, "additionalProperties": false } } } } }, "delete": { "operationId": "project_webhooks_delete", "summary": "delete (projects/:projectId/webhooks)", "tags": [ "webhooks" ], "description": "Dashboard alias; MCP uses canonical /webhooks. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": false, "x-controller": "ProjectWebhooks", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "deprecated": true } }, "/projects/{projectId}/webhooks/{id}/deliveries": { "get": { "operationId": "project_webhooks_deliveries", "summary": "deliveries (projects/:projectId/webhooks)", "tags": [ "webhooks" ], "description": "Dashboard alias; MCP uses canonical /webhooks. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": false, "x-controller": "ProjectWebhooks", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "deprecated": true } }, "/projects/{projectId}/webhooks/{id}/test": { "post": { "operationId": "project_webhooks_test", "summary": "test (projects/:projectId/webhooks)", "tags": [ "webhooks" ], "description": "Dashboard alias; MCP uses canonical /webhooks. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": false, "x-controller": "ProjectWebhooks", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "deprecated": true, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "enum": [ "test", "email.received" ] }, "recipient": { "type": "string", "maxLength": 320, "format": "email" } }, "additionalProperties": false } } } } } }, "/projects/@me/smtp/credentials": { "get": { "operationId": "projects_get_smtp_credentials", "summary": "get Smtp Credentials (projects)", "tags": [ "projects" ], "description": "Project configuration/credential boundary; use the authenticated API/dashboard. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": false, "x-controller": "Projects", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] } }, "/projects/@me/smtp": { "put": { "operationId": "projects_update_smtp_settings", "summary": "update Smtp Settings (projects)", "tags": [ "projects" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Projects", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "X-Project-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } } } } } }, "/projects/@me/smtp/test": { "post": { "operationId": "projects_test_smtp_settings", "summary": "test Smtp Settings (projects)", "tags": [ "projects" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Projects", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] } }, "/projects/@me/deliverability": { "get": { "operationId": "projects_get_deliverability", "summary": "get Deliverability (projects)", "tags": [ "projects" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Projects", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] } }, "/projects/{id}/setup-state": { "get": { "operationId": "projects_get_setup_state", "summary": "get Setup State (projects)", "tags": [ "projects" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Projects", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "X-Project-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/projects/{id}/security": { "get": { "operationId": "projects_get_security_metrics", "summary": "get Security Metrics (projects)", "tags": [ "projects" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Projects", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "X-Project-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/projects/{id}/members": { "get": { "operationId": "projects_get_members", "summary": "get Members (projects)", "tags": [ "projects" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Projects", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "X-Project-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] }, "post": { "operationId": "projects_add_member", "summary": "add Member (projects)", "tags": [ "projects" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Projects", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "X-Project-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "role": { "type": "string", "enum": [ "ADMIN", "MEMBER" ], "default": "MEMBER" } }, "required": [ "email" ], "additionalProperties": false } } } } } }, "/projects/{id}/members/{userId}": { "patch": { "operationId": "projects_update_member_role", "summary": "update Member Role (projects)", "tags": [ "projects" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Projects", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "X-Project-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "ADMIN", "MEMBER" ] } }, "required": [ "role" ], "additionalProperties": false } } } } }, "delete": { "operationId": "projects_remove_member", "summary": "remove Member (projects)", "tags": [ "projects" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Projects", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "X-Project-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/segments": { "get": { "operationId": "list_segments", "summary": "list (segments)", "tags": [ "segments" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Segments", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] }, "post": { "operationId": "create_segment", "summary": "create (segments)", "tags": [ "segments" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Segments", "responses": { "201": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": {}, "description": {}, "type": {}, "condition": {}, "trackMembership": {} }, "required": [ "name" ], "additionalProperties": true } } } } } }, "/segments/{id}": { "get": { "operationId": "get_segment", "summary": "get (segments)", "tags": [ "segments" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Segments", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] }, "patch": { "operationId": "segments_update", "summary": "update (segments)", "tags": [ "segments" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Segments", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": {}, "description": {}, "condition": {}, "trackMembership": {} }, "additionalProperties": true } } } } }, "delete": { "operationId": "delete_segment", "summary": "delete (segments)", "tags": [ "segments" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Segments", "responses": { "204": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/segments/{id}/contacts": { "get": { "operationId": "segments_get_contacts", "summary": "get Contacts (segments)", "tags": [ "segments" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Segments", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/segments/{id}/members": { "post": { "operationId": "segments_add_members", "summary": "add Members (segments)", "tags": [ "segments" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Segments", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "emails": {}, "createMissing": {}, "subscribed": {} }, "additionalProperties": true } } } } }, "delete": { "operationId": "segments_remove_members", "summary": "remove Members (segments)", "tags": [ "segments" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Segments", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/segments/{id}/compute": { "post": { "operationId": "segments_compute", "summary": "compute (segments)", "tags": [ "segments" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Segments", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/segments/{id}/refresh": { "post": { "operationId": "segments_refresh", "summary": "refresh (segments)", "tags": [ "segments" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Segments", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/sso/config": { "get": { "operationId": "sso_get_config", "summary": "get Config (sso)", "tags": [ "sso" ], "description": "Project configuration/credential boundary; use the authenticated API/dashboard. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": false, "x-controller": "Sso", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] } }, "/sso/configure": { "post": { "operationId": "sso_configure", "summary": "configure (sso)", "tags": [ "sso" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Sso", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "X-Project-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "protocol": { "type": "string", "enum": [ "oidc" ] }, "issuerUrl": { "type": "string", "format": "uri" }, "clientId": { "type": "string", "minLength": 1 }, "clientSecret": { "type": "string" }, "domain": { "type": "string", "minLength": 1, "pattern": "^[a-z0-9]+([\\-\\.]{1}[a-z0-9]+)*\\.[a-z]{2,}$" } }, "required": [ "protocol", "issuerUrl", "clientId", "domain" ], "additionalProperties": false }, { "type": "object", "properties": { "protocol": { "type": "string", "enum": [ "saml" ] }, "samlEntryPoint": { "type": "string", "format": "uri" }, "samlCertificate": { "type": "string", "minLength": 1 }, "samlIssuer": { "type": "string" }, "domain": { "type": "string", "minLength": 1, "pattern": "^[a-z0-9]+([\\-\\.]{1}[a-z0-9]+)*\\.[a-z]{2,}$" } }, "required": [ "protocol", "samlEntryPoint", "samlCertificate", "domain" ], "additionalProperties": false } ] } } } } } }, "/sso/verify-domain": { "post": { "operationId": "sso_verify_domain", "summary": "verify Domain (sso)", "tags": [ "sso" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Sso", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "X-Project-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/sso/set-require": { "post": { "operationId": "sso_set_require", "summary": "set Require (sso)", "tags": [ "sso" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Sso", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "X-Project-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "requireSso": { "type": "boolean" } }, "required": [ "requireSso" ], "additionalProperties": false } } } } } }, "/sso/disable": { "post": { "operationId": "sso_disable", "summary": "disable (sso)", "tags": [ "sso" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Sso", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "X-Project-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/sso/saml/metadata": { "get": { "operationId": "sso_saml_metadata", "summary": "saml Metadata (sso)", "tags": [ "sso" ], "description": "Project configuration/credential boundary; use the authenticated API/dashboard. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": false, "x-controller": "Sso", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] } }, "/sso/check": { "get": { "operationId": "sso_check", "summary": "check (sso)", "tags": [ "sso" ], "description": "Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [], "x-access": "public", "x-mcp": false, "x-controller": "Sso", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] } }, "/sso/initiate": { "get": { "operationId": "sso_initiate", "summary": "initiate (sso)", "tags": [ "sso" ], "description": "Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [], "x-access": "public", "x-mcp": false, "x-controller": "Sso", "responses": { "302": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "headers": { "Location": { "description": "Redirect destination", "schema": { "type": "string" } } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] } }, "/sso/saml/callback": { "post": { "operationId": "sso_saml_callback", "summary": "saml Callback (sso)", "tags": [ "sso" ], "description": "Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [], "x-access": "public", "x-mcp": false, "x-controller": "Sso", "responses": { "302": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "headers": { "Location": { "description": "Redirect destination", "schema": { "type": "string" } } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "RelayState": {} }, "additionalProperties": true } } } } } }, "/sso/callback": { "get": { "operationId": "sso_callback", "summary": "callback (sso)", "tags": [ "sso" ], "description": "Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [], "x-access": "public", "x-mcp": false, "x-controller": "Sso", "responses": { "302": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "headers": { "Location": { "description": "Redirect destination", "schema": { "type": "string" } } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "error", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "error_description", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/tags": { "get": { "operationId": "tags_list", "summary": "list (tags)", "tags": [ "tags" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Tags", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] }, "post": { "operationId": "tags_create", "summary": "create (tags)", "tags": [ "tags" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Tags", "responses": { "201": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": {}, "color": {} }, "additionalProperties": true } } } } } }, "/tags/{id}": { "patch": { "operationId": "tags_update", "summary": "update (tags)", "tags": [ "tags" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Tags", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": {}, "color": {} }, "additionalProperties": true } } } } }, "delete": { "operationId": "tags_delete", "summary": "delete (tags)", "tags": [ "tags" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Tags", "responses": { "204": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/templates": { "get": { "operationId": "list_templates", "summary": "list (templates)", "tags": [ "templates" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Templates", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "dir", "in": "query", "required": false, "schema": { "type": "string" } } ] }, "post": { "operationId": "create_template", "summary": "create (templates)", "tags": [ "templates" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Templates", "responses": { "201": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": {}, "description": {}, "subject": {}, "body": {}, "from": {}, "fromName": {}, "replyTo": {}, "type": {} }, "required": [ "name", "subject", "body", "from" ], "additionalProperties": true } } } } } }, "/templates/{id}": { "get": { "operationId": "get_template", "summary": "get (templates)", "tags": [ "templates" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Templates", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] }, "patch": { "operationId": "update_template", "summary": "update (templates)", "tags": [ "templates" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Templates", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": {}, "description": {}, "subject": {}, "body": {}, "from": {}, "fromName": {}, "replyTo": {}, "type": {} }, "additionalProperties": true } } } } }, "delete": { "operationId": "delete_template", "summary": "delete (templates)", "tags": [ "templates" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Templates", "responses": { "204": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/templates/bulk-update": { "post": { "operationId": "templates_bulk_update", "summary": "bulk Update (templates)", "tags": [ "templates" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Templates", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "maxItems": 1000 }, "delete": { "type": "boolean" } }, "required": [ "ids" ], "additionalProperties": false } } } } } }, "/templates/{id}/duplicate": { "post": { "operationId": "templates_duplicate", "summary": "duplicate (templates)", "tags": [ "templates" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Templates", "responses": { "201": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/templates/{id}/usage": { "get": { "operationId": "templates_get_usage", "summary": "get Usage (templates)", "tags": [ "templates" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Templates", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/templates/convert": { "post": { "operationId": "templates_convert", "summary": "convert (templates)", "tags": [ "templates" ], "description": "Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [], "x-access": "public", "x-mcp": false, "x-controller": "Templates", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "format": {}, "content": {} }, "additionalProperties": true } } } } } }, "/unsubscribe/{id}": { "post": { "operationId": "unsubscribe_one_click", "summary": "one Click (unsubscribe)", "tags": [ "unsubscribe" ], "description": "Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [], "x-access": "public", "x-mcp": false, "x-controller": "Unsubscribe", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] }, "get": { "operationId": "unsubscribe_redirect", "summary": "redirect (unsubscribe)", "tags": [ "unsubscribe" ], "description": "Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [], "x-access": "public", "x-mcp": false, "x-controller": "Unsubscribe", "responses": { "302": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "headers": { "Location": { "description": "Redirect destination", "schema": { "type": "string" } } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/uploads/image": { "post": { "operationId": "uploads_upload_image", "summary": "upload Image (uploads)", "tags": [ "uploads" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Uploads", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "image" ], "properties": { "image": { "type": "string", "format": "binary" } } } } } } } }, "/webhooks": { "get": { "operationId": "list_webhooks", "summary": "list (webhooks)", "tags": [ "webhooks" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "UserWebhooks", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] }, "post": { "operationId": "create_webhook", "summary": "create (webhooks)", "tags": [ "webhooks" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "UserWebhooks", "responses": { "201": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "minLength": 1 }, "description": { "type": "string", "maxLength": 500 }, "events": { "type": "array", "items": { "type": "string", "enum": [ "email.sent", "email.opened", "email.clicked", "email.bounced", "email.complained", "email.unsubscribed", "email.received", "contact.created", "contact.updated", "contact.subscribed", "contact.unsubscribed", "contact.deleted", "campaign.scheduled", "campaign.sent", "campaign.cancelled" ] } }, "inboundDomain": { "type": "string", "maxLength": 253, "nullable": true }, "inboundPattern": { "type": "string", "maxLength": 64, "nullable": true }, "enabled": { "type": "boolean" } }, "required": [ "url" ], "additionalProperties": false } } } } } }, "/webhooks/{id}": { "get": { "operationId": "get_webhook", "summary": "get (webhooks)", "tags": [ "webhooks" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "UserWebhooks", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] }, "patch": { "operationId": "update_webhook", "summary": "update (webhooks)", "tags": [ "webhooks" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "UserWebhooks", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "minLength": 1 }, "description": { "type": "string", "maxLength": 500 }, "events": { "type": "array", "items": { "type": "string", "enum": [ "email.sent", "email.opened", "email.clicked", "email.bounced", "email.complained", "email.unsubscribed", "email.received", "contact.created", "contact.updated", "contact.subscribed", "contact.unsubscribed", "contact.deleted", "campaign.scheduled", "campaign.sent", "campaign.cancelled" ] } }, "inboundDomain": { "type": "string", "maxLength": 253, "nullable": true }, "inboundPattern": { "type": "string", "maxLength": 64, "nullable": true }, "enabled": { "type": "boolean" }, "rotateSecret": { "type": "boolean" } }, "additionalProperties": false } } } } }, "delete": { "operationId": "delete_webhook", "summary": "delete (webhooks)", "tags": [ "webhooks" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "UserWebhooks", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/webhooks/{id}/deliveries": { "get": { "operationId": "list_webhook_deliveries", "summary": "deliveries (webhooks)", "tags": [ "webhooks" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "UserWebhooks", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/webhooks/{id}/test": { "post": { "operationId": "test_webhook", "summary": "test (webhooks)", "tags": [ "webhooks" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "UserWebhooks", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "enum": [ "test", "email.received" ] }, "recipient": { "type": "string", "maxLength": 320, "format": "email" } }, "additionalProperties": false } } } } } }, "/users/@me": { "get": { "operationId": "users_me", "summary": "me (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/users/@me/projects": { "get": { "operationId": "users_me_projects", "summary": "me Projects (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] }, "post": { "operationId": "users_create_project", "summary": "create Project (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "201": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 } }, "required": [ "name" ], "additionalProperties": false } } } } } }, "/users/@me/projects/{id}": { "patch": { "operationId": "users_update_project", "summary": "update Project (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "tracking": { "type": "string", "enum": [ "ENABLED", "DISABLED", "MARKETING_ONLY" ] }, "language": { "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" } }, "additionalProperties": false } } } } }, "delete": { "operationId": "users_delete_project", "summary": "delete Project (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/users/@me/projects/{id}/secret": { "get": { "operationId": "users_get_project_secret", "summary": "get Project Secret (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/users/@me/projects/{id}/regenerate-keys": { "post": { "operationId": "users_regenerate_project_keys", "summary": "regenerate Project Keys (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/users/@me/projects/{id}/checkout": { "post": { "operationId": "users_create_checkout_session", "summary": "create Checkout Session (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/users/@me/projects/{id}/checkout-embedded": { "post": { "operationId": "users_create_embedded_checkout_session", "summary": "create Embedded Checkout Session (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "plan", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/users/@me/projects/{id}/subscribe": { "post": { "operationId": "users_create_inline_subscription", "summary": "create Inline Subscription (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "plan", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/users/@me/projects/{id}/subscribe/activate": { "post": { "operationId": "users_activate_subscription", "summary": "activate Subscription (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "plan", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pmId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/users/@me/projects/{id}/change-plan": { "post": { "operationId": "users_change_plan", "summary": "change Plan (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "plan", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/users/@me/projects/{id}/addon/{addonId}": { "delete": { "operationId": "users_remove_addon", "summary": "remove Addon (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "addonId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/users/@me/projects/{id}/billing-portal": { "post": { "operationId": "users_create_billing_portal_session", "summary": "create Billing Portal Session (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/users/@me/projects/{id}/billing-limits": { "get": { "operationId": "users_get_billing_limits", "summary": "get Billing Limits (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] }, "put": { "operationId": "users_update_billing_limits", "summary": "update Billing Limits (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "workflows": { "type": "integer", "exclusiveMinimum": true, "minimum": 0, "nullable": true }, "campaigns": { "type": "integer", "exclusiveMinimum": true, "minimum": 0, "nullable": true }, "transactional": { "type": "integer", "exclusiveMinimum": true, "minimum": 0, "nullable": true }, "inbound": { "type": "integer", "exclusiveMinimum": true, "minimum": 0, "nullable": true } }, "required": [ "workflows", "campaigns", "transactional", "inbound" ], "additionalProperties": false } } } } } }, "/users/@me/projects/{id}/billing-daily": { "get": { "operationId": "users_get_billing_daily", "summary": "get Billing Daily (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/users/@me/projects/{id}/billing-consumption": { "get": { "operationId": "users_get_billing_consumption", "summary": "get Billing Consumption (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/users/@me/projects/{id}/billing-invoices": { "get": { "operationId": "users_get_billing_invoices", "summary": "get Billing Invoices (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/users/@me/projects/{id}/subscription-status": { "get": { "operationId": "users_get_subscription_status", "summary": "get Subscription Status (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/users/@me/projects/{id}/payment-method": { "get": { "operationId": "users_get_payment_method", "summary": "get Payment Method (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] }, "put": { "operationId": "users_update_payment_method", "summary": "update Payment Method (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "paymentMethodId": {} }, "required": [ "paymentMethodId" ], "additionalProperties": true } } } } } }, "/users/@me/projects/{id}/cancel-subscription": { "post": { "operationId": "users_cancel_subscription", "summary": "cancel Subscription (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/users/@me/projects/{id}/reactivate-subscription": { "post": { "operationId": "users_reactivate_subscription", "summary": "reactivate Subscription (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/users/@me/projects/{id}/setup-intent": { "post": { "operationId": "users_create_setup_intent", "summary": "create Setup Intent (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/users/@me/projects/{id}/security": { "get": { "operationId": "users_get_security_health", "summary": "get Security Health (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/users/@me/projects/{id}/reset": { "post": { "operationId": "users_reset_project", "summary": "reset Project (users)", "tags": [ "users" ], "description": "Account/security operation requires a dashboard user session. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "DashboardSession": [] } ], "x-access": "session", "x-mcp": false, "x-controller": "Users", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Project-Id", "in": "header", "required": false, "description": "Required on project-scoped session operations; must belong to the signed-in user.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/warmup": { "get": { "operationId": "warmup_list", "summary": "list (warmup)", "tags": [ "warmup" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Warmup", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [] }, "post": { "operationId": "warmup_create", "summary": "create (warmup)", "tags": [ "warmup" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Warmup", "responses": { "201": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": {}, "fromAddress": {}, "toAddresses": {}, "maxLimit": {}, "rampupDays": {} }, "additionalProperties": true } } } } } }, "/warmup/{id}": { "get": { "operationId": "warmup_get", "summary": "get (warmup)", "tags": [ "warmup" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Warmup", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] }, "patch": { "operationId": "warmup_update", "summary": "update (warmup)", "tags": [ "warmup" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Warmup", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": {}, "toAddresses": {}, "maxLimit": {} }, "additionalProperties": true } } } } }, "delete": { "operationId": "warmup_remove", "summary": "remove (warmup)", "tags": [ "warmup" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Warmup", "responses": { "204": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/warmup/{id}/advance": { "post": { "operationId": "warmup_advance", "summary": "advance (warmup)", "tags": [ "warmup" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Warmup", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/workflows": { "get": { "operationId": "workflows_list", "summary": "list (workflows)", "tags": [ "workflows" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Workflows", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "dir", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } } ] }, "post": { "operationId": "workflows_create", "summary": "create (workflows)", "tags": [ "workflows" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Workflows", "responses": { "201": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": {}, "description": {}, "triggerType": {}, "eventName": {}, "cronExpression": {}, "enabled": {}, "allowReentry": {} }, "required": [ "name" ], "additionalProperties": true } } } } } }, "/workflows/fields": { "get": { "operationId": "workflows_get_available_fields", "summary": "get Available Fields (workflows)", "tags": [ "workflows" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Workflows", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "eventName", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/workflows/bulk-update": { "post": { "operationId": "workflows_bulk_update", "summary": "bulk Update (workflows)", "tags": [ "workflows" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Workflows", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "maxItems": 1000 }, "delete": { "type": "boolean" }, "enabled": { "type": "boolean" } }, "required": [ "ids" ], "additionalProperties": false } } } } } }, "/workflows/{id}/ai-generate": { "post": { "operationId": "workflows_generate_with_ai", "summary": "generate With Ai (workflows)", "tags": [ "workflows" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Workflows", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "prompt": {} }, "additionalProperties": true } } } } } }, "/workflows/{id}": { "get": { "operationId": "workflows_get", "summary": "get (workflows)", "tags": [ "workflows" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Workflows", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] }, "patch": { "operationId": "workflows_update", "summary": "update (workflows)", "tags": [ "workflows" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Workflows", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": {}, "description": {}, "triggerType": {}, "triggerConfig": {}, "enabled": {}, "allowReentry": {} }, "additionalProperties": true } } } } }, "delete": { "operationId": "workflows_delete", "summary": "delete (workflows)", "tags": [ "workflows" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Workflows", "responses": { "204": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/workflows/{id}/duplicate": { "post": { "operationId": "workflows_duplicate", "summary": "duplicate (workflows)", "tags": [ "workflows" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Workflows", "responses": { "201": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/workflows/{id}/steps": { "post": { "operationId": "workflows_add_step", "summary": "add Step (workflows)", "tags": [ "workflows" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Workflows", "responses": { "201": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": {}, "name": {}, "position": {}, "config": {}, "templateId": {}, "autoConnect": {} }, "additionalProperties": true } } } } } }, "/workflows/{id}/steps/{stepId}": { "patch": { "operationId": "workflows_update_step", "summary": "update Step (workflows)", "tags": [ "workflows" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Workflows", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "stepId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": {}, "position": {}, "config": {}, "templateId": {} }, "additionalProperties": true } } } } }, "delete": { "operationId": "workflows_delete_step", "summary": "delete Step (workflows)", "tags": [ "workflows" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Workflows", "responses": { "204": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "stepId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "splice", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/workflows/{id}/transitions": { "post": { "operationId": "workflows_create_transition", "summary": "create Transition (workflows)", "tags": [ "workflows" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Workflows", "responses": { "201": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromStepId": {}, "toStepId": {}, "condition": {}, "priority": {} }, "additionalProperties": true } } } } } }, "/workflows/{id}/transitions/{transitionId}/insert-step": { "post": { "operationId": "workflows_insert_step_on_transition", "summary": "insert Step On Transition (workflows)", "tags": [ "workflows" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Workflows", "responses": { "201": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "transitionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": {}, "name": {}, "position": {}, "config": {}, "templateId": {} }, "additionalProperties": true } } } } } }, "/workflows/{id}/transitions/{transitionId}": { "delete": { "operationId": "workflows_delete_transition", "summary": "delete Transition (workflows)", "tags": [ "workflows" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Workflows", "responses": { "204": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "transitionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/workflows/{id}/executions": { "post": { "operationId": "workflows_start_execution", "summary": "start Execution (workflows)", "tags": [ "workflows" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Workflows", "responses": { "201": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": {}, "context": {} }, "required": [ "contactId" ], "additionalProperties": true } } } } }, "get": { "operationId": "workflows_list_executions", "summary": "list Executions (workflows)", "tags": [ "workflows" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Workflows", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/workflows/{id}/executions/{executionId}": { "get": { "operationId": "workflows_get_execution", "summary": "get Execution (workflows)", "tags": [ "workflows" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Workflows", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] }, "delete": { "operationId": "workflows_cancel_execution", "summary": "cancel Execution (workflows)", "tags": [ "workflows" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Workflows", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/workflows/{id}/executions/cancel-all": { "post": { "operationId": "workflows_cancel_all_executions", "summary": "cancel All Executions (workflows)", "tags": [ "workflows" ], "description": "Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.", "security": [ { "SecretKey": [] } ], "x-access": "secret-key", "x-mcp": true, "x-controller": "Workflows", "responses": { "200": { "description": "Successful response. Shape is returned by this operation; sending acceptance is not proof of inbox delivery.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid/revoked authentication" }, "403": { "description": "Insufficient permission or disabled project" }, "404": { "description": "Resource not found in this project" }, "429": { "description": "Rate or billing limit" }, "500": { "description": "Server error" }, "503": { "description": "Dependency unavailable" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } } }, "components": { "securitySchemes": { "SecretKey": { "type": "http", "scheme": "bearer", "description": "A secret project API key, never a public tracking key." }, "DashboardSession": { "type": "apiKey", "in": "cookie", "name": "next_token", "description": "Authenticated dashboard session. Secret project keys cannot perform account/security administration." }, "PublicTrackingKey": { "type": "http", "scheme": "bearer", "description": "Public project key for browser event tracking only." } } }, "x-webhook-events": [ "email.sent", "email.opened", "email.clicked", "email.bounced", "email.complained", "email.unsubscribed", "email.received", "contact.created", "contact.updated", "contact.subscribed", "contact.unsubscribed", "contact.deleted", "campaign.scheduled", "campaign.sent", "campaign.cancelled" ], "x-inbound-contract": { "mx": "mail.sendbound.com", "priority": 10, "event": "email.received", "signatureHeader": "Sendbound-Signature-V2", "deliveryHeader": "Sendbound-Delivery-Id", "timestampHeader": "Sendbound-Timestamp", "signed": "timestamp + \".\" + deliveryId + \".\" + rawBody", "algorithm": "HMAC-SHA256", "encoding": "v2=", "legacySignature": "Sendbound-Signature: sha256=", "attempts": 8, "backoffMilliseconds": 30000, "payloadFields": [ "id", "from", "to", "recipients", "subject", "text", "html", "messageId", "receivedAt", "attachments" ], "attachmentDownload": "/emails/{id}/attachments/{attachmentId}" } }