{ "info": { "name": "EmailsDone API", "description": "EmailsDone is a template-first transactional email API for developers who want password resets, verification emails, notifications, billing emails, and similar app messages to work without designing HTML.", "version": "1.0.0", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.emailsdone.dev", "type": "string" }, { "key": "apiKey", "value": "", "type": "string" } ], "item": [ { "name": "Email", "item": [ { "name": "Send account-locked", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"account-locked\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Unlock account\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Account locked\",\n \"intro\": \"Your account has been locked for security.\",\n \"lockDetails\": {\n \"lockedAt\": \"Locked At\",\n \"reason\": \"Reason\"\n },\n \"notice\": \"You may need to verify your identity before access is restored.\",\n \"preheader\": \"Your account has been locked for security.\",\n \"subject\": \"Account locked\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"account-locked\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Unlock account\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Account locked\",\n \"intro\": \"Your account has been locked for security.\",\n \"lockDetails\": {\n \"lockedAt\": \"Locked At\",\n \"reason\": \"Reason\"\n },\n \"notice\": \"You may need to verify your identity before access is restored.\",\n \"preheader\": \"Your account has been locked for security.\",\n \"subject\": \"Account locked\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"account-locked\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Unlock account\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Account locked\",\n \"intro\": \"Your account has been locked for security.\",\n \"lockDetails\": {\n \"lockedAt\": \"Locked At\",\n \"reason\": \"Reason\"\n },\n \"notice\": \"You may need to verify your identity before access is restored.\",\n \"preheader\": \"Your account has been locked for security.\",\n \"subject\": \"Account locked\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"account-locked\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Unlock account\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Account locked\",\n \"intro\": \"Your account has been locked for security.\",\n \"lockDetails\": {\n \"lockedAt\": \"Locked At\",\n \"reason\": \"Reason\"\n },\n \"notice\": \"You may need to verify your identity before access is restored.\",\n \"preheader\": \"Your account has been locked for security.\",\n \"subject\": \"Account locked\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"account-locked\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Unlock account\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Account locked\",\n \"intro\": \"Your account has been locked for security.\",\n \"lockDetails\": {\n \"lockedAt\": \"Locked At\",\n \"reason\": \"Reason\"\n },\n \"notice\": \"You may need to verify your identity before access is restored.\",\n \"preheader\": \"Your account has been locked for security.\",\n \"subject\": \"Account locked\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"account-locked\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Unlock account\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Account locked\",\n \"intro\": \"Your account has been locked for security.\",\n \"lockDetails\": {\n \"lockedAt\": \"Locked At\",\n \"reason\": \"Reason\"\n },\n \"notice\": \"You may need to verify your identity before access is restored.\",\n \"preheader\": \"Your account has been locked for security.\",\n \"subject\": \"Account locked\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"account-locked\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Unlock account\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Account locked\",\n \"intro\": \"Your account has been locked for security.\",\n \"lockDetails\": {\n \"lockedAt\": \"Locked At\",\n \"reason\": \"Reason\"\n },\n \"notice\": \"You may need to verify your identity before access is restored.\",\n \"preheader\": \"Your account has been locked for security.\",\n \"subject\": \"Account locked\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send announcement", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"announcement\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"Learn more\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Announcement\",\n \"preheader\": \"Message\",\n \"subject\": \"Announcement\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"announcement\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"Learn more\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Announcement\",\n \"preheader\": \"Message\",\n \"subject\": \"Announcement\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"announcement\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"Learn more\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Announcement\",\n \"preheader\": \"Message\",\n \"subject\": \"Announcement\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"announcement\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"Learn more\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Announcement\",\n \"preheader\": \"Message\",\n \"subject\": \"Announcement\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"announcement\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"Learn more\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Announcement\",\n \"preheader\": \"Message\",\n \"subject\": \"Announcement\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"announcement\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"Learn more\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Announcement\",\n \"preheader\": \"Message\",\n \"subject\": \"Announcement\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"announcement\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"Learn more\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Announcement\",\n \"preheader\": \"Message\",\n \"subject\": \"Announcement\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send api-key-created", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"api-key-created\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage API keys\",\n \"url\": \"https://example.com/app\"\n },\n \"apiKeyDetails\": {\n \"name\": \"Name\",\n \"createdAt\": \"Created At\",\n \"environment\": \"Environment\",\n \"createdBy\": \"Created By\"\n },\n \"heading\": \"API key created\",\n \"intro\": \"A new API key has been created.\",\n \"notice\": \"Keep API keys secure and do not share them publicly.\",\n \"preheader\": \"A new API key has been created.\",\n \"subject\": \"API key created\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"api-key-created\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage API keys\",\n \"url\": \"https://example.com/app\"\n },\n \"apiKeyDetails\": {\n \"name\": \"Name\",\n \"createdAt\": \"Created At\",\n \"environment\": \"Environment\",\n \"createdBy\": \"Created By\"\n },\n \"heading\": \"API key created\",\n \"intro\": \"A new API key has been created.\",\n \"notice\": \"Keep API keys secure and do not share them publicly.\",\n \"preheader\": \"A new API key has been created.\",\n \"subject\": \"API key created\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"api-key-created\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage API keys\",\n \"url\": \"https://example.com/app\"\n },\n \"apiKeyDetails\": {\n \"name\": \"Name\",\n \"createdAt\": \"Created At\",\n \"environment\": \"Environment\",\n \"createdBy\": \"Created By\"\n },\n \"heading\": \"API key created\",\n \"intro\": \"A new API key has been created.\",\n \"notice\": \"Keep API keys secure and do not share them publicly.\",\n \"preheader\": \"A new API key has been created.\",\n \"subject\": \"API key created\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"api-key-created\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage API keys\",\n \"url\": \"https://example.com/app\"\n },\n \"apiKeyDetails\": {\n \"name\": \"Name\",\n \"createdAt\": \"Created At\",\n \"environment\": \"Environment\",\n \"createdBy\": \"Created By\"\n },\n \"heading\": \"API key created\",\n \"intro\": \"A new API key has been created.\",\n \"notice\": \"Keep API keys secure and do not share them publicly.\",\n \"preheader\": \"A new API key has been created.\",\n \"subject\": \"API key created\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"api-key-created\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage API keys\",\n \"url\": \"https://example.com/app\"\n },\n \"apiKeyDetails\": {\n \"name\": \"Name\",\n \"createdAt\": \"Created At\",\n \"environment\": \"Environment\",\n \"createdBy\": \"Created By\"\n },\n \"heading\": \"API key created\",\n \"intro\": \"A new API key has been created.\",\n \"notice\": \"Keep API keys secure and do not share them publicly.\",\n \"preheader\": \"A new API key has been created.\",\n \"subject\": \"API key created\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"api-key-created\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage API keys\",\n \"url\": \"https://example.com/app\"\n },\n \"apiKeyDetails\": {\n \"name\": \"Name\",\n \"createdAt\": \"Created At\",\n \"environment\": \"Environment\",\n \"createdBy\": \"Created By\"\n },\n \"heading\": \"API key created\",\n \"intro\": \"A new API key has been created.\",\n \"notice\": \"Keep API keys secure and do not share them publicly.\",\n \"preheader\": \"A new API key has been created.\",\n \"subject\": \"API key created\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"api-key-created\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage API keys\",\n \"url\": \"https://example.com/app\"\n },\n \"apiKeyDetails\": {\n \"name\": \"Name\",\n \"createdAt\": \"Created At\",\n \"environment\": \"Environment\",\n \"createdBy\": \"Created By\"\n },\n \"heading\": \"API key created\",\n \"intro\": \"A new API key has been created.\",\n \"notice\": \"Keep API keys secure and do not share them publicly.\",\n \"preheader\": \"A new API key has been created.\",\n \"subject\": \"API key created\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send api-key-rotated", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"api-key-rotated\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage API keys\",\n \"url\": \"https://example.com/app\"\n },\n \"apiKeyDetails\": {\n \"name\": \"Name\",\n \"rotatedAt\": \"Rotated At\",\n \"environment\": \"Environment\",\n \"rotatedBy\": \"Rotated By\"\n },\n \"heading\": \"API key rotated\",\n \"intro\": \"An API key has been rotated.\",\n \"preheader\": \"An API key has been rotated.\",\n \"subject\": \"API key rotated\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"api-key-rotated\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage API keys\",\n \"url\": \"https://example.com/app\"\n },\n \"apiKeyDetails\": {\n \"name\": \"Name\",\n \"rotatedAt\": \"Rotated At\",\n \"environment\": \"Environment\",\n \"rotatedBy\": \"Rotated By\"\n },\n \"heading\": \"API key rotated\",\n \"intro\": \"An API key has been rotated.\",\n \"preheader\": \"An API key has been rotated.\",\n \"subject\": \"API key rotated\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"api-key-rotated\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage API keys\",\n \"url\": \"https://example.com/app\"\n },\n \"apiKeyDetails\": {\n \"name\": \"Name\",\n \"rotatedAt\": \"Rotated At\",\n \"environment\": \"Environment\",\n \"rotatedBy\": \"Rotated By\"\n },\n \"heading\": \"API key rotated\",\n \"intro\": \"An API key has been rotated.\",\n \"preheader\": \"An API key has been rotated.\",\n \"subject\": \"API key rotated\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"api-key-rotated\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage API keys\",\n \"url\": \"https://example.com/app\"\n },\n \"apiKeyDetails\": {\n \"name\": \"Name\",\n \"rotatedAt\": \"Rotated At\",\n \"environment\": \"Environment\",\n \"rotatedBy\": \"Rotated By\"\n },\n \"heading\": \"API key rotated\",\n \"intro\": \"An API key has been rotated.\",\n \"preheader\": \"An API key has been rotated.\",\n \"subject\": \"API key rotated\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"api-key-rotated\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage API keys\",\n \"url\": \"https://example.com/app\"\n },\n \"apiKeyDetails\": {\n \"name\": \"Name\",\n \"rotatedAt\": \"Rotated At\",\n \"environment\": \"Environment\",\n \"rotatedBy\": \"Rotated By\"\n },\n \"heading\": \"API key rotated\",\n \"intro\": \"An API key has been rotated.\",\n \"preheader\": \"An API key has been rotated.\",\n \"subject\": \"API key rotated\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"api-key-rotated\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage API keys\",\n \"url\": \"https://example.com/app\"\n },\n \"apiKeyDetails\": {\n \"name\": \"Name\",\n \"rotatedAt\": \"Rotated At\",\n \"environment\": \"Environment\",\n \"rotatedBy\": \"Rotated By\"\n },\n \"heading\": \"API key rotated\",\n \"intro\": \"An API key has been rotated.\",\n \"preheader\": \"An API key has been rotated.\",\n \"subject\": \"API key rotated\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"api-key-rotated\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage API keys\",\n \"url\": \"https://example.com/app\"\n },\n \"apiKeyDetails\": {\n \"name\": \"Name\",\n \"rotatedAt\": \"Rotated At\",\n \"environment\": \"Environment\",\n \"rotatedBy\": \"Rotated By\"\n },\n \"heading\": \"API key rotated\",\n \"intro\": \"An API key has been rotated.\",\n \"preheader\": \"An API key has been rotated.\",\n \"subject\": \"API key rotated\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send approval-approved", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"approval-approved\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"approvalDetails\": {\n \"item\": \"Item\",\n \"approvedBy\": \"Approved By\",\n \"approvedAt\": \"Approved At\"\n },\n \"heading\": \"Approved\",\n \"preheader\": \"Message\",\n \"subject\": \"Approved\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"approval-approved\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"approvalDetails\": {\n \"item\": \"Item\",\n \"approvedBy\": \"Approved By\",\n \"approvedAt\": \"Approved At\"\n },\n \"heading\": \"Approved\",\n \"preheader\": \"Message\",\n \"subject\": \"Approved\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"approval-approved\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"approvalDetails\": {\n \"item\": \"Item\",\n \"approvedBy\": \"Approved By\",\n \"approvedAt\": \"Approved At\"\n },\n \"heading\": \"Approved\",\n \"preheader\": \"Message\",\n \"subject\": \"Approved\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"approval-approved\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"approvalDetails\": {\n \"item\": \"Item\",\n \"approvedBy\": \"Approved By\",\n \"approvedAt\": \"Approved At\"\n },\n \"heading\": \"Approved\",\n \"preheader\": \"Message\",\n \"subject\": \"Approved\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"approval-approved\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"approvalDetails\": {\n \"item\": \"Item\",\n \"approvedBy\": \"Approved By\",\n \"approvedAt\": \"Approved At\"\n },\n \"heading\": \"Approved\",\n \"preheader\": \"Message\",\n \"subject\": \"Approved\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"approval-approved\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"approvalDetails\": {\n \"item\": \"Item\",\n \"approvedBy\": \"Approved By\",\n \"approvedAt\": \"Approved At\"\n },\n \"heading\": \"Approved\",\n \"preheader\": \"Message\",\n \"subject\": \"Approved\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"approval-approved\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"approvalDetails\": {\n \"item\": \"Item\",\n \"approvedBy\": \"Approved By\",\n \"approvedAt\": \"Approved At\"\n },\n \"heading\": \"Approved\",\n \"preheader\": \"Message\",\n \"subject\": \"Approved\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send approval-needed", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"approval-needed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Review request\"\n },\n \"approvalDetails\": {\n \"item\": \"Item\",\n \"requestedBy\": \"Requested By\",\n \"requestedAt\": \"Requested At\"\n },\n \"heading\": \"Approval needed\",\n \"message\": \"An item is waiting for approval.\",\n \"preheader\": \"An item is waiting for approval.\",\n \"subject\": \"Approval needed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"approval-needed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Review request\"\n },\n \"approvalDetails\": {\n \"item\": \"Item\",\n \"requestedBy\": \"Requested By\",\n \"requestedAt\": \"Requested At\"\n },\n \"heading\": \"Approval needed\",\n \"message\": \"An item is waiting for approval.\",\n \"preheader\": \"An item is waiting for approval.\",\n \"subject\": \"Approval needed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"approval-needed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Review request\"\n },\n \"approvalDetails\": {\n \"item\": \"Item\",\n \"requestedBy\": \"Requested By\",\n \"requestedAt\": \"Requested At\"\n },\n \"heading\": \"Approval needed\",\n \"message\": \"An item is waiting for approval.\",\n \"preheader\": \"An item is waiting for approval.\",\n \"subject\": \"Approval needed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"approval-needed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Review request\"\n },\n \"approvalDetails\": {\n \"item\": \"Item\",\n \"requestedBy\": \"Requested By\",\n \"requestedAt\": \"Requested At\"\n },\n \"heading\": \"Approval needed\",\n \"message\": \"An item is waiting for approval.\",\n \"preheader\": \"An item is waiting for approval.\",\n \"subject\": \"Approval needed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"approval-needed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Review request\"\n },\n \"approvalDetails\": {\n \"item\": \"Item\",\n \"requestedBy\": \"Requested By\",\n \"requestedAt\": \"Requested At\"\n },\n \"heading\": \"Approval needed\",\n \"message\": \"An item is waiting for approval.\",\n \"preheader\": \"An item is waiting for approval.\",\n \"subject\": \"Approval needed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"approval-needed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Review request\"\n },\n \"approvalDetails\": {\n \"item\": \"Item\",\n \"requestedBy\": \"Requested By\",\n \"requestedAt\": \"Requested At\"\n },\n \"heading\": \"Approval needed\",\n \"message\": \"An item is waiting for approval.\",\n \"preheader\": \"An item is waiting for approval.\",\n \"subject\": \"Approval needed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"approval-needed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Review request\"\n },\n \"approvalDetails\": {\n \"item\": \"Item\",\n \"requestedBy\": \"Requested By\",\n \"requestedAt\": \"Requested At\"\n },\n \"heading\": \"Approval needed\",\n \"message\": \"An item is waiting for approval.\",\n \"preheader\": \"An item is waiting for approval.\",\n \"subject\": \"Approval needed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send approval-rejected", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"approval-rejected\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"approvalDetails\": {\n \"item\": \"Item\",\n \"reviewedBy\": \"Reviewed By\",\n \"reviewedAt\": \"Reviewed At\",\n \"reason\": \"Reason\"\n },\n \"heading\": \"Not approved\",\n \"preheader\": \"Message\",\n \"subject\": \"Not approved\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"approval-rejected\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"approvalDetails\": {\n \"item\": \"Item\",\n \"reviewedBy\": \"Reviewed By\",\n \"reviewedAt\": \"Reviewed At\",\n \"reason\": \"Reason\"\n },\n \"heading\": \"Not approved\",\n \"preheader\": \"Message\",\n \"subject\": \"Not approved\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"approval-rejected\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"approvalDetails\": {\n \"item\": \"Item\",\n \"reviewedBy\": \"Reviewed By\",\n \"reviewedAt\": \"Reviewed At\",\n \"reason\": \"Reason\"\n },\n \"heading\": \"Not approved\",\n \"preheader\": \"Message\",\n \"subject\": \"Not approved\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"approval-rejected\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"approvalDetails\": {\n \"item\": \"Item\",\n \"reviewedBy\": \"Reviewed By\",\n \"reviewedAt\": \"Reviewed At\",\n \"reason\": \"Reason\"\n },\n \"heading\": \"Not approved\",\n \"preheader\": \"Message\",\n \"subject\": \"Not approved\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"approval-rejected\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"approvalDetails\": {\n \"item\": \"Item\",\n \"reviewedBy\": \"Reviewed By\",\n \"reviewedAt\": \"Reviewed At\",\n \"reason\": \"Reason\"\n },\n \"heading\": \"Not approved\",\n \"preheader\": \"Message\",\n \"subject\": \"Not approved\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"approval-rejected\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"approvalDetails\": {\n \"item\": \"Item\",\n \"reviewedBy\": \"Reviewed By\",\n \"reviewedAt\": \"Reviewed At\",\n \"reason\": \"Reason\"\n },\n \"heading\": \"Not approved\",\n \"preheader\": \"Message\",\n \"subject\": \"Not approved\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"approval-rejected\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"approvalDetails\": {\n \"item\": \"Item\",\n \"reviewedBy\": \"Reviewed By\",\n \"reviewedAt\": \"Reviewed At\",\n \"reason\": \"Reason\"\n },\n \"heading\": \"Not approved\",\n \"preheader\": \"Message\",\n \"subject\": \"Not approved\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send credits-exhausted", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"credits-exhausted\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Add credits\"\n },\n \"creditDetails\": {\n \"remaining\": \"Remaining\",\n \"used\": \"Used\",\n \"periodEndsAt\": \"Period Ends At\"\n },\n \"heading\": \"Credits exhausted\",\n \"intro\": \"Your available credits have been used.\",\n \"preheader\": \"Add credits to continue.\",\n \"subject\": \"Credits exhausted\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"credits-exhausted\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Add credits\"\n },\n \"creditDetails\": {\n \"remaining\": \"Remaining\",\n \"used\": \"Used\",\n \"periodEndsAt\": \"Period Ends At\"\n },\n \"heading\": \"Credits exhausted\",\n \"intro\": \"Your available credits have been used.\",\n \"preheader\": \"Add credits to continue.\",\n \"subject\": \"Credits exhausted\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"credits-exhausted\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Add credits\"\n },\n \"creditDetails\": {\n \"remaining\": \"Remaining\",\n \"used\": \"Used\",\n \"periodEndsAt\": \"Period Ends At\"\n },\n \"heading\": \"Credits exhausted\",\n \"intro\": \"Your available credits have been used.\",\n \"preheader\": \"Add credits to continue.\",\n \"subject\": \"Credits exhausted\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"credits-exhausted\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Add credits\"\n },\n \"creditDetails\": {\n \"remaining\": \"Remaining\",\n \"used\": \"Used\",\n \"periodEndsAt\": \"Period Ends At\"\n },\n \"heading\": \"Credits exhausted\",\n \"intro\": \"Your available credits have been used.\",\n \"preheader\": \"Add credits to continue.\",\n \"subject\": \"Credits exhausted\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"credits-exhausted\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Add credits\"\n },\n \"creditDetails\": {\n \"remaining\": \"Remaining\",\n \"used\": \"Used\",\n \"periodEndsAt\": \"Period Ends At\"\n },\n \"heading\": \"Credits exhausted\",\n \"intro\": \"Your available credits have been used.\",\n \"preheader\": \"Add credits to continue.\",\n \"subject\": \"Credits exhausted\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"credits-exhausted\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Add credits\"\n },\n \"creditDetails\": {\n \"remaining\": \"Remaining\",\n \"used\": \"Used\",\n \"periodEndsAt\": \"Period Ends At\"\n },\n \"heading\": \"Credits exhausted\",\n \"intro\": \"Your available credits have been used.\",\n \"preheader\": \"Add credits to continue.\",\n \"subject\": \"Credits exhausted\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"credits-exhausted\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Add credits\"\n },\n \"creditDetails\": {\n \"remaining\": \"Remaining\",\n \"used\": \"Used\",\n \"periodEndsAt\": \"Period Ends At\"\n },\n \"heading\": \"Credits exhausted\",\n \"intro\": \"Your available credits have been used.\",\n \"preheader\": \"Add credits to continue.\",\n \"subject\": \"Credits exhausted\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send credits-low", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"credits-low\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Add credits\",\n \"url\": \"https://example.com/app\"\n },\n \"creditDetails\": {\n \"remaining\": \"Remaining\",\n \"threshold\": \"Threshold\",\n \"periodEndsAt\": \"Period Ends At\"\n },\n \"heading\": \"Credits are running low\",\n \"intro\": \"Your available credits are running low.\",\n \"preheader\": \"Add credits to continue without interruption.\",\n \"subject\": \"Credits are running low\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"credits-low\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Add credits\",\n \"url\": \"https://example.com/app\"\n },\n \"creditDetails\": {\n \"remaining\": \"Remaining\",\n \"threshold\": \"Threshold\",\n \"periodEndsAt\": \"Period Ends At\"\n },\n \"heading\": \"Credits are running low\",\n \"intro\": \"Your available credits are running low.\",\n \"preheader\": \"Add credits to continue without interruption.\",\n \"subject\": \"Credits are running low\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"credits-low\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Add credits\",\n \"url\": \"https://example.com/app\"\n },\n \"creditDetails\": {\n \"remaining\": \"Remaining\",\n \"threshold\": \"Threshold\",\n \"periodEndsAt\": \"Period Ends At\"\n },\n \"heading\": \"Credits are running low\",\n \"intro\": \"Your available credits are running low.\",\n \"preheader\": \"Add credits to continue without interruption.\",\n \"subject\": \"Credits are running low\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"credits-low\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Add credits\",\n \"url\": \"https://example.com/app\"\n },\n \"creditDetails\": {\n \"remaining\": \"Remaining\",\n \"threshold\": \"Threshold\",\n \"periodEndsAt\": \"Period Ends At\"\n },\n \"heading\": \"Credits are running low\",\n \"intro\": \"Your available credits are running low.\",\n \"preheader\": \"Add credits to continue without interruption.\",\n \"subject\": \"Credits are running low\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"credits-low\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Add credits\",\n \"url\": \"https://example.com/app\"\n },\n \"creditDetails\": {\n \"remaining\": \"Remaining\",\n \"threshold\": \"Threshold\",\n \"periodEndsAt\": \"Period Ends At\"\n },\n \"heading\": \"Credits are running low\",\n \"intro\": \"Your available credits are running low.\",\n \"preheader\": \"Add credits to continue without interruption.\",\n \"subject\": \"Credits are running low\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"credits-low\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Add credits\",\n \"url\": \"https://example.com/app\"\n },\n \"creditDetails\": {\n \"remaining\": \"Remaining\",\n \"threshold\": \"Threshold\",\n \"periodEndsAt\": \"Period Ends At\"\n },\n \"heading\": \"Credits are running low\",\n \"intro\": \"Your available credits are running low.\",\n \"preheader\": \"Add credits to continue without interruption.\",\n \"subject\": \"Credits are running low\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"credits-low\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Add credits\",\n \"url\": \"https://example.com/app\"\n },\n \"creditDetails\": {\n \"remaining\": \"Remaining\",\n \"threshold\": \"Threshold\",\n \"periodEndsAt\": \"Period Ends At\"\n },\n \"heading\": \"Credits are running low\",\n \"intro\": \"Your available credits are running low.\",\n \"preheader\": \"Add credits to continue without interruption.\",\n \"subject\": \"Credits are running low\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send digest", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"digest\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View activity\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Your digest\",\n \"intro\": \"Here is a summary of recent activity.\",\n \"message\": \"\",\n \"preheader\": \"A summary of recent activity.\",\n \"subject\": \"Your digest\",\n \"summary\": {\n \"newItems\": \"New Items\",\n \"updates\": \"Updates\",\n \"alerts\": \"Alerts\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"digest\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View activity\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Your digest\",\n \"intro\": \"Here is a summary of recent activity.\",\n \"message\": \"\",\n \"preheader\": \"A summary of recent activity.\",\n \"subject\": \"Your digest\",\n \"summary\": {\n \"newItems\": \"New Items\",\n \"updates\": \"Updates\",\n \"alerts\": \"Alerts\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"digest\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View activity\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Your digest\",\n \"intro\": \"Here is a summary of recent activity.\",\n \"message\": \"\",\n \"preheader\": \"A summary of recent activity.\",\n \"subject\": \"Your digest\",\n \"summary\": {\n \"newItems\": \"New Items\",\n \"updates\": \"Updates\",\n \"alerts\": \"Alerts\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"digest\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View activity\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Your digest\",\n \"intro\": \"Here is a summary of recent activity.\",\n \"message\": \"\",\n \"preheader\": \"A summary of recent activity.\",\n \"subject\": \"Your digest\",\n \"summary\": {\n \"newItems\": \"New Items\",\n \"updates\": \"Updates\",\n \"alerts\": \"Alerts\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"digest\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View activity\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Your digest\",\n \"intro\": \"Here is a summary of recent activity.\",\n \"message\": \"\",\n \"preheader\": \"A summary of recent activity.\",\n \"subject\": \"Your digest\",\n \"summary\": {\n \"newItems\": \"New Items\",\n \"updates\": \"Updates\",\n \"alerts\": \"Alerts\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"digest\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View activity\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Your digest\",\n \"intro\": \"Here is a summary of recent activity.\",\n \"message\": \"\",\n \"preheader\": \"A summary of recent activity.\",\n \"subject\": \"Your digest\",\n \"summary\": {\n \"newItems\": \"New Items\",\n \"updates\": \"Updates\",\n \"alerts\": \"Alerts\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"digest\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View activity\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Your digest\",\n \"intro\": \"Here is a summary of recent activity.\",\n \"message\": \"\",\n \"preheader\": \"A summary of recent activity.\",\n \"subject\": \"Your digest\",\n \"summary\": {\n \"newItems\": \"New Items\",\n \"updates\": \"Updates\",\n \"alerts\": \"Alerts\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send email-changed", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"email-changed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"changeDetails\": {\n \"changedAt\": \"Changed At\",\n \"oldEmail\": \"Old Email\",\n \"newEmail\": \"New Email\"\n },\n \"footerNote\": \"If you did not make this change, review your account security.\",\n \"heading\": \"Email address changed\",\n \"intro\": \"The email address on your account was changed.\",\n \"preheader\": \"The email address on your account was changed.\",\n \"subject\": \"Email address changed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"email-changed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"changeDetails\": {\n \"changedAt\": \"Changed At\",\n \"oldEmail\": \"Old Email\",\n \"newEmail\": \"New Email\"\n },\n \"footerNote\": \"If you did not make this change, review your account security.\",\n \"heading\": \"Email address changed\",\n \"intro\": \"The email address on your account was changed.\",\n \"preheader\": \"The email address on your account was changed.\",\n \"subject\": \"Email address changed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"email-changed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"changeDetails\": {\n \"changedAt\": \"Changed At\",\n \"oldEmail\": \"Old Email\",\n \"newEmail\": \"New Email\"\n },\n \"footerNote\": \"If you did not make this change, review your account security.\",\n \"heading\": \"Email address changed\",\n \"intro\": \"The email address on your account was changed.\",\n \"preheader\": \"The email address on your account was changed.\",\n \"subject\": \"Email address changed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"email-changed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"changeDetails\": {\n \"changedAt\": \"Changed At\",\n \"oldEmail\": \"Old Email\",\n \"newEmail\": \"New Email\"\n },\n \"footerNote\": \"If you did not make this change, review your account security.\",\n \"heading\": \"Email address changed\",\n \"intro\": \"The email address on your account was changed.\",\n \"preheader\": \"The email address on your account was changed.\",\n \"subject\": \"Email address changed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"email-changed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"changeDetails\": {\n \"changedAt\": \"Changed At\",\n \"oldEmail\": \"Old Email\",\n \"newEmail\": \"New Email\"\n },\n \"footerNote\": \"If you did not make this change, review your account security.\",\n \"heading\": \"Email address changed\",\n \"intro\": \"The email address on your account was changed.\",\n \"preheader\": \"The email address on your account was changed.\",\n \"subject\": \"Email address changed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"email-changed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"changeDetails\": {\n \"changedAt\": \"Changed At\",\n \"oldEmail\": \"Old Email\",\n \"newEmail\": \"New Email\"\n },\n \"footerNote\": \"If you did not make this change, review your account security.\",\n \"heading\": \"Email address changed\",\n \"intro\": \"The email address on your account was changed.\",\n \"preheader\": \"The email address on your account was changed.\",\n \"subject\": \"Email address changed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"email-changed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"changeDetails\": {\n \"changedAt\": \"Changed At\",\n \"oldEmail\": \"Old Email\",\n \"newEmail\": \"New Email\"\n },\n \"footerNote\": \"If you did not make this change, review your account security.\",\n \"heading\": \"Email address changed\",\n \"intro\": \"The email address on your account was changed.\",\n \"preheader\": \"The email address on your account was changed.\",\n \"subject\": \"Email address changed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send export-ready", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"export-ready\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/download\",\n \"label\": \"Download export\"\n },\n \"exportDetails\": {\n \"createdAt\": \"Created At\",\n \"expiresAt\": \"Expires At\",\n \"format\": \"Format\",\n \"size\": \"Size\"\n },\n \"heading\": \"Your export is ready\",\n \"intro\": \"The export you requested is ready to download.\",\n \"preheader\": \"Download your completed export.\",\n \"subject\": \"Your export is ready\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"export-ready\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/download\",\n \"label\": \"Download export\"\n },\n \"exportDetails\": {\n \"createdAt\": \"Created At\",\n \"expiresAt\": \"Expires At\",\n \"format\": \"Format\",\n \"size\": \"Size\"\n },\n \"heading\": \"Your export is ready\",\n \"intro\": \"The export you requested is ready to download.\",\n \"preheader\": \"Download your completed export.\",\n \"subject\": \"Your export is ready\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"export-ready\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/download\",\n \"label\": \"Download export\"\n },\n \"exportDetails\": {\n \"createdAt\": \"Created At\",\n \"expiresAt\": \"Expires At\",\n \"format\": \"Format\",\n \"size\": \"Size\"\n },\n \"heading\": \"Your export is ready\",\n \"intro\": \"The export you requested is ready to download.\",\n \"preheader\": \"Download your completed export.\",\n \"subject\": \"Your export is ready\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"export-ready\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/download\",\n \"label\": \"Download export\"\n },\n \"exportDetails\": {\n \"createdAt\": \"Created At\",\n \"expiresAt\": \"Expires At\",\n \"format\": \"Format\",\n \"size\": \"Size\"\n },\n \"heading\": \"Your export is ready\",\n \"intro\": \"The export you requested is ready to download.\",\n \"preheader\": \"Download your completed export.\",\n \"subject\": \"Your export is ready\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"export-ready\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/download\",\n \"label\": \"Download export\"\n },\n \"exportDetails\": {\n \"createdAt\": \"Created At\",\n \"expiresAt\": \"Expires At\",\n \"format\": \"Format\",\n \"size\": \"Size\"\n },\n \"heading\": \"Your export is ready\",\n \"intro\": \"The export you requested is ready to download.\",\n \"preheader\": \"Download your completed export.\",\n \"subject\": \"Your export is ready\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"export-ready\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/download\",\n \"label\": \"Download export\"\n },\n \"exportDetails\": {\n \"createdAt\": \"Created At\",\n \"expiresAt\": \"Expires At\",\n \"format\": \"Format\",\n \"size\": \"Size\"\n },\n \"heading\": \"Your export is ready\",\n \"intro\": \"The export you requested is ready to download.\",\n \"preheader\": \"Download your completed export.\",\n \"subject\": \"Your export is ready\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"export-ready\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/download\",\n \"label\": \"Download export\"\n },\n \"exportDetails\": {\n \"createdAt\": \"Created At\",\n \"expiresAt\": \"Expires At\",\n \"format\": \"Format\",\n \"size\": \"Size\"\n },\n \"heading\": \"Your export is ready\",\n \"intro\": \"The export you requested is ready to download.\",\n \"preheader\": \"Download your completed export.\",\n \"subject\": \"Your export is ready\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send generation-complete", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"generation-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"View result\"\n },\n \"generationDetails\": {\n \"completedAt\": \"Completed At\",\n \"type\": \"Type\",\n \"reference\": \"Reference\"\n },\n \"heading\": \"Generation complete\",\n \"intro\": \"Your generated result is ready.\",\n \"preheader\": \"Your generated result is ready.\",\n \"subject\": \"Generation complete\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"generation-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"View result\"\n },\n \"generationDetails\": {\n \"completedAt\": \"Completed At\",\n \"type\": \"Type\",\n \"reference\": \"Reference\"\n },\n \"heading\": \"Generation complete\",\n \"intro\": \"Your generated result is ready.\",\n \"preheader\": \"Your generated result is ready.\",\n \"subject\": \"Generation complete\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"generation-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"View result\"\n },\n \"generationDetails\": {\n \"completedAt\": \"Completed At\",\n \"type\": \"Type\",\n \"reference\": \"Reference\"\n },\n \"heading\": \"Generation complete\",\n \"intro\": \"Your generated result is ready.\",\n \"preheader\": \"Your generated result is ready.\",\n \"subject\": \"Generation complete\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"generation-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"View result\"\n },\n \"generationDetails\": {\n \"completedAt\": \"Completed At\",\n \"type\": \"Type\",\n \"reference\": \"Reference\"\n },\n \"heading\": \"Generation complete\",\n \"intro\": \"Your generated result is ready.\",\n \"preheader\": \"Your generated result is ready.\",\n \"subject\": \"Generation complete\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"generation-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"View result\"\n },\n \"generationDetails\": {\n \"completedAt\": \"Completed At\",\n \"type\": \"Type\",\n \"reference\": \"Reference\"\n },\n \"heading\": \"Generation complete\",\n \"intro\": \"Your generated result is ready.\",\n \"preheader\": \"Your generated result is ready.\",\n \"subject\": \"Generation complete\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"generation-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"View result\"\n },\n \"generationDetails\": {\n \"completedAt\": \"Completed At\",\n \"type\": \"Type\",\n \"reference\": \"Reference\"\n },\n \"heading\": \"Generation complete\",\n \"intro\": \"Your generated result is ready.\",\n \"preheader\": \"Your generated result is ready.\",\n \"subject\": \"Generation complete\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"generation-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"View result\"\n },\n \"generationDetails\": {\n \"completedAt\": \"Completed At\",\n \"type\": \"Type\",\n \"reference\": \"Reference\"\n },\n \"heading\": \"Generation complete\",\n \"intro\": \"Your generated result is ready.\",\n \"preheader\": \"Your generated result is ready.\",\n \"subject\": \"Generation complete\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send import-complete", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"import-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View import\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Import complete\",\n \"importDetails\": {\n \"completedAt\": \"Completed At\",\n \"recordsImported\": \"Records Imported\",\n \"recordsSkipped\": \"Records Skipped\",\n \"fileName\": \"File Name\"\n },\n \"message\": \"Your import has completed.\",\n \"preheader\": \"Your import has completed.\",\n \"subject\": \"Import complete\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"import-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View import\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Import complete\",\n \"importDetails\": {\n \"completedAt\": \"Completed At\",\n \"recordsImported\": \"Records Imported\",\n \"recordsSkipped\": \"Records Skipped\",\n \"fileName\": \"File Name\"\n },\n \"message\": \"Your import has completed.\",\n \"preheader\": \"Your import has completed.\",\n \"subject\": \"Import complete\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"import-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View import\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Import complete\",\n \"importDetails\": {\n \"completedAt\": \"Completed At\",\n \"recordsImported\": \"Records Imported\",\n \"recordsSkipped\": \"Records Skipped\",\n \"fileName\": \"File Name\"\n },\n \"message\": \"Your import has completed.\",\n \"preheader\": \"Your import has completed.\",\n \"subject\": \"Import complete\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"import-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View import\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Import complete\",\n \"importDetails\": {\n \"completedAt\": \"Completed At\",\n \"recordsImported\": \"Records Imported\",\n \"recordsSkipped\": \"Records Skipped\",\n \"fileName\": \"File Name\"\n },\n \"message\": \"Your import has completed.\",\n \"preheader\": \"Your import has completed.\",\n \"subject\": \"Import complete\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"import-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View import\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Import complete\",\n \"importDetails\": {\n \"completedAt\": \"Completed At\",\n \"recordsImported\": \"Records Imported\",\n \"recordsSkipped\": \"Records Skipped\",\n \"fileName\": \"File Name\"\n },\n \"message\": \"Your import has completed.\",\n \"preheader\": \"Your import has completed.\",\n \"subject\": \"Import complete\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"import-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View import\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Import complete\",\n \"importDetails\": {\n \"completedAt\": \"Completed At\",\n \"recordsImported\": \"Records Imported\",\n \"recordsSkipped\": \"Records Skipped\",\n \"fileName\": \"File Name\"\n },\n \"message\": \"Your import has completed.\",\n \"preheader\": \"Your import has completed.\",\n \"subject\": \"Import complete\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"import-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View import\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Import complete\",\n \"importDetails\": {\n \"completedAt\": \"Completed At\",\n \"recordsImported\": \"Records Imported\",\n \"recordsSkipped\": \"Records Skipped\",\n \"fileName\": \"File Name\"\n },\n \"message\": \"Your import has completed.\",\n \"preheader\": \"Your import has completed.\",\n \"subject\": \"Import complete\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send invitation-accepted", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invitation-accepted\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Invitation accepted\",\n \"intro\": \"An invitation has been accepted.\",\n \"inviteDetails\": {\n \"acceptedBy\": \"Accepted By\",\n \"acceptedAt\": \"Accepted At\",\n \"workspace\": \"Workspace\",\n \"role\": \"Role\"\n },\n \"preheader\": \"An invitation has been accepted.\",\n \"subject\": \"Invitation accepted\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invitation-accepted\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Invitation accepted\",\n \"intro\": \"An invitation has been accepted.\",\n \"inviteDetails\": {\n \"acceptedBy\": \"Accepted By\",\n \"acceptedAt\": \"Accepted At\",\n \"workspace\": \"Workspace\",\n \"role\": \"Role\"\n },\n \"preheader\": \"An invitation has been accepted.\",\n \"subject\": \"Invitation accepted\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invitation-accepted\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Invitation accepted\",\n \"intro\": \"An invitation has been accepted.\",\n \"inviteDetails\": {\n \"acceptedBy\": \"Accepted By\",\n \"acceptedAt\": \"Accepted At\",\n \"workspace\": \"Workspace\",\n \"role\": \"Role\"\n },\n \"preheader\": \"An invitation has been accepted.\",\n \"subject\": \"Invitation accepted\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invitation-accepted\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Invitation accepted\",\n \"intro\": \"An invitation has been accepted.\",\n \"inviteDetails\": {\n \"acceptedBy\": \"Accepted By\",\n \"acceptedAt\": \"Accepted At\",\n \"workspace\": \"Workspace\",\n \"role\": \"Role\"\n },\n \"preheader\": \"An invitation has been accepted.\",\n \"subject\": \"Invitation accepted\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invitation-accepted\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Invitation accepted\",\n \"intro\": \"An invitation has been accepted.\",\n \"inviteDetails\": {\n \"acceptedBy\": \"Accepted By\",\n \"acceptedAt\": \"Accepted At\",\n \"workspace\": \"Workspace\",\n \"role\": \"Role\"\n },\n \"preheader\": \"An invitation has been accepted.\",\n \"subject\": \"Invitation accepted\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invitation-accepted\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Invitation accepted\",\n \"intro\": \"An invitation has been accepted.\",\n \"inviteDetails\": {\n \"acceptedBy\": \"Accepted By\",\n \"acceptedAt\": \"Accepted At\",\n \"workspace\": \"Workspace\",\n \"role\": \"Role\"\n },\n \"preheader\": \"An invitation has been accepted.\",\n \"subject\": \"Invitation accepted\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invitation-accepted\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Invitation accepted\",\n \"intro\": \"An invitation has been accepted.\",\n \"inviteDetails\": {\n \"acceptedBy\": \"Accepted By\",\n \"acceptedAt\": \"Accepted At\",\n \"workspace\": \"Workspace\",\n \"role\": \"Role\"\n },\n \"preheader\": \"An invitation has been accepted.\",\n \"subject\": \"Invitation accepted\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send invited-to-workspace", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invited-to-workspace\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Accept invitation\"\n },\n \"heading\": \"You're invited\",\n \"intro\": \"You have been invited to join.\",\n \"inviteDetails\": {\n \"workspace\": \"Workspace\",\n \"invitedBy\": \"Invited By\",\n \"role\": \"Role\",\n \"expiresAt\": \"Expires At\"\n },\n \"preheader\": \"Accept your invitation to continue.\",\n \"subject\": \"You're invited\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invited-to-workspace\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Accept invitation\"\n },\n \"heading\": \"You're invited\",\n \"intro\": \"You have been invited to join.\",\n \"inviteDetails\": {\n \"workspace\": \"Workspace\",\n \"invitedBy\": \"Invited By\",\n \"role\": \"Role\",\n \"expiresAt\": \"Expires At\"\n },\n \"preheader\": \"Accept your invitation to continue.\",\n \"subject\": \"You're invited\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invited-to-workspace\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Accept invitation\"\n },\n \"heading\": \"You're invited\",\n \"intro\": \"You have been invited to join.\",\n \"inviteDetails\": {\n \"workspace\": \"Workspace\",\n \"invitedBy\": \"Invited By\",\n \"role\": \"Role\",\n \"expiresAt\": \"Expires At\"\n },\n \"preheader\": \"Accept your invitation to continue.\",\n \"subject\": \"You're invited\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invited-to-workspace\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Accept invitation\"\n },\n \"heading\": \"You're invited\",\n \"intro\": \"You have been invited to join.\",\n \"inviteDetails\": {\n \"workspace\": \"Workspace\",\n \"invitedBy\": \"Invited By\",\n \"role\": \"Role\",\n \"expiresAt\": \"Expires At\"\n },\n \"preheader\": \"Accept your invitation to continue.\",\n \"subject\": \"You're invited\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invited-to-workspace\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Accept invitation\"\n },\n \"heading\": \"You're invited\",\n \"intro\": \"You have been invited to join.\",\n \"inviteDetails\": {\n \"workspace\": \"Workspace\",\n \"invitedBy\": \"Invited By\",\n \"role\": \"Role\",\n \"expiresAt\": \"Expires At\"\n },\n \"preheader\": \"Accept your invitation to continue.\",\n \"subject\": \"You're invited\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invited-to-workspace\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Accept invitation\"\n },\n \"heading\": \"You're invited\",\n \"intro\": \"You have been invited to join.\",\n \"inviteDetails\": {\n \"workspace\": \"Workspace\",\n \"invitedBy\": \"Invited By\",\n \"role\": \"Role\",\n \"expiresAt\": \"Expires At\"\n },\n \"preheader\": \"Accept your invitation to continue.\",\n \"subject\": \"You're invited\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invited-to-workspace\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Accept invitation\"\n },\n \"heading\": \"You're invited\",\n \"intro\": \"You have been invited to join.\",\n \"inviteDetails\": {\n \"workspace\": \"Workspace\",\n \"invitedBy\": \"Invited By\",\n \"role\": \"Role\",\n \"expiresAt\": \"Expires At\"\n },\n \"preheader\": \"Accept your invitation to continue.\",\n \"subject\": \"You're invited\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send invoice", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invoice\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"invoice\": {\n \"items\": [\n {\n \"quantity\": \"Quantity\",\n \"code\": \"Code\",\n \"description\": \"Description\",\n \"amount\": \"GBP 20.00\"\n }\n ],\n \"totals\": {\n \"subtotal\": \"GBP 20.00\",\n \"tax\": \"Tax\",\n \"total\": \"GBP 20.00\"\n }\n },\n \"invoiceNumber\": \"Invoice Number\",\n \"actionButton\": {\n \"label\": \"View invoice\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Invoice Invoice Number\",\n \"intro\": \"Your invoice is ready.\",\n \"preheader\": \"Your invoice is ready.\",\n \"subject\": \"Invoice Invoice Number\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invoice\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"invoice\": {\n \"items\": [\n {\n \"quantity\": \"Quantity\",\n \"code\": \"Code\",\n \"description\": \"Description\",\n \"amount\": \"GBP 20.00\"\n }\n ],\n \"totals\": {\n \"subtotal\": \"GBP 20.00\",\n \"tax\": \"Tax\",\n \"total\": \"GBP 20.00\"\n }\n },\n \"invoiceNumber\": \"Invoice Number\",\n \"actionButton\": {\n \"label\": \"View invoice\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Invoice Invoice Number\",\n \"intro\": \"Your invoice is ready.\",\n \"preheader\": \"Your invoice is ready.\",\n \"subject\": \"Invoice Invoice Number\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invoice\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"invoice\": {\n \"items\": [\n {\n \"quantity\": \"Quantity\",\n \"code\": \"Code\",\n \"description\": \"Description\",\n \"amount\": \"GBP 20.00\"\n }\n ],\n \"totals\": {\n \"subtotal\": \"GBP 20.00\",\n \"tax\": \"Tax\",\n \"total\": \"GBP 20.00\"\n }\n },\n \"invoiceNumber\": \"Invoice Number\",\n \"actionButton\": {\n \"label\": \"View invoice\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Invoice Invoice Number\",\n \"intro\": \"Your invoice is ready.\",\n \"preheader\": \"Your invoice is ready.\",\n \"subject\": \"Invoice Invoice Number\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invoice\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"invoice\": {\n \"items\": [\n {\n \"quantity\": \"Quantity\",\n \"code\": \"Code\",\n \"description\": \"Description\",\n \"amount\": \"GBP 20.00\"\n }\n ],\n \"totals\": {\n \"subtotal\": \"GBP 20.00\",\n \"tax\": \"Tax\",\n \"total\": \"GBP 20.00\"\n }\n },\n \"invoiceNumber\": \"Invoice Number\",\n \"actionButton\": {\n \"label\": \"View invoice\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Invoice Invoice Number\",\n \"intro\": \"Your invoice is ready.\",\n \"preheader\": \"Your invoice is ready.\",\n \"subject\": \"Invoice Invoice Number\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invoice\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"invoice\": {\n \"items\": [\n {\n \"quantity\": \"Quantity\",\n \"code\": \"Code\",\n \"description\": \"Description\",\n \"amount\": \"GBP 20.00\"\n }\n ],\n \"totals\": {\n \"subtotal\": \"GBP 20.00\",\n \"tax\": \"Tax\",\n \"total\": \"GBP 20.00\"\n }\n },\n \"invoiceNumber\": \"Invoice Number\",\n \"actionButton\": {\n \"label\": \"View invoice\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Invoice Invoice Number\",\n \"intro\": \"Your invoice is ready.\",\n \"preheader\": \"Your invoice is ready.\",\n \"subject\": \"Invoice Invoice Number\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invoice\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"invoice\": {\n \"items\": [\n {\n \"quantity\": \"Quantity\",\n \"code\": \"Code\",\n \"description\": \"Description\",\n \"amount\": \"GBP 20.00\"\n }\n ],\n \"totals\": {\n \"subtotal\": \"GBP 20.00\",\n \"tax\": \"Tax\",\n \"total\": \"GBP 20.00\"\n }\n },\n \"invoiceNumber\": \"Invoice Number\",\n \"actionButton\": {\n \"label\": \"View invoice\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Invoice Invoice Number\",\n \"intro\": \"Your invoice is ready.\",\n \"preheader\": \"Your invoice is ready.\",\n \"subject\": \"Invoice Invoice Number\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invoice\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"invoice\": {\n \"items\": [\n {\n \"quantity\": \"Quantity\",\n \"code\": \"Code\",\n \"description\": \"Description\",\n \"amount\": \"GBP 20.00\"\n }\n ],\n \"totals\": {\n \"subtotal\": \"GBP 20.00\",\n \"tax\": \"Tax\",\n \"total\": \"GBP 20.00\"\n }\n },\n \"invoiceNumber\": \"Invoice Number\",\n \"actionButton\": {\n \"label\": \"View invoice\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Invoice Invoice Number\",\n \"intro\": \"Your invoice is ready.\",\n \"preheader\": \"Your invoice is ready.\",\n \"subject\": \"Invoice Invoice Number\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send invoice-overdue", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invoice-overdue\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Pay invoice\"\n },\n \"heading\": \"Invoice overdue\",\n \"intro\": \"Payment for this invoice is now overdue.\",\n \"invoiceDetails\": {\n \"invoiceNumber\": \"Invoice Number\",\n \"amount\": \"Amount\",\n \"dueDate\": \"Due Date\",\n \"daysOverdue\": \"Days Overdue\"\n },\n \"preheader\": \"Payment is now overdue.\",\n \"subject\": \"Invoice overdue\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invoice-overdue\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Pay invoice\"\n },\n \"heading\": \"Invoice overdue\",\n \"intro\": \"Payment for this invoice is now overdue.\",\n \"invoiceDetails\": {\n \"invoiceNumber\": \"Invoice Number\",\n \"amount\": \"Amount\",\n \"dueDate\": \"Due Date\",\n \"daysOverdue\": \"Days Overdue\"\n },\n \"preheader\": \"Payment is now overdue.\",\n \"subject\": \"Invoice overdue\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invoice-overdue\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Pay invoice\"\n },\n \"heading\": \"Invoice overdue\",\n \"intro\": \"Payment for this invoice is now overdue.\",\n \"invoiceDetails\": {\n \"invoiceNumber\": \"Invoice Number\",\n \"amount\": \"Amount\",\n \"dueDate\": \"Due Date\",\n \"daysOverdue\": \"Days Overdue\"\n },\n \"preheader\": \"Payment is now overdue.\",\n \"subject\": \"Invoice overdue\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invoice-overdue\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Pay invoice\"\n },\n \"heading\": \"Invoice overdue\",\n \"intro\": \"Payment for this invoice is now overdue.\",\n \"invoiceDetails\": {\n \"invoiceNumber\": \"Invoice Number\",\n \"amount\": \"Amount\",\n \"dueDate\": \"Due Date\",\n \"daysOverdue\": \"Days Overdue\"\n },\n \"preheader\": \"Payment is now overdue.\",\n \"subject\": \"Invoice overdue\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invoice-overdue\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Pay invoice\"\n },\n \"heading\": \"Invoice overdue\",\n \"intro\": \"Payment for this invoice is now overdue.\",\n \"invoiceDetails\": {\n \"invoiceNumber\": \"Invoice Number\",\n \"amount\": \"Amount\",\n \"dueDate\": \"Due Date\",\n \"daysOverdue\": \"Days Overdue\"\n },\n \"preheader\": \"Payment is now overdue.\",\n \"subject\": \"Invoice overdue\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invoice-overdue\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Pay invoice\"\n },\n \"heading\": \"Invoice overdue\",\n \"intro\": \"Payment for this invoice is now overdue.\",\n \"invoiceDetails\": {\n \"invoiceNumber\": \"Invoice Number\",\n \"amount\": \"Amount\",\n \"dueDate\": \"Due Date\",\n \"daysOverdue\": \"Days Overdue\"\n },\n \"preheader\": \"Payment is now overdue.\",\n \"subject\": \"Invoice overdue\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"invoice-overdue\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Pay invoice\"\n },\n \"heading\": \"Invoice overdue\",\n \"intro\": \"Payment for this invoice is now overdue.\",\n \"invoiceDetails\": {\n \"invoiceNumber\": \"Invoice Number\",\n \"amount\": \"Amount\",\n \"dueDate\": \"Due Date\",\n \"daysOverdue\": \"Days Overdue\"\n },\n \"preheader\": \"Payment is now overdue.\",\n \"subject\": \"Invoice overdue\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send job-complete", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"job-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View result\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Job complete\",\n \"jobDetails\": {\n \"jobName\": \"Job Name\",\n \"completedAt\": \"Completed At\",\n \"duration\": \"Duration\",\n \"reference\": \"Reference\"\n },\n \"message\": \"Your job has completed.\",\n \"preheader\": \"Your job has completed.\",\n \"subject\": \"Job complete\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"job-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View result\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Job complete\",\n \"jobDetails\": {\n \"jobName\": \"Job Name\",\n \"completedAt\": \"Completed At\",\n \"duration\": \"Duration\",\n \"reference\": \"Reference\"\n },\n \"message\": \"Your job has completed.\",\n \"preheader\": \"Your job has completed.\",\n \"subject\": \"Job complete\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"job-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View result\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Job complete\",\n \"jobDetails\": {\n \"jobName\": \"Job Name\",\n \"completedAt\": \"Completed At\",\n \"duration\": \"Duration\",\n \"reference\": \"Reference\"\n },\n \"message\": \"Your job has completed.\",\n \"preheader\": \"Your job has completed.\",\n \"subject\": \"Job complete\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"job-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View result\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Job complete\",\n \"jobDetails\": {\n \"jobName\": \"Job Name\",\n \"completedAt\": \"Completed At\",\n \"duration\": \"Duration\",\n \"reference\": \"Reference\"\n },\n \"message\": \"Your job has completed.\",\n \"preheader\": \"Your job has completed.\",\n \"subject\": \"Job complete\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"job-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View result\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Job complete\",\n \"jobDetails\": {\n \"jobName\": \"Job Name\",\n \"completedAt\": \"Completed At\",\n \"duration\": \"Duration\",\n \"reference\": \"Reference\"\n },\n \"message\": \"Your job has completed.\",\n \"preheader\": \"Your job has completed.\",\n \"subject\": \"Job complete\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"job-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View result\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Job complete\",\n \"jobDetails\": {\n \"jobName\": \"Job Name\",\n \"completedAt\": \"Completed At\",\n \"duration\": \"Duration\",\n \"reference\": \"Reference\"\n },\n \"message\": \"Your job has completed.\",\n \"preheader\": \"Your job has completed.\",\n \"subject\": \"Job complete\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"job-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View result\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Job complete\",\n \"jobDetails\": {\n \"jobName\": \"Job Name\",\n \"completedAt\": \"Completed At\",\n \"duration\": \"Duration\",\n \"reference\": \"Reference\"\n },\n \"message\": \"Your job has completed.\",\n \"preheader\": \"Your job has completed.\",\n \"subject\": \"Job complete\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send login-code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"login-code\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"code\": \"123456\",\n \"footerNote\": \"If you did not request this code, you can safely ignore this email.\",\n \"heading\": \"Your login code\",\n \"intro\": \"Use this code to continue signing in.\",\n \"preheader\": \"Use this code to continue signing in.\",\n \"securityNote\": \"For security, this code will expire soon.\",\n \"subject\": \"Your login code\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"login-code\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"code\": \"123456\",\n \"footerNote\": \"If you did not request this code, you can safely ignore this email.\",\n \"heading\": \"Your login code\",\n \"intro\": \"Use this code to continue signing in.\",\n \"preheader\": \"Use this code to continue signing in.\",\n \"securityNote\": \"For security, this code will expire soon.\",\n \"subject\": \"Your login code\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"login-code\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"code\": \"123456\",\n \"footerNote\": \"If you did not request this code, you can safely ignore this email.\",\n \"heading\": \"Your login code\",\n \"intro\": \"Use this code to continue signing in.\",\n \"preheader\": \"Use this code to continue signing in.\",\n \"securityNote\": \"For security, this code will expire soon.\",\n \"subject\": \"Your login code\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"login-code\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"code\": \"123456\",\n \"footerNote\": \"If you did not request this code, you can safely ignore this email.\",\n \"heading\": \"Your login code\",\n \"intro\": \"Use this code to continue signing in.\",\n \"preheader\": \"Use this code to continue signing in.\",\n \"securityNote\": \"For security, this code will expire soon.\",\n \"subject\": \"Your login code\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"login-code\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"code\": \"123456\",\n \"footerNote\": \"If you did not request this code, you can safely ignore this email.\",\n \"heading\": \"Your login code\",\n \"intro\": \"Use this code to continue signing in.\",\n \"preheader\": \"Use this code to continue signing in.\",\n \"securityNote\": \"For security, this code will expire soon.\",\n \"subject\": \"Your login code\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"login-code\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"code\": \"123456\",\n \"footerNote\": \"If you did not request this code, you can safely ignore this email.\",\n \"heading\": \"Your login code\",\n \"intro\": \"Use this code to continue signing in.\",\n \"preheader\": \"Use this code to continue signing in.\",\n \"securityNote\": \"For security, this code will expire soon.\",\n \"subject\": \"Your login code\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"login-code\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"code\": \"123456\",\n \"footerNote\": \"If you did not request this code, you can safely ignore this email.\",\n \"heading\": \"Your login code\",\n \"intro\": \"Use this code to continue signing in.\",\n \"preheader\": \"Use this code to continue signing in.\",\n \"securityNote\": \"For security, this code will expire soon.\",\n \"subject\": \"Your login code\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send magic-link", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"magic-link\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Sign in\"\n },\n \"footerNote\": \"If you did not request this email, you can safely ignore it.\",\n \"heading\": \"Sign in to your account\",\n \"intro\": \"Use this secure link to sign in. This link is private and will expire soon.\",\n \"preheader\": \"Use this secure link to sign in.\",\n \"subject\": \"Your sign-in link for Project Name\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"magic-link\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Sign in\"\n },\n \"footerNote\": \"If you did not request this email, you can safely ignore it.\",\n \"heading\": \"Sign in to your account\",\n \"intro\": \"Use this secure link to sign in. This link is private and will expire soon.\",\n \"preheader\": \"Use this secure link to sign in.\",\n \"subject\": \"Your sign-in link for Project Name\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"magic-link\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Sign in\"\n },\n \"footerNote\": \"If you did not request this email, you can safely ignore it.\",\n \"heading\": \"Sign in to your account\",\n \"intro\": \"Use this secure link to sign in. This link is private and will expire soon.\",\n \"preheader\": \"Use this secure link to sign in.\",\n \"subject\": \"Your sign-in link for Project Name\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"magic-link\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Sign in\"\n },\n \"footerNote\": \"If you did not request this email, you can safely ignore it.\",\n \"heading\": \"Sign in to your account\",\n \"intro\": \"Use this secure link to sign in. This link is private and will expire soon.\",\n \"preheader\": \"Use this secure link to sign in.\",\n \"subject\": \"Your sign-in link for Project Name\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"magic-link\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Sign in\"\n },\n \"footerNote\": \"If you did not request this email, you can safely ignore it.\",\n \"heading\": \"Sign in to your account\",\n \"intro\": \"Use this secure link to sign in. This link is private and will expire soon.\",\n \"preheader\": \"Use this secure link to sign in.\",\n \"subject\": \"Your sign-in link for Project Name\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"magic-link\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Sign in\"\n },\n \"footerNote\": \"If you did not request this email, you can safely ignore it.\",\n \"heading\": \"Sign in to your account\",\n \"intro\": \"Use this secure link to sign in. This link is private and will expire soon.\",\n \"preheader\": \"Use this secure link to sign in.\",\n \"subject\": \"Your sign-in link for Project Name\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"magic-link\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Sign in\"\n },\n \"footerNote\": \"If you did not request this email, you can safely ignore it.\",\n \"heading\": \"Sign in to your account\",\n \"intro\": \"Use this secure link to sign in. This link is private and will expire soon.\",\n \"preheader\": \"Use this secure link to sign in.\",\n \"subject\": \"Your sign-in link for Project Name\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send mfa-disabled", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"mfa-disabled\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"footerNote\": \"If you did not make this change, review your account security.\",\n \"heading\": \"Multi-factor authentication disabled\",\n \"intro\": \"Multi-factor authentication has been disabled for your account.\",\n \"notice\": \"Your account may be less protected without multi-factor authentication.\",\n \"preheader\": \"Multi-factor authentication has been removed from your account.\",\n \"securityDetails\": {\n \"disabledAt\": \"Disabled At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"subject\": \"Multi-factor authentication disabled\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"mfa-disabled\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"footerNote\": \"If you did not make this change, review your account security.\",\n \"heading\": \"Multi-factor authentication disabled\",\n \"intro\": \"Multi-factor authentication has been disabled for your account.\",\n \"notice\": \"Your account may be less protected without multi-factor authentication.\",\n \"preheader\": \"Multi-factor authentication has been removed from your account.\",\n \"securityDetails\": {\n \"disabledAt\": \"Disabled At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"subject\": \"Multi-factor authentication disabled\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"mfa-disabled\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"footerNote\": \"If you did not make this change, review your account security.\",\n \"heading\": \"Multi-factor authentication disabled\",\n \"intro\": \"Multi-factor authentication has been disabled for your account.\",\n \"notice\": \"Your account may be less protected without multi-factor authentication.\",\n \"preheader\": \"Multi-factor authentication has been removed from your account.\",\n \"securityDetails\": {\n \"disabledAt\": \"Disabled At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"subject\": \"Multi-factor authentication disabled\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"mfa-disabled\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"footerNote\": \"If you did not make this change, review your account security.\",\n \"heading\": \"Multi-factor authentication disabled\",\n \"intro\": \"Multi-factor authentication has been disabled for your account.\",\n \"notice\": \"Your account may be less protected without multi-factor authentication.\",\n \"preheader\": \"Multi-factor authentication has been removed from your account.\",\n \"securityDetails\": {\n \"disabledAt\": \"Disabled At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"subject\": \"Multi-factor authentication disabled\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"mfa-disabled\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"footerNote\": \"If you did not make this change, review your account security.\",\n \"heading\": \"Multi-factor authentication disabled\",\n \"intro\": \"Multi-factor authentication has been disabled for your account.\",\n \"notice\": \"Your account may be less protected without multi-factor authentication.\",\n \"preheader\": \"Multi-factor authentication has been removed from your account.\",\n \"securityDetails\": {\n \"disabledAt\": \"Disabled At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"subject\": \"Multi-factor authentication disabled\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"mfa-disabled\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"footerNote\": \"If you did not make this change, review your account security.\",\n \"heading\": \"Multi-factor authentication disabled\",\n \"intro\": \"Multi-factor authentication has been disabled for your account.\",\n \"notice\": \"Your account may be less protected without multi-factor authentication.\",\n \"preheader\": \"Multi-factor authentication has been removed from your account.\",\n \"securityDetails\": {\n \"disabledAt\": \"Disabled At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"subject\": \"Multi-factor authentication disabled\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"mfa-disabled\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"footerNote\": \"If you did not make this change, review your account security.\",\n \"heading\": \"Multi-factor authentication disabled\",\n \"intro\": \"Multi-factor authentication has been disabled for your account.\",\n \"notice\": \"Your account may be less protected without multi-factor authentication.\",\n \"preheader\": \"Multi-factor authentication has been removed from your account.\",\n \"securityDetails\": {\n \"disabledAt\": \"Disabled At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"subject\": \"Multi-factor authentication disabled\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send mfa-enabled", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"mfa-enabled\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"footerNote\": \"If you did not make this change, review your account security.\",\n \"heading\": \"Multi-factor authentication enabled\",\n \"intro\": \"Multi-factor authentication has been enabled for your account.\",\n \"notice\": \"Your account now has an extra layer of protection.\",\n \"preheader\": \"An extra layer of security has been added to your account.\",\n \"securityDetails\": {\n \"enabledAt\": \"Enabled At\",\n \"method\": \"Method\",\n \"device\": \"Device\"\n },\n \"subject\": \"Multi-factor authentication enabled\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"mfa-enabled\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"footerNote\": \"If you did not make this change, review your account security.\",\n \"heading\": \"Multi-factor authentication enabled\",\n \"intro\": \"Multi-factor authentication has been enabled for your account.\",\n \"notice\": \"Your account now has an extra layer of protection.\",\n \"preheader\": \"An extra layer of security has been added to your account.\",\n \"securityDetails\": {\n \"enabledAt\": \"Enabled At\",\n \"method\": \"Method\",\n \"device\": \"Device\"\n },\n \"subject\": \"Multi-factor authentication enabled\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"mfa-enabled\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"footerNote\": \"If you did not make this change, review your account security.\",\n \"heading\": \"Multi-factor authentication enabled\",\n \"intro\": \"Multi-factor authentication has been enabled for your account.\",\n \"notice\": \"Your account now has an extra layer of protection.\",\n \"preheader\": \"An extra layer of security has been added to your account.\",\n \"securityDetails\": {\n \"enabledAt\": \"Enabled At\",\n \"method\": \"Method\",\n \"device\": \"Device\"\n },\n \"subject\": \"Multi-factor authentication enabled\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"mfa-enabled\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"footerNote\": \"If you did not make this change, review your account security.\",\n \"heading\": \"Multi-factor authentication enabled\",\n \"intro\": \"Multi-factor authentication has been enabled for your account.\",\n \"notice\": \"Your account now has an extra layer of protection.\",\n \"preheader\": \"An extra layer of security has been added to your account.\",\n \"securityDetails\": {\n \"enabledAt\": \"Enabled At\",\n \"method\": \"Method\",\n \"device\": \"Device\"\n },\n \"subject\": \"Multi-factor authentication enabled\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"mfa-enabled\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"footerNote\": \"If you did not make this change, review your account security.\",\n \"heading\": \"Multi-factor authentication enabled\",\n \"intro\": \"Multi-factor authentication has been enabled for your account.\",\n \"notice\": \"Your account now has an extra layer of protection.\",\n \"preheader\": \"An extra layer of security has been added to your account.\",\n \"securityDetails\": {\n \"enabledAt\": \"Enabled At\",\n \"method\": \"Method\",\n \"device\": \"Device\"\n },\n \"subject\": \"Multi-factor authentication enabled\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"mfa-enabled\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"footerNote\": \"If you did not make this change, review your account security.\",\n \"heading\": \"Multi-factor authentication enabled\",\n \"intro\": \"Multi-factor authentication has been enabled for your account.\",\n \"notice\": \"Your account now has an extra layer of protection.\",\n \"preheader\": \"An extra layer of security has been added to your account.\",\n \"securityDetails\": {\n \"enabledAt\": \"Enabled At\",\n \"method\": \"Method\",\n \"device\": \"Device\"\n },\n \"subject\": \"Multi-factor authentication enabled\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"mfa-enabled\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"footerNote\": \"If you did not make this change, review your account security.\",\n \"heading\": \"Multi-factor authentication enabled\",\n \"intro\": \"Multi-factor authentication has been enabled for your account.\",\n \"notice\": \"Your account now has an extra layer of protection.\",\n \"preheader\": \"An extra layer of security has been added to your account.\",\n \"securityDetails\": {\n \"enabledAt\": \"Enabled At\",\n \"method\": \"Method\",\n \"device\": \"Device\"\n },\n \"subject\": \"Multi-factor authentication enabled\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send new-device-login", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"new-device-login\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"footerNote\": \"If this was you, no action is needed.\",\n \"heading\": \"New sign-in detected\",\n \"intro\": \"Your account was accessed from a device we have not seen before.\",\n \"loginDetails\": {\n \"signedInAt\": \"Signed In At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"preheader\": \"A new device signed in to your account.\",\n \"subject\": \"New sign-in detected\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"new-device-login\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"footerNote\": \"If this was you, no action is needed.\",\n \"heading\": \"New sign-in detected\",\n \"intro\": \"Your account was accessed from a device we have not seen before.\",\n \"loginDetails\": {\n \"signedInAt\": \"Signed In At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"preheader\": \"A new device signed in to your account.\",\n \"subject\": \"New sign-in detected\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"new-device-login\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"footerNote\": \"If this was you, no action is needed.\",\n \"heading\": \"New sign-in detected\",\n \"intro\": \"Your account was accessed from a device we have not seen before.\",\n \"loginDetails\": {\n \"signedInAt\": \"Signed In At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"preheader\": \"A new device signed in to your account.\",\n \"subject\": \"New sign-in detected\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"new-device-login\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"footerNote\": \"If this was you, no action is needed.\",\n \"heading\": \"New sign-in detected\",\n \"intro\": \"Your account was accessed from a device we have not seen before.\",\n \"loginDetails\": {\n \"signedInAt\": \"Signed In At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"preheader\": \"A new device signed in to your account.\",\n \"subject\": \"New sign-in detected\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"new-device-login\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"footerNote\": \"If this was you, no action is needed.\",\n \"heading\": \"New sign-in detected\",\n \"intro\": \"Your account was accessed from a device we have not seen before.\",\n \"loginDetails\": {\n \"signedInAt\": \"Signed In At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"preheader\": \"A new device signed in to your account.\",\n \"subject\": \"New sign-in detected\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"new-device-login\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"footerNote\": \"If this was you, no action is needed.\",\n \"heading\": \"New sign-in detected\",\n \"intro\": \"Your account was accessed from a device we have not seen before.\",\n \"loginDetails\": {\n \"signedInAt\": \"Signed In At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"preheader\": \"A new device signed in to your account.\",\n \"subject\": \"New sign-in detected\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"new-device-login\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"footerNote\": \"If this was you, no action is needed.\",\n \"heading\": \"New sign-in detected\",\n \"intro\": \"Your account was accessed from a device we have not seen before.\",\n \"loginDetails\": {\n \"signedInAt\": \"Signed In At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"preheader\": \"A new device signed in to your account.\",\n \"subject\": \"New sign-in detected\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send notification-alert", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-alert\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"Review\",\n \"url\": \"https://example.com/app\"\n },\n \"alertDetails\": {\n \"time\": \"Time\",\n \"severity\": \"Severity\",\n \"source\": \"Source\"\n },\n \"heading\": \"Important alert\",\n \"preheader\": \"Message\",\n \"subject\": \"Important alert\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-alert\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"Review\",\n \"url\": \"https://example.com/app\"\n },\n \"alertDetails\": {\n \"time\": \"Time\",\n \"severity\": \"Severity\",\n \"source\": \"Source\"\n },\n \"heading\": \"Important alert\",\n \"preheader\": \"Message\",\n \"subject\": \"Important alert\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-alert\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"Review\",\n \"url\": \"https://example.com/app\"\n },\n \"alertDetails\": {\n \"time\": \"Time\",\n \"severity\": \"Severity\",\n \"source\": \"Source\"\n },\n \"heading\": \"Important alert\",\n \"preheader\": \"Message\",\n \"subject\": \"Important alert\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-alert\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"Review\",\n \"url\": \"https://example.com/app\"\n },\n \"alertDetails\": {\n \"time\": \"Time\",\n \"severity\": \"Severity\",\n \"source\": \"Source\"\n },\n \"heading\": \"Important alert\",\n \"preheader\": \"Message\",\n \"subject\": \"Important alert\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-alert\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"Review\",\n \"url\": \"https://example.com/app\"\n },\n \"alertDetails\": {\n \"time\": \"Time\",\n \"severity\": \"Severity\",\n \"source\": \"Source\"\n },\n \"heading\": \"Important alert\",\n \"preheader\": \"Message\",\n \"subject\": \"Important alert\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-alert\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"Review\",\n \"url\": \"https://example.com/app\"\n },\n \"alertDetails\": {\n \"time\": \"Time\",\n \"severity\": \"Severity\",\n \"source\": \"Source\"\n },\n \"heading\": \"Important alert\",\n \"preheader\": \"Message\",\n \"subject\": \"Important alert\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-alert\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"Review\",\n \"url\": \"https://example.com/app\"\n },\n \"alertDetails\": {\n \"time\": \"Time\",\n \"severity\": \"Severity\",\n \"source\": \"Source\"\n },\n \"heading\": \"Important alert\",\n \"preheader\": \"Message\",\n \"subject\": \"Important alert\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send notification-info", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-info\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"New notification\",\n \"preheader\": \"Message\",\n \"subject\": \"New notification\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-info\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"New notification\",\n \"preheader\": \"Message\",\n \"subject\": \"New notification\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-info\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"New notification\",\n \"preheader\": \"Message\",\n \"subject\": \"New notification\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-info\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"New notification\",\n \"preheader\": \"Message\",\n \"subject\": \"New notification\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-info\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"New notification\",\n \"preheader\": \"Message\",\n \"subject\": \"New notification\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-info\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"New notification\",\n \"preheader\": \"Message\",\n \"subject\": \"New notification\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-info\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"New notification\",\n \"preheader\": \"Message\",\n \"subject\": \"New notification\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send notification-success", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-success\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Completed successfully\",\n \"preheader\": \"Message\",\n \"subject\": \"Completed successfully\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-success\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Completed successfully\",\n \"preheader\": \"Message\",\n \"subject\": \"Completed successfully\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-success\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Completed successfully\",\n \"preheader\": \"Message\",\n \"subject\": \"Completed successfully\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-success\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Completed successfully\",\n \"preheader\": \"Message\",\n \"subject\": \"Completed successfully\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-success\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Completed successfully\",\n \"preheader\": \"Message\",\n \"subject\": \"Completed successfully\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-success\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Completed successfully\",\n \"preheader\": \"Message\",\n \"subject\": \"Completed successfully\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-success\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Completed successfully\",\n \"preheader\": \"Message\",\n \"subject\": \"Completed successfully\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send notification-warning", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-warning\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"Review\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Action may be needed\",\n \"preheader\": \"Message\",\n \"subject\": \"Action may be needed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-warning\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"Review\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Action may be needed\",\n \"preheader\": \"Message\",\n \"subject\": \"Action may be needed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-warning\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"Review\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Action may be needed\",\n \"preheader\": \"Message\",\n \"subject\": \"Action may be needed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-warning\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"Review\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Action may be needed\",\n \"preheader\": \"Message\",\n \"subject\": \"Action may be needed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-warning\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"Review\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Action may be needed\",\n \"preheader\": \"Message\",\n \"subject\": \"Action may be needed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-warning\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"Review\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Action may be needed\",\n \"preheader\": \"Message\",\n \"subject\": \"Action may be needed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"notification-warning\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"Review\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Action may be needed\",\n \"preheader\": \"Message\",\n \"subject\": \"Action may be needed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send password-changed", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"password-changed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"changeDetails\": {\n \"changedAt\": \"Changed At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"footerNote\": \"If you did not make this change, reset your password and review your account security.\",\n \"heading\": \"Password changed\",\n \"intro\": \"The password on your account was changed.\",\n \"preheader\": \"The password on your account was changed.\",\n \"subject\": \"Password changed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"password-changed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"changeDetails\": {\n \"changedAt\": \"Changed At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"footerNote\": \"If you did not make this change, reset your password and review your account security.\",\n \"heading\": \"Password changed\",\n \"intro\": \"The password on your account was changed.\",\n \"preheader\": \"The password on your account was changed.\",\n \"subject\": \"Password changed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"password-changed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"changeDetails\": {\n \"changedAt\": \"Changed At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"footerNote\": \"If you did not make this change, reset your password and review your account security.\",\n \"heading\": \"Password changed\",\n \"intro\": \"The password on your account was changed.\",\n \"preheader\": \"The password on your account was changed.\",\n \"subject\": \"Password changed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"password-changed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"changeDetails\": {\n \"changedAt\": \"Changed At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"footerNote\": \"If you did not make this change, reset your password and review your account security.\",\n \"heading\": \"Password changed\",\n \"intro\": \"The password on your account was changed.\",\n \"preheader\": \"The password on your account was changed.\",\n \"subject\": \"Password changed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"password-changed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"changeDetails\": {\n \"changedAt\": \"Changed At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"footerNote\": \"If you did not make this change, reset your password and review your account security.\",\n \"heading\": \"Password changed\",\n \"intro\": \"The password on your account was changed.\",\n \"preheader\": \"The password on your account was changed.\",\n \"subject\": \"Password changed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"password-changed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"changeDetails\": {\n \"changedAt\": \"Changed At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"footerNote\": \"If you did not make this change, reset your password and review your account security.\",\n \"heading\": \"Password changed\",\n \"intro\": \"The password on your account was changed.\",\n \"preheader\": \"The password on your account was changed.\",\n \"subject\": \"Password changed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"password-changed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"changeDetails\": {\n \"changedAt\": \"Changed At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"footerNote\": \"If you did not make this change, reset your password and review your account security.\",\n \"heading\": \"Password changed\",\n \"intro\": \"The password on your account was changed.\",\n \"preheader\": \"The password on your account was changed.\",\n \"subject\": \"Password changed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send password-reset", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"password-reset\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/reset\",\n \"label\": \"Reset password\"\n },\n \"footerNote\": \"If you did not request this, you can safely ignore this email. Your password will remain unchanged.\",\n \"heading\": \"Reset your password\",\n \"intro\": \"We received a request to reset your password.\",\n \"preheader\": \"Use this secure link to reset your password.\",\n \"requestDetails\": {\n \"requestedAt\": \"Requested At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"securityNote\": \"For security, this link is private and will expire soon.\",\n \"subject\": \"Reset your password\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"password-reset\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/reset\",\n \"label\": \"Reset password\"\n },\n \"footerNote\": \"If you did not request this, you can safely ignore this email. Your password will remain unchanged.\",\n \"heading\": \"Reset your password\",\n \"intro\": \"We received a request to reset your password.\",\n \"preheader\": \"Use this secure link to reset your password.\",\n \"requestDetails\": {\n \"requestedAt\": \"Requested At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"securityNote\": \"For security, this link is private and will expire soon.\",\n \"subject\": \"Reset your password\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"password-reset\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/reset\",\n \"label\": \"Reset password\"\n },\n \"footerNote\": \"If you did not request this, you can safely ignore this email. Your password will remain unchanged.\",\n \"heading\": \"Reset your password\",\n \"intro\": \"We received a request to reset your password.\",\n \"preheader\": \"Use this secure link to reset your password.\",\n \"requestDetails\": {\n \"requestedAt\": \"Requested At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"securityNote\": \"For security, this link is private and will expire soon.\",\n \"subject\": \"Reset your password\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"password-reset\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/reset\",\n \"label\": \"Reset password\"\n },\n \"footerNote\": \"If you did not request this, you can safely ignore this email. Your password will remain unchanged.\",\n \"heading\": \"Reset your password\",\n \"intro\": \"We received a request to reset your password.\",\n \"preheader\": \"Use this secure link to reset your password.\",\n \"requestDetails\": {\n \"requestedAt\": \"Requested At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"securityNote\": \"For security, this link is private and will expire soon.\",\n \"subject\": \"Reset your password\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"password-reset\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/reset\",\n \"label\": \"Reset password\"\n },\n \"footerNote\": \"If you did not request this, you can safely ignore this email. Your password will remain unchanged.\",\n \"heading\": \"Reset your password\",\n \"intro\": \"We received a request to reset your password.\",\n \"preheader\": \"Use this secure link to reset your password.\",\n \"requestDetails\": {\n \"requestedAt\": \"Requested At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"securityNote\": \"For security, this link is private and will expire soon.\",\n \"subject\": \"Reset your password\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"password-reset\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/reset\",\n \"label\": \"Reset password\"\n },\n \"footerNote\": \"If you did not request this, you can safely ignore this email. Your password will remain unchanged.\",\n \"heading\": \"Reset your password\",\n \"intro\": \"We received a request to reset your password.\",\n \"preheader\": \"Use this secure link to reset your password.\",\n \"requestDetails\": {\n \"requestedAt\": \"Requested At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"securityNote\": \"For security, this link is private and will expire soon.\",\n \"subject\": \"Reset your password\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"password-reset\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/reset\",\n \"label\": \"Reset password\"\n },\n \"footerNote\": \"If you did not request this, you can safely ignore this email. Your password will remain unchanged.\",\n \"heading\": \"Reset your password\",\n \"intro\": \"We received a request to reset your password.\",\n \"preheader\": \"Use this secure link to reset your password.\",\n \"requestDetails\": {\n \"requestedAt\": \"Requested At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"securityNote\": \"For security, this link is private and will expire soon.\",\n \"subject\": \"Reset your password\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send payment-failed", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"payment-failed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Update payment\"\n },\n \"actionNote\": \"Update your payment details to continue.\",\n \"footerNote\": \"If you have already updated your payment details, no further action is needed.\",\n \"heading\": \"Payment failed\",\n \"intro\": \"We could not complete your latest payment.\",\n \"paymentDetails\": {\n \"amount\": \"Amount\",\n \"dueDate\": \"Due Date\",\n \"paymentMethod\": \"Payment Method\",\n \"reason\": \"Reason\"\n },\n \"preheader\": \"Update your payment details to continue.\",\n \"subject\": \"Payment failed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"payment-failed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Update payment\"\n },\n \"actionNote\": \"Update your payment details to continue.\",\n \"footerNote\": \"If you have already updated your payment details, no further action is needed.\",\n \"heading\": \"Payment failed\",\n \"intro\": \"We could not complete your latest payment.\",\n \"paymentDetails\": {\n \"amount\": \"Amount\",\n \"dueDate\": \"Due Date\",\n \"paymentMethod\": \"Payment Method\",\n \"reason\": \"Reason\"\n },\n \"preheader\": \"Update your payment details to continue.\",\n \"subject\": \"Payment failed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"payment-failed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Update payment\"\n },\n \"actionNote\": \"Update your payment details to continue.\",\n \"footerNote\": \"If you have already updated your payment details, no further action is needed.\",\n \"heading\": \"Payment failed\",\n \"intro\": \"We could not complete your latest payment.\",\n \"paymentDetails\": {\n \"amount\": \"Amount\",\n \"dueDate\": \"Due Date\",\n \"paymentMethod\": \"Payment Method\",\n \"reason\": \"Reason\"\n },\n \"preheader\": \"Update your payment details to continue.\",\n \"subject\": \"Payment failed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"payment-failed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Update payment\"\n },\n \"actionNote\": \"Update your payment details to continue.\",\n \"footerNote\": \"If you have already updated your payment details, no further action is needed.\",\n \"heading\": \"Payment failed\",\n \"intro\": \"We could not complete your latest payment.\",\n \"paymentDetails\": {\n \"amount\": \"Amount\",\n \"dueDate\": \"Due Date\",\n \"paymentMethod\": \"Payment Method\",\n \"reason\": \"Reason\"\n },\n \"preheader\": \"Update your payment details to continue.\",\n \"subject\": \"Payment failed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"payment-failed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Update payment\"\n },\n \"actionNote\": \"Update your payment details to continue.\",\n \"footerNote\": \"If you have already updated your payment details, no further action is needed.\",\n \"heading\": \"Payment failed\",\n \"intro\": \"We could not complete your latest payment.\",\n \"paymentDetails\": {\n \"amount\": \"Amount\",\n \"dueDate\": \"Due Date\",\n \"paymentMethod\": \"Payment Method\",\n \"reason\": \"Reason\"\n },\n \"preheader\": \"Update your payment details to continue.\",\n \"subject\": \"Payment failed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"payment-failed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Update payment\"\n },\n \"actionNote\": \"Update your payment details to continue.\",\n \"footerNote\": \"If you have already updated your payment details, no further action is needed.\",\n \"heading\": \"Payment failed\",\n \"intro\": \"We could not complete your latest payment.\",\n \"paymentDetails\": {\n \"amount\": \"Amount\",\n \"dueDate\": \"Due Date\",\n \"paymentMethod\": \"Payment Method\",\n \"reason\": \"Reason\"\n },\n \"preheader\": \"Update your payment details to continue.\",\n \"subject\": \"Payment failed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"payment-failed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Update payment\"\n },\n \"actionNote\": \"Update your payment details to continue.\",\n \"footerNote\": \"If you have already updated your payment details, no further action is needed.\",\n \"heading\": \"Payment failed\",\n \"intro\": \"We could not complete your latest payment.\",\n \"paymentDetails\": {\n \"amount\": \"Amount\",\n \"dueDate\": \"Due Date\",\n \"paymentMethod\": \"Payment Method\",\n \"reason\": \"Reason\"\n },\n \"preheader\": \"Update your payment details to continue.\",\n \"subject\": \"Payment failed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send payment-succeeded", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"payment-succeeded\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View receipt\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Payment received\",\n \"intro\": \"Your payment was successful.\",\n \"paymentDetails\": {\n \"amount\": \"Amount\",\n \"paidAt\": \"Paid At\",\n \"paymentMethod\": \"Payment Method\",\n \"reference\": \"Reference\"\n },\n \"preheader\": \"Your payment was successful.\",\n \"subject\": \"Payment received\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"payment-succeeded\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View receipt\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Payment received\",\n \"intro\": \"Your payment was successful.\",\n \"paymentDetails\": {\n \"amount\": \"Amount\",\n \"paidAt\": \"Paid At\",\n \"paymentMethod\": \"Payment Method\",\n \"reference\": \"Reference\"\n },\n \"preheader\": \"Your payment was successful.\",\n \"subject\": \"Payment received\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"payment-succeeded\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View receipt\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Payment received\",\n \"intro\": \"Your payment was successful.\",\n \"paymentDetails\": {\n \"amount\": \"Amount\",\n \"paidAt\": \"Paid At\",\n \"paymentMethod\": \"Payment Method\",\n \"reference\": \"Reference\"\n },\n \"preheader\": \"Your payment was successful.\",\n \"subject\": \"Payment received\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"payment-succeeded\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View receipt\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Payment received\",\n \"intro\": \"Your payment was successful.\",\n \"paymentDetails\": {\n \"amount\": \"Amount\",\n \"paidAt\": \"Paid At\",\n \"paymentMethod\": \"Payment Method\",\n \"reference\": \"Reference\"\n },\n \"preheader\": \"Your payment was successful.\",\n \"subject\": \"Payment received\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"payment-succeeded\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View receipt\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Payment received\",\n \"intro\": \"Your payment was successful.\",\n \"paymentDetails\": {\n \"amount\": \"Amount\",\n \"paidAt\": \"Paid At\",\n \"paymentMethod\": \"Payment Method\",\n \"reference\": \"Reference\"\n },\n \"preheader\": \"Your payment was successful.\",\n \"subject\": \"Payment received\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"payment-succeeded\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View receipt\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Payment received\",\n \"intro\": \"Your payment was successful.\",\n \"paymentDetails\": {\n \"amount\": \"Amount\",\n \"paidAt\": \"Paid At\",\n \"paymentMethod\": \"Payment Method\",\n \"reference\": \"Reference\"\n },\n \"preheader\": \"Your payment was successful.\",\n \"subject\": \"Payment received\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"payment-succeeded\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View receipt\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Payment received\",\n \"intro\": \"Your payment was successful.\",\n \"paymentDetails\": {\n \"amount\": \"Amount\",\n \"paidAt\": \"Paid At\",\n \"paymentMethod\": \"Payment Method\",\n \"reference\": \"Reference\"\n },\n \"preheader\": \"Your payment was successful.\",\n \"subject\": \"Payment received\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send processing-failed", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"processing-failed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Processing failed\",\n \"message\": \"Something could not be processed.\",\n \"preheader\": \"Something could not be processed.\",\n \"processingDetails\": {\n \"failedAt\": \"Failed At\",\n \"item\": \"Item\",\n \"reason\": \"Reason\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Processing failed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"processing-failed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Processing failed\",\n \"message\": \"Something could not be processed.\",\n \"preheader\": \"Something could not be processed.\",\n \"processingDetails\": {\n \"failedAt\": \"Failed At\",\n \"item\": \"Item\",\n \"reason\": \"Reason\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Processing failed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"processing-failed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Processing failed\",\n \"message\": \"Something could not be processed.\",\n \"preheader\": \"Something could not be processed.\",\n \"processingDetails\": {\n \"failedAt\": \"Failed At\",\n \"item\": \"Item\",\n \"reason\": \"Reason\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Processing failed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"processing-failed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Processing failed\",\n \"message\": \"Something could not be processed.\",\n \"preheader\": \"Something could not be processed.\",\n \"processingDetails\": {\n \"failedAt\": \"Failed At\",\n \"item\": \"Item\",\n \"reason\": \"Reason\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Processing failed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"processing-failed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Processing failed\",\n \"message\": \"Something could not be processed.\",\n \"preheader\": \"Something could not be processed.\",\n \"processingDetails\": {\n \"failedAt\": \"Failed At\",\n \"item\": \"Item\",\n \"reason\": \"Reason\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Processing failed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"processing-failed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Processing failed\",\n \"message\": \"Something could not be processed.\",\n \"preheader\": \"Something could not be processed.\",\n \"processingDetails\": {\n \"failedAt\": \"Failed At\",\n \"item\": \"Item\",\n \"reason\": \"Reason\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Processing failed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"processing-failed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Processing failed\",\n \"message\": \"Something could not be processed.\",\n \"preheader\": \"Something could not be processed.\",\n \"processingDetails\": {\n \"failedAt\": \"Failed At\",\n \"item\": \"Item\",\n \"reason\": \"Reason\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Processing failed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send queued-request-ready", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"queued-request-ready\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"View result\"\n },\n \"heading\": \"Your request is ready\",\n \"intro\": \"Your queued request has completed.\",\n \"preheader\": \"Your queued request has completed.\",\n \"requestDetails\": {\n \"requestedAt\": \"Requested At\",\n \"completedAt\": \"Completed At\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Your request is ready\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"queued-request-ready\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"View result\"\n },\n \"heading\": \"Your request is ready\",\n \"intro\": \"Your queued request has completed.\",\n \"preheader\": \"Your queued request has completed.\",\n \"requestDetails\": {\n \"requestedAt\": \"Requested At\",\n \"completedAt\": \"Completed At\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Your request is ready\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"queued-request-ready\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"View result\"\n },\n \"heading\": \"Your request is ready\",\n \"intro\": \"Your queued request has completed.\",\n \"preheader\": \"Your queued request has completed.\",\n \"requestDetails\": {\n \"requestedAt\": \"Requested At\",\n \"completedAt\": \"Completed At\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Your request is ready\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"queued-request-ready\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"View result\"\n },\n \"heading\": \"Your request is ready\",\n \"intro\": \"Your queued request has completed.\",\n \"preheader\": \"Your queued request has completed.\",\n \"requestDetails\": {\n \"requestedAt\": \"Requested At\",\n \"completedAt\": \"Completed At\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Your request is ready\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"queued-request-ready\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"View result\"\n },\n \"heading\": \"Your request is ready\",\n \"intro\": \"Your queued request has completed.\",\n \"preheader\": \"Your queued request has completed.\",\n \"requestDetails\": {\n \"requestedAt\": \"Requested At\",\n \"completedAt\": \"Completed At\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Your request is ready\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"queued-request-ready\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"View result\"\n },\n \"heading\": \"Your request is ready\",\n \"intro\": \"Your queued request has completed.\",\n \"preheader\": \"Your queued request has completed.\",\n \"requestDetails\": {\n \"requestedAt\": \"Requested At\",\n \"completedAt\": \"Completed At\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Your request is ready\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"queued-request-ready\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"View result\"\n },\n \"heading\": \"Your request is ready\",\n \"intro\": \"Your queued request has completed.\",\n \"preheader\": \"Your queued request has completed.\",\n \"requestDetails\": {\n \"requestedAt\": \"Requested At\",\n \"completedAt\": \"Completed At\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Your request is ready\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send refund-issued", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"refund-issued\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"footerNote\": \"Refund timing may depend on the payment method used.\",\n \"heading\": \"Refund issued\",\n \"intro\": \"A refund has been issued.\",\n \"preheader\": \"A refund has been issued.\",\n \"refundDetails\": {\n \"amount\": \"Amount\",\n \"issuedAt\": \"Issued At\",\n \"paymentMethod\": \"Payment Method\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Refund issued\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"refund-issued\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"footerNote\": \"Refund timing may depend on the payment method used.\",\n \"heading\": \"Refund issued\",\n \"intro\": \"A refund has been issued.\",\n \"preheader\": \"A refund has been issued.\",\n \"refundDetails\": {\n \"amount\": \"Amount\",\n \"issuedAt\": \"Issued At\",\n \"paymentMethod\": \"Payment Method\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Refund issued\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"refund-issued\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"footerNote\": \"Refund timing may depend on the payment method used.\",\n \"heading\": \"Refund issued\",\n \"intro\": \"A refund has been issued.\",\n \"preheader\": \"A refund has been issued.\",\n \"refundDetails\": {\n \"amount\": \"Amount\",\n \"issuedAt\": \"Issued At\",\n \"paymentMethod\": \"Payment Method\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Refund issued\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"refund-issued\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"footerNote\": \"Refund timing may depend on the payment method used.\",\n \"heading\": \"Refund issued\",\n \"intro\": \"A refund has been issued.\",\n \"preheader\": \"A refund has been issued.\",\n \"refundDetails\": {\n \"amount\": \"Amount\",\n \"issuedAt\": \"Issued At\",\n \"paymentMethod\": \"Payment Method\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Refund issued\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"refund-issued\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"footerNote\": \"Refund timing may depend on the payment method used.\",\n \"heading\": \"Refund issued\",\n \"intro\": \"A refund has been issued.\",\n \"preheader\": \"A refund has been issued.\",\n \"refundDetails\": {\n \"amount\": \"Amount\",\n \"issuedAt\": \"Issued At\",\n \"paymentMethod\": \"Payment Method\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Refund issued\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"refund-issued\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"footerNote\": \"Refund timing may depend on the payment method used.\",\n \"heading\": \"Refund issued\",\n \"intro\": \"A refund has been issued.\",\n \"preheader\": \"A refund has been issued.\",\n \"refundDetails\": {\n \"amount\": \"Amount\",\n \"issuedAt\": \"Issued At\",\n \"paymentMethod\": \"Payment Method\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Refund issued\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"refund-issued\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"footerNote\": \"Refund timing may depend on the payment method used.\",\n \"heading\": \"Refund issued\",\n \"intro\": \"A refund has been issued.\",\n \"preheader\": \"A refund has been issued.\",\n \"refundDetails\": {\n \"amount\": \"Amount\",\n \"issuedAt\": \"Issued At\",\n \"paymentMethod\": \"Payment Method\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Refund issued\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send reminder", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"reminder\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Reminder\",\n \"preheader\": \"Message\",\n \"reminderDetails\": {\n \"dueAt\": \"Due At\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Reminder\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"reminder\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Reminder\",\n \"preheader\": \"Message\",\n \"reminderDetails\": {\n \"dueAt\": \"Due At\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Reminder\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"reminder\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Reminder\",\n \"preheader\": \"Message\",\n \"reminderDetails\": {\n \"dueAt\": \"Due At\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Reminder\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"reminder\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Reminder\",\n \"preheader\": \"Message\",\n \"reminderDetails\": {\n \"dueAt\": \"Due At\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Reminder\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"reminder\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Reminder\",\n \"preheader\": \"Message\",\n \"reminderDetails\": {\n \"dueAt\": \"Due At\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Reminder\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"reminder\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Reminder\",\n \"preheader\": \"Message\",\n \"reminderDetails\": {\n \"dueAt\": \"Due At\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Reminder\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"reminder\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"There is an update in your account.\",\n \"actionButton\": {\n \"label\": \"View\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Reminder\",\n \"preheader\": \"Message\",\n \"reminderDetails\": {\n \"dueAt\": \"Due At\",\n \"reference\": \"Reference\"\n },\n \"subject\": \"Reminder\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send report-ready", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"report-ready\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"View report\"\n },\n \"heading\": \"Your report is ready\",\n \"intro\": \"The report you requested is ready.\",\n \"preheader\": \"View your completed report.\",\n \"reportDetails\": {\n \"name\": \"Name\",\n \"createdAt\": \"Created At\",\n \"period\": \"Period\"\n },\n \"subject\": \"Your report is ready\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"report-ready\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"View report\"\n },\n \"heading\": \"Your report is ready\",\n \"intro\": \"The report you requested is ready.\",\n \"preheader\": \"View your completed report.\",\n \"reportDetails\": {\n \"name\": \"Name\",\n \"createdAt\": \"Created At\",\n \"period\": \"Period\"\n },\n \"subject\": \"Your report is ready\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"report-ready\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"View report\"\n },\n \"heading\": \"Your report is ready\",\n \"intro\": \"The report you requested is ready.\",\n \"preheader\": \"View your completed report.\",\n \"reportDetails\": {\n \"name\": \"Name\",\n \"createdAt\": \"Created At\",\n \"period\": \"Period\"\n },\n \"subject\": \"Your report is ready\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"report-ready\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"View report\"\n },\n \"heading\": \"Your report is ready\",\n \"intro\": \"The report you requested is ready.\",\n \"preheader\": \"View your completed report.\",\n \"reportDetails\": {\n \"name\": \"Name\",\n \"createdAt\": \"Created At\",\n \"period\": \"Period\"\n },\n \"subject\": \"Your report is ready\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"report-ready\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"View report\"\n },\n \"heading\": \"Your report is ready\",\n \"intro\": \"The report you requested is ready.\",\n \"preheader\": \"View your completed report.\",\n \"reportDetails\": {\n \"name\": \"Name\",\n \"createdAt\": \"Created At\",\n \"period\": \"Period\"\n },\n \"subject\": \"Your report is ready\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"report-ready\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"View report\"\n },\n \"heading\": \"Your report is ready\",\n \"intro\": \"The report you requested is ready.\",\n \"preheader\": \"View your completed report.\",\n \"reportDetails\": {\n \"name\": \"Name\",\n \"createdAt\": \"Created At\",\n \"period\": \"Period\"\n },\n \"subject\": \"Your report is ready\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"report-ready\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"View report\"\n },\n \"heading\": \"Your report is ready\",\n \"intro\": \"The report you requested is ready.\",\n \"preheader\": \"View your completed report.\",\n \"reportDetails\": {\n \"name\": \"Name\",\n \"createdAt\": \"Created At\",\n \"period\": \"Period\"\n },\n \"subject\": \"Your report is ready\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send role-changed", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"role-changed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Role changed\",\n \"intro\": \"A team member's role has changed.\",\n \"preheader\": \"A team member's role has changed.\",\n \"roleDetails\": {\n \"member\": \"Member\",\n \"previousRole\": \"Previous Role\",\n \"newRole\": \"New Role\",\n \"changedAt\": \"Changed At\"\n },\n \"subject\": \"Role changed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"role-changed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Role changed\",\n \"intro\": \"A team member's role has changed.\",\n \"preheader\": \"A team member's role has changed.\",\n \"roleDetails\": {\n \"member\": \"Member\",\n \"previousRole\": \"Previous Role\",\n \"newRole\": \"New Role\",\n \"changedAt\": \"Changed At\"\n },\n \"subject\": \"Role changed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"role-changed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Role changed\",\n \"intro\": \"A team member's role has changed.\",\n \"preheader\": \"A team member's role has changed.\",\n \"roleDetails\": {\n \"member\": \"Member\",\n \"previousRole\": \"Previous Role\",\n \"newRole\": \"New Role\",\n \"changedAt\": \"Changed At\"\n },\n \"subject\": \"Role changed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"role-changed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Role changed\",\n \"intro\": \"A team member's role has changed.\",\n \"preheader\": \"A team member's role has changed.\",\n \"roleDetails\": {\n \"member\": \"Member\",\n \"previousRole\": \"Previous Role\",\n \"newRole\": \"New Role\",\n \"changedAt\": \"Changed At\"\n },\n \"subject\": \"Role changed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"role-changed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Role changed\",\n \"intro\": \"A team member's role has changed.\",\n \"preheader\": \"A team member's role has changed.\",\n \"roleDetails\": {\n \"member\": \"Member\",\n \"previousRole\": \"Previous Role\",\n \"newRole\": \"New Role\",\n \"changedAt\": \"Changed At\"\n },\n \"subject\": \"Role changed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"role-changed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Role changed\",\n \"intro\": \"A team member's role has changed.\",\n \"preheader\": \"A team member's role has changed.\",\n \"roleDetails\": {\n \"member\": \"Member\",\n \"previousRole\": \"Previous Role\",\n \"newRole\": \"New Role\",\n \"changedAt\": \"Changed At\"\n },\n \"subject\": \"Role changed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"role-changed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Role changed\",\n \"intro\": \"A team member's role has changed.\",\n \"preheader\": \"A team member's role has changed.\",\n \"roleDetails\": {\n \"member\": \"Member\",\n \"previousRole\": \"Previous Role\",\n \"newRole\": \"New Role\",\n \"changedAt\": \"Changed At\"\n },\n \"subject\": \"Role changed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send subscription-cancelled", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-cancelled\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage subscription\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription cancelled\",\n \"intro\": \"Your subscription has been cancelled.\",\n \"preheader\": \"Your subscription has been cancelled.\",\n \"subject\": \"Subscription cancelled\",\n \"subscriptionDetails\": {\n \"cancelledAt\": \"Cancelled At\",\n \"accessEndsAt\": \"Access Ends At\",\n \"plan\": \"Plan\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-cancelled\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage subscription\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription cancelled\",\n \"intro\": \"Your subscription has been cancelled.\",\n \"preheader\": \"Your subscription has been cancelled.\",\n \"subject\": \"Subscription cancelled\",\n \"subscriptionDetails\": {\n \"cancelledAt\": \"Cancelled At\",\n \"accessEndsAt\": \"Access Ends At\",\n \"plan\": \"Plan\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-cancelled\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage subscription\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription cancelled\",\n \"intro\": \"Your subscription has been cancelled.\",\n \"preheader\": \"Your subscription has been cancelled.\",\n \"subject\": \"Subscription cancelled\",\n \"subscriptionDetails\": {\n \"cancelledAt\": \"Cancelled At\",\n \"accessEndsAt\": \"Access Ends At\",\n \"plan\": \"Plan\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-cancelled\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage subscription\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription cancelled\",\n \"intro\": \"Your subscription has been cancelled.\",\n \"preheader\": \"Your subscription has been cancelled.\",\n \"subject\": \"Subscription cancelled\",\n \"subscriptionDetails\": {\n \"cancelledAt\": \"Cancelled At\",\n \"accessEndsAt\": \"Access Ends At\",\n \"plan\": \"Plan\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-cancelled\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage subscription\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription cancelled\",\n \"intro\": \"Your subscription has been cancelled.\",\n \"preheader\": \"Your subscription has been cancelled.\",\n \"subject\": \"Subscription cancelled\",\n \"subscriptionDetails\": {\n \"cancelledAt\": \"Cancelled At\",\n \"accessEndsAt\": \"Access Ends At\",\n \"plan\": \"Plan\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-cancelled\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage subscription\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription cancelled\",\n \"intro\": \"Your subscription has been cancelled.\",\n \"preheader\": \"Your subscription has been cancelled.\",\n \"subject\": \"Subscription cancelled\",\n \"subscriptionDetails\": {\n \"cancelledAt\": \"Cancelled At\",\n \"accessEndsAt\": \"Access Ends At\",\n \"plan\": \"Plan\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-cancelled\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage subscription\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription cancelled\",\n \"intro\": \"Your subscription has been cancelled.\",\n \"preheader\": \"Your subscription has been cancelled.\",\n \"subject\": \"Subscription cancelled\",\n \"subscriptionDetails\": {\n \"cancelledAt\": \"Cancelled At\",\n \"accessEndsAt\": \"Access Ends At\",\n \"plan\": \"Plan\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send subscription-paused", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-paused\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage subscription\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription paused\",\n \"intro\": \"Your subscription has been paused.\",\n \"preheader\": \"Your subscription has been paused.\",\n \"subject\": \"Subscription paused\",\n \"subscriptionDetails\": {\n \"pausedAt\": \"Paused At\",\n \"resumesAt\": \"Resumes At\",\n \"plan\": \"Plan\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-paused\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage subscription\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription paused\",\n \"intro\": \"Your subscription has been paused.\",\n \"preheader\": \"Your subscription has been paused.\",\n \"subject\": \"Subscription paused\",\n \"subscriptionDetails\": {\n \"pausedAt\": \"Paused At\",\n \"resumesAt\": \"Resumes At\",\n \"plan\": \"Plan\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-paused\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage subscription\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription paused\",\n \"intro\": \"Your subscription has been paused.\",\n \"preheader\": \"Your subscription has been paused.\",\n \"subject\": \"Subscription paused\",\n \"subscriptionDetails\": {\n \"pausedAt\": \"Paused At\",\n \"resumesAt\": \"Resumes At\",\n \"plan\": \"Plan\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-paused\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage subscription\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription paused\",\n \"intro\": \"Your subscription has been paused.\",\n \"preheader\": \"Your subscription has been paused.\",\n \"subject\": \"Subscription paused\",\n \"subscriptionDetails\": {\n \"pausedAt\": \"Paused At\",\n \"resumesAt\": \"Resumes At\",\n \"plan\": \"Plan\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-paused\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage subscription\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription paused\",\n \"intro\": \"Your subscription has been paused.\",\n \"preheader\": \"Your subscription has been paused.\",\n \"subject\": \"Subscription paused\",\n \"subscriptionDetails\": {\n \"pausedAt\": \"Paused At\",\n \"resumesAt\": \"Resumes At\",\n \"plan\": \"Plan\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-paused\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage subscription\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription paused\",\n \"intro\": \"Your subscription has been paused.\",\n \"preheader\": \"Your subscription has been paused.\",\n \"subject\": \"Subscription paused\",\n \"subscriptionDetails\": {\n \"pausedAt\": \"Paused At\",\n \"resumesAt\": \"Resumes At\",\n \"plan\": \"Plan\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-paused\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage subscription\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription paused\",\n \"intro\": \"Your subscription has been paused.\",\n \"preheader\": \"Your subscription has been paused.\",\n \"subject\": \"Subscription paused\",\n \"subscriptionDetails\": {\n \"pausedAt\": \"Paused At\",\n \"resumesAt\": \"Resumes At\",\n \"plan\": \"Plan\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send subscription-renewed", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-renewed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View details\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription renewed\",\n \"intro\": \"Your subscription has renewed.\",\n \"preheader\": \"Your subscription has renewed.\",\n \"subject\": \"Subscription renewed\",\n \"subscriptionDetails\": {\n \"plan\": \"Plan\",\n \"renewedAt\": \"Renewed At\",\n \"nextRenewalAt\": \"Next Renewal At\",\n \"amount\": \"Amount\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-renewed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View details\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription renewed\",\n \"intro\": \"Your subscription has renewed.\",\n \"preheader\": \"Your subscription has renewed.\",\n \"subject\": \"Subscription renewed\",\n \"subscriptionDetails\": {\n \"plan\": \"Plan\",\n \"renewedAt\": \"Renewed At\",\n \"nextRenewalAt\": \"Next Renewal At\",\n \"amount\": \"Amount\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-renewed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View details\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription renewed\",\n \"intro\": \"Your subscription has renewed.\",\n \"preheader\": \"Your subscription has renewed.\",\n \"subject\": \"Subscription renewed\",\n \"subscriptionDetails\": {\n \"plan\": \"Plan\",\n \"renewedAt\": \"Renewed At\",\n \"nextRenewalAt\": \"Next Renewal At\",\n \"amount\": \"Amount\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-renewed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View details\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription renewed\",\n \"intro\": \"Your subscription has renewed.\",\n \"preheader\": \"Your subscription has renewed.\",\n \"subject\": \"Subscription renewed\",\n \"subscriptionDetails\": {\n \"plan\": \"Plan\",\n \"renewedAt\": \"Renewed At\",\n \"nextRenewalAt\": \"Next Renewal At\",\n \"amount\": \"Amount\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-renewed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View details\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription renewed\",\n \"intro\": \"Your subscription has renewed.\",\n \"preheader\": \"Your subscription has renewed.\",\n \"subject\": \"Subscription renewed\",\n \"subscriptionDetails\": {\n \"plan\": \"Plan\",\n \"renewedAt\": \"Renewed At\",\n \"nextRenewalAt\": \"Next Renewal At\",\n \"amount\": \"Amount\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-renewed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View details\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription renewed\",\n \"intro\": \"Your subscription has renewed.\",\n \"preheader\": \"Your subscription has renewed.\",\n \"subject\": \"Subscription renewed\",\n \"subscriptionDetails\": {\n \"plan\": \"Plan\",\n \"renewedAt\": \"Renewed At\",\n \"nextRenewalAt\": \"Next Renewal At\",\n \"amount\": \"Amount\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-renewed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View details\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription renewed\",\n \"intro\": \"Your subscription has renewed.\",\n \"preheader\": \"Your subscription has renewed.\",\n \"subject\": \"Subscription renewed\",\n \"subscriptionDetails\": {\n \"plan\": \"Plan\",\n \"renewedAt\": \"Renewed At\",\n \"nextRenewalAt\": \"Next Renewal At\",\n \"amount\": \"Amount\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send subscription-started", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-started\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage subscription\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription started\",\n \"intro\": \"Your subscription is active.\",\n \"preheader\": \"Your subscription is active.\",\n \"subject\": \"Subscription started\",\n \"subscriptionDetails\": {\n \"plan\": \"Plan\",\n \"startedAt\": \"Started At\",\n \"renewsAt\": \"Renews At\",\n \"amount\": \"Amount\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-started\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage subscription\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription started\",\n \"intro\": \"Your subscription is active.\",\n \"preheader\": \"Your subscription is active.\",\n \"subject\": \"Subscription started\",\n \"subscriptionDetails\": {\n \"plan\": \"Plan\",\n \"startedAt\": \"Started At\",\n \"renewsAt\": \"Renews At\",\n \"amount\": \"Amount\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-started\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage subscription\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription started\",\n \"intro\": \"Your subscription is active.\",\n \"preheader\": \"Your subscription is active.\",\n \"subject\": \"Subscription started\",\n \"subscriptionDetails\": {\n \"plan\": \"Plan\",\n \"startedAt\": \"Started At\",\n \"renewsAt\": \"Renews At\",\n \"amount\": \"Amount\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-started\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage subscription\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription started\",\n \"intro\": \"Your subscription is active.\",\n \"preheader\": \"Your subscription is active.\",\n \"subject\": \"Subscription started\",\n \"subscriptionDetails\": {\n \"plan\": \"Plan\",\n \"startedAt\": \"Started At\",\n \"renewsAt\": \"Renews At\",\n \"amount\": \"Amount\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-started\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage subscription\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription started\",\n \"intro\": \"Your subscription is active.\",\n \"preheader\": \"Your subscription is active.\",\n \"subject\": \"Subscription started\",\n \"subscriptionDetails\": {\n \"plan\": \"Plan\",\n \"startedAt\": \"Started At\",\n \"renewsAt\": \"Renews At\",\n \"amount\": \"Amount\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-started\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage subscription\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription started\",\n \"intro\": \"Your subscription is active.\",\n \"preheader\": \"Your subscription is active.\",\n \"subject\": \"Subscription started\",\n \"subscriptionDetails\": {\n \"plan\": \"Plan\",\n \"startedAt\": \"Started At\",\n \"renewsAt\": \"Renews At\",\n \"amount\": \"Amount\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"subscription-started\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Manage subscription\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Subscription started\",\n \"intro\": \"Your subscription is active.\",\n \"preheader\": \"Your subscription is active.\",\n \"subject\": \"Subscription started\",\n \"subscriptionDetails\": {\n \"plan\": \"Plan\",\n \"startedAt\": \"Started At\",\n \"renewsAt\": \"Renews At\",\n \"amount\": \"Amount\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send suspicious-login", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"suspicious-login\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Suspicious sign-in attempt\",\n \"intro\": \"A sign-in attempt looked unusual and may need your attention.\",\n \"loginDetails\": {\n \"attemptedAt\": \"Attempted At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"notice\": \"If this was not you, review your account security.\",\n \"preheader\": \"Review this sign-in attempt.\",\n \"subject\": \"Suspicious sign-in attempt\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"suspicious-login\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Suspicious sign-in attempt\",\n \"intro\": \"A sign-in attempt looked unusual and may need your attention.\",\n \"loginDetails\": {\n \"attemptedAt\": \"Attempted At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"notice\": \"If this was not you, review your account security.\",\n \"preheader\": \"Review this sign-in attempt.\",\n \"subject\": \"Suspicious sign-in attempt\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"suspicious-login\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Suspicious sign-in attempt\",\n \"intro\": \"A sign-in attempt looked unusual and may need your attention.\",\n \"loginDetails\": {\n \"attemptedAt\": \"Attempted At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"notice\": \"If this was not you, review your account security.\",\n \"preheader\": \"Review this sign-in attempt.\",\n \"subject\": \"Suspicious sign-in attempt\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"suspicious-login\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Suspicious sign-in attempt\",\n \"intro\": \"A sign-in attempt looked unusual and may need your attention.\",\n \"loginDetails\": {\n \"attemptedAt\": \"Attempted At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"notice\": \"If this was not you, review your account security.\",\n \"preheader\": \"Review this sign-in attempt.\",\n \"subject\": \"Suspicious sign-in attempt\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"suspicious-login\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Suspicious sign-in attempt\",\n \"intro\": \"A sign-in attempt looked unusual and may need your attention.\",\n \"loginDetails\": {\n \"attemptedAt\": \"Attempted At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"notice\": \"If this was not you, review your account security.\",\n \"preheader\": \"Review this sign-in attempt.\",\n \"subject\": \"Suspicious sign-in attempt\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"suspicious-login\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Suspicious sign-in attempt\",\n \"intro\": \"A sign-in attempt looked unusual and may need your attention.\",\n \"loginDetails\": {\n \"attemptedAt\": \"Attempted At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"notice\": \"If this was not you, review your account security.\",\n \"preheader\": \"Review this sign-in attempt.\",\n \"subject\": \"Suspicious sign-in attempt\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"suspicious-login\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Review account\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Suspicious sign-in attempt\",\n \"intro\": \"A sign-in attempt looked unusual and may need your attention.\",\n \"loginDetails\": {\n \"attemptedAt\": \"Attempted At\",\n \"device\": \"Device\",\n \"country\": \"Country\",\n \"ip\": \"Ip\"\n },\n \"notice\": \"If this was not you, review your account security.\",\n \"preheader\": \"Review this sign-in attempt.\",\n \"subject\": \"Suspicious sign-in attempt\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send team-member-added", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"team-member-added\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Team member added\",\n \"intro\": \"A new member has been added.\",\n \"memberDetails\": {\n \"name\": \"Name\",\n \"email\": \"Email\",\n \"role\": \"Role\",\n \"addedAt\": \"Added At\"\n },\n \"preheader\": \"A new member has been added.\",\n \"subject\": \"Team member added\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"team-member-added\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Team member added\",\n \"intro\": \"A new member has been added.\",\n \"memberDetails\": {\n \"name\": \"Name\",\n \"email\": \"Email\",\n \"role\": \"Role\",\n \"addedAt\": \"Added At\"\n },\n \"preheader\": \"A new member has been added.\",\n \"subject\": \"Team member added\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"team-member-added\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Team member added\",\n \"intro\": \"A new member has been added.\",\n \"memberDetails\": {\n \"name\": \"Name\",\n \"email\": \"Email\",\n \"role\": \"Role\",\n \"addedAt\": \"Added At\"\n },\n \"preheader\": \"A new member has been added.\",\n \"subject\": \"Team member added\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"team-member-added\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Team member added\",\n \"intro\": \"A new member has been added.\",\n \"memberDetails\": {\n \"name\": \"Name\",\n \"email\": \"Email\",\n \"role\": \"Role\",\n \"addedAt\": \"Added At\"\n },\n \"preheader\": \"A new member has been added.\",\n \"subject\": \"Team member added\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"team-member-added\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Team member added\",\n \"intro\": \"A new member has been added.\",\n \"memberDetails\": {\n \"name\": \"Name\",\n \"email\": \"Email\",\n \"role\": \"Role\",\n \"addedAt\": \"Added At\"\n },\n \"preheader\": \"A new member has been added.\",\n \"subject\": \"Team member added\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"team-member-added\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Team member added\",\n \"intro\": \"A new member has been added.\",\n \"memberDetails\": {\n \"name\": \"Name\",\n \"email\": \"Email\",\n \"role\": \"Role\",\n \"addedAt\": \"Added At\"\n },\n \"preheader\": \"A new member has been added.\",\n \"subject\": \"Team member added\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"team-member-added\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Team member added\",\n \"intro\": \"A new member has been added.\",\n \"memberDetails\": {\n \"name\": \"Name\",\n \"email\": \"Email\",\n \"role\": \"Role\",\n \"addedAt\": \"Added At\"\n },\n \"preheader\": \"A new member has been added.\",\n \"subject\": \"Team member added\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send team-member-removed", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"team-member-removed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Team member removed\",\n \"intro\": \"A member has been removed.\",\n \"memberDetails\": {\n \"name\": \"Name\",\n \"email\": \"Email\",\n \"removedAt\": \"Removed At\"\n },\n \"preheader\": \"A member has been removed.\",\n \"subject\": \"Team member removed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"team-member-removed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Team member removed\",\n \"intro\": \"A member has been removed.\",\n \"memberDetails\": {\n \"name\": \"Name\",\n \"email\": \"Email\",\n \"removedAt\": \"Removed At\"\n },\n \"preheader\": \"A member has been removed.\",\n \"subject\": \"Team member removed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"team-member-removed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Team member removed\",\n \"intro\": \"A member has been removed.\",\n \"memberDetails\": {\n \"name\": \"Name\",\n \"email\": \"Email\",\n \"removedAt\": \"Removed At\"\n },\n \"preheader\": \"A member has been removed.\",\n \"subject\": \"Team member removed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"team-member-removed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Team member removed\",\n \"intro\": \"A member has been removed.\",\n \"memberDetails\": {\n \"name\": \"Name\",\n \"email\": \"Email\",\n \"removedAt\": \"Removed At\"\n },\n \"preheader\": \"A member has been removed.\",\n \"subject\": \"Team member removed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"team-member-removed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Team member removed\",\n \"intro\": \"A member has been removed.\",\n \"memberDetails\": {\n \"name\": \"Name\",\n \"email\": \"Email\",\n \"removedAt\": \"Removed At\"\n },\n \"preheader\": \"A member has been removed.\",\n \"subject\": \"Team member removed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"team-member-removed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Team member removed\",\n \"intro\": \"A member has been removed.\",\n \"memberDetails\": {\n \"name\": \"Name\",\n \"email\": \"Email\",\n \"removedAt\": \"Removed At\"\n },\n \"preheader\": \"A member has been removed.\",\n \"subject\": \"Team member removed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"team-member-removed\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View team\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Team member removed\",\n \"intro\": \"A member has been removed.\",\n \"memberDetails\": {\n \"name\": \"Name\",\n \"email\": \"Email\",\n \"removedAt\": \"Removed At\"\n },\n \"preheader\": \"A member has been removed.\",\n \"subject\": \"Team member removed\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send trial-ending", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"trial-ending\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Upgrade\"\n },\n \"trialEndDate\": \"June 15, 2026\",\n \"heading\": \"Your trial is ending soon\",\n \"intro\": \"Your trial ends on Trial End Date.\",\n \"preheader\": \"Upgrade to continue after your trial ends.\",\n \"subject\": \"Your trial is ending soon\",\n \"upgradeNote\": \"Upgrade before your trial ends to continue.\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"trial-ending\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Upgrade\"\n },\n \"trialEndDate\": \"June 15, 2026\",\n \"heading\": \"Your trial is ending soon\",\n \"intro\": \"Your trial ends on Trial End Date.\",\n \"preheader\": \"Upgrade to continue after your trial ends.\",\n \"subject\": \"Your trial is ending soon\",\n \"upgradeNote\": \"Upgrade before your trial ends to continue.\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"trial-ending\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Upgrade\"\n },\n \"trialEndDate\": \"June 15, 2026\",\n \"heading\": \"Your trial is ending soon\",\n \"intro\": \"Your trial ends on Trial End Date.\",\n \"preheader\": \"Upgrade to continue after your trial ends.\",\n \"subject\": \"Your trial is ending soon\",\n \"upgradeNote\": \"Upgrade before your trial ends to continue.\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"trial-ending\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Upgrade\"\n },\n \"trialEndDate\": \"June 15, 2026\",\n \"heading\": \"Your trial is ending soon\",\n \"intro\": \"Your trial ends on Trial End Date.\",\n \"preheader\": \"Upgrade to continue after your trial ends.\",\n \"subject\": \"Your trial is ending soon\",\n \"upgradeNote\": \"Upgrade before your trial ends to continue.\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"trial-ending\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Upgrade\"\n },\n \"trialEndDate\": \"June 15, 2026\",\n \"heading\": \"Your trial is ending soon\",\n \"intro\": \"Your trial ends on Trial End Date.\",\n \"preheader\": \"Upgrade to continue after your trial ends.\",\n \"subject\": \"Your trial is ending soon\",\n \"upgradeNote\": \"Upgrade before your trial ends to continue.\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"trial-ending\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Upgrade\"\n },\n \"trialEndDate\": \"June 15, 2026\",\n \"heading\": \"Your trial is ending soon\",\n \"intro\": \"Your trial ends on Trial End Date.\",\n \"preheader\": \"Upgrade to continue after your trial ends.\",\n \"subject\": \"Your trial is ending soon\",\n \"upgradeNote\": \"Upgrade before your trial ends to continue.\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"trial-ending\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Upgrade\"\n },\n \"trialEndDate\": \"June 15, 2026\",\n \"heading\": \"Your trial is ending soon\",\n \"intro\": \"Your trial ends on Trial End Date.\",\n \"preheader\": \"Upgrade to continue after your trial ends.\",\n \"subject\": \"Your trial is ending soon\",\n \"upgradeNote\": \"Upgrade before your trial ends to continue.\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send trial-started", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"trial-started\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Get started\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Your trial has started\",\n \"intro\": \"Your trial is ready to use.\",\n \"preheader\": \"Your trial is ready to use.\",\n \"subject\": \"Your trial has started\",\n \"trialDetails\": {\n \"startedAt\": \"Started At\",\n \"endsAt\": \"Ends At\",\n \"plan\": \"Plan\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"trial-started\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Get started\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Your trial has started\",\n \"intro\": \"Your trial is ready to use.\",\n \"preheader\": \"Your trial is ready to use.\",\n \"subject\": \"Your trial has started\",\n \"trialDetails\": {\n \"startedAt\": \"Started At\",\n \"endsAt\": \"Ends At\",\n \"plan\": \"Plan\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"trial-started\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Get started\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Your trial has started\",\n \"intro\": \"Your trial is ready to use.\",\n \"preheader\": \"Your trial is ready to use.\",\n \"subject\": \"Your trial has started\",\n \"trialDetails\": {\n \"startedAt\": \"Started At\",\n \"endsAt\": \"Ends At\",\n \"plan\": \"Plan\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"trial-started\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Get started\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Your trial has started\",\n \"intro\": \"Your trial is ready to use.\",\n \"preheader\": \"Your trial is ready to use.\",\n \"subject\": \"Your trial has started\",\n \"trialDetails\": {\n \"startedAt\": \"Started At\",\n \"endsAt\": \"Ends At\",\n \"plan\": \"Plan\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"trial-started\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Get started\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Your trial has started\",\n \"intro\": \"Your trial is ready to use.\",\n \"preheader\": \"Your trial is ready to use.\",\n \"subject\": \"Your trial has started\",\n \"trialDetails\": {\n \"startedAt\": \"Started At\",\n \"endsAt\": \"Ends At\",\n \"plan\": \"Plan\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"trial-started\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Get started\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Your trial has started\",\n \"intro\": \"Your trial is ready to use.\",\n \"preheader\": \"Your trial is ready to use.\",\n \"subject\": \"Your trial has started\",\n \"trialDetails\": {\n \"startedAt\": \"Started At\",\n \"endsAt\": \"Ends At\",\n \"plan\": \"Plan\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"trial-started\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"Get started\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Your trial has started\",\n \"intro\": \"Your trial is ready to use.\",\n \"preheader\": \"Your trial is ready to use.\",\n \"subject\": \"Your trial has started\",\n \"trialDetails\": {\n \"startedAt\": \"Started At\",\n \"endsAt\": \"Ends At\",\n \"plan\": \"Plan\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send upload-complete", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"upload-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View upload\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Upload complete\",\n \"message\": \"Your upload has completed.\",\n \"preheader\": \"Your upload has completed.\",\n \"subject\": \"Upload complete\",\n \"uploadDetails\": {\n \"fileName\": \"File Name\",\n \"uploadedAt\": \"Uploaded At\",\n \"size\": \"Size\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"upload-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View upload\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Upload complete\",\n \"message\": \"Your upload has completed.\",\n \"preheader\": \"Your upload has completed.\",\n \"subject\": \"Upload complete\",\n \"uploadDetails\": {\n \"fileName\": \"File Name\",\n \"uploadedAt\": \"Uploaded At\",\n \"size\": \"Size\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"upload-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View upload\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Upload complete\",\n \"message\": \"Your upload has completed.\",\n \"preheader\": \"Your upload has completed.\",\n \"subject\": \"Upload complete\",\n \"uploadDetails\": {\n \"fileName\": \"File Name\",\n \"uploadedAt\": \"Uploaded At\",\n \"size\": \"Size\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"upload-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View upload\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Upload complete\",\n \"message\": \"Your upload has completed.\",\n \"preheader\": \"Your upload has completed.\",\n \"subject\": \"Upload complete\",\n \"uploadDetails\": {\n \"fileName\": \"File Name\",\n \"uploadedAt\": \"Uploaded At\",\n \"size\": \"Size\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"upload-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View upload\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Upload complete\",\n \"message\": \"Your upload has completed.\",\n \"preheader\": \"Your upload has completed.\",\n \"subject\": \"Upload complete\",\n \"uploadDetails\": {\n \"fileName\": \"File Name\",\n \"uploadedAt\": \"Uploaded At\",\n \"size\": \"Size\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"upload-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View upload\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Upload complete\",\n \"message\": \"Your upload has completed.\",\n \"preheader\": \"Your upload has completed.\",\n \"subject\": \"Upload complete\",\n \"uploadDetails\": {\n \"fileName\": \"File Name\",\n \"uploadedAt\": \"Uploaded At\",\n \"size\": \"Size\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"upload-complete\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"label\": \"View upload\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Upload complete\",\n \"message\": \"Your upload has completed.\",\n \"preheader\": \"Your upload has completed.\",\n \"subject\": \"Upload complete\",\n \"uploadDetails\": {\n \"fileName\": \"File Name\",\n \"uploadedAt\": \"Uploaded At\",\n \"size\": \"Size\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send usage-threshold", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"usage-threshold\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"Your usage has reached a configured threshold.\",\n \"actionButton\": {\n \"label\": \"View usage\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Usage threshold reached\",\n \"preheader\": \"Your usage has reached a configured threshold.\",\n \"subject\": \"Usage threshold reached\",\n \"usageDetails\": {\n \"used\": \"Used\",\n \"limit\": \"Limit\",\n \"percentage\": \"Percentage\",\n \"periodEndsAt\": \"Period Ends At\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"usage-threshold\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"Your usage has reached a configured threshold.\",\n \"actionButton\": {\n \"label\": \"View usage\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Usage threshold reached\",\n \"preheader\": \"Your usage has reached a configured threshold.\",\n \"subject\": \"Usage threshold reached\",\n \"usageDetails\": {\n \"used\": \"Used\",\n \"limit\": \"Limit\",\n \"percentage\": \"Percentage\",\n \"periodEndsAt\": \"Period Ends At\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"usage-threshold\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"Your usage has reached a configured threshold.\",\n \"actionButton\": {\n \"label\": \"View usage\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Usage threshold reached\",\n \"preheader\": \"Your usage has reached a configured threshold.\",\n \"subject\": \"Usage threshold reached\",\n \"usageDetails\": {\n \"used\": \"Used\",\n \"limit\": \"Limit\",\n \"percentage\": \"Percentage\",\n \"periodEndsAt\": \"Period Ends At\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"usage-threshold\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"Your usage has reached a configured threshold.\",\n \"actionButton\": {\n \"label\": \"View usage\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Usage threshold reached\",\n \"preheader\": \"Your usage has reached a configured threshold.\",\n \"subject\": \"Usage threshold reached\",\n \"usageDetails\": {\n \"used\": \"Used\",\n \"limit\": \"Limit\",\n \"percentage\": \"Percentage\",\n \"periodEndsAt\": \"Period Ends At\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"usage-threshold\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"Your usage has reached a configured threshold.\",\n \"actionButton\": {\n \"label\": \"View usage\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Usage threshold reached\",\n \"preheader\": \"Your usage has reached a configured threshold.\",\n \"subject\": \"Usage threshold reached\",\n \"usageDetails\": {\n \"used\": \"Used\",\n \"limit\": \"Limit\",\n \"percentage\": \"Percentage\",\n \"periodEndsAt\": \"Period Ends At\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"usage-threshold\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"Your usage has reached a configured threshold.\",\n \"actionButton\": {\n \"label\": \"View usage\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Usage threshold reached\",\n \"preheader\": \"Your usage has reached a configured threshold.\",\n \"subject\": \"Usage threshold reached\",\n \"usageDetails\": {\n \"used\": \"Used\",\n \"limit\": \"Limit\",\n \"percentage\": \"Percentage\",\n \"periodEndsAt\": \"Period Ends At\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"usage-threshold\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"message\": \"Your usage has reached a configured threshold.\",\n \"actionButton\": {\n \"label\": \"View usage\",\n \"url\": \"https://example.com/app\"\n },\n \"heading\": \"Usage threshold reached\",\n \"preheader\": \"Your usage has reached a configured threshold.\",\n \"subject\": \"Usage threshold reached\",\n \"usageDetails\": {\n \"used\": \"Used\",\n \"limit\": \"Limit\",\n \"percentage\": \"Percentage\",\n \"periodEndsAt\": \"Period Ends At\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send verify-email", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"verify-email\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/verify\",\n \"label\": \"Verify email\"\n },\n \"footerNote\": \"If you did not create an account, you can safely ignore this email.\",\n \"heading\": \"Verify your email\",\n \"intro\": \"Please confirm your email address to finish setting up your account.\",\n \"preheader\": \"Confirm your email address to finish setting up your account.\",\n \"securityNote\": \"Verifying your email helps keep your account secure and ensures you can receive important notifications.\",\n \"subject\": \"Verify your email address\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"verify-email\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/verify\",\n \"label\": \"Verify email\"\n },\n \"footerNote\": \"If you did not create an account, you can safely ignore this email.\",\n \"heading\": \"Verify your email\",\n \"intro\": \"Please confirm your email address to finish setting up your account.\",\n \"preheader\": \"Confirm your email address to finish setting up your account.\",\n \"securityNote\": \"Verifying your email helps keep your account secure and ensures you can receive important notifications.\",\n \"subject\": \"Verify your email address\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"verify-email\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/verify\",\n \"label\": \"Verify email\"\n },\n \"footerNote\": \"If you did not create an account, you can safely ignore this email.\",\n \"heading\": \"Verify your email\",\n \"intro\": \"Please confirm your email address to finish setting up your account.\",\n \"preheader\": \"Confirm your email address to finish setting up your account.\",\n \"securityNote\": \"Verifying your email helps keep your account secure and ensures you can receive important notifications.\",\n \"subject\": \"Verify your email address\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"verify-email\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/verify\",\n \"label\": \"Verify email\"\n },\n \"footerNote\": \"If you did not create an account, you can safely ignore this email.\",\n \"heading\": \"Verify your email\",\n \"intro\": \"Please confirm your email address to finish setting up your account.\",\n \"preheader\": \"Confirm your email address to finish setting up your account.\",\n \"securityNote\": \"Verifying your email helps keep your account secure and ensures you can receive important notifications.\",\n \"subject\": \"Verify your email address\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"verify-email\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/verify\",\n \"label\": \"Verify email\"\n },\n \"footerNote\": \"If you did not create an account, you can safely ignore this email.\",\n \"heading\": \"Verify your email\",\n \"intro\": \"Please confirm your email address to finish setting up your account.\",\n \"preheader\": \"Confirm your email address to finish setting up your account.\",\n \"securityNote\": \"Verifying your email helps keep your account secure and ensures you can receive important notifications.\",\n \"subject\": \"Verify your email address\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"verify-email\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/verify\",\n \"label\": \"Verify email\"\n },\n \"footerNote\": \"If you did not create an account, you can safely ignore this email.\",\n \"heading\": \"Verify your email\",\n \"intro\": \"Please confirm your email address to finish setting up your account.\",\n \"preheader\": \"Confirm your email address to finish setting up your account.\",\n \"securityNote\": \"Verifying your email helps keep your account secure and ensures you can receive important notifications.\",\n \"subject\": \"Verify your email address\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"verify-email\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/verify\",\n \"label\": \"Verify email\"\n },\n \"footerNote\": \"If you did not create an account, you can safely ignore this email.\",\n \"heading\": \"Verify your email\",\n \"intro\": \"Please confirm your email address to finish setting up your account.\",\n \"preheader\": \"Confirm your email address to finish setting up your account.\",\n \"securityNote\": \"Verifying your email helps keep your account secure and ensures you can receive important notifications.\",\n \"subject\": \"Verify your email address\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Send welcome", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"welcome\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Open {{projectName}}\"\n },\n \"callToActionHeading\": \"\",\n \"callToActionParagraph\": \"\",\n \"heading\": \"Welcome to Project Name\",\n \"intro\": \"Your account has been created and you're ready to get started.\",\n \"preheader\": \"Your account is ready to go.\",\n \"subject\": \"Welcome to Project Name\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 Accepted queue response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"welcome\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Open {{projectName}}\"\n },\n \"callToActionHeading\": \"\",\n \"callToActionParagraph\": \"\",\n \"heading\": \"Welcome to Project Name\",\n \"intro\": \"Your account has been created and you're ready to get started.\",\n \"preheader\": \"Your account is ready to go.\",\n \"subject\": \"Welcome to Project Name\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"status\": \"accepted\",\n \"messageId\": \"msg_abc123\",\n \"idempotent\": false\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"welcome\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Open {{projectName}}\"\n },\n \"callToActionHeading\": \"\",\n \"callToActionParagraph\": \"\",\n \"heading\": \"Welcome to Project Name\",\n \"intro\": \"Your account has been created and you're ready to get started.\",\n \"preheader\": \"Your account is ready to go.\",\n \"subject\": \"Welcome to Project Name\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected templateId, to, and data.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"welcome\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Open {{projectName}}\"\n },\n \"callToActionHeading\": \"\",\n \"callToActionParagraph\": \"\",\n \"heading\": \"Welcome to Project Name\",\n \"intro\": \"Your account has been created and you're ready to get started.\",\n \"preheader\": \"Your account is ready to go.\",\n \"subject\": \"Welcome to Project Name\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"welcome\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Open {{projectName}}\"\n },\n \"callToActionHeading\": \"\",\n \"callToActionParagraph\": \"\",\n \"heading\": \"Welcome to Project Name\",\n \"intro\": \"Your account has been created and you're ready to get started.\",\n \"preheader\": \"Your account is ready to go.\",\n \"subject\": \"Welcome to Project Name\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"welcome\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Open {{projectName}}\"\n },\n \"callToActionHeading\": \"\",\n \"callToActionParagraph\": \"\",\n \"heading\": \"Welcome to Project Name\",\n \"intro\": \"Your account has been created and you're ready to get started.\",\n \"preheader\": \"Your account is ready to go.\",\n \"subject\": \"Welcome to Project Name\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text", "description": "Optional retry key that prevents duplicate sends when callers retry the same request." } ], "url": { "raw": "{{baseUrl}}/v1/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send" ] }, "description": "Use this endpoint for password resets, verification emails, app notifications, billing messages, and other transactional events. A successful response means the message has been accepted and queued, not that SES has already delivered it.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"welcome\",\n \"templateVersion\": \"v1\",\n \"to\": \"user@example.com\",\n \"data\": {\n \"actionButton\": {\n \"url\": \"https://example.com/app\",\n \"label\": \"Open {{projectName}}\"\n },\n \"callToActionHeading\": \"\",\n \"callToActionParagraph\": \"\",\n \"heading\": \"Welcome to Project Name\",\n \"intro\": \"Your account has been created and you're ready to get started.\",\n \"preheader\": \"Your account is ready to go.\",\n \"subject\": \"Welcome to Project Name\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] } ] }, { "name": "Quota", "item": [ { "name": "Get quota status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/quota", "host": [ "{{baseUrl}}" ], "path": [ "v1", "quota" ] }, "description": "Use this endpoint when an app or coding agent needs to check whether the current environment can keep sending. The response is operational state, not billing authority." }, "response": [ { "name": "200 Quota and access state for the tenant and environment", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/quota", "host": [ "{{baseUrl}}" ], "path": [ "v1", "quota" ] }, "description": "Use this endpoint when an app or coding agent needs to check whether the current environment can keep sending. The response is operational state, not billing authority." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"quota\": {\n \"tenantId\": \"tenant_123\",\n \"projectId\": \"project_123\",\n \"environmentId\": \"production\",\n \"planId\": \"build\",\n \"accessStatus\": \"active\",\n \"sendingStatus\": \"active\",\n \"period\": {\n \"id\": \"2026-05\",\n \"startsAt\": \"2026-05-01T00:00:00.000Z\",\n \"endsAt\": \"2026-06-01T00:00:00.000Z\"\n },\n \"monthly\": {\n \"limit\": 1000,\n \"used\": 42,\n \"remaining\": 958,\n \"overageAllowed\": false,\n \"overageEmails\": 0,\n \"status\": \"available\"\n },\n \"environment\": {\n \"usedThisMonth\": 42\n }\n }\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/quota", "host": [ "{{baseUrl}}" ], "path": [ "v1", "quota" ] }, "description": "Use this endpoint when an app or coding agent needs to check whether the current environment can keep sending. The response is operational state, not billing authority." }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Request validation failed.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/quota", "host": [ "{{baseUrl}}" ], "path": [ "v1", "quota" ] }, "description": "Use this endpoint when an app or coding agent needs to check whether the current environment can keep sending. The response is operational state, not billing authority." }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/quota", "host": [ "{{baseUrl}}" ], "path": [ "v1", "quota" ] }, "description": "Use this endpoint when an app or coding agent needs to check whether the current environment can keep sending. The response is operational state, not billing authority." }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "403 Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/quota", "host": [ "{{baseUrl}}" ], "path": [ "v1", "quota" ] }, "description": "Use this endpoint when an app or coding agent needs to check whether the current environment can keep sending. The response is operational state, not billing authority." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"api_key_revoked\",\n \"message\": \"API key has been revoked.\"\n}" }, { "name": "404 Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/quota", "host": [ "{{baseUrl}}" ], "path": [ "v1", "quota" ] }, "description": "Use this endpoint when an app or coding agent needs to check whether the current environment can keep sending. The response is operational state, not billing authority." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"project_not_found\",\n \"message\": \"Project not found for API key.\"\n}" }, { "name": "405 Method not allowed", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/quota", "host": [ "{{baseUrl}}" ], "path": [ "v1", "quota" ] }, "description": "Use this endpoint when an app or coding agent needs to check whether the current environment can keep sending. The response is operational state, not billing authority." }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"method_not_allowed\",\n \"message\": \"Only GET is allowed.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/quota", "host": [ "{{baseUrl}}" ], "path": [ "v1", "quota" ] }, "description": "Use this endpoint when an app or coding agent needs to check whether the current environment can keep sending. The response is operational state, not billing authority." }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/quota", "host": [ "{{baseUrl}}" ], "path": [ "v1", "quota" ] }, "description": "Use this endpoint when an app or coding agent needs to check whether the current environment can keep sending. The response is operational state, not billing authority." }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] } ] }, { "name": "Recipients", "item": [ { "name": "Resubscribe a recipient", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/recipients/resubscribe", "host": [ "{{baseUrl}}" ], "path": [ "v1", "recipients", "resubscribe" ] }, "description": "Use this endpoint only when the recipient has explicitly chosen to receive app notifications again. It writes an audit event and clears the app notification unsubscribe state for the API key environment.", "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"scope\": \"app_notifications\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 Successful resubscribe response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/recipients/resubscribe", "host": [ "{{baseUrl}}" ], "path": [ "v1", "recipients", "resubscribe" ] }, "description": "Use this endpoint only when the recipient has explicitly chosen to receive app notifications again. It writes an audit event and clears the app notification unsubscribe state for the API key environment.", "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"scope\": \"app_notifications\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/recipients/resubscribe", "host": [ "{{baseUrl}}" ], "path": [ "v1", "recipients", "resubscribe" ] }, "description": "Use this endpoint only when the recipient has explicitly chosen to receive app notifications again. It writes an audit event and clears the app notification unsubscribe state for the API key environment.", "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"scope\": \"app_notifications\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"Invalid resubscribe request.\",\n \"message\": \"Expected a valid email and app_notifications scope.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/recipients/resubscribe", "host": [ "{{baseUrl}}" ], "path": [ "v1", "recipients", "resubscribe" ] }, "description": "Use this endpoint only when the recipient has explicitly chosen to receive app notifications again. It writes an audit event and clears the app notification unsubscribe state for the API key environment.", "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"scope\": \"app_notifications\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/recipients/resubscribe", "host": [ "{{baseUrl}}" ], "path": [ "v1", "recipients", "resubscribe" ] }, "description": "Use this endpoint only when the recipient has explicitly chosen to receive app notifications again. It writes an audit event and clears the app notification unsubscribe state for the API key environment.", "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"scope\": \"app_notifications\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "403 Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/recipients/resubscribe", "host": [ "{{baseUrl}}" ], "path": [ "v1", "recipients", "resubscribe" ] }, "description": "Use this endpoint only when the recipient has explicitly chosen to receive app notifications again. It writes an audit event and clears the app notification unsubscribe state for the API key environment.", "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"scope\": \"app_notifications\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"api_key_revoked\",\n \"message\": \"API key has been revoked.\"\n}" }, { "name": "405 Method not allowed", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/recipients/resubscribe", "host": [ "{{baseUrl}}" ], "path": [ "v1", "recipients", "resubscribe" ] }, "description": "Use this endpoint only when the recipient has explicitly chosen to receive app notifications again. It writes an audit event and clears the app notification unsubscribe state for the API key environment.", "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"scope\": \"app_notifications\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"method_not_allowed\",\n \"message\": \"Only POST is allowed.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/recipients/resubscribe", "host": [ "{{baseUrl}}" ], "path": [ "v1", "recipients", "resubscribe" ] }, "description": "Use this endpoint only when the recipient has explicitly chosen to receive app notifications again. It writes an audit event and clears the app notification unsubscribe state for the API key environment.", "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"scope\": \"app_notifications\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/recipients/resubscribe", "host": [ "{{baseUrl}}" ], "path": [ "v1", "recipients", "resubscribe" ] }, "description": "Use this endpoint only when the recipient has explicitly chosen to receive app notifications again. It writes an audit event and clears the app notification unsubscribe state for the API key environment.", "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"scope\": \"app_notifications\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] }, { "name": "Get recipient status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/recipients/status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "recipients", "status" ] }, "description": "Use this endpoint to inspect whether an app can send notifications to a recipient and to display recent delivery state without exposing raw message bodies.", "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"limit\": 10\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 Recipient status and recent message metadata", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/recipients/status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "recipients", "status" ] }, "description": "Use this endpoint to inspect whether an app can send notifications to a recipient and to display recent delivery state without exposing raw message bodies.", "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"limit\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"recipient\": {\n \"emailMasked\": \"u***@example.com\",\n \"recipientDomain\": \"example.com\",\n \"state\": \"clear\",\n \"subscription\": {\n \"scope\": \"app_notifications\",\n \"status\": \"subscribed\",\n \"unsubscribedAt\": null,\n \"resubscribedAt\": null\n },\n \"delivery\": {\n \"hardBounceCount\": 0,\n \"complaintCount\": 0,\n \"cooldownUntil\": null,\n \"complainedAt\": null\n },\n \"canSendNotifications\": true\n },\n \"messages\": []\n}" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/recipients/status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "recipients", "status" ] }, "description": "Use this endpoint to inspect whether an app can send notifications to a recipient and to display recent delivery state without exposing raw message bodies.", "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"limit\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"invalid_request\",\n \"message\": \"Expected a valid recipient email.\"\n}" }, { "name": "401 Invalid or missing API key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/recipients/status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "recipients", "status" ] }, "description": "Use this endpoint to inspect whether an app can send notifications to a recipient and to display recent delivery state without exposing raw message bodies.", "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"limit\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"missing_api_key\",\n \"message\": \"Authorization bearer token is missing.\"\n}" }, { "name": "402 Billing or quota issue", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/recipients/status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "recipients", "status" ] }, "description": "Use this endpoint to inspect whether an app can send notifications to a recipient and to display recent delivery state without exposing raw message bodies.", "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"limit\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"trial_expired\",\n \"message\": \"The trial can no longer send email.\"\n}" }, { "name": "403 Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/recipients/status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "recipients", "status" ] }, "description": "Use this endpoint to inspect whether an app can send notifications to a recipient and to display recent delivery state without exposing raw message bodies.", "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"limit\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"api_key_revoked\",\n \"message\": \"API key has been revoked.\"\n}" }, { "name": "404 Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/recipients/status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "recipients", "status" ] }, "description": "Use this endpoint to inspect whether an app can send notifications to a recipient and to display recent delivery state without exposing raw message bodies.", "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"limit\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"project_not_found\",\n \"message\": \"Project not found for API key.\"\n}" }, { "name": "405 Method not allowed", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/recipients/status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "recipients", "status" ] }, "description": "Use this endpoint to inspect whether an app can send notifications to a recipient and to display recent delivery state without exposing raw message bodies.", "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"limit\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"method_not_allowed\",\n \"message\": \"Only POST is allowed.\"\n}" }, { "name": "429 Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/recipients/status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "recipients", "status" ] }, "description": "Use this endpoint to inspect whether an app can send notifications to a recipient and to display recent delivery state without exposing raw message bodies.", "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"limit\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"rate_limited\",\n \"message\": \"Too many requests.\"\n}" }, { "name": "500 Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/recipients/status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "recipients", "status" ] }, "description": "Use this endpoint to inspect whether an app can send notifications to a recipient and to display recent delivery state without exposing raw message bodies.", "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"limit\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"error\": \"internal\",\n \"message\": \"Unexpected server error.\"\n}" } ] } ] } ] }