{ "auth": { "bearer": [ { "key": "token", "type": "string", "value": "{{sendmux_api_key}}" } ], "type": "bearer" }, "event": [], "info": { "description": { "content": "Programmatic access to your Sendmux email infrastructure.", "type": "text/plain" }, "name": "Sendmux Mailbox API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "description": { "content": "", "type": "text/plain" }, "event": [], "item": [ { "event": [], "name": "Create a presigned mailbox attachment upload", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"content_type\": \"\",\n \"filename\": \"\",\n \"size_bytes\": \"\"\n}" }, "description": { "content": "Creates a short-lived signed PUT URL for one attachment. The caller must be authenticated to mint the URL; the later PUT uses the signed URL, exact Content-Type, and exact Content-Length without sending an API key. The PUT returns a blob ID that can be supplied to `POST /mailbox/messages/send`.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "Create a presigned mailbox attachment upload", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "attachment-uploads" ], "query": [ { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Attachment upload URL created", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid upload request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "", "code": 413, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Request body or attachment too large", "status": "Request Entity Too Large" }, { "_postman_previewlanguage": "json", "body": "", "code": 503, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Attachment uploads unavailable", "status": "Service Unavailable" } ] }, { "event": [], "name": "Upload a mailbox attachment", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "raw": "" }, "description": { "content": "Uploads one attachment as binary data and returns a blob ID that can be supplied to `POST /mailbox/messages/send`.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "Upload a mailbox attachment", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "attachments:upload" ], "query": [ { "description": "(Required) ", "disabled": false, "key": "filename", "value": "" }, { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Attachment uploaded", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid upload request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "", "code": 413, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Attachment too large", "status": "Request Entity Too Large" }, { "_postman_previewlanguage": "json", "body": "", "code": 503, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox service unavailable", "status": "Service Unavailable" } ] }, { "event": [], "name": "Get mailbox changes", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns message changes in the legacy shape when `types` is omitted. Pass a comma-separated `types` list for a typed state map.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "Get mailbox changes", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "changes" ], "query": [ { "disabled": true, "key": "since_state", "value": "" }, { "disabled": true, "key": "types", "value": "" }, { "disabled": true, "key": "messages_since_state", "value": "" }, { "disabled": true, "key": "folders_since_state", "value": "" }, { "disabled": true, "key": "threads_since_state", "value": "" }, { "disabled": true, "key": "submissions_since_state", "value": "" }, { "disabled": true, "key": "identities_since_state", "value": "" }, { "disabled": true, "key": "quotas_since_state", "value": "" }, { "disabled": true, "key": "limit", "value": "" }, { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox changes", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid sync state", "status": "Bad Request" } ] }, { "event": [], "name": "Stream mailbox events", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Streams bounded rich mailbox events for connected clients. Each received-message event includes subject, participants, preview, attachment metadata, and a capped body snapshot; use the message endpoints for full content or attachment bytes.", "type": "text/plain" }, "header": [ { "description": "", "disabled": true, "key": "Last-Event-ID", "value": "" }, { "key": "Accept", "value": "text/event-stream" } ], "method": "GET", "name": "Stream mailbox events", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "events" ], "query": [ { "disabled": true, "key": "event_types", "value": "" }, { "disabled": true, "key": "last_event_id", "value": "" }, { "disabled": true, "key": "ping", "value": "" }, { "disabled": true, "key": "close_after", "value": "" }, { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "text", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "text/event-stream" } ], "name": "Server-sent event stream. Event data uses the MailboxRealtimeEvent shape.", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid stream parameters", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox API key required", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "", "code": 429, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Too many realtime connections", "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "", "code": 503, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Realtime events unavailable", "status": "Service Unavailable" } ] }, { "event": [], "name": "List mailbox folders", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns a cursor-paginated list of folders for the authenticated mailbox.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "List mailbox folders", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "folders" ], "query": [ { "disabled": true, "key": "cursor", "value": "" }, { "disabled": true, "key": "limit", "value": "" }, { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Folder list", "status": "OK" } ] }, { "event": [], "name": "Create a mailbox folder", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"name\": \"\",\n \"parent_id\": \"\",\n \"sort_order\": \"\"\n}" }, "description": { "content": "Creates a folder in the authenticated mailbox.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "Create a mailbox folder", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "folders" ], "query": [ { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Folder created", "status": "Created" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request body", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "", "code": 413, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Request body too large", "status": "Request Entity Too Large" }, { "_postman_previewlanguage": "json", "body": "", "code": 422, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Folder validation failed", "status": "Unprocessable Entity (WebDAV) (RFC 4918)" } ] }, { "event": [], "name": "Delete a mailbox folder", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Deletes an empty custom folder unconditionally unless `If-Match` is supplied. Built-in folders and non-empty folders cannot be deleted. Send `If-Match` with a prior ETag to reject stale deletes.", "type": "text/plain" }, "header": [ { "description": "", "disabled": true, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "Delete a mailbox folder", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "folders", ":folder_id" ], "query": [ { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [ { "description": "(Required) ", "disabled": false, "key": "folder_id", "type": "any", "value": "" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Deletion result", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 409, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Folder cannot be deleted", "status": "Conflict" } ] }, { "event": [], "name": "Get a mailbox folder", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns one folder from the authenticated mailbox. Responses include a weak `ETag` header.", "type": "text/plain" }, "header": [ { "description": "", "disabled": true, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "Get a mailbox folder", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "folders", ":folder_id" ], "query": [ { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [ { "description": "(Required) ", "disabled": false, "key": "folder_id", "type": "any", "value": "" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Folder", "status": "OK" }, { "_postman_previewlanguage": "text", "body": "", "code": 304, "cookie": [], "header": [ { "key": "Content-Type", "value": "text/plain" } ], "name": "Not modified", "status": "Not Modified" }, { "_postman_previewlanguage": "json", "body": "", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Folder not found", "status": "Not Found" } ] }, { "event": [], "name": "Update a mailbox folder", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"name\": \"\",\n \"parent_id\": \"\",\n \"sort_order\": \"\"\n}" }, "description": { "content": "Updates a folder unconditionally unless `If-Match` is supplied. Send `If-Match` with a prior ETag to reject stale edits.", "type": "text/plain" }, "header": [ { "description": "", "disabled": true, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "name": "Update a mailbox folder", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "folders", ":folder_id" ], "query": [ { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [ { "description": "(Required) ", "disabled": false, "key": "folder_id", "type": "any", "value": "" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Updated folder", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request body", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Folder not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "", "code": 409, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "ETag conflict", "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "", "code": 413, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Request body too large", "status": "Request Entity Too Large" } ] }, { "event": [], "name": "Get folder changes", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns folder changes since a prior folder state, or the current folder state when omitted.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "Get folder changes", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "folders", "changes" ], "query": [ { "disabled": true, "key": "since_state", "value": "" }, { "disabled": true, "key": "limit", "value": "" }, { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Folder changes", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid sync state", "status": "Bad Request" } ] }, { "event": [], "name": "Get folder query changes", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns folder-list index changes since a prior folder query state, or the current folder query state when omitted.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "Get folder query changes", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "folders", "query-changes" ], "query": [ { "disabled": true, "key": "since_query_state", "value": "" }, { "disabled": true, "key": "limit", "value": "" }, { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Folder query changes", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid query sync state", "status": "Bad Request" } ] }, { "event": [], "name": "List mailbox sender identities", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns sender identities available to the authenticated mailbox.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "List mailbox sender identities", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "identities" ], "query": [ { "disabled": true, "key": "cursor", "value": "" }, { "disabled": true, "key": "limit", "value": "" }, { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Identity list", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid query parameter", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox API key required", "status": "Forbidden" } ] }, { "event": [], "name": "Get mailbox sender identity", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns the default sender identity and signatures for the authenticated mailbox.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "Get mailbox sender identity", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "identity" ], "query": [ { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox sender identity", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox API key required", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "", "code": 503, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox service unavailable", "status": "Service Unavailable" } ] }, { "event": [], "name": "Update mailbox sender identity", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"html_signature\": \"\",\n \"name\": \"\",\n \"text_signature\": \"\"\n}" }, "description": { "content": "Updates the default sender name, plain text signature, and HTML signature for the authenticated mailbox.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "name": "Update mailbox sender identity", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "identity" ], "query": [ { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Updated mailbox sender identity", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request body", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox API key required", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "", "code": 413, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Request body too large", "status": "Request Entity Too Large" }, { "_postman_previewlanguage": "json", "body": "", "code": 422, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Identity could not be updated", "status": "Unprocessable Entity (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "json", "body": "", "code": 503, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox service unavailable", "status": "Service Unavailable" } ] }, { "event": [], "name": "List granted mailboxes", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Lists the mailboxes available to the current mailbox credential or connected app. Use this before choosing a `mailbox_id` for mailbox actions when more than one mailbox is available.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "List granted mailboxes", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "mailboxes" ], "query": [ { "disabled": true, "key": "cursor", "value": "" }, { "disabled": true, "key": "limit", "value": "" }, { "disabled": true, "key": "q", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Granted mailboxes", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox access required", "status": "Forbidden" } ] }, { "event": [], "name": "Self-introspect the calling mailbox", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns the mailbox the bearer token is scoped to, including live storage usage. Intended for SDK auto-discovery — call once on startup to resolve the mailbox ID. Requires a mailbox-scoped API key; root keys receive 403.\n\nResponses carry a weak `ETag` header — send it back as `If-None-Match` on the next request and the server will return `304 Not Modified` (no body) when the mailbox state has not changed.", "type": "text/plain" }, "header": [ { "description": "", "disabled": true, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "Self-introspect the calling mailbox", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "me" ], "query": [ { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "description": "Weak ETag for conditional GETs.", "disabled": true, "key": "ETag", "value": "W/\"a1b2c3d4e5f60718\"" }, { "key": "Content-Type", "value": "application/json" } ], "name": "The calling mailbox", "status": "OK" }, { "_postman_previewlanguage": "text", "body": "", "code": 304, "cookie": [], "header": [ { "description": "Current weak ETag (same as request's `If-None-Match`).", "disabled": true, "key": "ETag", "value": "string" }, { "key": "Content-Type", "value": "text/plain" } ], "name": "Not Modified — the client's cached copy (matching `If-None-Match`) is still current.", "status": "Not Modified" }, { "_postman_previewlanguage": "json", "body": "", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Root key used on a mailbox-scoped endpoint", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox not found", "status": "Not Found" } ] }, { "event": [], "name": "List mailbox messages", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns a cursor-paginated list of messages for the authenticated mailbox. Requires a mailbox API key.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "List mailbox messages", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "messages" ], "query": [ { "disabled": true, "key": "cursor", "value": "" }, { "disabled": true, "key": "limit", "value": "" }, { "disabled": true, "key": "folder_id", "value": "" }, { "disabled": true, "key": "thread_id", "value": "" }, { "disabled": true, "key": "q", "value": "" }, { "disabled": true, "key": "from", "value": "" }, { "disabled": true, "key": "to", "value": "" }, { "disabled": true, "key": "cc", "value": "" }, { "disabled": true, "key": "bcc", "value": "" }, { "disabled": true, "key": "subject", "value": "" }, { "disabled": true, "key": "body", "value": "" }, { "disabled": true, "key": "header_name", "value": "" }, { "disabled": true, "key": "header_value", "value": "" }, { "disabled": true, "key": "min_size_bytes", "value": "" }, { "disabled": true, "key": "max_size_bytes", "value": "" }, { "disabled": true, "key": "keyword", "value": "" }, { "disabled": true, "key": "not_keyword", "value": "" }, { "disabled": true, "key": "after", "value": "" }, { "disabled": true, "key": "before", "value": "" }, { "disabled": true, "key": "has_attachment", "value": "" }, { "disabled": true, "key": "is_unread", "value": "" }, { "disabled": true, "key": "sort_by", "value": "" }, { "disabled": true, "key": "sort_direction", "value": "" }, { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Message list", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid query parameter", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox API key required", "status": "Forbidden" } ] }, { "event": [], "name": "Batch delete mailbox messages", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"ids\": [\n \"\"\n ],\n \"if_in_state\": \"\",\n \"permanent\": \"\"\n}" }, "description": { "content": "Moves up to 100 messages to Trash by default with state-safe conflict handling. Set `permanent=true` to permanently delete them.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "Batch delete mailbox messages", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "messages:batch-delete" ], "query": [ { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Batch delete result", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request body", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "", "code": 409, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "State conflict", "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "", "code": 413, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Request body too large", "status": "Request Entity Too Large" } ] }, { "event": [], "name": "Batch get mailbox messages", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"body_mode\": \"\",\n \"ids\": [\n \"\"\n ],\n \"include_attachments\": \"\",\n \"include_headers\": \"\",\n \"include_html\": \"\",\n \"include_links\": \"\",\n \"max_body_chars\": \"\",\n \"part\": \"\",\n \"strip_quotes\": \"\",\n \"strip_signature\": \"\"\n}" }, "description": { "content": "Returns exact messages by ID. Use `body_mode` to choose summary-only output, raw body output, or clean JSON content. Attachment output remains metadata only; attachment contents are not parsed.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "Batch get mailbox messages", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "messages:batch-get" ], "query": [ { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Batch message result", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request body", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Message not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "", "code": 413, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Request body too large", "status": "Request Entity Too Large" } ] }, { "event": [], "name": "Batch update mailbox messages", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"flagged\": \"\",\n \"ids\": [\n \"\"\n ],\n \"if_in_state\": \"\",\n \"keywords\": {\n \"key_0\": \"\"\n },\n \"seen\": \"\"\n}" }, "description": { "content": "Updates allowed message flags and keywords for up to 100 messages with state-safe conflict handling.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "Batch update mailbox messages", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "messages:batch-update" ], "query": [ { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Batch update result", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request body", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "", "code": 409, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "State conflict", "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "", "code": 413, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Request body too large", "status": "Request Entity Too Large" } ] }, { "event": [], "name": "Delete a mailbox message", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Moves a message to Trash by default, unconditionally unless `If-Match` is supplied. Set `permanent=true` to permanently delete it. Send `If-Match` with a prior ETag to reject stale deletes.", "type": "text/plain" }, "header": [ { "description": "", "disabled": true, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "Delete a mailbox message", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "messages", ":message_id" ], "query": [ { "disabled": true, "key": "permanent", "value": "" }, { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [ { "description": "(Required) ", "disabled": false, "key": "message_id", "type": "any", "value": "" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Deletion result", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Message not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "", "code": 409, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "ETag or state conflict", "status": "Conflict" } ] }, { "event": [], "name": "Get a mailbox message", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns one message from the authenticated mailbox. Responses include a weak `ETag` header. When attachment metadata includes short-lived download URLs, a conditional request may return `200` even when the stable message ETag matches so the response can renew expired URLs.", "type": "text/plain" }, "header": [ { "description": "", "disabled": true, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "Get a mailbox message", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "messages", ":message_id" ], "query": [ { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [ { "description": "(Required) ", "disabled": false, "key": "message_id", "type": "any", "value": "" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Message", "status": "OK" }, { "_postman_previewlanguage": "text", "body": "", "code": 304, "cookie": [], "header": [ { "key": "Content-Type", "value": "text/plain" } ], "name": "Not modified", "status": "Not Modified" }, { "_postman_previewlanguage": "json", "body": "", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Message not found", "status": "Not Found" } ] }, { "event": [], "name": "Update mailbox message flags", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"flagged\": \"\",\n \"keywords\": {\n \"key_0\": \"\"\n },\n \"seen\": \"\"\n}" }, "description": { "content": "Updates mutable message flags and keywords unconditionally unless `If-Match` is supplied. Send `If-Match` with a prior ETag to reject stale edits.", "type": "text/plain" }, "header": [ { "description": "", "disabled": true, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "name": "Update mailbox message flags", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "messages", ":message_id" ], "query": [ { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [ { "description": "(Required) ", "disabled": false, "key": "message_id", "type": "any", "value": "" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Updated message", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request body", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Message not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "", "code": 409, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "ETag conflict", "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "", "code": 413, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Request body too large", "status": "Request Entity Too Large" } ] }, { "event": [], "name": "Download a message attachment", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Streams one attachment from a message through the authenticated endpoint. Attachment metadata also provides short-lived download URLs for clients that cannot set request headers. Supports standard byte ranges.", "type": "text/plain" }, "header": [ { "description": "", "disabled": true, "key": "Range", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "Download a message attachment", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "messages", ":message_id", "attachments", ":attachment_id" ], "query": [ { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" }, { "disabled": true, "key": "download_token", "value": "" } ], "variable": [ { "description": "(Required) ", "disabled": false, "key": "message_id", "type": "any", "value": "" }, { "description": "(Required) ", "disabled": false, "key": "attachment_id", "type": "any", "value": "" } ] } }, "response": [ { "_postman_previewlanguage": "text", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "text/plain" } ], "name": "Attachment bytes", "status": "OK" }, { "_postman_previewlanguage": "text", "body": "", "code": 206, "cookie": [], "header": [ { "key": "Content-Type", "value": "text/plain" } ], "name": "Partial attachment bytes", "status": "Partial Content" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid range header", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Attachment not found", "status": "Not Found" } ] }, { "event": [], "name": "Get raw message body", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns raw message body content for the authenticated mailbox. This endpoint does not strip signatures, strip quoted replies, extract links, or clean the body into a structured content shape.", "type": "text/plain" }, "header": [ { "description": "", "disabled": true, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "Get raw message body", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "messages", ":message_id", "body" ], "query": [ { "disabled": true, "key": "part", "value": "" }, { "disabled": true, "key": "max_body_chars", "value": "" }, { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [ { "description": "(Required) ", "disabled": false, "key": "message_id", "type": "any", "value": "" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Raw message body", "status": "OK" }, { "_postman_previewlanguage": "text", "body": "", "code": 304, "cookie": [], "header": [ { "key": "Content-Type", "value": "text/plain" } ], "name": "Not modified", "status": "Not Modified" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid query parameter", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Message not found", "status": "Not Found" } ] }, { "event": [], "name": "Get clean message content", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns deterministic clean JSON content for one message. Attachment output is metadata only; attachment contents are not parsed by this endpoint.", "type": "text/plain" }, "header": [ { "description": "", "disabled": true, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "Get clean message content", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "messages", ":message_id", "content" ], "query": [ { "disabled": true, "key": "part", "value": "" }, { "disabled": true, "key": "max_body_chars", "value": "" }, { "disabled": true, "key": "strip_signature", "value": "" }, { "disabled": true, "key": "strip_quotes", "value": "" }, { "disabled": true, "key": "include_links", "value": "" }, { "disabled": true, "key": "include_html", "value": "" }, { "disabled": true, "key": "include_headers", "value": "" }, { "disabled": true, "key": "include_attachments", "value": "" }, { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [ { "description": "(Required) ", "disabled": false, "key": "message_id", "type": "any", "value": "" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Clean message content", "status": "OK" }, { "_postman_previewlanguage": "text", "body": "", "code": 304, "cookie": [], "header": [ { "key": "Content-Type", "value": "text/plain" } ], "name": "Not modified", "status": "Not Modified" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid query parameter", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Message not found", "status": "Not Found" } ] }, { "event": [], "name": "Count mailbox messages", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns a count for the supplied mailbox message filters without returning message rows.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "Count mailbox messages", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "messages", "count" ], "query": [ { "disabled": true, "key": "folder_id", "value": "" }, { "disabled": true, "key": "thread_id", "value": "" }, { "disabled": true, "key": "q", "value": "" }, { "disabled": true, "key": "from", "value": "" }, { "disabled": true, "key": "to", "value": "" }, { "disabled": true, "key": "cc", "value": "" }, { "disabled": true, "key": "bcc", "value": "" }, { "disabled": true, "key": "subject", "value": "" }, { "disabled": true, "key": "body", "value": "" }, { "disabled": true, "key": "header_name", "value": "" }, { "disabled": true, "key": "header_value", "value": "" }, { "disabled": true, "key": "min_size_bytes", "value": "" }, { "disabled": true, "key": "max_size_bytes", "value": "" }, { "disabled": true, "key": "keyword", "value": "" }, { "disabled": true, "key": "not_keyword", "value": "" }, { "disabled": true, "key": "after", "value": "" }, { "disabled": true, "key": "before", "value": "" }, { "disabled": true, "key": "has_attachment", "value": "" }, { "disabled": true, "key": "is_unread", "value": "" }, { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Message count", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid query parameter", "status": "Bad Request" } ] }, { "event": [], "name": "Get message query changes", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns filtered message-list index changes since a prior message query state, or the current message query state when omitted.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "Get message query changes", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "messages", "query-changes" ], "query": [ { "disabled": true, "key": "since_query_state", "value": "" }, { "disabled": true, "key": "limit", "value": "" }, { "disabled": true, "key": "up_to_id", "value": "" }, { "disabled": true, "key": "calculate_total", "value": "" }, { "disabled": true, "key": "folder_id", "value": "" }, { "disabled": true, "key": "q", "value": "" }, { "disabled": true, "key": "from", "value": "" }, { "disabled": true, "key": "to", "value": "" }, { "disabled": true, "key": "cc", "value": "" }, { "disabled": true, "key": "bcc", "value": "" }, { "disabled": true, "key": "subject", "value": "" }, { "disabled": true, "key": "body", "value": "" }, { "disabled": true, "key": "header_name", "value": "" }, { "disabled": true, "key": "header_value", "value": "" }, { "disabled": true, "key": "min_size_bytes", "value": "" }, { "disabled": true, "key": "max_size_bytes", "value": "" }, { "disabled": true, "key": "keyword", "value": "" }, { "disabled": true, "key": "not_keyword", "value": "" }, { "disabled": true, "key": "after", "value": "" }, { "disabled": true, "key": "before", "value": "" }, { "disabled": true, "key": "has_attachment", "value": "" }, { "disabled": true, "key": "is_unread", "value": "" }, { "disabled": true, "key": "sort_by", "value": "" }, { "disabled": true, "key": "sort_direction", "value": "" }, { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Message query changes", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid query sync state or filter", "status": "Bad Request" } ] }, { "event": [], "name": "Get message search snippets", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns subject and preview snippets for a text search. Provide `message_ids` to snippet exact messages, or omit it to snippet the first filtered results.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "Get message search snippets", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "messages", "search-snippets" ], "query": [ { "disabled": true, "key": "folder_id", "value": "" }, { "disabled": true, "key": "from", "value": "" }, { "disabled": true, "key": "to", "value": "" }, { "disabled": true, "key": "cc", "value": "" }, { "disabled": true, "key": "bcc", "value": "" }, { "disabled": true, "key": "subject", "value": "" }, { "disabled": true, "key": "body", "value": "" }, { "disabled": true, "key": "header_name", "value": "" }, { "disabled": true, "key": "header_value", "value": "" }, { "disabled": true, "key": "min_size_bytes", "value": "" }, { "disabled": true, "key": "max_size_bytes", "value": "" }, { "disabled": true, "key": "keyword", "value": "" }, { "disabled": true, "key": "not_keyword", "value": "" }, { "disabled": true, "key": "after", "value": "" }, { "disabled": true, "key": "before", "value": "" }, { "disabled": true, "key": "has_attachment", "value": "" }, { "disabled": true, "key": "is_unread", "value": "" }, { "description": "(Required) ", "disabled": false, "key": "q", "value": "" }, { "disabled": true, "key": "message_ids", "value": "" }, { "disabled": true, "key": "limit", "value": "" }, { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Search snippets", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid query parameter", "status": "Bad Request" } ] }, { "event": [], "name": "Send a mailbox message", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"attachments\": [\n {\n \"content\": \"\",\n \"content_type\": \"\",\n \"filename\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"email\": \"\",\n \"name\": \"\"\n }\n ],\n \"cc\": [\n {\n \"email\": \"\",\n \"name\": \"\"\n }\n ],\n \"custom_headers\": {\n \"key_0\": \"\"\n },\n \"from\": {\n \"email\": \"\",\n \"name\": \"\"\n },\n \"html_body\": \"\",\n \"reply_to\": [\n {\n \"email\": \"\",\n \"name\": \"\"\n }\n ],\n \"subject\": \"\",\n \"text_body\": \"\",\n \"to\": [\n {\n \"email\": \"\",\n \"name\": \"\"\n }\n ]\n}" }, "description": { "content": "Creates and queues a message from the authenticated mailbox. Supply an `Idempotency-Key` header to safely retry. Attachments may use small inline base64 content or blob IDs returned by `POST /mailbox/attachments:upload` or `POST /mailbox/attachment-uploads`.", "type": "text/plain" }, "header": [ { "description": "", "disabled": true, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "Send a mailbox message", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "messages", "send" ], "query": [ { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Message queued", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request body", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "", "code": 409, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Idempotency conflict", "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "", "code": 413, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Request body too large", "status": "Request Entity Too Large" }, { "_postman_previewlanguage": "json", "body": "", "code": 422, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Message validation failed", "status": "Unprocessable Entity (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "json", "body": "", "code": 503, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox service unavailable", "status": "Service Unavailable" } ] }, { "event": [], "name": "List mailbox quotas", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns a cursor-paginated list of quota usage and limits for the authenticated mailbox.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "List mailbox quotas", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "quotas" ], "query": [ { "disabled": true, "key": "cursor", "value": "" }, { "disabled": true, "key": "limit", "value": "" }, { "disabled": true, "key": "name", "value": "" }, { "disabled": true, "key": "scope", "value": "" }, { "disabled": true, "key": "resource_type", "value": "" }, { "disabled": true, "key": "type", "value": "" }, { "disabled": true, "key": "sort_by", "value": "" }, { "disabled": true, "key": "sort_direction", "value": "" }, { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Quota list", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid query parameter", "status": "Bad Request" } ] }, { "event": [], "name": "Get quota changes", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns quota changes since a prior quota state, or the current quota state when omitted.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "Get quota changes", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "quotas", "changes" ], "query": [ { "disabled": true, "key": "since_state", "value": "" }, { "disabled": true, "key": "limit", "value": "" }, { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Quota changes", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid sync state", "status": "Bad Request" } ] }, { "event": [], "name": "Get mailbox API session", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns mailbox API capabilities, resource state tokens, limits, and disabled feature flags for the authenticated mailbox.", "type": "text/plain" }, "header": [ { "description": "", "disabled": true, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "Get mailbox API session", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "session" ], "query": [ { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox API session", "status": "OK" }, { "_postman_previewlanguage": "text", "body": "", "code": 304, "cookie": [], "header": [ { "key": "Content-Type", "value": "text/plain" } ], "name": "Not modified", "status": "Not Modified" }, { "_postman_previewlanguage": "json", "body": "", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox API key required", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "", "code": 503, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox service unavailable", "status": "Service Unavailable" } ] }, { "event": [], "name": "List mailbox submissions", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns a cursor-paginated list of send submissions for the authenticated mailbox, including delivery lifecycle fields when available.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "List mailbox submissions", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "submissions" ], "query": [ { "disabled": true, "key": "cursor", "value": "" }, { "disabled": true, "key": "limit", "value": "" }, { "disabled": true, "key": "identity_ids", "value": "" }, { "disabled": true, "key": "email_ids", "value": "" }, { "disabled": true, "key": "thread_ids", "value": "" }, { "disabled": true, "key": "undo_status", "value": "" }, { "disabled": true, "key": "after", "value": "" }, { "disabled": true, "key": "before", "value": "" }, { "disabled": true, "key": "sort_by", "value": "" }, { "disabled": true, "key": "sort_direction", "value": "" }, { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Submission list", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid query parameter", "status": "Bad Request" } ] }, { "event": [], "name": "Get a mailbox submission", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns one send submission for the authenticated mailbox. Responses include a weak `ETag` header.", "type": "text/plain" }, "header": [ { "description": "", "disabled": true, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "Get a mailbox submission", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "submissions", ":submission_id" ], "query": [ { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [ { "description": "(Required) ", "disabled": false, "key": "submission_id", "type": "any", "value": "" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Submission", "status": "OK" }, { "_postman_previewlanguage": "text", "body": "", "code": 304, "cookie": [], "header": [ { "key": "Content-Type", "value": "text/plain" } ], "name": "Not modified", "status": "Not Modified" }, { "_postman_previewlanguage": "json", "body": "", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Submission not found", "status": "Not Found" } ] }, { "event": [], "name": "Get submission changes", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns send submission changes since a prior submission state, or the current state when omitted.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "Get submission changes", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "submissions", "changes" ], "query": [ { "disabled": true, "key": "since_state", "value": "" }, { "disabled": true, "key": "limit", "value": "" }, { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Submission changes", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid sync state", "status": "Bad Request" } ] }, { "event": [], "name": "List mailbox threads", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns a cursor-paginated list of conversation threads for the authenticated mailbox. Filter by text, participant, folder, unread state, attachment presence, or date range.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "List mailbox threads", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "threads" ], "query": [ { "disabled": true, "key": "cursor", "value": "" }, { "disabled": true, "key": "limit", "value": "" }, { "disabled": true, "key": "q", "value": "" }, { "disabled": true, "key": "participant", "value": "" }, { "disabled": true, "key": "folder_id", "value": "" }, { "disabled": true, "key": "after", "value": "" }, { "disabled": true, "key": "before", "value": "" }, { "disabled": true, "key": "has_attachment", "value": "" }, { "disabled": true, "key": "is_unread", "value": "" }, { "disabled": true, "key": "sort_direction", "value": "" }, { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Thread list", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid query parameter", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox API key required", "status": "Forbidden" } ] }, { "event": [], "name": "Get a mailbox thread", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns thread metadata, message IDs, participants, last message, unread count, and state for one conversation. Responses include a weak `ETag` header.", "type": "text/plain" }, "header": [ { "description": "", "disabled": true, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "Get a mailbox thread", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "threads", ":thread_id" ], "query": [ { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [ { "description": "(Required) ", "disabled": false, "key": "thread_id", "type": "any", "value": "" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Thread", "status": "OK" }, { "_postman_previewlanguage": "text", "body": "", "code": 304, "cookie": [], "header": [ { "key": "Content-Type", "value": "text/plain" } ], "name": "Not modified", "status": "Not Modified" }, { "_postman_previewlanguage": "json", "body": "", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Thread not found", "status": "Not Found" } ] }, { "event": [], "name": "Get clean thread content", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns a cursor-paginated clean JSON view of messages in a thread. Attachment output is metadata only; attachment contents are not parsed by this endpoint.", "type": "text/plain" }, "header": [ { "description": "", "disabled": true, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "Get clean thread content", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "threads", ":thread_id", "content" ], "query": [ { "disabled": true, "key": "part", "value": "" }, { "disabled": true, "key": "max_body_chars", "value": "" }, { "disabled": true, "key": "strip_signature", "value": "" }, { "disabled": true, "key": "strip_quotes", "value": "" }, { "disabled": true, "key": "include_links", "value": "" }, { "disabled": true, "key": "include_html", "value": "" }, { "disabled": true, "key": "include_headers", "value": "" }, { "disabled": true, "key": "include_attachments", "value": "" }, { "disabled": true, "key": "cursor", "value": "" }, { "disabled": true, "key": "limit", "value": "" }, { "disabled": true, "key": "sort", "value": "" }, { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [ { "description": "(Required) ", "disabled": false, "key": "thread_id", "type": "any", "value": "" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Clean thread content", "status": "OK" }, { "_postman_previewlanguage": "text", "body": "", "code": 304, "cookie": [], "header": [ { "key": "Content-Type", "value": "text/plain" } ], "name": "Not modified", "status": "Not Modified" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid query parameter", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Thread not found", "status": "Not Found" } ] }, { "event": [], "name": "List thread messages", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns cursor-paginated message summaries for one thread. Use the thread content endpoint when you need cleaned bodies.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "List thread messages", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "threads", ":thread_id", "messages" ], "query": [ { "disabled": true, "key": "cursor", "value": "" }, { "disabled": true, "key": "limit", "value": "" }, { "disabled": true, "key": "sort", "value": "" }, { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [ { "description": "(Required) ", "disabled": false, "key": "thread_id", "type": "any", "value": "" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Thread messages", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid query parameter", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Thread not found", "status": "Not Found" } ] }, { "event": [], "name": "Get mailbox usage", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns a compact usage view derived from mailbox quota records. Responses include a weak `ETag` header.", "type": "text/plain" }, "header": [ { "description": "", "disabled": true, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "Get mailbox usage", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailbox", "usage" ], "query": [ { "description": "Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.", "disabled": true, "key": "mailbox_id", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox usage", "status": "OK" }, { "_postman_previewlanguage": "text", "body": "", "code": 304, "cookie": [], "header": [ { "key": "Content-Type", "value": "text/plain" } ], "name": "Not modified", "status": "Not Modified" } ] } ], "name": "Mailbox API" }, { "description": { "content": "", "type": "text/plain" }, "event": [], "item": [ { "event": [], "name": "List mailboxes", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns a cursor-paginated list of mailboxes configured for the team, ordered by `created_at` descending. Pass `cursor=` from the previous response to fetch the next page.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "List mailboxes", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailboxes" ], "query": [ { "disabled": true, "key": "cursor", "value": "" }, { "disabled": true, "key": "limit", "value": "" }, { "disabled": true, "key": "include_deleted", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox list", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Insufficient permissions", "status": "Forbidden" } ] }, { "event": [], "name": "Create a mailbox", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"display_name\": \"\",\n \"email\": \"\",\n \"quota_bytes\": \"\",\n \"send_scope\": {\n \"group_public_ids\": [\n \"\"\n ],\n \"provider_public_ids\": [\n \"\"\n ],\n \"type\": \"\"\n }\n}" }, "description": { "content": "Provisions a new mailbox plus an initial bearer token and matching IMAP/SMTP mailbox password. The domain portion of the email must already be verified via POST /domains. If supplied, `quota_bytes` must be one of the current storage tiers: 1073741824 (1 GB), 5368709120 (5 GB), or 53687091200 (50 GB). Creation provisions resources on our mail platform and, for `@myagent.mx` addresses, on Amazon SES — any failure rolls the partial state back automatically.\n\nSupply an `Idempotency-Key` header (any unique string, max 255 chars) to safely retry on network errors. Replays with the same key return the original response; replays with a different body return `409 idempotency_conflict`.", "type": "text/plain" }, "header": [ { "description": "", "disabled": true, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "Create a mailbox", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailboxes" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 201, "cookie": [], "header": [ { "description": "Canonical GET URL for the newly created mailbox.", "disabled": true, "key": "Location", "value": "/api/v1/mailboxes/mx_clxxxxxxxxxxxxxxxxxxxxxxxxx" }, { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox created. The response carries a `Location` header pointing at the canonical GET URL for the new mailbox.", "status": "Created" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request body", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "", "code": 409, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Email already in use (error code `conflict`), or `Idempotency-Key` was replayed with a different body (`idempotency_conflict`).", "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "", "code": 413, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Request body too large", "status": "Request Entity Too Large" }, { "_postman_previewlanguage": "json", "body": "", "code": 422, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Domain not yet verified or semantic validation failure", "status": "Unprocessable Entity (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "json", "body": "", "code": 503, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Team is not yet provisioned for sending", "status": "Service Unavailable" } ] }, { "event": [], "name": "Delete a mailbox", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Removes a mailbox from our mail platform, Amazon SES (for `@myagent.mx` addresses), and Sendmux. All associated API keys are revoked.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "Delete a mailbox", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailboxes", ":public_id" ], "query": [], "variable": [ { "description": "(Required) ", "disabled": false, "key": "public_id", "type": "any", "value": "" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Deletion result", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox not found", "status": "Not Found" } ] }, { "event": [], "name": "Get a mailbox", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns a single mailbox, tenant-scoped to the caller's team. Responses carry a weak `ETag` header — send it back as `If-None-Match` on the next request and the server will return `304 Not Modified` (no body) when the resource has not changed. The same ETag is the value to use in `If-Match` on PATCH for optimistic concurrency.", "type": "text/plain" }, "header": [ { "description": "", "disabled": true, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "Get a mailbox", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailboxes", ":public_id" ], "query": [], "variable": [ { "description": "(Required) ", "disabled": false, "key": "public_id", "type": "any", "value": "" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "description": "Weak ETag for conditional GETs and optimistic-concurrency PATCHes.", "disabled": true, "key": "ETag", "value": "W/\"a1b2c3d4e5f60718\"" }, { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox", "status": "OK" }, { "_postman_previewlanguage": "text", "body": "", "code": 304, "cookie": [], "header": [ { "description": "Current weak ETag (same as request's `If-None-Match`).", "disabled": true, "key": "ETag", "value": "string" }, { "key": "Content-Type", "value": "text/plain" } ], "name": "Not Modified — the client's cached copy (matching `If-None-Match`) is still current.", "status": "Not Modified" }, { "_postman_previewlanguage": "json", "body": "", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox not found", "status": "Not Found" } ] }, { "event": [], "name": "Update a mailbox", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"display_name\": \"\",\n \"quota_bytes\": \"\",\n \"send_scope\": {\n \"group_public_ids\": [\n \"\"\n ],\n \"provider_public_ids\": [\n \"\"\n ],\n \"type\": \"\"\n }\n}" }, "description": { "content": "Updates any combination of display_name, quota_bytes, and send_scope on a mailbox. The display_name and send_scope changes land in a single transaction; quota_bytes is applied afterwards because it also updates external state on our mail platform. Quota can only be set to 1073741824 (1 GB), 5368709120 (5 GB), or 53687091200 (50 GB), and cannot be shrunk below the mailbox's current usage.\n\nFor optimistic concurrency, send `If-Match: ` using the ETag from a prior GET. A mismatched `If-Match` returns `409 conflict` (the server's ETag is echoed back so you can decide whether to re-fetch). Responses carry the new ETag so chained edits can pipeline without a re-GET.", "type": "text/plain" }, "header": [ { "description": "", "disabled": true, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "name": "Update a mailbox", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailboxes", ":public_id" ], "query": [], "variable": [ { "description": "(Required) ", "disabled": false, "key": "public_id", "type": "any", "value": "" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "description": "Weak ETag for the post-update resource.", "disabled": true, "key": "ETag", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "name": "Updated mailbox", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request body", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "", "code": 409, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "`If-Match` ETag does not match the server's current version.", "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "", "code": 413, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Request body too large", "status": "Request Entity Too Large" }, { "_postman_previewlanguage": "json", "body": "", "code": 422, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Validation error — unsupported quota tier, quota below current usage, or cross-tenant send_scope reference", "status": "Unprocessable Entity (WebDAV) (RFC 4918)" } ] }, { "event": [], "name": "Create a mailbox API key", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"app_name\": \"\"\n}" }, "description": { "content": "Mints an additional bearer token plus IMAP/SMTP mailbox password for an existing mailbox. The plaintext key and password are shown exactly once — store them immediately.\n\nSupply an `Idempotency-Key` header (any unique string, max 255 chars) to safely retry on network errors. Replays with the same key return the original response; replays with a different body return `409 idempotency_conflict`.", "type": "text/plain" }, "header": [ { "description": "", "disabled": true, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "Create a mailbox API key", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailboxes", ":public_id", "keys" ], "query": [], "variable": [ { "description": "(Required) ", "disabled": false, "key": "public_id", "type": "any", "value": "" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 201, "cookie": [], "header": [ { "description": "Canonical URL for the newly created API key.", "disabled": true, "key": "Location", "value": "/api/v1/mailboxes/mx_clxxxxxxxxxxxxxxxxxxxxxxxxx/keys/smx_clxxxxxxxxxxxxxxxxxxxxxxxxx" }, { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox API key created. The response carries a `Location` header pointing at the canonical URL for the new key.", "status": "Created" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request body", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "", "code": 409, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Credential limit reached (`limit_exceeded`) or idempotency key conflict (`idempotency_conflict`).", "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "", "code": 413, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Request body too large", "status": "Request Entity Too Large" }, { "_postman_previewlanguage": "json", "body": "", "code": 422, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox is not active", "status": "Unprocessable Entity (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "json", "body": "", "code": 503, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Credential setup temporarily unavailable", "status": "Service Unavailable" } ] }, { "event": [], "name": "Revoke a mailbox API key", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Revokes a specific bearer token + matching mailbox password. Idempotent on already-revoked keys.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "Revoke a mailbox API key", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailboxes", ":public_id", "keys", ":key_id" ], "query": [], "variable": [ { "description": "(Required) ", "disabled": false, "key": "public_id", "type": "any", "value": "" }, { "description": "(Required) ", "disabled": false, "key": "key_id", "type": "any", "value": "" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Deletion result", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox or key not found", "status": "Not Found" } ] }, { "event": [], "name": "Resume a mailbox", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Restores a suspended mailbox so it can authenticate, receive mail, and send from the mailbox address again. The operation is idempotent and accepts `Idempotency-Key` for safe retries.", "type": "text/plain" }, "header": [ { "description": "", "disabled": true, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "Resume a mailbox", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailboxes", ":public_id", "resume" ], "query": [], "variable": [ { "description": "(Required) ", "disabled": false, "key": "public_id", "type": "any", "value": "" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Resumed mailbox", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Root API key required", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "", "code": 409, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox is deleted, or `Idempotency-Key` was replayed with a different request body.", "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "", "code": 503, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox service temporarily unavailable", "status": "Service Unavailable" } ] }, { "event": [], "name": "Suspend a mailbox", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Suspends a mailbox without deleting messages, credentials, or settings. Suspended mailboxes cannot receive mail, authenticate to mailbox protocols, or send from the mailbox address. The operation is idempotent and accepts `Idempotency-Key` for safe retries.", "type": "text/plain" }, "header": [ { "description": "", "disabled": true, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "Suspend a mailbox", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailboxes", ":public_id", "suspend" ], "query": [], "variable": [ { "description": "(Required) ", "disabled": false, "key": "public_id", "type": "any", "value": "" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Suspended mailbox", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Root API key required", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "", "code": 409, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox is deleted, or `Idempotency-Key` was replayed with a different request body.", "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "", "code": 503, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox service temporarily unavailable", "status": "Service Unavailable" } ] }, { "event": [], "name": "Check mailbox address availability", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Checks whether an email address can be reserved for mailbox creation. `@myagent.mx` availability is global across all teams; custom-domain availability is scoped to the caller's team and requires a verified send/receive mailbox domain.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "Check mailbox address availability", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailboxes", "availability" ], "query": [ { "description": "(Required) ", "disabled": false, "key": "email", "value": "" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox address availability", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Root API key with mailbox.admin.create is required", "status": "Forbidden" } ] } ], "name": "Mailboxes" }, { "description": { "content": "", "type": "text/plain" }, "event": [], "item": [ { "event": [], "name": "Get mailbox sender filters", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": { "content": "Returns the current sender-filter mode and rule set for a mailbox. Mailbox-scoped rules override any domain-wide rules set on the parent domain.\n\nResponses carry a weak `ETag` — send it as `If-None-Match` to skip the body when the filter set has not changed (returns `304 Not Modified`). The same ETag is the value to use in `If-Match` on the corresponding PUT for optimistic concurrency.", "type": "text/plain" }, "header": [ { "description": "", "disabled": true, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "Get mailbox sender filters", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailboxes", ":public_id", "filters" ], "query": [], "variable": [ { "description": "(Required) ", "disabled": false, "key": "public_id", "type": "any", "value": "" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "description": "Weak ETag for conditional GETs and optimistic-concurrency PUTs.", "disabled": true, "key": "ETag", "value": "W/\"a1b2c3d4e5f60718\"" }, { "key": "Content-Type", "value": "application/json" } ], "name": "Filter state", "status": "OK" }, { "_postman_previewlanguage": "text", "body": "", "code": 304, "cookie": [], "header": [ { "description": "Current weak ETag.", "disabled": true, "key": "ETag", "value": "string" }, { "key": "Content-Type", "value": "text/plain" } ], "name": "Not Modified — the client's cached copy (matching `If-None-Match`) is still current.", "status": "Not Modified" }, { "_postman_previewlanguage": "json", "body": "", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "", "code": 503, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Filter service temporarily unavailable", "status": "Service Unavailable" } ] }, { "event": [], "name": "Replace mailbox sender filters", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"mode\": \"\",\n \"rules\": [\n {\n \"note\": \"\",\n \"pattern\": \"\",\n \"type\": \"\"\n }\n ]\n}" }, "description": { "content": "Atomically replaces the sender-filter mode and rule set for a mailbox. The entire rule set is swapped in a single operation — there is no intermediate state where the mailbox has a partial ruleset. A maximum of 1000 rules per request is enforced.\n\nFor optimistic concurrency, send `If-Match: ` using the ETag from a prior GET. A mismatched `If-Match` returns `409 conflict` (the server's ETag is echoed back so you can decide whether to re-fetch). Responses carry the new ETag so chained edits can pipeline without a re-GET.", "type": "text/plain" }, "header": [ { "description": "", "disabled": true, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "Replace mailbox sender filters", "url": { "host": [ "{{mailbox_base_url}}" ], "path": [ "mailboxes", ":public_id", "filters" ], "query": [], "variable": [ { "description": "(Required) ", "disabled": false, "key": "public_id", "type": "any", "value": "" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "", "code": 200, "cookie": [], "header": [ { "description": "Weak ETag for the post-update resource.", "disabled": true, "key": "ETag", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "name": "Updated filter state", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request body", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Mailbox not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "", "code": 409, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "`If-Match` ETag does not match the server's current version.", "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "", "code": 413, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Request body too large", "status": "Request Entity Too Large" }, { "_postman_previewlanguage": "json", "body": "", "code": 422, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rule cap exceeded or invalid rule pattern", "status": "Unprocessable Entity (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "json", "body": "", "code": 503, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Filter service temporarily unavailable", "status": "Service Unavailable" } ] } ], "name": "Mailbox Filters" } ], "variable": [ { "key": "sendmux_api_key", "type": "string", "value": "" }, { "key": "mailbox_base_url", "type": "string", "value": "https://app.sendmux.ai/api/v1" } ] }