9b:"/_next/static/chunks/1mzl677lvmbrj.js" 9c:I[152883,["$15","$16","$17","$18","$9b"],"default"] 9d:I[488056,["$15","$16","$17","$18"],""] 1b:["/api-keys"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1c:["/api-keys"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1d:["/api-keys/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 1e:["/audiences/{audienceId}/contacts"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1f:["/audiences/{audienceId}/contacts/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 20:["/audiences/{audienceId}/contacts/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 21:["/audiences/{audienceId}/contacts/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 22:["/broadcasts"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 23:["/broadcasts"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 24:["/broadcasts/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 25:["/broadcasts/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 26:["/broadcasts/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 27:["/broadcasts/{id}/cancel"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 28:["/broadcasts/{id}/send"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 29:["/contact-properties"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 2a:["/contact-properties"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 2b:["/contact-properties/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 2c:["/contact-properties/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 2d:["/contact-properties/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 2e:["/contacts"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 2f:["/contacts"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 30:["Create contacts in bulk"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 31:["Read contacts in bulk"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 32:["Delete contacts in bulk"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 9e:I[106764,["$15","$16","$17","$18","$91","$92","$93","$94"],"OpenAPIPage"] 9f:I[280695,["$2"],"IconMark"] 33:["/contacts/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 34:["/contacts/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 35:["/contacts/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 36:["Mint a preference-center link for a contact"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 37:["/contacts/{id}/segments/{segmentId}"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 38:["/contacts/{id}/segments/{segmentId}"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 39:["/contacts/{id}/topics"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 3a:["/contacts/{id}/topics"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 3b:["/deliverability"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 3c:["/domains"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 3d:["/domains"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 3e:["/domains/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 3f:["/domains/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 40:["/domains/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 41:["/domains/{id}/verify"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 42:["/emails"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 43:["/emails"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 44:["/emails/batch"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 45:["/emails/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 46:["/emails/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 47:["/emails/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 48:["/emails/{id}/cancel"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 49:["/emails/{id}/insights"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 4a:["List received emails"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 4b:["List a received email's attachments"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 4c:["Retrieve a received email's attachment"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 4d:["Delete a received email"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 4e:["Retrieve a received email"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 4f:["Forward a received email"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 50:["Reply to a received email"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 51:["List inboxes"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 52:["Create an inbox"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 53:["Delete an inbox"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 54:["Retrieve an inbox"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 55:["Update an inbox"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 56:["Retrieve an inbox's agent settings"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 57:["Update an inbox's agent settings"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 58:["Retrieve the latest verification code"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 59:["List drafts"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 5a:["Create a draft"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 5b:["Delete a draft"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 5c:["Retrieve a draft"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 5d:["Update a draft"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 5e:["Reject a draft"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 5f:["Send a draft"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 60:["List an inbox's labels"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 61:["Create a label"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 62:["Delete a label"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 63:["Update a label"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 64:["List quarantined emails"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 65:["Release a quarantined email"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 66:["Retrieve an inbox's safety rules"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 67:["Update an inbox's safety rules"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 68:["List threads"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 69:["Search threads"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 6a:["Delete a thread"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 6b:["Retrieve a thread"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 6c:["Update a thread"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 6d:["List a thread's emails"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 6e:["Retrieve a thread email"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 6f:["Forward a thread email"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 70:["Reply to a thread email"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 71:["/segments"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 72:["/segments"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 73:["/segments/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 74:["/segments/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 75:["/segments/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 76:["/segments/{id}/contacts"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 77:["/suppressions"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 78:["/suppressions"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 79:["/suppressions/batch/add"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 7a:["/suppressions/batch/remove"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 7b:["/suppressions/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 7c:["/suppressions/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 7d:["/templates"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 7e:["/templates"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 7f:["/templates/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 80:["/templates/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 81:["/templates/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 82:["/templates/{id}/duplicate"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 83:["/templates/{id}/publish"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 84:["/topics"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 85:["/topics"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 86:["/topics/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 87:["/topics/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 88:["/topics/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 89:["/usage"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 8a:["/webhooks"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 8b:["/webhooks"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 8c:["/webhooks/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 8d:["/webhooks/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 8e:["/webhooks/{id}"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 8f:["Rotate a webhook's signing secret"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 90:["$","$L3",null,{"parallelRouterKey":"children","error":"$9c","errorStyles":[],"errorScripts":[["$","script","script-0",{"src":"/_next/static/chunks/1mzl677lvmbrj.js","async":true,"nonce":"$undefined"}]],"template":["$","$L4",null,{}],"templateStyles":"$undefined","templateScripts":"$undefined","notFound":[["$","div",null,{"className":"flex flex-1 flex-col items-center justify-center gap-4 px-6 py-24 text-center","children":[["$","div",null,{"className":"font-extrabold text-[clamp(64px,12vw,96px)] text-fd-foreground leading-none tabular-nums tracking-[-0.01em]","children":"404"}],["$","h1",null,{"className":"font-[Erode,Georgia,serif] font-medium text-[28px] text-fd-foreground leading-[1.1] tracking-[-0.02em]","children":"No such page."}],["$","p",null,{"className":"max-w-[440px] text-[15px] text-fd-muted-foreground","children":"Wrong address, or the page moved."}],["$","div",null,{"className":"mt-2 flex flex-wrap justify-center gap-3","children":[["$","$L9d",null,{"href":"/","className":"inline-flex h-[30px] items-center rounded-md bg-fd-primary px-2.5 font-semibold text-fd-primary-foreground text-sm hover:opacity-[.88]","children":"Go to the docs"}],["$","a",null,{"href":"https://app.millionsend.com","className":"inline-flex h-[30px] items-center rounded-md border border-fd-border bg-fd-accent px-2.5 font-semibold text-fd-foreground text-sm hover:opacity-[.88]","children":"Open the dashboard"}]]}]]}],[]],"forbidden":"$undefined","unauthorized":"$undefined"}] 9a:["$","$L9e",null,{"preloaded":{"docs":{"./public/openapi.json":{"openapi":"3.2.0","info":{"title":"MillionSend API","version":"1.0.0"},"servers":[{"url":"https://api.millionsend.com","description":"MillionSend Cloud"},{"url":"{baseUrl}","description":"Self-hosted instance","variables":{"baseUrl":{"default":"http://localhost:3001"}}}],"components":{"schemas":{"ContactIdResponse":{"type":"object","properties":{"object":{"type":"string","enum":["contact"]},"id":{"type":"string","format":"uuid"}},"required":["object","id"]},"ErrorResponse":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"}},"required":["statusCode","name","message"]},"CreateContactRequest":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"Bare email address (no display name); unique per team"},"first_name":{"type":"string","description":"First name"},"last_name":{"type":"string","description":"Last name"},"unsubscribed":{"type":"boolean","description":"Global opt-out from all marketing sends"},"properties":{"type":"object","additionalProperties":{"nullable":true},"description":"Flat map of custom properties (string or number values)"},"segments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"]},"description":"Segments to add the contact to on creation"},"topics":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"subscription":{"type":"string","enum":["opt_in","opt_out"]}},"required":["id","subscription"]},"description":"Initial per-topic subscription choices"}},"required":["email"]},"BatchGetContactsResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"email":{"type":"string"},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"created_at":{"type":"string"},"unsubscribed":{"type":"boolean"},"properties":{"type":"object","additionalProperties":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["string"]},"value":{"type":"string"}},"required":["type","value"]},{"type":"object","properties":{"type":{"type":"string","enum":["number"]},"value":{"type":"number"}},"required":["type","value"]},{"type":"object","properties":{"type":{"type":"string","enum":["date"]},"value":{"type":"string"}},"required":["type","value"]}]},"description":"Present with include=properties"},"topics":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"subscription":{"type":"string","enum":["opt_in","opt_out"],"description":"Effective choice: the contact's explicit one, else the topic's default"},"explicit":{"type":"boolean","description":"True when the contact or the API chose this; false when it is the topic's default"},"visibility":{"type":"string","enum":["public","private"],"description":"The hosted preference page lists public topics only"}},"required":["id","name","description","subscription","explicit","visibility"]},"description":"Present with include=topics"},"object":{"type":"string","enum":["contact"]}},"required":["id","email","first_name","last_name","created_at","unsubscribed","object"]},"description":"The contacts found, in request order"},"missing":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","description":"Position in the request's contacts array"},"id":{"type":"string","format":"uuid"},"email":{"type":"string"}},"required":["index"]},"description":"Request entries that matched no contact of the team"}},"required":["object","data","missing"]},"BatchGetContactsRequest":{"type":"object","properties":{"contacts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"email":{"type":"string","format":"email"}}},"minItems":1,"maxItems":1000,"description":"Up to 1000 contacts, each by id or by email address (matched case-insensitively)"},"include":{"type":"array","items":{"type":"string","enum":["properties","topics"]},"description":"Facets to attach to every contact returned: properties and/or topics"}},"required":["contacts"]},"BatchRemoveContactsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RemoveContactResponse"}}},"required":["data"]},"RemoveContactResponse":{"type":"object","properties":{"object":{"type":"string","enum":["contact"]},"contact":{"type":"string","format":"uuid"},"deleted":{"type":"boolean","enum":[true]}},"required":["object","contact","deleted"]},"BatchRemoveContactsRequest":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"maxItems":1000,"description":"Contact ids to delete, up to 1000"},"emails":{"type":"array","items":{"type":"string","format":"email"},"minItems":1,"maxItems":1000,"description":"Contact email addresses to delete, up to 1000; matched case-insensitively"},"erase":{"type":"boolean","description":"Also erase each address from email history, event payloads and API logs (GDPR/LGPD); by default the send log is kept"}}},"BatchContactsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","enum":["contact"]},"index":{"type":"integer","description":"Position of the item in the request array"},"id":{"type":"string","format":"uuid","description":"The contact's id (the existing one for skipped/updated)"},"status":{"type":"string","enum":["created","updated","skipped"]}},"required":["object","index","id","status"]},"description":"One entry per successful item, in request order"},"counts":{"type":"object","properties":{"created":{"type":"integer"},"updated":{"type":"integer"},"skipped":{"type":"integer"},"failed":{"type":"integer"}},"required":["created","updated","skipped","failed"],"description":"Per-status totals over the request items; they sum to the request length"},"errors":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer"},"statusCode":{"type":"integer"},"name":{"type":"string"},"message":{"type":"string"}},"required":["index","statusCode","name","message"]},"description":"Permissive mode only: the failed items by request index, each with the statusCode and name strict mode would answer for it"}},"required":["data","counts"]},"BatchContactsRequest":{"type":"array","items":{"nullable":true,"description":"A CreateContactRequest item"},"minItems":1,"maxItems":1000,"description":"1-1000 CreateContactRequest items"},"ListContactsResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"email":{"type":"string"},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"created_at":{"type":"string"},"unsubscribed":{"type":"boolean"},"properties":{"type":"object","additionalProperties":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["string"]},"value":{"type":"string"}},"required":["type","value"]},{"type":"object","properties":{"type":{"type":"string","enum":["number"]},"value":{"type":"number"}},"required":["type","value"]},{"type":"object","properties":{"type":{"type":"string","enum":["date"]},"value":{"type":"string"}},"required":["type","value"]}]},"description":"Present with include=properties"},"topics":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"subscription":{"type":"string","enum":["opt_in","opt_out"],"description":"Effective choice: the contact's explicit one, else the topic's default"},"explicit":{"type":"boolean","description":"True when the contact or the API chose this; false when it is the topic's default"},"visibility":{"type":"string","enum":["public","private"],"description":"The hosted preference page lists public topics only"}},"required":["id","name","description","subscription","explicit","visibility"]},"description":"Present with include=topics"}},"required":["id","email","first_name","last_name","created_at","unsubscribed"]}},"has_more":{"type":"boolean"}},"required":["object","data","has_more"]},"GetContactResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"email":{"type":"string"},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"created_at":{"type":"string"},"unsubscribed":{"type":"boolean"},"object":{"type":"string","enum":["contact"]},"properties":{"type":"object","additionalProperties":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["string"]},"value":{"type":"string"}},"required":["type","value"]},{"type":"object","properties":{"type":{"type":"string","enum":["number"]},"value":{"type":"number"}},"required":["type","value"]},{"type":"object","properties":{"type":{"type":"string","enum":["date"]},"value":{"type":"string"}},"required":["type","value"]}]}}},"required":["id","email","first_name","last_name","created_at","unsubscribed","object","properties"]},"UpdateContactRequest":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"description":"First name; null clears it"},"last_name":{"type":"string","nullable":true,"description":"Last name; null clears it"},"unsubscribed":{"type":"boolean","description":"Global opt-out from all marketing sends"},"properties":{"type":"object","additionalProperties":{"nullable":true},"description":"Custom properties to set (merged); null removes a key"}}},"ContactPreferencesLinkResponse":{"type":"object","properties":{"object":{"type":"string","enum":["preferences_link"]},"contact":{"type":"string","format":"uuid"},"url":{"type":"string","format":"uri","description":"The contact's hosted preference page; no expiry, treat as a secret"}},"required":["object","contact","url"]},"ListContactTopicsResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"subscription":{"type":"string","enum":["opt_in","opt_out"],"description":"Effective choice: the contact's explicit one, else the topic's default"},"explicit":{"type":"boolean","description":"True when the contact or the API chose this; false when it is the topic's default"},"visibility":{"type":"string","enum":["public","private"],"description":"The hosted preference page lists public topics only"}},"required":["id","name","description","subscription","explicit","visibility"]}},"has_more":{"type":"boolean","enum":[false]}},"required":["object","data","has_more"]},"UpdateContactTopicsResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"]},"UpdateContactTopicsRequest":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"subscription":{"type":"string","enum":["opt_in","opt_out"]}},"required":["id","subscription"]}},"AddContactSegmentResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"]},"RemoveContactSegmentResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"audienceId":{"type":"string","format":"uuid"},"deleted":{"type":"boolean","enum":[true]}},"required":["id","audienceId","deleted"]},"GetContactPropertyResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string"},"key":{"type":"string"},"type":{"type":"string","enum":["string","number","date"],"description":"string or number, as on Resend, or date (MillionSend extension): an ISO 8601 date or date-time, or Unix time in seconds or milliseconds from 2000 to 2100"},"fallback_value":{"anyOf":[{"type":"string"},{"type":"number"},{"nullable":true}]},"object":{"type":"string","enum":["contact_property"]}},"required":["id","created_at","key","type","fallback_value","object"]},"CreateContactPropertyRequest":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":200},"type":{"type":"string","enum":["string","number","date"],"description":"string or number, as on Resend, or date (MillionSend extension): an ISO 8601 date or date-time, or Unix time in seconds or milliseconds from 2000 to 2100"},"fallback_value":{"anyOf":[{"type":"string","maxLength":1000},{"type":"number"},{"nullable":true}]}},"required":["key","type"]},"ListContactPropertiesResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string"},"key":{"type":"string"},"type":{"type":"string","enum":["string","number","date"],"description":"string or number, as on Resend, or date (MillionSend extension): an ISO 8601 date or date-time, or Unix time in seconds or milliseconds from 2000 to 2100"},"fallback_value":{"anyOf":[{"type":"string"},{"type":"number"},{"nullable":true}]}},"required":["id","created_at","key","type","fallback_value"]}},"has_more":{"type":"boolean"}},"required":["object","data","has_more"]},"ContactPropertyIdResponse":{"type":"object","properties":{"object":{"type":"string","enum":["contact_property"]},"id":{"type":"string","format":"uuid"}},"required":["object","id"]},"UpdateContactPropertyRequest":{"type":"object","properties":{"fallback_value":{"anyOf":[{"type":"string","maxLength":1000},{"type":"number"},{"nullable":true}]}}},"RemoveContactPropertyResponse":{"type":"object","properties":{"object":{"type":"string","enum":["contact_property"]},"id":{"type":"string","format":"uuid"},"deleted":{"type":"boolean","enum":[true]}},"required":["object","id","deleted"]},"SegmentResponse":{"type":"object","properties":{"object":{"type":"string","enum":["segment"]},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"filter":{"$ref":"#/components/schemas/SegmentFilter"},"created_at":{"type":"string"}},"required":["object","id","name","filter","created_at"]},"SegmentFilter":{"type":"object","nullable":true,"properties":{"match":{"type":"string","enum":["all","any"]},"conditions":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"op":{"type":"string"},"value":{"type":"string","nullable":true,"maxLength":500}},"required":["field","op","value"]},"maxItems":50}},"required":["match","conditions"]},"CreateSegmentRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1},"filter":{"$ref":"#/components/schemas/SegmentFilter"}},"required":["name"]},"ListSegmentsResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","enum":["segment"]},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"filter":{"$ref":"#/components/schemas/SegmentFilter"},"created_at":{"type":"string"}},"required":["object","id","name","filter","created_at"]}},"has_more":{"type":"boolean"}},"required":["object","data","has_more"]},"GetSegmentResponse":{"type":"object","properties":{"object":{"type":"string","enum":["segment"]},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"filter":{"$ref":"#/components/schemas/SegmentFilter"},"created_at":{"type":"string"},"contact_count":{"type":"number"}},"required":["object","id","name","filter","created_at","contact_count"]},"UpdateSegmentRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1},"filter":{"$ref":"#/components/schemas/SegmentFilter"}}},"RemoveSegmentResponse":{"type":"object","properties":{"object":{"type":"string","enum":["segment"]},"id":{"type":"string","format":"uuid"},"deleted":{"type":"boolean","enum":[true]}},"required":["object","id","deleted"]},"SendBroadcastResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"finishes_at":{"type":"string","nullable":true,"description":"When the last email is expected to go out (ISO 8601); null when unknown"},"estimated":{"type":"boolean","enum":[true],"description":"finishes_at is an estimate that moves as other sends come in"},"warning":{"type":"object","properties":{"code":{"type":"string","enum":["paced","queued_behind","warming_up","new_domain_limit"],"description":"paced: more than the capacity available now. queued_behind: other sends go first. warming_up: the sender domain's warm-up spreads the send over days, most active contacts first, or holds it while paused. new_domain_limit: the sender domain's new domain limit spreads the send over days."},"days":{"type":"integer","description":"Days the send spans; 0 while the domain's warm-up is paused"},"message":{"type":"string"}},"required":["code","days","message"]}},"required":["id"]},"CreateBroadcastRequest":{"type":"object","properties":{"name":{"type":"string","description":"Internal name shown in the dashboard"},"segment_id":{"type":"string","format":"uuid","description":"Segment to send to; omitted means every contact of the team"},"from":{"type":"string","description":"Sender, \"Name \"; the domain must be one of the team's own verified domains when the broadcast is sent: sending from an address on the shared inbox domain answers 403"},"subject":{"type":"string","minLength":1,"maxLength":998,"description":"Subject line; supports {{{FIRST_NAME|there}}} merge fields"},"html":{"type":"string","description":"HTML body; include {{{UNSUBSCRIBE_URL}}} for the opt-out link"},"text":{"type":"string","description":"Plain-text body; at least one of html/text is required"},"reply_to":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":50}],"description":"Reply-To address or list"},"preview_text":{"type":"string","description":"Inbox preview (preheader) text"},"topic_id":{"type":"string","nullable":true,"format":"uuid","description":"Topic id; only contacts subscribed to it receive the broadcast"},"send":{"type":"boolean","description":"true sends (or schedules) immediately instead of saving a draft"},"scheduled_at":{"type":"string","description":"Deliver later (requires send: true): ISO 8601 with offset or relative like \"in 1 hour\""}},"required":["from","subject"]},"ListBroadcastsResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"segment_id":{"type":"string","nullable":true,"format":"uuid"},"status":{"type":"string"},"created_at":{"type":"string"},"scheduled_at":{"type":"string","nullable":true},"sent_at":{"type":"string","nullable":true},"sent_count":{"type":"integer","nullable":true,"description":"Emails handed off so far; null before the send starts and once its emails have left the retention window"},"finishes_at":{"type":"string","nullable":true,"description":"Estimated instant the last email goes out, while the broadcast is going out; else null"}},"required":["id","name","segment_id","status","created_at","scheduled_at","sent_at","sent_count","finishes_at"]}},"has_more":{"type":"boolean"}},"required":["object","data","has_more"]},"GetBroadcastResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"segment_id":{"type":"string","nullable":true,"format":"uuid"},"status":{"type":"string"},"created_at":{"type":"string"},"scheduled_at":{"type":"string","nullable":true},"sent_at":{"type":"string","nullable":true},"sent_count":{"type":"integer","nullable":true,"description":"Emails handed off so far; null before the send starts and once its emails have left the retention window"},"finishes_at":{"type":"string","nullable":true,"description":"Estimated instant the last email goes out, while the broadcast is going out; else null"},"object":{"type":"string","enum":["broadcast"]},"from":{"type":"string"},"subject":{"type":"string"},"reply_to":{"type":"array","nullable":true,"items":{"type":"string"}},"preview_text":{"type":"string","nullable":true},"topic_id":{"type":"string","nullable":true,"format":"uuid"},"html":{"type":"string","nullable":true},"text":{"type":"string","nullable":true}},"required":["id","name","segment_id","status","created_at","scheduled_at","sent_at","sent_count","finishes_at","object","from","subject","reply_to","preview_text","topic_id","html","text"]},"BroadcastIdResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"]},"UpdateBroadcastRequest":{"type":"object","properties":{"name":{"type":"string"},"segment_id":{"type":"string","format":"uuid"},"from":{"type":"string"},"subject":{"type":"string","minLength":1,"maxLength":998},"html":{"type":"string"},"text":{"type":"string"},"reply_to":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":50}]},"preview_text":{"type":"string"},"topic_id":{"type":"string","nullable":true,"format":"uuid"}}},"RemoveBroadcastResponse":{"type":"object","properties":{"object":{"type":"string","enum":["broadcast"]},"id":{"type":"string","format":"uuid"},"deleted":{"type":"boolean","enum":[true]}},"required":["object","id","deleted"]},"SendBroadcastRequest":{"type":"object","properties":{"scheduled_at":{"type":"string","description":"Deliver later: ISO 8601 with offset or relative like \"in 1 hour\"; omitted sends now"}}},"CancelBroadcastResponse":{"type":"object","properties":{"object":{"type":"string","enum":["broadcast"]},"id":{"type":"string","format":"uuid"},"canceled_remaining":{"type":"integer","description":"Emails stopped before going out; the ones already sent are not recalled"}},"required":["object","id","canceled_remaining"]},"TopicResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string"},"default_subscription":{"type":"string","enum":["opt_in","opt_out"]},"visibility":{"type":"string","enum":["private","public"]},"created_at":{"type":"string"}},"required":["id","name","default_subscription","visibility","created_at"]},"CreateTopicRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1},"description":{"type":"string"},"default_subscription":{"type":"string","enum":["opt_in","opt_out"]},"visibility":{"type":"string","enum":["private","public"]}},"required":["name","default_subscription"]},"ListTopicsResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string"},"default_subscription":{"type":"string","enum":["opt_in","opt_out"]},"visibility":{"type":"string","enum":["private","public"]},"created_at":{"type":"string"}},"required":["id","name","default_subscription","visibility","created_at"]}},"has_more":{"type":"boolean","enum":[false]}},"required":["object","data","has_more"]},"TopicIdResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"]},"UpdateTopicRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1},"description":{"type":"string"},"visibility":{"type":"string","enum":["private","public"]}}},"RemoveTopicResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"object":{"type":"string","enum":["topic"]},"deleted":{"type":"boolean","enum":[true]}},"required":["id","object","deleted"]},"CreateDomainResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"status":{"type":"string"},"created_at":{"type":"string"},"region":{"type":"string"},"open_tracking":{"type":"boolean"},"click_tracking":{"type":"boolean"},"tracking_subdomain":{"type":"string","nullable":true},"capabilities":{"type":"object","properties":{"sending":{"type":"string","description":"enabled; on the shared row, disabled while the instance pauses sending from the shared domain"},"receiving":{"type":"string","description":"enabled while the domain receives mail; always disabled on an instance that does not"}},"required":["sending","receiving"]},"receiving_catch_all":{"type":"boolean","description":"MillionSend extension: whether mail to an address without an inbox is stored (true) or refused at RCPT (false)"},"shared":{"type":"boolean","description":"MillionSend extension: true on the team's subdomain of the shared inbox domain, a read-only row listed after the team's own domains (403 on changes) that POST /inboxes domain_id takes; false on the team's own domains"},"sending_mode":{"type":"string","enum":["open","reply_only","receive_only"],"description":"MillionSend extension, on the shared row only: what its inboxes' addresses may send. open starts conversations, reply_only replies inside their threads, receive_only sends nothing. Holds on names still apply per send: an address whose username or from_name imitates a brand, or one on an older label that does, replies only, even when the mode is open."},"sending_mode_reason":{"type":"string","nullable":true,"enum":["plan","instance",null],"description":"MillionSend extension, on the shared row only: what holds sending below open: the team's plan or the instance; null when open"},"records":{"type":"array","items":{"type":"object","properties":{"record":{"type":"string","description":"Which record this is: DKIM, SPF (the MAIL FROM MX and TXT rows), DMARC, Tracking (the branded tracking CNAME, present once a tracking subdomain is set) or Receiving (the MX inbound mail needs, present while receiving is enabled; it reads verified only when it is among the domain's lowest-numbered MX records). Only the DKIM and SPF rows gate sending."},"name":{"type":"string"},"type":{"type":"string"},"ttl":{"type":"string"},"status":{"type":"string","description":"not_started | pending | verified | failed. DKIM and SPF rows combine public DNS with the provider's verification: found in DNS but not yet confirmed reads pending, a different published value reads failed, no record reads not_started. DMARC reads verified when a policy covers the domain — its own or a parent domain's (see inherited_from) — and not_started when none does. Tracking reads verified once its CNAME resolves."},"value":{"type":"string"},"priority":{"type":"number"},"live":{"type":"string","enum":["found","missing","mismatch","unknown"],"description":"What public DNS answers for this record right now: found, missing, mismatch (a different value is published) or unknown (the lookup did not conclude). Omitted when no live check ran (the create response)."},"detail":{"type":"string","description":"One sentence explaining a row that is not verified: found but awaiting the provider, the value that is published instead, no record at the name, or which parent DMARC policy covers the domain. Omitted when there is nothing to add."},"inherited_from":{"type":"string","description":"DMARC only: the _dmarc name whose policy covers this domain when it has no record of its own (RFC 7489 organizational-domain fallback)."},"policy":{"type":"string","enum":["none","quarantine","reject"],"description":"DMARC only, alongside inherited_from: the inherited policy's p= value."}},"required":["record","name","type","ttl","status","value"]}}},"required":["id","name","status","created_at","region","open_tracking","click_tracking","tracking_subdomain","capabilities","receiving_catch_all","shared","records"]},"CreateDomainRequest":{"type":"object","properties":{"name":{"type":"string"},"region":{"type":"string","enum":["us-east-1","eu-west-1","sa-east-1","ap-northeast-1"],"description":"SES region of the identity, one of the regions this deployment serves (the values listed here; the first is the default). Any other region is rejected with 422. A domain has one region, fixed when it is added."},"custom_return_path":{"type":"string","default":"send"},"open_tracking":{"type":"boolean","description":"Inject a tracking pixel served from the tracking subdomain and record email.opened events. Off by default."},"click_tracking":{"type":"boolean","description":"Rewrite links to redirect through the tracking subdomain and record email.clicked events. Off by default."},"tracking_subdomain":{"type":"string","description":"DNS label of the branded tracking host, e.g. \"links\" for links.. Setting it adds a Tracking CNAME to records[]; links are tracked through it once that CNAME resolves. Required on MillionSend Cloud to turn tracking on."},"capabilities":{"type":"object","properties":{"sending":{"type":"string","enum":["enabled","disabled"],"description":"Only enabled is accepted: a domain of your own can't be receive-only, so disabled is a 422."},"receiving":{"type":"string","enum":["enabled","disabled"],"description":"Inbound mail for every address at the domain (a catch-all), readable at /emails/receiving and announced by the email.received webhook. Enabling needs a verified domain on an instance that receives mail, and adds a Receiving MX record to records[]. A domain that already has mailboxes is best received on a subdomain (inbound.example.com): the Receiving MX would take their mail."}},"description":"Resend's domain capabilities; omitted fields keep their value."}},"required":["name"]},"ListDomainsResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"status":{"type":"string"},"created_at":{"type":"string"},"region":{"type":"string"},"open_tracking":{"type":"boolean"},"click_tracking":{"type":"boolean"},"tracking_subdomain":{"type":"string","nullable":true},"capabilities":{"type":"object","properties":{"sending":{"type":"string","description":"enabled; on the shared row, disabled while the instance pauses sending from the shared domain"},"receiving":{"type":"string","description":"enabled while the domain receives mail; always disabled on an instance that does not"}},"required":["sending","receiving"]},"receiving_catch_all":{"type":"boolean","description":"MillionSend extension: whether mail to an address without an inbox is stored (true) or refused at RCPT (false)"},"shared":{"type":"boolean","description":"MillionSend extension: true on the team's subdomain of the shared inbox domain, a read-only row listed after the team's own domains (403 on changes) that POST /inboxes domain_id takes; false on the team's own domains"},"sending_mode":{"type":"string","enum":["open","reply_only","receive_only"],"description":"MillionSend extension, on the shared row only: what its inboxes' addresses may send. open starts conversations, reply_only replies inside their threads, receive_only sends nothing. Holds on names still apply per send: an address whose username or from_name imitates a brand, or one on an older label that does, replies only, even when the mode is open."},"sending_mode_reason":{"type":"string","nullable":true,"enum":["plan","instance",null],"description":"MillionSend extension, on the shared row only: what holds sending below open: the team's plan or the instance; null when open"}},"required":["id","name","status","created_at","region","open_tracking","click_tracking","tracking_subdomain","capabilities","receiving_catch_all","shared"]}},"has_more":{"type":"boolean"}},"required":["object","data","has_more"]},"GetDomainResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"status":{"type":"string"},"created_at":{"type":"string"},"region":{"type":"string"},"open_tracking":{"type":"boolean"},"click_tracking":{"type":"boolean"},"tracking_subdomain":{"type":"string","nullable":true},"capabilities":{"type":"object","properties":{"sending":{"type":"string","description":"enabled; on the shared row, disabled while the instance pauses sending from the shared domain"},"receiving":{"type":"string","description":"enabled while the domain receives mail; always disabled on an instance that does not"}},"required":["sending","receiving"]},"receiving_catch_all":{"type":"boolean","description":"MillionSend extension: whether mail to an address without an inbox is stored (true) or refused at RCPT (false)"},"shared":{"type":"boolean","description":"MillionSend extension: true on the team's subdomain of the shared inbox domain, a read-only row listed after the team's own domains (403 on changes) that POST /inboxes domain_id takes; false on the team's own domains"},"sending_mode":{"type":"string","enum":["open","reply_only","receive_only"],"description":"MillionSend extension, on the shared row only: what its inboxes' addresses may send. open starts conversations, reply_only replies inside their threads, receive_only sends nothing. Holds on names still apply per send: an address whose username or from_name imitates a brand, or one on an older label that does, replies only, even when the mode is open."},"sending_mode_reason":{"type":"string","nullable":true,"enum":["plan","instance",null],"description":"MillionSend extension, on the shared row only: what holds sending below open: the team's plan or the instance; null when open"},"object":{"type":"string","enum":["domain"]},"records":{"type":"array","items":{"type":"object","properties":{"record":{"type":"string","description":"Which record this is: DKIM, SPF (the MAIL FROM MX and TXT rows), DMARC, Tracking (the branded tracking CNAME, present once a tracking subdomain is set) or Receiving (the MX inbound mail needs, present while receiving is enabled; it reads verified only when it is among the domain's lowest-numbered MX records). Only the DKIM and SPF rows gate sending."},"name":{"type":"string"},"type":{"type":"string"},"ttl":{"type":"string"},"status":{"type":"string","description":"not_started | pending | verified | failed. DKIM and SPF rows combine public DNS with the provider's verification: found in DNS but not yet confirmed reads pending, a different published value reads failed, no record reads not_started. DMARC reads verified when a policy covers the domain — its own or a parent domain's (see inherited_from) — and not_started when none does. Tracking reads verified once its CNAME resolves."},"value":{"type":"string"},"priority":{"type":"number"},"live":{"type":"string","enum":["found","missing","mismatch","unknown"],"description":"What public DNS answers for this record right now: found, missing, mismatch (a different value is published) or unknown (the lookup did not conclude). Omitted when no live check ran (the create response)."},"detail":{"type":"string","description":"One sentence explaining a row that is not verified: found but awaiting the provider, the value that is published instead, no record at the name, or which parent DMARC policy covers the domain. Omitted when there is nothing to add."},"inherited_from":{"type":"string","description":"DMARC only: the _dmarc name whose policy covers this domain when it has no record of its own (RFC 7489 organizational-domain fallback)."},"policy":{"type":"string","enum":["none","quarantine","reject"],"description":"DMARC only, alongside inherited_from: the inherited policy's p= value."}},"required":["record","name","type","ttl","status","value"]}}},"required":["id","name","status","created_at","region","open_tracking","click_tracking","tracking_subdomain","capabilities","receiving_catch_all","shared","object","records"]},"UpdateDomainRequest":{"type":"object","properties":{"click_tracking":{"type":"boolean","description":"Rewrite links to redirect through the tracking subdomain and record email.clicked events. Off by default."},"open_tracking":{"type":"boolean","description":"Inject a tracking pixel served from the tracking subdomain and record email.opened events. Off by default."},"tracking_subdomain":{"type":"string","nullable":true,"description":"DNS label of the branded tracking host, e.g. \"links\" for links.. Setting it adds a Tracking CNAME to records[]; links are tracked through it once that CNAME resolves. Required on MillionSend Cloud to turn tracking on. Empty string or null clears it."},"tls":{"nullable":true},"capabilities":{"type":"object","properties":{"sending":{"type":"string","enum":["enabled","disabled"],"description":"Only enabled is accepted: a domain of your own can't be receive-only, so disabled is a 422."},"receiving":{"type":"string","enum":["enabled","disabled"],"description":"Inbound mail for every address at the domain (a catch-all), readable at /emails/receiving and announced by the email.received webhook. Enabling needs a verified domain on an instance that receives mail, and adds a Receiving MX record to records[]. A domain that already has mailboxes is best received on a subdomain (inbound.example.com): the Receiving MX would take their mail."}},"description":"Resend's domain capabilities; omitted fields keep their value."},"receiving_catch_all":{"type":"boolean","description":"MillionSend extension: store mail to addresses without an inbox (true) or refuse it at RCPT (false). Turning it on needs receiving enabled and, on MillionSend Cloud, a paid plan."}}},"RemoveDomainResponse":{"type":"object","properties":{"object":{"type":"string","enum":["domain"]},"id":{"type":"string","format":"uuid"},"deleted":{"type":"boolean","enum":[true]}},"required":["object","id","deleted"]},"CreateApiKeyResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"token":{"type":"string"}},"required":["id","token"]},"CreateApiKeyRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"permission":{"type":"string","enum":["full_access","sending_access"],"default":"full_access"},"domain_id":{"type":"string","nullable":true,"format":"uuid","description":"Restricts the key to sending from this one verified domain of the team: a GET /domains row with shared: false. Omitted or null, the key inherits the calling key's scope: all domains, or the calling key's domain if it is domain-scoped. A domain-scoped calling key cannot name any other domain (403 restricted_api_key)."},"inbox_id":{"type":"string","nullable":true,"format":"uuid","description":"MillionSend extension: restricts the key to one inbox of the team. It reads that inbox's threads, drafts and received mail and sends only from its address; every other route answers 403 restricted_api_key. Needs full_access, can't be combined with domain_id, and an inbox holds at most 5 active keys (outside the team's 25)."}},"required":["name"]},"ListApiKeysResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"created_at":{"type":"string"},"last_used_at":{"type":"string","nullable":true},"inbox_id":{"type":"string","nullable":true,"format":"uuid","description":"MillionSend extension: the one inbox the key is restricted to, or null"}},"required":["id","name","created_at","last_used_at","inbox_id"]}},"has_more":{"type":"boolean"}},"required":["object","data","has_more"]},"RemoveApiKeyResponse":{"type":"object","properties":{"object":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"deleted":{"type":"boolean","enum":[true]}},"required":["object","id","deleted"]},"CreateWebhookResponse":{"type":"object","properties":{"object":{"type":"string","enum":["webhook"]},"id":{"type":"string","format":"uuid"},"signing_secret":{"type":"string"}},"required":["object","id","signing_secret"]},"CreateWebhookRequest":{"type":"object","properties":{"endpoint":{"type":"string","maxLength":2048,"format":"uri"},"events":{"type":"array","items":{"type":"string","enum":["email.scheduled","email.sent","email.delivered","email.delivery_delayed","email.bounced","email.complained","email.failed","email.suppressed","email.opened","email.clicked","email.prefetched","email.received","deliverability.warning","deliverability.paused","quota.warning","quota.reached","quota.paused","contact.created","contact.updated","contact.deleted","contact.unsubscribed","contact.resubscribed","contact.topic_opt_in","contact.topic_opt_out","suppression.added","suppression.removed","inbox.created","inbox.updated","inbox.deleted","inbox.expired","inbox.thread.created","inbox.thread.folder.updated","inbox.thread.labels.updated","inbox.email.received","inbox.email.sent","inbox.email.quarantined","inbox.draft.created","inbox.draft.updated","inbox.draft.sent","inbox.draft.deleted"]},"minItems":1},"inbox_ids":{"type":"array","nullable":true,"items":{"type":"string","format":"uuid"},"maxItems":100,"description":"MillionSend extension: inbox events and email.received reach this endpoint only for these inboxes of the team (at most 100). null means every inbox. Omitted: every inbox."},"signing_secret":{"type":"string","description":"Signing secret to use instead of minting one: whsec_ followed by base64 of 24-64 bytes, the format Resend/Svix issue. An existing secret carried over keeps the receiver verifying unchanged; when omitted, a new one is generated."}},"required":["endpoint","events"]},"ListWebhooksResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"endpoint":{"type":"string"},"created_at":{"type":"string"},"status":{"type":"string","enum":["enabled","disabled"]},"events":{"type":"array","nullable":true,"items":{"type":"string"}},"inbox_ids":{"type":"array","nullable":true,"items":{"type":"string"},"description":"MillionSend extension: inbox events and email.received reach this endpoint only for these inboxes of the team (at most 100). null means every inbox."}},"required":["id","endpoint","created_at","status","events","inbox_ids"]}},"has_more":{"type":"boolean"}},"required":["object","data","has_more"]},"GetWebhookResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"endpoint":{"type":"string"},"created_at":{"type":"string"},"status":{"type":"string","enum":["enabled","disabled"]},"events":{"type":"array","nullable":true,"items":{"type":"string"}},"inbox_ids":{"type":"array","nullable":true,"items":{"type":"string"},"description":"MillionSend extension: inbox events and email.received reach this endpoint only for these inboxes of the team (at most 100). null means every inbox."},"object":{"type":"string","enum":["webhook"]},"signing_secret":{"type":"string","description":"Not returned to a team member's MCP call; the dashboard shows members only its last 4 characters"},"previous_secret_expires_at":{"type":"string","nullable":true,"description":"While set, deliveries are also signed with the secret this one replaced (a rotation's overlap window)"}},"required":["id","endpoint","created_at","status","events","inbox_ids","object","previous_secret_expires_at"]},"RotateWebhookSecretResponse":{"type":"object","properties":{"object":{"type":"string","enum":["webhook"]},"id":{"type":"string","format":"uuid"},"signing_secret":{"type":"string"},"previous_secret_expires_at":{"type":"string","nullable":true}},"required":["object","id","signing_secret","previous_secret_expires_at"]},"RotateWebhookSecretRequest":{"type":"object","properties":{"signing_secret":{"type":"string","description":"New secret to sign with: whsec_ followed by base64 of 24-64 bytes. Omit to mint one."},"overlap_hours":{"type":"integer","minimum":0,"maximum":72,"description":"Hours the previous secret keeps signing alongside the new one (default 24, max 72). Every delivery in the window carries both signatures, so a receiver holding either verifies; 0 drops the old secret at once."}}},"WebhookIdResponse":{"type":"object","properties":{"object":{"type":"string","enum":["webhook"]},"id":{"type":"string","format":"uuid"}},"required":["object","id"]},"UpdateWebhookRequest":{"type":"object","properties":{"endpoint":{"type":"string","maxLength":2048,"format":"uri"},"events":{"type":"array","items":{"type":"string","enum":["email.scheduled","email.sent","email.delivered","email.delivery_delayed","email.bounced","email.complained","email.failed","email.suppressed","email.opened","email.clicked","email.prefetched","email.received","deliverability.warning","deliverability.paused","quota.warning","quota.reached","quota.paused","contact.created","contact.updated","contact.deleted","contact.unsubscribed","contact.resubscribed","contact.topic_opt_in","contact.topic_opt_out","suppression.added","suppression.removed","inbox.created","inbox.updated","inbox.deleted","inbox.expired","inbox.thread.created","inbox.thread.folder.updated","inbox.thread.labels.updated","inbox.email.received","inbox.email.sent","inbox.email.quarantined","inbox.draft.created","inbox.draft.updated","inbox.draft.sent","inbox.draft.deleted"]},"minItems":1},"status":{"type":"string","enum":["enabled","disabled"]},"inbox_ids":{"type":"array","nullable":true,"items":{"type":"string","format":"uuid"},"maxItems":100,"description":"MillionSend extension: inbox events and email.received reach this endpoint only for these inboxes of the team (at most 100). null means every inbox. Omitted: unchanged."}}},"RemoveWebhookResponse":{"type":"object","properties":{"object":{"type":"string","enum":["webhook"]},"id":{"type":"string","format":"uuid"},"deleted":{"type":"boolean","enum":[true]}},"required":["object","id","deleted"]},"BatchAddSuppressionsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SuppressionIdResponse"}}},"required":["data"]},"SuppressionIdResponse":{"type":"object","properties":{"object":{"type":"string","enum":["suppression"]},"id":{"type":"string","format":"uuid"}},"required":["object","id"]},"BatchAddSuppressionsRequest":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string","format":"email"},"minItems":1,"maxItems":1000,"description":"Addresses to block, up to 1000; duplicates collapse"},"origin":{"type":"string","enum":["bounce","complaint","manual","unsubscribe"],"description":"Origin recorded on rows this request creates (default manual): bounce, complaint, manual or unsubscribe; an address already suppressed keeps its origin"}},"required":["emails"]},"BatchRemoveSuppressionsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RemoveSuppressionResponse"}}},"required":["data"]},"RemoveSuppressionResponse":{"type":"object","properties":{"object":{"type":"string","enum":["suppression"]},"id":{"type":"string","format":"uuid"},"deleted":{"type":"boolean","enum":[true]}},"required":["object","id","deleted"]},"BatchRemoveSuppressionsRequest":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string","format":"email"},"minItems":1,"maxItems":1000,"description":"Addresses to unblock, up to 1000"},"ids":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"maxItems":1000,"description":"Suppression ids to remove, up to 1000"}}},"CreateSuppressionRequest":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"Bare email address to block; stored normalized (lowercase)"},"origin":{"type":"string","enum":["bounce","complaint","manual","unsubscribe"],"description":"Origin recorded on rows this request creates (default manual): bounce, complaint, manual or unsubscribe; an address already suppressed keeps its origin"}},"required":["email"]},"ListSuppressionsResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"email":{"type":"string"},"origin":{"type":"string","enum":["bounce","complaint","manual","unsubscribe"]},"source_id":{"type":"string","nullable":true,"format":"uuid","description":"Email id whose bounce/complaint created the entry"},"created_at":{"type":"string"}},"required":["id","email","origin","source_id","created_at"]}},"has_more":{"type":"boolean"}},"required":["object","data","has_more"]},"GetSuppressionResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"email":{"type":"string"},"origin":{"type":"string","enum":["bounce","complaint","manual","unsubscribe"]},"source_id":{"type":"string","nullable":true,"format":"uuid","description":"Email id whose bounce/complaint created the entry"},"created_at":{"type":"string"},"object":{"type":"string","enum":["suppression"]}},"required":["id","email","origin","source_id","created_at","object"]},"TemplateIdResponse":{"type":"object","properties":{"object":{"type":"string","enum":["template"]},"id":{"type":"string","format":"uuid"}},"required":["object","id"]},"CreateTemplateRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"subject":{"type":"string","nullable":true,"maxLength":998,"description":"\"\" or null clears the subject"},"html":{"type":"string","minLength":1,"maxLength":500000,"description":"Stored as sent; the dashboard sanitizes at render"},"text":{"type":"string","nullable":true,"maxLength":500000,"description":"\"\" or null clears the text part"},"alias":{"type":"string","nullable":true,"minLength":1,"maxLength":100,"pattern":"^[A-Za-z0-9][A-Za-z0-9._-]*$","description":"Case-sensitive handle, unique per team; GET /templates/{alias} resolves it"},"from":{"type":"string","nullable":true,"description":"Not supported yet: any value is a 422"},"reply_to":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"nullable":true}],"description":"Not supported yet: any value is a 422"},"variables":{"type":"array","items":{"nullable":true},"description":"Not supported yet: a non-empty list is a 422"}},"required":["name","html"]},"ListTemplatesResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"alias":{"type":"string","nullable":true},"status":{"type":"string","enum":["published"]},"published_at":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","name","alias","status","published_at","created_at","updated_at"]}},"has_more":{"type":"boolean"}},"required":["object","data","has_more"]},"GetTemplateResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"alias":{"type":"string","nullable":true},"status":{"type":"string","enum":["published"]},"published_at":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"object":{"type":"string","enum":["template"]},"current_version_id":{"type":"string","format":"uuid"},"from":{"nullable":true},"subject":{"type":"string","nullable":true},"reply_to":{"nullable":true},"html":{"type":"string"},"text":{"type":"string","nullable":true},"variables":{"type":"array","items":{"nullable":true},"description":"Always empty"},"has_unpublished_versions":{"type":"boolean","enum":[false]}},"required":["id","name","alias","status","published_at","created_at","updated_at","object","current_version_id","from","subject","reply_to","html","text","variables","has_unpublished_versions"]},"UpdateTemplateRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"subject":{"type":"string","nullable":true,"maxLength":998,"description":"\"\" or null clears the subject"},"html":{"type":"string","minLength":1,"maxLength":500000},"text":{"type":"string","nullable":true,"maxLength":500000},"alias":{"type":"string","nullable":true,"minLength":1,"maxLength":100,"pattern":"^[A-Za-z0-9][A-Za-z0-9._-]*$","description":"null clears the alias"},"from":{"type":"string","nullable":true,"description":"Not supported yet: any value is a 422"},"reply_to":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"nullable":true}],"description":"Not supported yet: any value is a 422"},"variables":{"type":"array","items":{"nullable":true},"description":"Not supported yet: a non-empty list is a 422"}}},"RemoveTemplateResponse":{"type":"object","properties":{"object":{"type":"string","enum":["template"]},"id":{"type":"string","format":"uuid"},"deleted":{"type":"boolean","enum":[true]}},"required":["object","id","deleted"]},"UsageResponse":{"type":"object","properties":{"object":{"type":"string","enum":["usage"]},"cloud":{"type":"boolean","description":"True on MillionSend Cloud, where plan limits apply"},"plan":{"type":"string","nullable":true,"enum":["free","starter","pro","scale",null],"description":"Effective plan; null self-hosted or on the instance's own (system) team"},"limits":{"type":"object","properties":{"emails_per_day":{"type":"integer","nullable":true,"description":"Daily cap (UTC day) on Free and Starter; null on monthly plans and self-hosted. On Free, every Free team created by the same person shares it"},"emails_per_month":{"type":"integer","nullable":true,"description":"Emails included per billing period on Pro and Scale; null on daily plans and self-hosted"},"domains":{"type":"integer","nullable":true,"description":"null = unlimited or self-hosted"},"contacts":{"type":"integer","nullable":true,"description":"Contacts the team may hold; null = unlimited or self-hosted"},"inboxes":{"type":"integer","nullable":true,"description":"Inboxes the team may hold at once; null = unlimited or self-hosted"}},"required":["emails_per_day","emails_per_month","domains","contacts","inboxes"]},"today":{"type":"object","properties":{"emails_sent":{"type":"integer","description":"Emails accepted so far this UTC day; on Free, by every Free team created by the same person"},"resets_at":{"type":"string","description":"Next UTC midnight, when the daily counter resets"}},"required":["emails_sent","resets_at"]},"period":{"type":"object","nullable":true,"properties":{"emails_sent":{"type":"integer","description":"Emails accepted so far this billing period"},"included":{"type":"integer","description":"Emails the plan includes per period"},"overage_enabled":{"type":"boolean","description":"Whether sends past `included` bill overage instead of being refused"},"overage_usd_per_1k":{"type":"number","description":"Overage price per 1,000 emails, in USD"},"starts_at":{"type":"string","description":"Billing period start"},"ends_at":{"type":"string","description":"Billing period end, when the counter resets"}},"required":["emails_sent","included","overage_enabled","overage_usd_per_1k","starts_at","ends_at"],"description":"Billing-period usage on monthly plans; null on daily plans and self-hosted"},"team":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"]},"app_url":{"type":"string","nullable":true,"description":"Dashboard origin, for building links; null when unset"}},"required":["object","cloud","plan","limits","today","period","team","app_url"]},"Inbox":{"type":"object","properties":{"object":{"type":"string","enum":["inbox"]},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"email_address":{"type":"string"},"domain_id":{"type":"string","format":"uuid","description":"A shared address's is its team's shared subdomain: the GET /domains row with shared: true"},"receiving_address":{"type":"string","nullable":true},"from_name":{"type":"string","nullable":true},"unread":{"type":"integer","description":"Threads with an unread message"},"drafts":{"type":"integer","description":"Unsent drafts"},"last_received":{"type":"string","nullable":true},"created_at":{"type":"string"},"kind":{"type":"string","enum":["agent","human"]},"shared":{"type":"boolean","description":"On the shared inbox domain"},"expires_at":{"type":"string","nullable":true},"quarantined":{"type":"integer","description":"Held messages not yet released"},"pending_approval":{"type":"integer","description":"Drafts waiting for a person"}},"required":["object","id","name","email_address","domain_id","receiving_address","from_name","unread","drafts","last_received","created_at","kind","shared","expires_at","quarantined","pending_approval"]},"CreateInboxRequest":{"type":"object","properties":{"email_address":{"type":"string","description":"An address on one of your verified domains; it needs receiving on unless forwarding is true. MillionSend extension: omitted, the inbox gets an address on the shared inbox domain (no DNS), named by username or random, unless domain_id names one of your domains."},"domain_id":{"type":"string","format":"uuid","description":"MillionSend extension: the id of a GET /domains row, instead of email_address. The team's subdomain of the shared domain (the row with shared: true) is the same as leaving email_address out; one of your verified domains needs username, the part before the @."},"username":{"type":"string","description":"MillionSend extension: with email_address omitted, the part before the @ of the shared-domain address, trimmed and lowercased: 1-64 letters, digits, dots, hyphens and underscores, starting and ending with a letter or digit, never cut short. Reserved names (postmaster, abuse, admin, security, support, noreply, no-reply, billing, hostmaster, webmaster, mailer-daemon, root, compared without dots, hyphens and underscores), the fwd- prefix and brand look-alikes answer 422, and one already in use 409. Where the instance reviews names, a chosen one is reviewed first: 503 with retry-after while that review is unavailable. Omitted: a random one. With a domain_id of one of your domains, it is the part before the @ there, required, under email_address's rule."},"name":{"type":"string","description":"Internal name, 1-320 characters, so any address fits. Defaults to email_address."},"from_name":{"type":"string","description":"The name recipients see, a plain name (not \"Name \"); \"\" leaves it unset. On the shared domain it may not imitate a brand, and it is reviewed like username."},"forwarding":{"type":"boolean","description":"Receive without an MX record: mail forwarded to the inbox's receiving_address lands in it"},"kind":{"type":"string","enum":["agent","human"],"description":"MillionSend extension: agent (default; threads, screening, drafts that wait for approval) or human (a team mailbox)"},"expires_in":{"type":"string","nullable":true,"description":"MillionSend extension: a lifetime counted from now, \"1h\" to \"365d\"; omitted or null, the inbox never expires. A shared-domain inbox left unused for 90 days (no mail in or out, no API calls on it) is deleted either way."},"safety":{"$ref":"#/components/schemas/InboxSafetyPatch"}}},"InboxSafetyPatch":{"type":"object","properties":{"accept_from":{"type":"string","enum":["anyone","verified","allowlist"],"description":"Who may write in: anyone; verified (DMARC-aligned senders, known threads, the allowlist); allowlist only. Mail that fails is quarantined."},"allowlist":{"type":"array","items":{"type":"string"},"maxItems":500,"description":"\"local@domain\" (exact) or \"*@domain\" (the domain and its subdomains). On the shared domain it only lets mail in"},"owner_addresses":{"type":"array","items":{"type":"string"},"maxItems":50,"description":"Owners besides the team members' login addresses; ignored on the shared domain"},"screening":{"type":"boolean","description":"Score external mail for prompt injection (agent inboxes only)"},"extract_codes":{"type":"boolean","description":"Expose extracted codes and sign-in links"},"send_policy":{"type":"string","enum":["reply_only","allowlist","open"],"description":"What the inbox may send without a person's approval. On the shared domain \"allowlist\" answers 422, and so does \"open\" unless the instance lets the team start conversations there (paid plans only)"},"require_approval":{"type":"boolean","description":"Every send waits for a person"},"private_codes":{"type":"boolean","description":"Received codes and sign-in links can't be sent on to anyone but owners"},"send_cap":{"type":"integer","nullable":true,"description":"Unattended recipients per UTC day; null: no cap. 1-50 on the shared domain"},"forward_to":{"type":"array","items":{"type":"string"},"maxItems":5,"description":"Forward every delivered message to these team member or owner addresses; team members only on the shared domain"}},"additionalProperties":false,"description":"MillionSend extension: safety rules over the kind's defaults"},"ListInboxesResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"has_more":{"type":"boolean"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"email_address":{"type":"string"},"from_name":{"type":"string","nullable":true},"unread":{"type":"integer"},"last_received":{"type":"string","nullable":true},"kind":{"type":"string","enum":["agent","human"]},"shared":{"type":"boolean"},"expires_at":{"type":"string","nullable":true}},"required":["id","name","email_address","from_name","unread","last_received","kind","shared","expires_at"]}}},"required":["object","has_more","data"]},"UpdateInboxRequest":{"type":"object","properties":{"name":{"type":"string"},"from_name":{"type":"string","description":"\"\" removes it. On the shared domain a new one may not imitate a brand, and it is reviewed first where the instance reviews names (503 with retry-after while that review is unavailable)."},"expires_in":{"type":"string","nullable":true,"description":"MillionSend extension: a new lifetime counted from now, \"1h\" to \"365d\"; null never expires"}}},"RemoveInboxResponse":{"type":"object","properties":{"object":{"type":"string","enum":["inbox"]},"id":{"type":"string","format":"uuid"},"deleted":{"type":"boolean","enum":[true]}},"required":["object","id","deleted"]},"InboxAgent":{"type":"object","properties":{"object":{"type":"string","enum":["inbox_agent"]},"instructions":{"nullable":true},"tone":{"nullable":true},"enabled_actions":{"type":"array","items":{"type":"string"},"maxItems":0}},"required":["object","instructions","tone","enabled_actions"]},"UpdateInboxAgentRequest":{"type":"object","properties":{"instructions":{"type":"string","nullable":true},"tone":{"type":"string","nullable":true},"enabled_actions":{"type":"array","items":{"type":"string"}}}},"InboxSafety":{"type":"object","properties":{"object":{"type":"string","enum":["inbox_safety"]},"inbox_id":{"type":"string","format":"uuid"},"accept_from":{"type":"string","enum":["anyone","verified","allowlist"],"description":"Who may write in: anyone; verified (DMARC-aligned senders, known threads, the allowlist); allowlist only. Mail that fails is quarantined."},"allowlist":{"type":"array","items":{"type":"string"},"maxItems":500,"description":"\"local@domain\" (exact) or \"*@domain\" (the domain and its subdomains). On the shared domain it only lets mail in"},"owner_addresses":{"type":"array","items":{"type":"string"},"maxItems":50,"description":"Owners besides the team members' login addresses; ignored on the shared domain"},"screening":{"type":"boolean","description":"Score external mail for prompt injection (agent inboxes only)"},"extract_codes":{"type":"boolean","description":"Expose extracted codes and sign-in links"},"send_policy":{"type":"string","enum":["reply_only","allowlist","open"],"description":"What the inbox may send without a person's approval. On the shared domain \"allowlist\" answers 422, and so does \"open\" unless the instance lets the team start conversations there (paid plans only)"},"require_approval":{"type":"boolean","description":"Every send waits for a person"},"private_codes":{"type":"boolean","description":"Received codes and sign-in links can't be sent on to anyone but owners"},"send_cap":{"type":"integer","nullable":true,"description":"Unattended recipients per UTC day; null: no cap. 1-50 on the shared domain"},"forward_to":{"type":"array","items":{"type":"string"},"maxItems":5,"description":"Forward every delivered message to these team member or owner addresses; team members only on the shared domain"}},"required":["object","inbox_id","accept_from","allowlist","owner_addresses","screening","extract_codes","send_policy","require_approval","private_codes","send_cap","forward_to"]},"ListInboxLabelsResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string","description":"Uppercase #RRGGBB"},"created_at":{"type":"string"}},"required":["id","name","color","created_at"]}}},"required":["object","data"]},"InboxLabel":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string","description":"Uppercase #RRGGBB"},"created_at":{"type":"string"},"object":{"type":"string","enum":["inbox_label"]}},"required":["id","name","color","created_at","object"]},"CreateInboxLabelRequest":{"type":"object","properties":{"name":{"type":"string","description":"1-64 characters, unique in the inbox regardless of case"},"color":{"type":"string","description":"#RRGGBB; a color is picked when omitted"}},"required":["name"]},"UpdateInboxLabelRequest":{"type":"object","properties":{"name":{"type":"string"},"color":{"type":"string"}}},"RemoveInboxLabelResponse":{"type":"object","properties":{"object":{"type":"string","enum":["inbox_label"]},"id":{"type":"string","format":"uuid"},"deleted":{"type":"boolean","enum":[true]}},"required":["object","id","deleted"]},"SearchInboxThreadsResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"has_more":{"type":"boolean"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"subject":{"type":"string","nullable":true},"from":{"type":"string","nullable":true},"to":{"type":"array","items":{"type":"string"}},"cc":{"type":"array","items":{"type":"string"}},"bcc":{"type":"array","items":{"type":"string"}},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string"}},"required":["id","name","color"]}},"message_count":{"type":"integer"},"has_attachment":{"type":"boolean"},"has_draft":{"type":"boolean"},"read":{"type":"boolean"},"quarantined":{"type":"integer","description":"MillionSend extension, with include_quarantined=true: messages in quarantine, not yet released; mail still being screened isn't counted. Held mail never counts as unread"},"received_at":{"type":"string"},"folder":{"type":"string","enum":["inbox","archive","spam","sent","trash"]},"matched_email_id":{"type":"string","nullable":true,"format":"uuid"},"highlights":{"type":"object","properties":{"subject":{"type":"array","items":{"type":"string"}},"from":{"type":"array","items":{"type":"string"}},"to":{"type":"array","items":{"type":"string"}},"cc":{"type":"array","items":{"type":"string"}},"bcc":{"type":"array","items":{"type":"string"}}},"description":"Fragments with **match** markers; only keys that matched; {} without query"}},"required":["id","subject","from","to","cc","bcc","labels","message_count","has_attachment","has_draft","read","received_at","folder","matched_email_id","highlights"]}}},"required":["object","has_more","data"]},"ListInboxThreadsResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"has_more":{"type":"boolean"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"subject":{"type":"string","nullable":true},"from":{"type":"string","nullable":true},"to":{"type":"array","items":{"type":"string"}},"cc":{"type":"array","items":{"type":"string"}},"bcc":{"type":"array","items":{"type":"string"}},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string"}},"required":["id","name","color"]}},"message_count":{"type":"integer"},"has_attachment":{"type":"boolean"},"has_draft":{"type":"boolean"},"read":{"type":"boolean"},"quarantined":{"type":"integer","description":"MillionSend extension, with include_quarantined=true: messages in quarantine, not yet released; mail still being screened isn't counted. Held mail never counts as unread"},"received_at":{"type":"string"},"folder":{"type":"string","enum":["inbox","archive","spam","sent","trash"]}},"required":["id","subject","from","to","cc","bcc","labels","message_count","has_attachment","has_draft","read","received_at","folder"]}}},"required":["object","has_more","data"]},"InboxThread":{"type":"object","properties":{"object":{"type":"string","enum":["inbox_thread"]},"id":{"type":"string","format":"uuid"},"subject":{"type":"string","nullable":true},"folder":{"type":"string","enum":["inbox","archive","spam","sent","trash"]},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string"}},"required":["id","name","color"]}},"read":{"type":"boolean"},"quarantined":{"type":"integer","description":"MillionSend extension: held messages; 0 for inbox-scoped keys"}},"required":["object","id","subject","folder","labels","read","quarantined"]},"UpdateInboxThreadRequest":{"type":"object","properties":{"read":{"type":"boolean","description":"Marks every message read or unread"},"folder":{"type":"string","enum":["inbox","archive","spam","trash"],"description":"sent is assigned, never chosen"},"label_id":{"type":"string","format":"uuid","description":"Applies this label"}}},"RemoveInboxThreadResponse":{"type":"object","properties":{"object":{"type":"string","enum":["inbox_thread"]},"id":{"type":"string","format":"uuid"},"deleted":{"type":"boolean"}},"required":["object","id","deleted"]},"ListInboxThreadEmailsResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"has_more":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/InboxThreadEmail"}}},"required":["object","has_more","data"]},"InboxThreadEmail":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"from":{"type":"string"},"to":{"type":"array","items":{"type":"string"}},"cc":{"type":"array","items":{"type":"string"}},"bcc":{"type":"array","items":{"type":"string"}},"reply_to":{"type":"array","items":{"type":"string"}},"subject":{"type":"string","nullable":true},"message_id":{"type":"string","nullable":true},"html":{"type":"string","nullable":true},"text":{"type":"string","nullable":true},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"filename":{"type":"string","nullable":true},"size":{"type":"integer","nullable":true}},"required":["id","filename","size"]}},"read":{"type":"boolean"},"received_at":{"type":"string"},"direction":{"type":"string","enum":["inbound"]},"extracted_text":{"type":"string","nullable":true,"description":"MillionSend extension: hidden text, quotes and signature removed"},"screening":{"type":"object","properties":{"verdict":{"type":"string","enum":["pending","clean","suspicious","quarantined","released"]},"sender_trust":{"type":"string","enum":["owner","allowlisted","known_thread","external","unauthenticated","failed"]},"quarantine_reason":{"type":"string","nullable":true,"enum":["failed_auth","unauthenticated_sender","not_allowlisted","injection","phishing","virus","unscreened","screening_cap",null]},"reasons":{"type":"array","items":{"type":"string"}},"injection_score":{"type":"integer","nullable":true},"phishing_score":{"type":"integer","nullable":true},"hidden_text_removed":{"type":"boolean"}},"required":["verdict","sender_trust","quarantine_reason","reasons","injection_score","phishing_score","hidden_text_removed"]},"spam_verdict":{"type":"string","nullable":true,"enum":["pass","gray","fail",null]},"virus_verdict":{"type":"string","nullable":true,"enum":["pass","fail","processing_failed",null]}},"required":["id","from","to","cc","bcc","reply_to","subject","message_id","html","text","attachments","read","received_at","direction","extracted_text","screening","spam_verdict","virus_verdict"]},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"from":{"type":"string"},"to":{"type":"array","items":{"type":"string"}},"cc":{"type":"array","items":{"type":"string"}},"bcc":{"type":"array","items":{"type":"string"}},"reply_to":{"type":"array","items":{"type":"string"}},"subject":{"type":"string","nullable":true},"message_id":{"type":"string","nullable":true},"html":{"type":"string","nullable":true},"text":{"type":"string","nullable":true},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"filename":{"type":"string","nullable":true},"size":{"type":"integer","nullable":true}},"required":["id","filename","size"]}},"read":{"type":"boolean"},"received_at":{"type":"string"},"direction":{"type":"string","enum":["outbound"]},"status":{"type":"string","description":"MillionSend extension: the email's last event"}},"required":["id","from","to","cc","bcc","reply_to","subject","message_id","html","text","attachments","read","received_at","direction","status"]}]},"ListQuarantinedEmailsResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"has_more":{"type":"boolean"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"thread_id":{"type":"string","nullable":true,"format":"uuid"},"from":{"type":"string"},"subject":{"type":"string","nullable":true},"received_at":{"type":"string"},"quarantine_reason":{"type":"string","enum":["failed_auth","unauthenticated_sender","not_allowlisted","injection","phishing","virus","unscreened","screening_cap"]},"sender_trust":{"type":"string","enum":["owner","allowlisted","known_thread","external","unauthenticated","failed"]},"injection_score":{"type":"integer","nullable":true},"phishing_score":{"type":"integer","nullable":true},"virus_signature":{"type":"string","nullable":true}},"required":["id","thread_id","from","subject","received_at","quarantine_reason","sender_trust","injection_score","phishing_score","virus_signature"]}}},"required":["object","has_more","data"]},"InboxRelease":{"type":"object","properties":{"object":{"type":"string","enum":["inbox_release"]},"inbox_id":{"type":"string","format":"uuid"},"email_id":{"type":"string","format":"uuid"},"released_at":{"type":"string"},"trusted_sender":{"type":"string","nullable":true}},"required":["object","inbox_id","email_id","released_at","trusted_sender"]},"ReleaseQuarantinedRequest":{"type":"object","properties":{"trust_sender":{"type":"boolean","description":"Also add the sender's address to the inbox allowlist"}}},"VerificationCode":{"type":"object","properties":{"object":{"type":"string","enum":["verification_code"]},"status":{"type":"string","enum":["found","none","ambiguous","timeout"]},"kind":{"type":"string","nullable":true,"enum":["otp","link",null]},"code":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"link_domain_matches_sender":{"type":"boolean","nullable":true},"email_id":{"type":"string","nullable":true,"format":"uuid"},"from":{"type":"string","nullable":true},"received_at":{"type":"string","nullable":true},"sender_trust":{"type":"string","nullable":true,"enum":["owner","allowlisted","known_thread","external","unauthenticated","failed",null]}},"required":["object","status","kind","code","url","link_domain_matches_sender","email_id","from","received_at","sender_trust"]},"InboxSentEmail":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"direction":{"type":"string","enum":["outbound"]},"from":{"type":"string"},"to":{"type":"array","items":{"type":"string"}},"cc":{"type":"array","items":{"type":"string"}},"bcc":{"type":"array","items":{"type":"string"}},"reply_to":{"type":"array","items":{"type":"string"}},"subject":{"type":"string","nullable":true},"message_id":{"type":"string","nullable":true,"description":"Always null on a send"},"html":{"type":"string","nullable":true},"text":{"type":"string","nullable":true},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"filename":{"type":"string","nullable":true},"size":{"type":"number","nullable":true}},"required":["id","filename","size"]}},"read":{"type":"boolean"},"received_at":{"type":"string"},"status":{"type":"string"},"email_id":{"type":"string","format":"uuid"},"thread_id":{"type":"string","nullable":true,"format":"uuid"},"inbox_id":{"type":"string","nullable":true,"format":"uuid"}},"required":["id","direction","from","to","cc","bcc","reply_to","subject","message_id","html","text","attachments","read","received_at","status","email_id","thread_id","inbox_id"]},"InboxDraft":{"type":"object","properties":{"object":{"type":"string","enum":["inbox_draft"]},"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["standalone","reply"]},"to":{"type":"array","nullable":true,"items":{"type":"string"}},"cc":{"type":"array","items":{"type":"string"}},"bcc":{"type":"array","items":{"type":"string"}},"subject":{"type":"string","nullable":true},"html":{"type":"string","nullable":true},"text":{"type":"string","nullable":true},"thread_id":{"type":"string","nullable":true,"format":"uuid"},"reply_to_email_id":{"type":"string","nullable":true,"format":"uuid"},"email_id":{"type":"string","nullable":true,"format":"uuid"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"status":{"type":"string","enum":["draft","pending_approval","sent","rejected","expired"]},"approval_reasons":{"type":"array","items":{"type":"string"}},"forward":{"type":"boolean"},"decided_by":{"type":"string","nullable":true},"decided_at":{"type":"string","nullable":true},"expires_at":{"type":"string","nullable":true}},"required":["object","id","type","to","cc","bcc","subject","html","text","thread_id","reply_to_email_id","email_id","created_at","updated_at","status","approval_reasons","forward","decided_by","decided_at","expires_at"]},"InboxReplyRequest":{"type":"object","properties":{"html":{"type":"string","description":"HTML body"},"text":{"type":"string","description":"Plain-text body"},"subject":{"type":"string","description":"1-2000 characters on one line; defaults to the thread subject with Re: or Fwd:"},"cc":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"maxItems":50}],"description":"An address or a list of them; \"Name

\" works too"},"bcc":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"maxItems":50}],"description":"An address or a list of them; \"Name

\" works too"},"reply_all":{"type":"boolean","description":"Also copy the message's other recipients (cc), never its bcc"},"requires_approval":{"type":"boolean","description":"MillionSend extension: hold the email as a draft that a person approves (202 with the Draft)"}}},"InboxForwardRequest":{"type":"object","properties":{"to":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"maxItems":50}],"description":"An address or a list of them; \"Name

\" works too"},"cc":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"maxItems":50}],"description":"An address or a list of them; \"Name

\" works too"},"bcc":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"maxItems":50}],"description":"An address or a list of them; \"Name

\" works too"},"html":{"type":"string","description":"HTML body"},"text":{"type":"string","description":"Plain-text body"},"subject":{"type":"string","description":"1-2000 characters on one line; defaults to the thread subject with Re: or Fwd:"},"requires_approval":{"type":"boolean","description":"MillionSend extension: hold the email as a draft that a person approves (202 with the Draft)"}},"required":["to"]},"CreateInboxDraftRequest":{"type":"object","properties":{"to":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"maxItems":50},{"nullable":true}],"description":"An address or a list of them; \"Name

\" works too"},"cc":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"maxItems":50},{"nullable":true}],"description":"An address or a list of them; \"Name

\" works too"},"bcc":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"maxItems":50},{"nullable":true}],"description":"An address or a list of them; \"Name

\" works too"},"subject":{"type":"string","nullable":true},"html":{"type":"string","nullable":true},"text":{"type":"string","nullable":true},"thread_id":{"type":"string","format":"uuid","description":"With reply_to_email_id: a reply draft in this thread"},"reply_to_email_id":{"type":"string","format":"uuid","description":"The email of the thread the draft answers"}}},"ListInboxDraftsResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"has_more":{"type":"boolean"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["standalone","reply"]},"to":{"type":"array","nullable":true,"items":{"type":"string"}},"cc":{"type":"array","items":{"type":"string"}},"bcc":{"type":"array","items":{"type":"string"}},"subject":{"type":"string","nullable":true},"snippet":{"type":"string","nullable":true},"thread_id":{"type":"string","nullable":true,"format":"uuid"},"reply_to_email_id":{"type":"string","nullable":true,"format":"uuid"},"updated_at":{"type":"string"},"status":{"type":"string","enum":["draft","pending_approval","sent","rejected","expired"]},"approval_reasons":{"type":"array","items":{"type":"string"}}},"required":["id","type","to","cc","bcc","subject","snippet","thread_id","reply_to_email_id","updated_at","status","approval_reasons"]}}},"required":["object","has_more","data"]},"UpdateInboxDraftRequest":{"type":"object","properties":{"to":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"maxItems":50},{"nullable":true}],"description":"An address or a list of them; \"Name

\" works too"},"cc":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"maxItems":50},{"nullable":true}],"description":"An address or a list of them; \"Name

\" works too"},"bcc":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"maxItems":50},{"nullable":true}],"description":"An address or a list of them; \"Name

\" works too"},"subject":{"type":"string","nullable":true},"html":{"type":"string","nullable":true},"text":{"type":"string","nullable":true}}},"DeleteInboxDraftResponse":{"type":"object","properties":{"object":{"type":"string","enum":["inbox_draft"]},"id":{"type":"string","format":"uuid"},"deleted":{"type":"boolean","enum":[true]}},"required":["object","id","deleted"]},"SendInboxDraftResponse":{"type":"object","properties":{"object":{"type":"string","enum":["inbox_draft"]},"id":{"type":"string","format":"uuid"},"thread_id":{"type":"string","nullable":true,"format":"uuid"},"email_id":{"type":"string","format":"uuid"}},"required":["object","id","thread_id","email_id"]},"ReceivedEmailSendResponse":{"type":"object","properties":{"object":{"type":"string","enum":["email"]},"id":{"type":"string","format":"uuid"},"thread_id":{"type":"string","nullable":true,"format":"uuid"},"inbox_id":{"type":"string","nullable":true,"format":"uuid"}},"required":["object","id","thread_id","inbox_id"]},"ReceivedEmailReplyRequest":{"allOf":[{"$ref":"#/components/schemas/InboxReplyRequest"},{"type":"object","properties":{"from":{"type":"string","description":"Sender on a verified team domain; defaults to the inbox address the email reached, else the first address it was received for"},"inbox_id":{"type":"string","format":"uuid","description":"The inbox to answer from, among those the email reached"}}}]},"ReceivedEmailForwardRequest":{"allOf":[{"$ref":"#/components/schemas/InboxForwardRequest"},{"type":"object","properties":{"from":{"type":"string","description":"Sender on a verified team domain; defaults to the inbox address the email reached, else the first address it was received for"},"inbox_id":{"type":"string","format":"uuid","description":"The inbox to answer from, among those the email reached"},"mode":{"type":"string","enum":["inline","attachment"],"description":"inline (default) quotes the original under the note; attachment sends it as forwarded_message.eml"}}}]},"SendEmailResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"warning":{"type":"object","properties":{"code":{"type":"string","enum":["new_domain_limit"]},"message":{"type":"string"},"sends_after":{"type":"string","description":"The earliest the email goes out by the domain's daily limit (ISO 8601)"}},"required":["code","message","sends_after"],"description":"Only on an email the new domain limit holds for later. It is still accepted and goes out on its own."}},"required":["id"]},"SendEmailRequest":{"type":"object","properties":{"from":{"type":"string","description":"Sender, \"Name \" or bare address; the domain must be verified for the team","example":"Acme "},"to":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":50}],"description":"Recipient address or list of up to 50","example":["success@simulator.amazonses.com"]},"subject":{"type":"string","minLength":1,"maxLength":998,"description":"Subject line"},"html":{"type":"string","description":"HTML body; at least one of html/text is required"},"text":{"type":"string","description":"Plain-text body; at least one of html/text is required"},"cc":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":50}],"description":"Cc address or list"},"bcc":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":50}],"description":"Bcc address or list"},"reply_to":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":50}],"description":"Reply-To address or list"},"scheduled_at":{"type":"string","description":"Deliver later: ISO 8601 with offset, or relative like \"in 2 hours\" (an ISO 8601 datetime with offset (e.g. \"2026-09-01T12:00:00Z\") or a relative time like \"in 5 mins\", \"in 2 hours\", or \"in 1 day\"); max 30 days ahead"},"tags":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"value":{"type":"string"}},"required":["name","value"]},"description":"Key/value labels attached to the email for filtering; names starting with millionsend_, in any letter case, are reserved"},"topic_id":{"type":"string","nullable":true,"format":"uuid","description":"Topic id: recipients opted out of the topic are skipped; a send to one address that is a contact also gets that contact's unsubscribe link"},"attachments":{"type":"array","items":{"type":"object","properties":{"filename":{"anyOf":[{"type":"string","minLength":1,"maxLength":1000},{"type":"boolean","enum":[false]},{"nullable":true}]},"content":{"type":"string"},"content_type":{"type":"string"},"content_id":{"type":"string","minLength":1,"maxLength":255,"description":"Inline part: the HTML shows it with

\">"},"path":{"type":"string"}}},"description":"Attachments with base64 content (no remote paths)"},"headers":{"type":"object","additionalProperties":{"type":"string"},"description":"Extra message headers (transport headers are rejected)"},"template":{"nullable":true,"description":"Not supported: any value is a 422; an email takes html and/or text"}},"required":["from","to","subject"]},"BatchEmailResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"warning":{"type":"object","properties":{"code":{"type":"string","enum":["new_domain_limit"]},"message":{"type":"string"},"sends_after":{"type":"string","description":"The earliest the email goes out by the domain's daily limit (ISO 8601)"}},"required":["code","message","sends_after"],"description":"Only on an email the new domain limit holds for later. It is still accepted and goes out on its own."}},"required":["id"]}},"errors":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer"},"message":{"type":"string"}},"required":["index","message"]}}},"required":["data"]},"BatchEmailRequest":{"type":"array","items":{"nullable":true},"minItems":1,"maxItems":100},"CancelEmailResponse":{"type":"object","properties":{"object":{"type":"string","enum":["email"]},"id":{"type":"string","format":"uuid"}},"required":["object","id"]},"UpdateEmailResponse":{"type":"object","properties":{"object":{"type":"string","enum":["email"]},"id":{"type":"string","format":"uuid"}},"required":["object","id"]},"UpdateEmailRequest":{"type":"object","properties":{"scheduled_at":{"type":"string"}},"required":["scheduled_at"]},"ListReceivedEmailsResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"has_more":{"type":"boolean"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"to":{"type":"array","items":{"type":"string"}},"from":{"type":"string","description":"Bare address from the From header; the display name is in headers.from"},"created_at":{"type":"string"},"subject":{"type":"string"},"bcc":{"type":"array","items":{"type":"string"}},"cc":{"type":"array","items":{"type":"string"}},"reply_to":{"type":"array","items":{"type":"string"}},"received_for":{"type":"array","items":{"type":"string"},"description":"The team's envelope recipients: the addresses the message was delivered to here"},"message_id":{"type":"string"},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"filename":{"type":"string","nullable":true},"content_type":{"type":"string"},"content_id":{"type":"string","nullable":true},"content_disposition":{"type":"string","nullable":true},"size":{"type":"integer"}},"required":["id","filename","content_type","content_id","content_disposition","size"]}},"inbox_id":{"type":"string","nullable":true,"format":"uuid","description":"MillionSend extension: the inbox this read is about (an inbox-scoped key's own, the inbox_id filter's, else the oldest inbox the email reached); null for mail no inbox took"},"thread_id":{"type":"string","nullable":true,"format":"uuid","description":"MillionSend extension: that inbox's thread"},"inboxes":{"type":"array","items":{"type":"object","properties":{"inbox_id":{"type":"string","format":"uuid"},"thread_id":{"type":"string","format":"uuid"},"verdict":{"type":"string","enum":["pending","clean","suspicious","quarantined","released"]}},"required":["inbox_id","thread_id","verdict"]},"description":"MillionSend extension, full access keys only: every inbox the email reached and its screening verdict there"},"spam_verdict":{"type":"string","nullable":true,"enum":["pass","gray","fail",null],"description":"MillionSend extension: the local spam score's verdict; null for mail from before it existed"},"virus_verdict":{"type":"string","nullable":true,"enum":["pass","fail","processing_failed",null],"description":"MillionSend extension: clamd's verdict (fail blocks every download for good); null when nothing scanned it"},"read":{"type":"boolean","description":"MillionSend extension, with an inbox in context: whether that inbox marked it read"},"screening":{"type":"object","properties":{"verdict":{"type":"string","enum":["pending","clean","suspicious","quarantined","released"]},"sender_trust":{"type":"string","enum":["owner","allowlisted","known_thread","external","unauthenticated","failed"]}},"required":["verdict","sender_trust"],"description":"MillionSend extension: the screening verdict and the sender's trust tier"},"extracted":{"type":"object","properties":{"kinds":{"type":"array","items":{"type":"string","enum":["code","link"]}}},"required":["kinds"],"description":"MillionSend extension: whether a verification code or sign-in link was found; the values come with GET of one email"}},"required":["id","to","from","created_at","subject","bcc","cc","reply_to","received_for","message_id","attachments","inbox_id","thread_id","spam_verdict","virus_verdict","screening","extracted"]}},"held":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"inbox_id":{"type":"string","nullable":true,"format":"uuid"},"reason":{"type":"string","enum":["pending","quarantined"]},"quarantine_reason":{"type":"string","nullable":true,"enum":["failed_auth","unauthenticated_sender","not_allowlisted","injection","phishing","virus","unscreened","screening_cap",null]},"created_at":{"type":"string"}},"required":["id","inbox_id","reason","quarantine_reason","created_at"]},"description":"MillionSend extension, with wait only: matching mail that arrived but is held (being screened or quarantined), ids and why only"}},"required":["object","has_more","data"]},"GetReceivedEmailResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"to":{"type":"array","items":{"type":"string"}},"from":{"type":"string","description":"Bare address from the From header; the display name is in headers.from"},"created_at":{"type":"string"},"subject":{"type":"string"},"bcc":{"type":"array","items":{"type":"string"}},"cc":{"type":"array","items":{"type":"string"}},"reply_to":{"type":"array","items":{"type":"string"}},"received_for":{"type":"array","items":{"type":"string"},"description":"The team's envelope recipients: the addresses the message was delivered to here"},"message_id":{"type":"string"},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"filename":{"type":"string","nullable":true},"content_type":{"type":"string"},"content_id":{"type":"string","nullable":true},"content_disposition":{"type":"string","nullable":true},"size":{"type":"integer"}},"required":["id","filename","content_type","content_id","content_disposition","size"]}},"inbox_id":{"type":"string","nullable":true,"format":"uuid","description":"MillionSend extension: the inbox this read is about (an inbox-scoped key's own, the inbox_id filter's, else the oldest inbox the email reached); null for mail no inbox took"},"thread_id":{"type":"string","nullable":true,"format":"uuid","description":"MillionSend extension: that inbox's thread"},"inboxes":{"type":"array","items":{"type":"object","properties":{"inbox_id":{"type":"string","format":"uuid"},"thread_id":{"type":"string","format":"uuid"},"verdict":{"type":"string","enum":["pending","clean","suspicious","quarantined","released"]}},"required":["inbox_id","thread_id","verdict"]},"description":"MillionSend extension, full access keys only: every inbox the email reached and its screening verdict there"},"spam_verdict":{"type":"string","nullable":true,"enum":["pass","gray","fail",null],"description":"MillionSend extension: the local spam score's verdict; null for mail from before it existed"},"virus_verdict":{"type":"string","nullable":true,"enum":["pass","fail","processing_failed",null],"description":"MillionSend extension: clamd's verdict (fail blocks every download for good); null when nothing scanned it"},"read":{"type":"boolean","description":"MillionSend extension, with an inbox in context: whether that inbox marked it read"},"screening":{"type":"object","properties":{"verdict":{"type":"string","enum":["pending","clean","suspicious","quarantined","released"]},"sender_trust":{"type":"string","enum":["owner","allowlisted","known_thread","external","unauthenticated","failed"]},"quarantine_reason":{"type":"string","nullable":true,"enum":["failed_auth","unauthenticated_sender","not_allowlisted","injection","phishing","virus","unscreened","screening_cap",null]},"reasons":{"type":"array","items":{"type":"string"}},"injection_score":{"type":"integer","nullable":true},"phishing_score":{"type":"integer","nullable":true},"hidden_text_removed":{"type":"boolean"}},"required":["verdict","sender_trust","quarantine_reason","reasons","injection_score","phishing_score","hidden_text_removed"],"description":"MillionSend extension: the screening verdict, the sender's trust tier, why it was held, the inbound judge's reasons and scores (0-100), and whether hidden text was removed from what agents read"},"spam_score":{"type":"integer","nullable":true,"description":"MillionSend extension: the local spam score, 0-100"},"virus_signature":{"type":"string","nullable":true,"description":"MillionSend extension: clamd's signature name when it failed"},"extracted_text":{"type":"string","nullable":true,"description":"MillionSend extension: what a person sees of the reply, as text with light markdown: hidden text, invisible characters, quoted history and signature taken out. null once the content retention removed it"},"extracted":{"type":"object","properties":{"kinds":{"type":"array","items":{"type":"string","enum":["code","link"]}},"code":{"type":"string","nullable":true},"link":{"type":"string","nullable":true},"link_domain_matches_sender":{"type":"boolean","nullable":true},"ambiguous":{"type":"boolean"}},"required":["kinds","code","link","link_domain_matches_sender","ambiguous"],"description":"MillionSend extension: the verification code or sign-in link, served only from delivered mail of a sender that did not fail authentication, in an inbox that extracts codes. Links are never fetched."},"object":{"type":"string","enum":["email"]},"html":{"type":"string","nullable":true},"html_format":{"type":"string","enum":["data_uri","cid"]},"text":{"type":"string","nullable":true},"headers":{"type":"object","nullable":true,"additionalProperties":{"type":"string"},"description":"Top-level headers, lowercase names; a repeated header's values joined by newlines"},"authentication":{"type":"object","properties":{"spf":{"type":"string"},"dkim":{"type":"string"},"dmarc":{"type":"string"}},"required":["spf","dkim","dmarc"],"description":"pass, fail, gray, processing_failed or unknown, checked when the message arrived"},"raw":{"type":"object","nullable":true,"properties":{"download_url":{"type":"string"},"expires_at":{"type":"string"}},"required":["download_url","expires_at"],"description":"The original RFC 822 message: a signed link valid for one hour that needs no API key. null once the content retention period removed the message."}},"required":["id","to","from","created_at","subject","bcc","cc","reply_to","received_for","message_id","attachments","inbox_id","thread_id","spam_verdict","virus_verdict","screening","spam_score","virus_signature","extracted_text","extracted","object","html","html_format","text","headers","authentication","raw"]},"DeleteReceivedEmailResponse":{"type":"object","properties":{"object":{"type":"string","enum":["email"]},"id":{"type":"string","format":"uuid"},"deleted":{"type":"boolean","enum":[true]}},"required":["object","id","deleted"]},"ListReceivedAttachmentsResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"has_more":{"type":"boolean"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"filename":{"type":"string"},"size":{"type":"integer"},"content_type":{"type":"string"},"content_disposition":{"type":"string","enum":["inline","attachment"]},"content_id":{"type":"string"},"download_url":{"type":"string","description":"Signed link to the file's bytes, valid for one hour; it needs no API key"},"expires_at":{"type":"string"}},"required":["id","size","content_type","content_disposition","download_url","expires_at"]}}},"required":["object","has_more","data"]},"GetReceivedAttachmentResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"filename":{"type":"string"},"size":{"type":"integer"},"content_type":{"type":"string"},"content_disposition":{"type":"string","enum":["inline","attachment"]},"content_id":{"type":"string"},"download_url":{"type":"string","description":"Signed link to the file's bytes, valid for one hour; it needs no API key"},"expires_at":{"type":"string"},"object":{"type":"string","enum":["attachment"]}},"required":["id","size","content_type","content_disposition","download_url","expires_at","object"]},"GetEmailResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"from":{"type":"string"},"to":{"type":"array","items":{"type":"string"}},"cc":{"type":"array","nullable":true,"items":{"type":"string"}},"bcc":{"type":"array","nullable":true,"items":{"type":"string"}},"reply_to":{"type":"array","nullable":true,"items":{"type":"string"}},"subject":{"type":"string"},"created_at":{"type":"string"},"scheduled_at":{"type":"string","nullable":true},"last_event":{"type":"string"},"queued_reason":{"type":"string","nullable":true,"enum":["new_domain_limit","warming_up","daily_quota","monthly_quota","capacity",null],"description":"Why a queued email waits: the sending domain's new domain limit or warm-up, the plan's daily or monthly quota, or sending capacity. Null when it isn't waiting."},"sends_after":{"type":"string","nullable":true,"description":"The earliest a waiting email goes out (ISO 8601). Null when no time is known, as for capacity and the warm-up."},"object":{"type":"string","enum":["email"]},"html":{"type":"string","nullable":true},"text":{"type":"string","nullable":true},"message_id":{"type":"string"},"score":{"type":"number","nullable":true}},"required":["id","from","to","cc","bcc","reply_to","subject","created_at","scheduled_at","last_event","queued_reason","sends_after","object","html","text","message_id","score"]},"EmailInsightsResponse":{"type":"object","properties":{"object":{"type":"string","enum":["email_insights"]},"email_id":{"type":"string","format":"uuid"},"score":{"type":"number","description":"Best-practice score, 0-10, one decimal"},"score_version":{"type":"integer"},"band":{"type":"string","enum":["excellent","good","needs_attention","at_risk"]},"marketing":{"type":"boolean"},"html_size_bytes":{"type":"integer","nullable":true},"computed_at":{"type":"string"},"checks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Check id from the @millionsend/core check catalog"},"severity":{"type":"string","enum":["critical","major","minor","info"]},"status":{"type":"string","enum":["pass","fail","passed_by_design","not_applicable","unknown"]},"penalty":{"type":"number","description":"Points deducted from the score; 0 unless status is fail"},"detail":{"type":"object","additionalProperties":{"nullable":true}}},"required":["id","severity","status","penalty"]}}},"required":["object","email_id","score","score_version","band","marketing","html_size_bytes","computed_at","checks"]},"DeliverabilityResponse":{"type":"object","properties":{"object":{"type":"string","enum":["deliverability"]},"score":{"type":"number","nullable":true},"band":{"type":"string","nullable":true,"enum":["excellent","good","needs_attention","at_risk",null]},"content_score":{"type":"number","nullable":true},"outcome_score":{"type":"number","nullable":true},"complaint_rate":{"type":"number"},"hard_bounce_rate":{"type":"number"},"emails_sent":{"type":"integer"},"scored_recipients":{"type":"integer"},"window_days":{"type":"integer"},"insufficient_outcome_data":{"type":"boolean"},"guardrail_status":{"type":"string","enum":["ok","warning","paused"]},"score_version":{"type":"integer"}},"required":["object","score","band","content_score","outcome_score","complaint_rate","hard_bounce_rate","emails_sent","scored_recipients","window_days","insufficient_outcome_data","guardrail_status","score_version"]},"ListEmailsResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"from":{"type":"string"},"to":{"type":"array","items":{"type":"string"}},"cc":{"type":"array","nullable":true,"items":{"type":"string"}},"bcc":{"type":"array","nullable":true,"items":{"type":"string"}},"reply_to":{"type":"array","nullable":true,"items":{"type":"string"}},"subject":{"type":"string"},"created_at":{"type":"string"},"scheduled_at":{"type":"string","nullable":true},"last_event":{"type":"string"},"queued_reason":{"type":"string","nullable":true,"enum":["new_domain_limit","warming_up","daily_quota","monthly_quota","capacity",null],"description":"Why a queued email waits: the sending domain's new domain limit or warm-up, the plan's daily or monthly quota, or sending capacity. Null when it isn't waiting."},"sends_after":{"type":"string","nullable":true,"description":"The earliest a waiting email goes out (ISO 8601). Null when no time is known, as for capacity and the warm-up."}},"required":["id","from","to","cc","bcc","reply_to","subject","created_at","scheduled_at","last_event","queued_reason","sends_after"]}},"has_more":{"type":"boolean"}},"required":["object","data","has_more"]},"RemoveEmailResponse":{"type":"object","properties":{"object":{"type":"string","enum":["email"]},"id":{"type":"string","format":"uuid"},"deleted":{"type":"boolean","enum":[true]}},"required":["object","id","deleted"]}},"parameters":{}},"paths":{"/contacts":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContactRequest"}}}},"responses":{"200":{"description":"Contact created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactIdResponse"}}}},"403":{"description":"Plan limit reached","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Unknown segment or topic","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Contact already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"description":"Newest first, as on Resend, with cursor pagination: `after` takes the last id of a page and pages toward older items, `before` takes the first id and pages back toward newer ones.","parameters":[{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page size, 1-100 (default 20)"},"required":false,"description":"Page size, 1-100 (default 20)","name":"limit","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value."},"required":false,"description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.","name":"after","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after."},"required":false,"description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after.","name":"before","in":"query"},{"schema":{"type":"string","description":"MillionSend extension: comma-separated facets attached to every item — `properties` (the {type, value} map GET /contacts/{id} returns) and `topics` (the rows GET /contacts/{id}/topics returns). Omitted, each item has the Resend shape."},"required":false,"description":"MillionSend extension: comma-separated facets attached to every item — `properties` (the {type, value} map GET /contacts/{id} returns) and `topics` (the rows GET /contacts/{id}/topics returns). Omitted, each item has the Resend shape.","name":"include","in":"query"}],"responses":{"200":{"description":"Contacts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListContactsResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/contacts/batch/get":{"post":{"summary":"Read contacts in bulk","description":"MillionSend extension: returns up to 1000 contacts by id or by email address in one request, in request order, optionally with their properties and topic subscriptions. Entries that match no contact are listed under `missing` instead of failing the call. One call counts as one request against the rate limit.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchGetContactsRequest"}}}},"responses":{"200":{"description":"The contacts found, and the entries that matched none","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchGetContactsResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/contacts/batch/remove":{"post":{"summary":"Delete contacts in bulk","description":"MillionSend extension (Resend deletes contacts one at a time): deletes up to 1000 contacts by id or by email address in one request and lists the rows actually deleted; unknown ids or addresses are skipped. Emails stay in the log; `erase: true` also scrubs each address from email history, event payloads and API logs, like DELETE /contacts/{id}?erase=true.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchRemoveContactsRequest"}}}},"responses":{"200":{"description":"The contacts that were deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchRemoveContactsResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/contacts/batch":{"post":{"summary":"Create contacts in bulk","description":"MillionSend extension: creates up to 1000 contacts in one request (Resend imports contacts only via CSV). Each item is a CreateContactRequest. `on_conflict` decides what happens to an email that already belongs to a contact — `error` (default), `skip`, or `upsert`. An upsert updates `first_name`/`last_name` only when provided, merges `properties` (provided keys overwrite), adds `segments` and upserts `topics`. `unsubscribed: true` opts the contact out; `unsubscribed: false` on an already unsubscribed contact is ignored — a batch never re-subscribes anyone, that stays an explicit PATCH /contacts/{id}. The `x-batch-validation` header picks strict (default, all-or-nothing) or permissive (valid subset written, failures listed in `errors`).","parameters":[{"schema":{"type":"string","enum":["error","skip","upsert"],"default":"error","description":"What to do with an item whose email (case-insensitive) already belongs to a contact: `error` fails the item, `skip` leaves the contact untouched and reports its id, `upsert` merges the item into it. Also decides how an email repeated inside the batch is handled: `error` fails the later occurrence, `skip` keeps the first, `upsert` collapses them into one write (later scalar fields win, associations are unioned)."},"required":false,"description":"What to do with an item whose email (case-insensitive) already belongs to a contact: `error` fails the item, `skip` leaves the contact untouched and reports its id, `upsert` merges the item into it. Also decides how an email repeated inside the batch is handled: `error` fails the later occurrence, `skip` keeps the first, `upsert` collapses them into one write (later scalar fields win, associations are unioned).","name":"on_conflict","in":"query"},{"schema":{"type":"string","enum":["strict","permissive"],"description":"`strict` (default): any invalid item rejects the whole batch with that item's status and a `contacts.{index}: ` message prefix, writing nothing. `permissive`: invalid items are listed in `errors` and the valid subset is written."},"required":false,"description":"`strict` (default): any invalid item rejects the whole batch with that item's status and a `contacts.{index}: ` message prefix, writing nothing. `permissive`: invalid items are listed in `errors` and the valid subset is written.","name":"x-batch-validation","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchContactsRequest"}}}},"responses":{"200":{"description":"Batch processed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchContactsResponse"}}}},"403":{"description":"Plan limit reached (strict mode)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Unknown segment or topic (strict mode)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Contact already exists (strict mode, on_conflict=error)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/contacts/{id}":{"get":{"parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Contact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetContactResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateContactRequest"}}}},"responses":{"200":{"description":"Contact updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactIdResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"description":"Deletes the contact and its segment memberships. Its emails stay in the log; pass `erase=true` to also scrub the address from email history, event payloads and API logs.","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true","false"],"description":"MillionSend extension. `true` also erases the address from email history, event payloads and API logs (a GDPR/LGPD erasure); by default the send log is kept and ages out with the team's retention window"},"required":false,"description":"MillionSend extension. `true` also erases the address from email history, event payloads and API logs (a GDPR/LGPD erasure); by default the send log is kept and ages out with the team's retention window","name":"erase","in":"query"}],"responses":{"200":{"description":"Contact deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveContactResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/contacts/{id}/preferences-link":{"post":{"summary":"Mint a preference-center link for a contact","description":"MillionSend extension. Returns the contact's hosted preferences URL, the same page the unsubscribe links in their emails open, so a product settings screen can deep-link into it. The page lists the team's public topics and carries the global unsubscribe. The link is a signed, contact-scoped capability with no expiry: anyone holding it can change that contact's preferences, so hand it only to the contact.","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"The contact's preference page URL","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactPreferencesLinkResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"APP_BASE_URL or the encryption key is not configured","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/contacts/{id}/topics":{"get":{"parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Every topic of the team with the contact's effective subscription and whether it was chosen explicitly","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListContactTopicsResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateContactTopicsRequest"}}}},"responses":{"200":{"description":"Contact topic subscriptions updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateContactTopicsResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/contacts/{id}/segments/{segmentId}":{"post":{"parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"segmentId","in":"path"}],"responses":{"200":{"description":"Contact added to the segment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddContactSegmentResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"segmentId","in":"path"}],"responses":{"200":{"description":"Contact removed from the segment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveContactSegmentResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/audiences/{audienceId}/contacts":{"post":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"audienceId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContactRequest"}}}},"responses":{"200":{"description":"Contact created in the audience","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactIdResponse"}}}},"403":{"description":"Plan limit reached","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Contact already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/audiences/{audienceId}/contacts/{id}":{"get":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"audienceId","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Contact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetContactResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"audienceId","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateContactRequest"}}}},"responses":{"200":{"description":"Contact updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactIdResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"audienceId","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true","false"],"description":"MillionSend extension. `true` also erases the address from email history, event payloads and API logs (a GDPR/LGPD erasure); by default the send log is kept and ages out with the team's retention window"},"required":false,"description":"MillionSend extension. `true` also erases the address from email history, event payloads and API logs (a GDPR/LGPD erasure); by default the send log is kept and ages out with the team's retention window","name":"erase","in":"query"}],"responses":{"200":{"description":"Contact deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveContactResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/contact-properties":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContactPropertyRequest"}}}},"responses":{"200":{"description":"Contact property created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetContactPropertyResponse"}}}},"409":{"description":"Property already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"description":"Newest first, as on Resend, with cursor pagination: `after` takes the last id of a page and pages toward older items, `before` takes the first id and pages back toward newer ones.","parameters":[{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page size, 1-100 (default 20)"},"required":false,"description":"Page size, 1-100 (default 20)","name":"limit","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value."},"required":false,"description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.","name":"after","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after."},"required":false,"description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after.","name":"before","in":"query"}],"responses":{"200":{"description":"Contact properties","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListContactPropertiesResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/contact-properties/{id}":{"get":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Contact property","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetContactPropertyResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateContactPropertyRequest"}}}},"responses":{"200":{"description":"Contact property updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactPropertyIdResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Contact property deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveContactPropertyResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/segments":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSegmentRequest"}}}},"responses":{"200":{"description":"Segment created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"description":"Newest first, as on Resend, with cursor pagination: `after` takes the last id of a page and pages toward older items, `before` takes the first id and pages back toward newer ones.","parameters":[{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page size, 1-100 (default 20)"},"required":false,"description":"Page size, 1-100 (default 20)","name":"limit","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value."},"required":false,"description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.","name":"after","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after."},"required":false,"description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after.","name":"before","in":"query"}],"responses":{"200":{"description":"Segments","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSegmentsResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/segments/{id}":{"get":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Segment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSegmentResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSegmentRequest"}}}},"responses":{"200":{"description":"Segment updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Segment deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveSegmentResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Segment is in use","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/segments/{id}/contacts":{"get":{"description":"Newest first, as on Resend, with cursor pagination: `after` takes the last id of a page and pages toward older items, `before` takes the first id and pages back toward newer ones.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page size, 1-100 (default 20)"},"required":false,"description":"Page size, 1-100 (default 20)","name":"limit","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value."},"required":false,"description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.","name":"after","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after."},"required":false,"description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after.","name":"before","in":"query"},{"schema":{"type":"string","description":"MillionSend extension: comma-separated facets attached to every item — `properties` (the {type, value} map GET /contacts/{id} returns) and `topics` (the rows GET /contacts/{id}/topics returns). Omitted, each item has the Resend shape."},"required":false,"description":"MillionSend extension: comma-separated facets attached to every item — `properties` (the {type, value} map GET /contacts/{id} returns) and `topics` (the rows GET /contacts/{id}/topics returns). Omitted, each item has the Resend shape.","name":"include","in":"query"}],"responses":{"200":{"description":"Contacts the segment resolves to","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListContactsResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/broadcasts":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBroadcastRequest"}}}},"responses":{"200":{"description":"Broadcast created (and scheduled when send: true)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendBroadcastResponse"}}}},"400":{"description":"Broadcast state conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Restricted API key, sending paused, or a From on the shared inbox domain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"description":"Newest first, as on Resend, with cursor pagination: `after` takes the last id of a page and pages toward older items, `before` takes the first id and pages back toward newer ones.","parameters":[{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page size, 1-100 (default 20)"},"required":false,"description":"Page size, 1-100 (default 20)","name":"limit","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value."},"required":false,"description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.","name":"after","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after."},"required":false,"description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after.","name":"before","in":"query"}],"responses":{"200":{"description":"Broadcasts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBroadcastsResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/broadcasts/{id}":{"get":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Broadcast","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBroadcastResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBroadcastRequest"}}}},"responses":{"200":{"description":"Broadcast updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BroadcastIdResponse"}}}},"400":{"description":"Not a draft","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Broadcast deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveBroadcastResponse"}}}},"400":{"description":"Not a draft","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/broadcasts/{id}/send":{"post":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendBroadcastRequest"}}}},"responses":{"200":{"description":"Broadcast scheduled; finishes_at and warning say when it goes out","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendBroadcastResponse"}}}},"400":{"description":"Not a draft","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Sending paused, or a From on the shared inbox domain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/broadcasts/{id}/cancel":{"post":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Broadcast canceled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelBroadcastResponse"}}}},"400":{"description":"Not queued","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/topics":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTopicRequest"}}}},"responses":{"200":{"description":"Topic created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopicResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"responses":{"200":{"description":"Topics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTopicsResponse"}}}}}}},"/topics/{id}":{"get":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Topic","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopicResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTopicRequest"}}}},"responses":{"200":{"description":"Topic updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopicIdResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Topic deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveTopicResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Topic is in use","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/domains":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDomainRequest"}}}},"responses":{"200":{"description":"Domain created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDomainResponse"}}}},"403":{"description":"Plan domain limit reached","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Domain already added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many domains created this hour; retry-after says when to try again","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"description":"Newest first, as on Resend, with cursor pagination: `after` takes the last id of a page and pages toward older items, `before` takes the first id and pages back toward newer ones. The team's subdomain of the shared domain, when it has one, is the last row (`shared: true`).","parameters":[{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page size, 1-100 (default 20)"},"required":false,"description":"Page size, 1-100 (default 20)","name":"limit","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value."},"required":false,"description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.","name":"after","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after."},"required":false,"description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after.","name":"before","in":"query"}],"responses":{"200":{"description":"Domains","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDomainsResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/domains/{id}":{"get":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Domain with its DNS records; the team's shared subdomain has none (records: [])","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDomainResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDomainRequest"}}}},"responses":{"200":{"description":"Domain updated; full object with records","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDomainResponse"}}}},"403":{"description":"Catch-all receiving needs a paid plan, or the team's subdomain of the shared domain, which is read-only","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Another team receives mail for this domain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Domain deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveDomainResponse"}}}},"403":{"description":"Team suspended, not available for this team, or the team's subdomain of the shared domain, which is read-only","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/domains/{id}/verify":{"post":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Verification result: the domain with per-record status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDomainResponse"}}}},"403":{"description":"The team's subdomain of the shared domain, which is read-only","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api-keys":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateApiKeyRequest"}}}},"responses":{"200":{"description":"API key created; the token is returned only here","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateApiKeyResponse"}}}},"403":{"description":"Restricted API key: a sending_access key, an inbox-scoped key, or a domain_id outside the calling key's domain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"description":"Newest first, as on Resend, with cursor pagination: `after` takes the last id of a page and pages toward older items, `before` takes the first id and pages back toward newer ones.","parameters":[{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page size, 1-100 (default 20)"},"required":false,"description":"Page size, 1-100 (default 20)","name":"limit","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value."},"required":false,"description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.","name":"after","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after."},"required":false,"description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after.","name":"before","in":"query"}],"responses":{"200":{"description":"API keys (never tokens)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListApiKeysResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api-keys/{id}":{"delete":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"API key revoked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveApiKeyResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/webhooks":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookRequest"}}}},"responses":{"200":{"description":"Webhook created; signing_secret is also retrievable via GET /webhooks/{id}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"description":"Newest first, as on Resend, with cursor pagination: `after` takes the last id of a page and pages toward older items, `before` takes the first id and pages back toward newer ones.","parameters":[{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page size, 1-100 (default 20)"},"required":false,"description":"Page size, 1-100 (default 20)","name":"limit","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value."},"required":false,"description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.","name":"after","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after."},"required":false,"description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after.","name":"before","in":"query"}],"responses":{"200":{"description":"Webhooks (list rows never carry the signing secret)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWebhooksResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/webhooks/{id}":{"get":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Webhook, including its signing secret","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWebhookResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWebhookRequest"}}}},"responses":{"200":{"description":"Webhook updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookIdResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Webhook deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveWebhookResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/webhooks/{id}/rotate":{"post":{"summary":"Rotate a webhook's signing secret","description":"MillionSend extension. Mints a new signing secret (or takes the one in signing_secret) and returns it. For overlap_hours the previous secret keeps signing too: every delivery in that window carries both signatures, space-separated in webhook-signature, so the receiver can switch at any point without a gap. A second rotation inside the window replaces the previous secret.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RotateWebhookSecretRequest"}}}},"responses":{"200":{"description":"The new secret and when the previous one stops signing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RotateWebhookSecretResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/suppressions/batch/add":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchAddSuppressionsRequest"}}}},"responses":{"200":{"description":"One entry per distinct address (case-insensitive) in input order; addresses already suppressed for any reason return their existing id and keep their origin. New rows record the request's origin (bounce, complaint, manual or unsubscribe; default manual). Accepts up to 1000 addresses (Resend: 100).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchAddSuppressionsResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/suppressions/batch/remove":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchRemoveSuppressionsRequest"}}}},"responses":{"200":{"description":"Exactly one of emails or ids (up to 1000 each); lists only the rows actually removed. Rows whose address was erased (GDPR/LGPD) keep blocking sends but are hidden from the list and from lookups by email; they are reachable by id only.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchRemoveSuppressionsResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/suppressions":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSuppressionRequest"}}}},"responses":{"200":{"description":"Address blocked with the given origin (bounce, complaint, manual or unsubscribe; default manual). Idempotent: an address already suppressed for any reason (bounce, complaint, unsubscribe, manual) keeps its entry and origin, and its existing id is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuppressionIdResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"description":"Newest first, as on Resend, with cursor pagination: `after` takes the last id of a page and pages toward older items, `before` takes the first id and pages back toward newer ones.","parameters":[{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page size, 1-100 (default 20)"},"required":false,"description":"Page size, 1-100 (default 20)","name":"limit","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value."},"required":false,"description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.","name":"after","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after."},"required":false,"description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after.","name":"before","in":"query"},{"schema":{"type":"string","enum":["bounce","complaint","manual","unsubscribe"],"description":"Only suppressions of this origin: bounce, complaint, manual or unsubscribe"},"required":false,"description":"Only suppressions of this origin: bounce, complaint, manual or unsubscribe","name":"origin","in":"query"}],"responses":{"200":{"description":"Suppressions, optionally filtered by origin (bounce, complaint, manual, or the superset value unsubscribe for retained one-click opt-outs). Rows whose address was erased (GDPR/LGPD) keep blocking sends but are hidden from the list and from lookups by email; they are reachable by id only.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSuppressionsResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/suppressions/{id}":{"get":{"parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Suppression by id or by email address. Rows whose address was erased (GDPR/LGPD) keep blocking sends but are hidden from the list and from lookups by email; they are reachable by id only. An erased row reports \"[erased]\" as its email.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSuppressionResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Suppression removed, by id or by email address; the address can receive mail again. Rows whose address was erased (GDPR/LGPD) keep blocking sends but are hidden from the list and from lookups by email; they are reachable by id only.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveSuppressionResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/templates":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTemplateRequest"}}}},"responses":{"200":{"description":"Template created. Templates have no draft/publish cycle: every save is live, so status is always published.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateIdResponse"}}}},"409":{"description":"Alias already in use","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error, including from/reply_to/variables (not supported yet)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"description":"Newest first, as on Resend, with cursor pagination: `after` takes the last id of a page and pages toward older items, `before` takes the first id and pages back toward newer ones.","parameters":[{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page size, 1-100 (default 20)"},"required":false,"description":"Page size, 1-100 (default 20)","name":"limit","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value."},"required":false,"description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.","name":"after","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after."},"required":false,"description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after.","name":"before","in":"query"}],"responses":{"200":{"description":"Templates","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTemplatesResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/templates/{id}":{"get":{"parameters":[{"schema":{"type":"string","minLength":1,"description":"Template id or alias"},"required":true,"description":"Template id or alias","name":"id","in":"path"}],"responses":{"200":{"description":"Template by id or alias. Templates have no draft/publish cycle: every save is live, so status is always published. from, reply_to and variables are not supported yet and read as null, null and [].","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTemplateResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"parameters":[{"schema":{"type":"string","minLength":1,"description":"Template id or alias"},"required":true,"description":"Template id or alias","name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTemplateRequest"}}}},"responses":{"200":{"description":"Template updated (live immediately)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateIdResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Alias already in use","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error, including from/reply_to/variables (not supported yet)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"parameters":[{"schema":{"type":"string","minLength":1,"description":"Template id or alias"},"required":true,"description":"Template id or alias","name":"id","in":"path"}],"responses":{"200":{"description":"Template deleted. Broadcasts keep their own copy of the content.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveTemplateResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/templates/{id}/publish":{"post":{"parameters":[{"schema":{"type":"string","minLength":1,"description":"Template id or alias"},"required":true,"description":"Template id or alias","name":"id","in":"path"}],"responses":{"200":{"description":"No-op kept for SDK compatibility. Templates have no draft/publish cycle: every save is live, so status is always published.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateIdResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/templates/{id}/duplicate":{"post":{"parameters":[{"schema":{"type":"string","minLength":1,"description":"Template id or alias"},"required":true,"description":"Template id or alias","name":"id","in":"path"}],"responses":{"200":{"description":"Copy named \" (copy)\" with no alias; returns the new template id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateIdResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/usage":{"get":{"responses":{"200":{"description":"Effective plan, its send, domain, contact and inbox limits, today's accepted send count (UTC day) and, on a monthly plan, the billing period's usage. On Cloud's Free plan the daily count is shared by every Free team created by the same person, as the cap is. MillionSend extension; plan, limits and period are null on a self-hosted instance and on the instance's own (system) team.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageResponse"}}}},"403":{"description":"Restricted API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/inboxes":{"post":{"summary":"Create an inbox","description":"An address that receives into threads, on one of your verified domains (receiving on, or forwarding: true) or, with email_address omitted, an address on the shared inbox domain that needs no DNS: username names it, or it is random. domain_id takes a row of GET /domains instead of email_address: the team's shared subdomain, or one of your domains with username. It never expires unless expires_in says so. Returns the full inbox. MillionSend extensions: username, domain_id, kind (agent by default), expires_in and safety.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInboxRequest"}}}},"responses":{"201":{"description":"Inbox created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inbox"}}}},"403":{"description":"The plan's inbox limit, or a restricted API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The address is already used by an inbox","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many inboxes created in the last hour, or too many names reviewed or refused on the shared domain today","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"A chosen username or from_name on the shared domain can't be reviewed right now, or the team's subdomain on the shared domain is still waiting for its name review; retry-after says when to try again","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"summary":"List inboxes","description":"The team's inboxes, newest first (`after` pages toward older ones). An inbox-scoped key lists only its inbox.","parameters":[{"schema":{"type":"string","description":"Page size, 1-100 (default 20)"},"required":false,"description":"Page size, 1-100 (default 20)","name":"limit","in":"query"},{"schema":{"type":"string","description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value."},"required":false,"description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.","name":"after","in":"query"},{"schema":{"type":"string","description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after."},"required":false,"description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after.","name":"before","in":"query"},{"schema":{"type":"string","enum":["agent","human"],"description":"MillionSend extension: agent or human inboxes only"},"required":false,"description":"MillionSend extension: agent or human inboxes only","name":"kind","in":"query"}],"responses":{"200":{"description":"Inboxes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListInboxesResponse"}}}},"404":{"description":"Pagination cursor not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/inboxes/{inbox_id}":{"get":{"summary":"Retrieve an inbox","description":"By id, or by its email address (case-insensitive). An expired inbox is not found.","parameters":[{"schema":{"type":"string","description":"The inbox ID or its email address"},"required":true,"description":"The inbox ID or its email address","name":"inbox_id","in":"path"}],"responses":{"200":{"description":"Inbox","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inbox"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update an inbox","description":"Its name or from_name; MillionSend extension: expires_in, a new lifetime counted from now. On a shared-domain inbox a new from_name is reviewed first (503 while that review is unavailable). Returns the full inbox.","parameters":[{"schema":{"type":"string","format":"uuid","description":"The inbox ID"},"required":true,"description":"The inbox ID","name":"inbox_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateInboxRequest"}}}},"responses":{"200":{"description":"Inbox updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inbox"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many names reviewed or refused on the shared domain today","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"A new from_name on the shared domain can't be reviewed right now; retry-after says when to try again","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"summary":"Delete an inbox","description":"Its threads, drafts, labels and the messages only it received go with it, and its address stops receiving. Its inbox-scoped API keys are revoked. Owners and admins only.","parameters":[{"schema":{"type":"string","format":"uuid","description":"The inbox ID"},"required":true,"description":"The inbox ID","name":"inbox_id","in":"path"}],"responses":{"200":{"description":"Inbox deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveInboxResponse"}}}},"403":{"description":"Restricted API key or role","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/inboxes/{inbox_id}/agent":{"get":{"summary":"Retrieve an inbox's agent settings","description":"Resend's hosted-agent settings. MillionSend runs no agent of its own, so an inbox never has one.","parameters":[{"schema":{"type":"string","format":"uuid","description":"The inbox ID"},"required":true,"description":"The inbox ID","name":"inbox_id","in":"path"}],"responses":{"200":{"description":"No hosted agent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxAgent"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update an inbox's agent settings","description":"Always 422: MillionSend runs no hosted agent.","parameters":[{"schema":{"type":"string","format":"uuid","description":"The inbox ID"},"required":true,"description":"The inbox ID","name":"inbox_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateInboxAgentRequest"}}}},"responses":{"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Not supported","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/inboxes/{inbox_id}/safety":{"get":{"summary":"Retrieve an inbox's safety rules","description":"MillionSend extension: who may write in, screening, code extraction, what the inbox may send and where it forwards.","parameters":[{"schema":{"type":"string","format":"uuid","description":"The inbox ID"},"required":true,"description":"The inbox ID","name":"inbox_id","in":"path"}],"responses":{"200":{"description":"Safety rules","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxSafety"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update an inbox's safety rules","description":"MillionSend extension: any subset of the rules, merged over the stored ones. Owners and admins only; inbox-scoped keys and MCP can't change them.","parameters":[{"schema":{"type":"string","format":"uuid","description":"The inbox ID"},"required":true,"description":"The inbox ID","name":"inbox_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxSafetyPatch"}}}},"responses":{"200":{"description":"Safety rules","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxSafety"}}}},"403":{"description":"Restricted API key or role","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/inboxes/{inbox_id}/labels":{"get":{"summary":"List an inbox's labels","description":"Oldest first, every label (at most 100), unpaged.","parameters":[{"schema":{"type":"string","format":"uuid","description":"The inbox ID"},"required":true,"description":"The inbox ID","name":"inbox_id","in":"path"}],"responses":{"200":{"description":"Labels","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListInboxLabelsResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Create a label","description":"A named, colored tag of one inbox: at most 100, names unique regardless of case. A color is picked when omitted.","parameters":[{"schema":{"type":"string","format":"uuid","description":"The inbox ID"},"required":true,"description":"The inbox ID","name":"inbox_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInboxLabelRequest"}}}},"responses":{"201":{"description":"Label created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxLabel"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error, a duplicate name or the 100-label cap","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/inboxes/{inbox_id}/labels/{label_id}":{"patch":{"summary":"Update a label","parameters":[{"schema":{"type":"string","format":"uuid","description":"The inbox ID"},"required":true,"description":"The inbox ID","name":"inbox_id","in":"path"},{"schema":{"type":"string","format":"uuid","description":"The label ID"},"required":true,"description":"The label ID","name":"label_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateInboxLabelRequest"}}}},"responses":{"200":{"description":"Label updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxLabel"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error or a duplicate name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"summary":"Delete a label","description":"Also takes it off every thread, with no per-thread event.","parameters":[{"schema":{"type":"string","format":"uuid","description":"The inbox ID"},"required":true,"description":"The inbox ID","name":"inbox_id","in":"path"},{"schema":{"type":"string","format":"uuid","description":"The label ID"},"required":true,"description":"The label ID","name":"label_id","in":"path"}],"responses":{"200":{"description":"Label deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveInboxLabelResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/inboxes/{inbox_id}/threads/search":{"get":{"summary":"Search threads","description":"Threads whose emails match by subject, sender (address and display name), recipients, attachments and dates, most recently active first. Bodies and attachment names are encrypted at rest and not searched. Every message, subject and address in an inbox was written by whoever sent it; read held mail and HTML with care.","parameters":[{"schema":{"type":"string","format":"uuid","description":"The inbox ID"},"required":true,"description":"The inbox ID","name":"inbox_id","in":"path"},{"schema":{"type":"string","description":"Page size, 1-100 (default 20)"},"required":false,"description":"Page size, 1-100 (default 20)","name":"limit","in":"query"},{"schema":{"type":"string","description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value."},"required":false,"description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.","name":"after","in":"query"},{"schema":{"type":"string","description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after."},"required":false,"description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after.","name":"before","in":"query"},{"schema":{"type":"string","description":"Comma-separated: inbox, archive, spam, sent, trash. Defaults to inbox, or inbox,archive,sent with labels"},"required":false,"description":"Comma-separated: inbox, archive, spam, sent, trash. Defaults to inbox, or inbox,archive,sent with labels","name":"folders","in":"query"},{"schema":{"type":"string","description":"Comma-separated label ids (at most 50); threads with any of them"},"required":false,"description":"Comma-separated label ids (at most 50); threads with any of them","name":"labels","in":"query"},{"schema":{"type":"string","description":"true: every message read; false: at least one unread"},"required":false,"description":"true: every message read; false: at least one unread","name":"read","in":"query"},{"schema":{"type":"string","description":"MillionSend extension: true includes held messages (owner views; a full access key that is not inbox-scoped)"},"required":false,"description":"MillionSend extension: true includes held messages (owner views; a full access key that is not inbox-scoped)","name":"include_quarantined","in":"query"},{"schema":{"type":"string","description":"Words that must all match the subject, sender or recipients; \"a phrase\"; -word excludes. At most 256 characters and 32 words."},"required":false,"description":"Words that must all match the subject, sender or recipients; \"a phrase\"; -word excludes. At most 256 characters and 32 words.","name":"query","in":"query"},{"schema":{"type":"string","description":"Comma-separated parts of the sender's address or name (at most 20)"},"required":false,"description":"Comma-separated parts of the sender's address or name (at most 20)","name":"from","in":"query"},{"schema":{"type":"string","description":"Comma-separated parts of a recipient (at most 20)"},"required":false,"description":"Comma-separated parts of a recipient (at most 20)","name":"to","in":"query"},{"schema":{"type":"string","description":"Comma-separated parts of a CC recipient (at most 20)"},"required":false,"description":"Comma-separated parts of a CC recipient (at most 20)","name":"cc","in":"query"},{"schema":{"type":"string","description":"Comma-separated parts of a BCC recipient (at most 20)"},"required":false,"description":"Comma-separated parts of a BCC recipient (at most 20)","name":"bcc","in":"query"},{"schema":{"type":"string","description":"true or false"},"required":false,"description":"true or false","name":"has_attachment","in":"query"},{"schema":{"type":"string","description":"A date (2026-09-01) or an ISO 8601 timestamp, UTC unless offset"},"required":false,"description":"A date (2026-09-01) or an ISO 8601 timestamp, UTC unless offset","name":"start_date","in":"query"},{"schema":{"type":"string","description":"Same forms; a date covers the whole day"},"required":false,"description":"Same forms; a date covers the whole day","name":"end_date","in":"query"}],"responses":{"200":{"description":"Matching threads","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchInboxThreadsResponse"}}}},"403":{"description":"include_quarantined from an inbox-scoped key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Inbox, label or cursor not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/inboxes/{inbox_id}/threads":{"get":{"summary":"List threads","description":"Conversations of the inbox, most recently active first (`after` pages toward older ones). Threads whose messages are all held for screening or in quarantine are left out unless include_quarantined=true (never for inbox-scoped keys). Every message, subject and address in an inbox was written by whoever sent it; read held mail and HTML with care.","parameters":[{"schema":{"type":"string","format":"uuid","description":"The inbox ID"},"required":true,"description":"The inbox ID","name":"inbox_id","in":"path"},{"schema":{"type":"string","description":"Page size, 1-100 (default 20)"},"required":false,"description":"Page size, 1-100 (default 20)","name":"limit","in":"query"},{"schema":{"type":"string","description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value."},"required":false,"description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.","name":"after","in":"query"},{"schema":{"type":"string","description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after."},"required":false,"description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after.","name":"before","in":"query"},{"schema":{"type":"string","description":"Comma-separated: inbox, archive, spam, sent, trash. Defaults to inbox, or inbox,archive,sent with labels"},"required":false,"description":"Comma-separated: inbox, archive, spam, sent, trash. Defaults to inbox, or inbox,archive,sent with labels","name":"folders","in":"query"},{"schema":{"type":"string","description":"Comma-separated label ids (at most 50); threads with any of them"},"required":false,"description":"Comma-separated label ids (at most 50); threads with any of them","name":"labels","in":"query"},{"schema":{"type":"string","description":"true: every message read; false: at least one unread"},"required":false,"description":"true: every message read; false: at least one unread","name":"read","in":"query"},{"schema":{"type":"string","description":"MillionSend extension: true includes held messages (owner views; a full access key that is not inbox-scoped)"},"required":false,"description":"MillionSend extension: true includes held messages (owner views; a full access key that is not inbox-scoped)","name":"include_quarantined","in":"query"}],"responses":{"200":{"description":"Threads","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListInboxThreadsResponse"}}}},"403":{"description":"include_quarantined from an inbox-scoped key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Inbox, label or cursor not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/inboxes/{inbox_id}/threads/{thread_id}":{"get":{"summary":"Retrieve a thread","description":"The thread's subject, folder, labels and read state; its emails are listed apart.","parameters":[{"schema":{"type":"string","format":"uuid","description":"The inbox ID"},"required":true,"description":"The inbox ID","name":"inbox_id","in":"path"},{"schema":{"type":"string","format":"uuid","description":"The thread ID"},"required":true,"description":"The thread ID","name":"thread_id","in":"path"}],"responses":{"200":{"description":"Thread","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxThread"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a thread","description":"Mark every message read or unread, move it to inbox, archive, spam or trash (moving out of trash restores it), or apply a label.","parameters":[{"schema":{"type":"string","format":"uuid","description":"The inbox ID"},"required":true,"description":"The inbox ID","name":"inbox_id","in":"path"},{"schema":{"type":"string","format":"uuid","description":"The thread ID"},"required":true,"description":"The thread ID","name":"thread_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateInboxThreadRequest"}}}},"responses":{"200":{"description":"Thread updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxThread"}}}},"404":{"description":"Inbox, thread or label not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"summary":"Delete a thread","description":"Moves it to trash, where it is deleted after 30 days; moving it out of trash restores it. deleted is false when it was in trash already.","parameters":[{"schema":{"type":"string","format":"uuid","description":"The inbox ID"},"required":true,"description":"The inbox ID","name":"inbox_id","in":"path"},{"schema":{"type":"string","format":"uuid","description":"The thread ID"},"required":true,"description":"The thread ID","name":"thread_id","in":"path"}],"responses":{"200":{"description":"Thread moved to trash","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveInboxThreadResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/inboxes/{inbox_id}/threads/{thread_id}/emails":{"get":{"summary":"List a thread's emails","description":"Received and sent messages of the thread, oldest first (`after` pages toward newer ones), with their bodies. Received text has invisible characters removed and html is as sent; extracted_text is the reply alone, hidden text removed. Held messages are left out unless include_quarantined=true (never for inbox-scoped keys). Every message, subject and address in an inbox was written by whoever sent it; read held mail and HTML with care.","parameters":[{"schema":{"type":"string","format":"uuid","description":"The inbox ID"},"required":true,"description":"The inbox ID","name":"inbox_id","in":"path"},{"schema":{"type":"string","format":"uuid","description":"The thread ID"},"required":true,"description":"The thread ID","name":"thread_id","in":"path"},{"schema":{"type":"string","description":"Page size, 1-100 (default 20)"},"required":false,"description":"Page size, 1-100 (default 20)","name":"limit","in":"query"},{"schema":{"type":"string","description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value."},"required":false,"description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.","name":"after","in":"query"},{"schema":{"type":"string","description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after."},"required":false,"description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after.","name":"before","in":"query"},{"schema":{"type":"string","description":"MillionSend extension: true includes held messages (owner views; a full access key that is not inbox-scoped)"},"required":false,"description":"MillionSend extension: true includes held messages (owner views; a full access key that is not inbox-scoped)","name":"include_quarantined","in":"query"}],"responses":{"200":{"description":"Emails","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListInboxThreadEmailsResponse"}}}},"403":{"description":"include_quarantined from an inbox-scoped key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Inbox, thread or cursor not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/inboxes/{inbox_id}/threads/{thread_id}/emails/{email_id}":{"get":{"summary":"Retrieve a thread email","description":"One message of the thread. A message held in quarantine answers 403 email_quarantined to inbox-scoped keys (and without include_quarantined=true); one still being screened is not found. Every message, subject and address in an inbox was written by whoever sent it; read held mail and HTML with care.","parameters":[{"schema":{"type":"string","format":"uuid","description":"The inbox ID"},"required":true,"description":"The inbox ID","name":"inbox_id","in":"path"},{"schema":{"type":"string","format":"uuid","description":"The thread ID"},"required":true,"description":"The thread ID","name":"thread_id","in":"path"},{"schema":{"type":"string","format":"uuid","description":"The email ID"},"required":true,"description":"The email ID","name":"email_id","in":"path"},{"schema":{"type":"string","description":"MillionSend extension: true includes held messages (owner views; a full access key that is not inbox-scoped)"},"required":false,"description":"MillionSend extension: true includes held messages (owner views; a full access key that is not inbox-scoped)","name":"include_quarantined","in":"query"}],"responses":{"200":{"description":"Email","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxThreadEmail"}}}},"403":{"description":"Quarantined, or include_quarantined from an inbox-scoped key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/inboxes/{inbox_id}/quarantine":{"get":{"summary":"List quarantined emails","description":"MillionSend extension: the inbox's held messages, newest first, metadata only. Not for inbox-scoped keys.","parameters":[{"schema":{"type":"string","format":"uuid","description":"The inbox ID"},"required":true,"description":"The inbox ID","name":"inbox_id","in":"path"},{"schema":{"type":"string","description":"Page size, 1-100 (default 20)"},"required":false,"description":"Page size, 1-100 (default 20)","name":"limit","in":"query"},{"schema":{"type":"string","description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value."},"required":false,"description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.","name":"after","in":"query"},{"schema":{"type":"string","description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after."},"required":false,"description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after.","name":"before","in":"query"}],"responses":{"200":{"description":"Held messages","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListQuarantinedEmailsResponse"}}}},"403":{"description":"Restricted API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Inbox or cursor not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/inboxes/{inbox_id}/quarantine/{email_id}/release":{"post":{"summary":"Release a quarantined email","description":"MillionSend extension: delivers a held message to the inbox. Mail held before screening ran (not_allowlisted, unauthenticated_sender, failed_auth) is screened first when screening can run, and stays held when the judge scores it at 80 or more (409 held_by_screening); otherwise it is never screened again. trust_sender also adds the sender to the allowlist, only for mail held as not_allowlisted from a verified (external) sender. MCP connections release for an agent: never mail held for prompt injection, phishing, a virus or failed authentication (403 forbidden), and any other hold only once screening, run at every MCP release, scores it under 80; while screening can't run, nothing is released (503 screening_unavailable). Not for inbox-scoped keys.","parameters":[{"schema":{"type":"string","format":"uuid","description":"The inbox ID"},"required":true,"description":"The inbox ID","name":"inbox_id","in":"path"},{"schema":{"type":"string","format":"uuid","description":"The received email's ID"},"required":true,"description":"The received email's ID","name":"email_id","in":"path"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReleaseQuarantinedRequest"}}}},"responses":{"200":{"description":"Released","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxRelease"}}}},"403":{"description":"Restricted API key, trust_sender refused, or an MCP connection releasing mail held for its content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found or not quarantined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Screening held it again: it stays in quarantine","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error, or the allowlist is full","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"An MCP connection's release while screening can't run; retry-after says when to try again","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/inboxes/{inbox_id}/codes/latest":{"get":{"summary":"Retrieve the latest verification code","description":"MillionSend extension: the newest code or sign-in link in delivered mail, never from held mail or senders that failed authentication; links are never fetched. max_age counts from delivery, so a code released from quarantine counts from its release; since skips mail received at or before it, so a second sign-in waits for its own code. wait > 0 long-polls until one arrives (status timeout when none did). Always 200; status none when there is nothing.","parameters":[{"schema":{"type":"string","format":"uuid","description":"The inbox ID"},"required":true,"description":"The inbox ID","name":"inbox_id","in":"path"},{"schema":{"type":"string","description":"An exact sender address, or a domain covering itself and its subdomains"},"required":false,"description":"An exact sender address, or a domain covering itself and its subdomains","name":"from","in":"query"},{"schema":{"type":"string","description":"Seconds to wait for a code to arrive, 0-50 (default 0)"},"required":false,"description":"Seconds to wait for a code to arrive, 0-50 (default 0)","name":"wait","in":"query"},{"schema":{"type":"string","description":"How long ago the code may have reached the inbox, in seconds, 60-86400 (default 600); a released code counts from its release"},"required":false,"description":"How long ago the code may have reached the inbox, in seconds, 60-86400 (default 600); a released code counts from its release","name":"max_age","in":"query"},{"schema":{"type":"string","format":"date-time","description":"Only mail received after this ISO 8601 instant, such as the received_at of a code already used"},"required":false,"description":"Only mail received after this ISO 8601 instant, such as the received_at of a code already used","name":"since","in":"query"}],"responses":{"200":{"description":"The latest code, or a status saying why none","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationCode"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many waits at once","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/inboxes/{inbox_id}/threads/{thread_id}/emails/{email_id}/reply":{"post":{"summary":"Reply to a thread email","description":"Replies from the inbox address in the thread, with In-Reply-To and References set: to the email's Reply-To or sender (or, for an email the inbox sent, its recipients), plus everyone else on it with `reply_all`. Bcc is never copied. Accepts an `Idempotency-Key`. When the inbox's rules hold the reply (or `requires_approval` is true) it is kept as a draft for a person to approve and the answer is 202 with the Draft.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"inbox_id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"thread_id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"email_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxReplyRequest"}}}},"responses":{"200":{"description":"Sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxSentEmail"}}}},"202":{"description":"Held for approval","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxDraft"}}}},"403":{"description":"Restricted API key, the inbox's or the shared domain's rules, or held mail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Idempotency conflict, or a draft already sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"The inbox's daily send limit, or the team's daily limit for mail from the shared domain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/inboxes/{inbox_id}/threads/{thread_id}/emails/{email_id}/forward":{"post":{"summary":"Forward a thread email","description":"Forwards the email from the inbox address, quoted under \"---------- Forwarded message ---------\" with its From, Date, Subject and To, after an optional note. Its attachments go along within 10 MiB. An email that carries malware is never forwarded. Accepts an `Idempotency-Key`; a forward the inbox's rules hold answers 202 with the Draft.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"inbox_id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"thread_id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"email_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxForwardRequest"}}}},"responses":{"200":{"description":"Sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxSentEmail"}}}},"202":{"description":"Held for approval","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxDraft"}}}},"403":{"description":"Restricted API key, the inbox's or the shared domain's rules, or held mail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Idempotency conflict, or a draft already sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"The inbox's daily send limit, or the team's daily limit for mail from the shared domain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/inboxes/{inbox_id}/drafts":{"post":{"summary":"Create a draft","description":"A standalone draft, or with `thread_id` and `reply_to_email_id` a reply draft in that thread. One unsent reply draft per email: creating another answers 200 with the existing one. A reply draft copies no recipients; set `to` before sending. Nothing is sent until POST /inboxes/{inbox_id}/drafts/{draft_id}/send.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"inbox_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInboxDraftRequest"}}}},"responses":{"200":{"description":"The existing reply draft","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxDraft"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxDraft"}}}},"403":{"description":"Restricted API key, the inbox's or the shared domain's rules, or held mail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Idempotency conflict, or a draft already sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"The inbox's daily send limit, or the team's daily limit for mail from the shared domain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"summary":"List drafts","description":"Unsent drafts (draft and pending_approval), most recently updated first; `after` pages toward older ones.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"inbox_id","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page size, 1-100 (default 20)"},"required":false,"description":"Page size, 1-100 (default 20)","name":"limit","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value."},"required":false,"description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.","name":"after","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after."},"required":false,"description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after.","name":"before","in":"query"}],"responses":{"200":{"description":"Drafts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListInboxDraftsResponse"}}}},"403":{"description":"Restricted API key, the inbox's or the shared domain's rules, or held mail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Idempotency conflict, or a draft already sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"The inbox's daily send limit, or the team's daily limit for mail from the shared domain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/inboxes/{inbox_id}/drafts/{draft_id}":{"get":{"summary":"Retrieve a draft","description":"One draft with its body, also after it was sent (status sent, email_id set).","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"inbox_id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"draft_id","in":"path"}],"responses":{"200":{"description":"Draft","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxDraft"}}}},"403":{"description":"Restricted API key, the inbox's or the shared domain's rules, or held mail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Idempotency conflict, or a draft already sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"The inbox's daily send limit, or the team's daily limit for mail from the shared domain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a draft","description":"Each given field replaces the stored one; null clears it. Setting html or text replaces the whole body: the part left out becomes null. A sent draft, or one that changed during the request, answers 409. An edit by an agent sends a draft waiting for approval back to draft.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"inbox_id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"draft_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateInboxDraftRequest"}}}},"responses":{"200":{"description":"Draft","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxDraft"}}}},"403":{"description":"Restricted API key, the inbox's or the shared domain's rules, or held mail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Idempotency conflict, or a draft already sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"The inbox's daily send limit, or the team's daily limit for mail from the shared domain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"summary":"Delete a draft","description":"Removes an unsent draft; a sent one answers 409.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"inbox_id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"draft_id","in":"path"}],"responses":{"200":{"description":"Deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteInboxDraftResponse"}}}},"403":{"description":"Restricted API key, the inbox's or the shared domain's rules, or held mail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Idempotency conflict, or a draft already sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"The inbox's daily send limit, or the team's daily limit for mail from the shared domain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/inboxes/{inbox_id}/drafts/{draft_id}/send":{"post":{"summary":"Send a draft","description":"Sends the draft from the inbox address; takes no body and accepts an `Idempotency-Key`. A draft waiting for approval goes out only when a person or a team-wide full access key sends it (403 approval_required otherwise), and their send skips the inbox's rules but never the team's limits or the shared domain's rules. An agent's send of a draft runs the rules and may hold it (202).","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"inbox_id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"draft_id","in":"path"}],"responses":{"200":{"description":"Sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendInboxDraftResponse"}}}},"202":{"description":"Held for approval","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxDraft"}}}},"403":{"description":"Restricted API key, the inbox's or the shared domain's rules, or held mail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Idempotency conflict, or a draft already sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"The inbox's daily send limit, or the team's daily limit for mail from the shared domain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/inboxes/{inbox_id}/drafts/{draft_id}/reject":{"post":{"summary":"Reject a draft","description":"MillionSend extension: a person or a team-wide full access key turns down a draft waiting for approval. It stays readable with status rejected; webhooks report it deleted.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"inbox_id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"draft_id","in":"path"}],"responses":{"200":{"description":"Rejected","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxDraft"}}}},"403":{"description":"Restricted API key, the inbox's or the shared domain's rules, or held mail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Idempotency conflict, or a draft already sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"The inbox's daily send limit, or the team's daily limit for mail from the shared domain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/emails/receiving/{id}/reply":{"post":{"summary":"Reply to a received email","description":"MillionSend extension: replies server-side, threaded with In-Reply-To and References. It goes out from the inbox the email reached (`inbox_id` picks one), else from the first address it was received for, or from `from`. A reply from an inbox runs its rules and may be held as a draft (202). Accepts an `Idempotency-Key`. Needs a full access key.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceivedEmailReplyRequest"}}}},"responses":{"200":{"description":"Sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceivedEmailSendResponse"}}}},"202":{"description":"Held for approval","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxDraft"}}}},"403":{"description":"Restricted API key, the inbox's or the shared domain's rules, or held mail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Idempotency conflict, or a draft already sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"The inbox's daily send limit, or the team's daily limit for mail from the shared domain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/emails/receiving/{id}/forward":{"post":{"summary":"Forward a received email","description":"MillionSend extension: forwards server-side, inline under a note (default) or with the original attached as forwarded_message.eml (`mode: attachment`), within 10 MiB. An email that carries malware is never forwarded. Sender rules and the 202 draft answer are those of the reply. Accepts an `Idempotency-Key`. Needs a full access key.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceivedEmailForwardRequest"}}}},"responses":{"200":{"description":"Sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceivedEmailSendResponse"}}}},"202":{"description":"Held for approval","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxDraft"}}}},"403":{"description":"Restricted API key, the inbox's or the shared domain's rules, or held mail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Idempotency conflict, or a draft already sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"The inbox's daily send limit, or the team's daily limit for mail from the shared domain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/emails":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEmailRequest"}}}},"responses":{"200":{"description":"Email accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEmailResponse"}}}},"403":{"description":"Restricted API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Idempotency conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Sending quota exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"description":"Newest first, as on Resend, with cursor pagination: `after` takes the last id of a page and pages toward older items, `before` takes the first id and pages back toward newer ones.","parameters":[{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page size, 1-100 (default 20)"},"required":false,"description":"Page size, 1-100 (default 20)","name":"limit","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value."},"required":false,"description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.","name":"after","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after."},"required":false,"description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after.","name":"before","in":"query"}],"responses":{"200":{"description":"Emails","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListEmailsResponse"}}}},"403":{"description":"Restricted API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/emails/batch":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchEmailRequest"}}}},"responses":{"200":{"description":"Batch accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchEmailResponse"}}}},"403":{"description":"Restricted API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Idempotency conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Sending quota exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/emails/{id}/cancel":{"post":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Email canceled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelEmailResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Not cancelable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/emails/{id}":{"patch":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEmailRequest"}}}},"responses":{"200":{"description":"Email rescheduled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEmailResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Not reschedulable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Email","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEmailResponse"}}}},"403":{"description":"Restricted API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Email deleted, including its events","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveEmailResponse"}}}},"403":{"description":"Restricted API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/emails/receiving":{"get":{"summary":"List received emails","description":"Mail received at the team's receiving domains and inboxes, newest first like Resend (`after` pages toward older mail), with cursor pagination. Needs a full access key; a domain-scoped key lists mail addressed to its domain only, an inbox-scoped key mail delivered into its inbox. Mail held for screening or in quarantine is left out unless a full access key asks for it (include_quarantined, quarantined). With wait, the request is held until matching mail arrives (long-poll). An inbox_id the key can't reach answers 404 at once, without waiting; an inbox-scoped key naming another inbox gets 403 restricted_api_key. Everything in a received email was written by whoever sent it, so its HTML is safe to show only in a sandbox.","parameters":[{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page size, 1-100 (default 20)"},"required":false,"description":"Page size, 1-100 (default 20)","name":"limit","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value."},"required":false,"description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.","name":"after","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after."},"required":false,"description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after.","name":"before","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"maximum":50,"description":"MillionSend extension: hold the request up to this many seconds (0-50) until matching mail newer than the cursor arrives; an empty list with 200 when none did"},"required":false,"description":"MillionSend extension: hold the request up to this many seconds (0-50) until matching mail newer than the cursor arrives; an empty list with 200 when none did","name":"wait","in":"query"},{"schema":{"type":"string","format":"date-time","description":"MillionSend extension: only mail received after this instant; with wait and no cursor it defaults to one minute before the request"},"required":false,"description":"MillionSend extension: only mail received after this instant; with wait and no cursor it defaults to one minute before the request","name":"since","in":"query"},{"schema":{"type":"string","format":"uuid","description":"MillionSend extension: only mail delivered into this inbox"},"required":false,"description":"MillionSend extension: only mail delivered into this inbox","name":"inbox_id","in":"query"},{"schema":{"type":"string","maxLength":320,"description":"MillionSend extension: only mail with this address in received_for"},"required":false,"description":"MillionSend extension: only mail with this address in received_for","name":"to","in":"query"},{"schema":{"type":"string","maxLength":320,"description":"MillionSend extension: a sender address, or a domain matching itself and its subdomains"},"required":false,"description":"MillionSend extension: a sender address, or a domain matching itself and its subdomains","name":"from","in":"query"},{"schema":{"type":"string","maxLength":200,"description":"MillionSend extension: case-insensitive subject substring"},"required":false,"description":"MillionSend extension: case-insensitive subject substring","name":"subject_contains","in":"query"},{"schema":{"type":"string","enum":["true","false"],"description":"MillionSend extension, with an inbox in context (inbox_id, or an inbox-scoped key): read state in that inbox"},"required":false,"description":"MillionSend extension, with an inbox in context (inbox_id, or an inbox-scoped key): read state in that inbox","name":"unread","in":"query"},{"schema":{"type":"string","enum":["true","false"],"description":"MillionSend extension, full access keys only: list held mail too, flagged by screening"},"required":false,"description":"MillionSend extension, full access keys only: list held mail too, flagged by screening","name":"include_quarantined","in":"query"},{"schema":{"type":"string","enum":["true","false"],"description":"MillionSend extension, full access keys only: list held mail only"},"required":false,"description":"MillionSend extension, full access keys only: list held mail only","name":"quarantined","in":"query"}],"responses":{"200":{"description":"Received emails","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListReceivedEmailsResponse"}}}},"403":{"description":"Restricted API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Inbox not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many concurrent waits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/emails/receiving/{id}":{"get":{"summary":"Retrieve a received email","description":"One received email with its html, text, headers, authentication results and a signed link to the original message, plus MillionSend's screening, verdicts, the extracted read and, where allowed, its verification code or sign-in link. Needs a full access key. An inbox-scoped key or an MCP token gets 403 email_quarantined for held mail, and 404 while it is being screened. Everything in a received email was written by whoever sent it, so its HTML is safe to show only in a sandbox.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["data_uri","cid"],"description":"data_uri (default) inlines images the HTML references by cid: as data: URIs; cid leaves the cid: references, the parts being in attachments"},"required":false,"description":"data_uri (default) inlines images the HTML references by cid: as data: URIs; cid leaves the cid: references, the parts being in attachments","name":"html_format","in":"query"}],"responses":{"200":{"description":"Received email","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReceivedEmailResponse"}}}},"403":{"description":"Restricted API key, or the email is quarantined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"summary":"Delete a received email","description":"MillionSend extension: erases one received email now, its sealed content, inbox memberships and received secrets with it, and threads it leaves empty. Needs a full access key that is not scoped to an inbox; for an MCP token, the owner or admin role. Webhook payloads already sent keep their metadata until the payload retention strips them.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReceivedEmailResponse"}}}},"403":{"description":"Restricted API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/emails/receiving/{email_id}/attachments":{"get":{"summary":"List a received email's attachments","description":"The attachments and inline parts of one received email, each with a signed download link valid for one hour; all of them unless `limit` is given. Needs a full access key. The links of an email that carries malware answer 410.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"email_id","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page size, 1-100 (default 20)"},"required":false,"description":"Page size, 1-100 (default 20)","name":"limit","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value."},"required":false,"description":"Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.","name":"after","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after."},"required":false,"description":"Cursor: id of the first item of the current page; returns the previous page; same rule as after.","name":"before","in":"query"}],"responses":{"200":{"description":"Attachments","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListReceivedAttachmentsResponse"}}}},"403":{"description":"Restricted API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/emails/receiving/{email_id}/attachments/{id}":{"get":{"summary":"Retrieve a received email's attachment","description":"One attachment's metadata and a signed download link valid for one hour. Needs a full access key.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"email_id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Attachment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReceivedAttachmentResponse"}}}},"403":{"description":"Restricted API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/emails/{id}/insights":{"get":{"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Best-practice check results and score computed when the email was sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailInsightsResponse"}}}},"403":{"description":"Restricted API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/deliverability":{"get":{"responses":{"200":{"description":"Account deliverability score over the trailing 30 days","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliverabilityResponse"}}}},"403":{"description":"Restricted API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}},"proxyUrl":"$undefined"},"document":"./public/openapi.json","operations":[{"path":"/emails/{id}/cancel","method":"post"}],"showDescription":true}]

/emails/{id}/cancel

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Path Parameters

Response Body