{
  "info": {
    "name": "Mailyte API",
    "description": "The Mailyte API lets your own software do everything you can do in the Mailyte\ndashboard and webmail: send mail, manage domains and mailboxes, read delivery\nevents, run campaigns, and receive webhooks.\n\nThere are two credentials, because there are two kinds of caller.\n\nAn **organization API key** (`mk_live_…`) belongs to an organization and acts on\nits behalf — this is what your application uses. A **mailbox token** belongs to\none mailbox and acts as that person, and is what the Mailbox API takes.\n\nEvery response from the organization API is wrapped in the same envelope:\n\n```json\n{ \"message\": \"…\", \"data\": { }, \"success\": true, \"code\": 200 }\n```\n\n`data` holds the result. `success` and `code` restate the HTTP status so a client\nthat only reads the body can still tell what happened.\n\nSet the `apiKey` collection variable to your own key before sending anything.\nPath parameters are `:name` placeholders — Postman will prompt for them.",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "bearer",
    "bearer": [
      {
        "key": "token",
        "value": "{{apiKey}}",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://app.mailyte.com",
      "type": "string"
    },
    {
      "key": "apiKey",
      "value": "",
      "type": "string"
    },
    {
      "key": "mailboxBaseUrl",
      "value": "https://courier.mailyte.com",
      "type": "string"
    },
    {
      "key": "mailboxToken",
      "value": "",
      "type": "string"
    }
  ],
  "item": [
    {
      "name": "Sending",
      "description": "Submit messages for delivery, individually or in batches.",
      "item": [
        {
          "name": "Send a message",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/messages",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "messages"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"to\": [\n    \"Ada Lovelace <ada@example.com>\"\n  ],\n  \"cc\": [\n    \"accounts@acme.com\"\n  ],\n  \"from\": \"hello@yourdomain.com\",\n  \"reply_to\": \"support@yourdomain.com\",\n  \"subject\": \"Your receipt from Acme\",\n  \"html\": \"<h1>Thanks, {{first_name}}</h1><p>Your order is on its way.</p>\",\n  \"text\": \"Thanks, {{first_name}}\\nYour order is on its way.\",\n  \"variables\": {\n    \"first_name\": \"Ada\"\n  },\n  \"tags\": [\n    \"receipt\"\n  ],\n  \"headers\": {\n    \"X-Order-Id\": \"ord_1234\"\n  },\n  \"metadata\": {\n    \"order_id\": \"ord_1234\",\n    \"tier\": \"pro\"\n  },\n  \"attachments\": [\n    {\n      \"name\": \"invoice.pdf\",\n      \"content\": \"JVBERi0xLjQKJ...\",\n      \"content_type\": \"application/pdf\"\n    }\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `messages:send`\n\nSubmits one message for delivery and returns as soon as it is accepted — delivery\nitself happens asynchronously, so a `200` here means \"queued\", not \"in their inbox\".\nWatch for the outcome through [delivery events](/developer/guides/handling-delivery-events)\nor a webhook.\n\nThree things have to be true before a send will work, and they are the cause of\nalmost every first-attempt failure:\n\n1. **The domain in `from` is verified.** See [Managing domains and DNS](/developer/guides/domains-and-dns).\n2. **`from` is a verified sender** belonging to your organization. An address that\n   merely sits on a verified domain is not enough; it has to exist as a sender.\n3. **The recipient is not suppressed.** Mailyte refuses sends to addresses that have\n   bounced, complained or unsubscribed, and it refuses them *before* your own list\n   logic gets a say. A suppressed recipient returns `422` and records an\n   `email.dropped` event.\n\nProvide content either directly (`subject` plus `html` and/or `text`) or by naming a\n`template_id`. If you do both, the fields you pass win over the template's.\n`variables` are substituted in either case."
          }
        },
        {
          "name": "List scheduled messages",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/messages/scheduled",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "messages",
                "scheduled"
              ]
            },
            "description": "Required scope: `messages:send`\n\nYour scheduled messages, **soonest first** — the opposite order to every other list here,\nbecause this one is about what is about to happen and newest-first would bury the next send\nunder everything already gone.\n\nBodies are not echoed back. You already have the message you scheduled, and repeating up to\n10 MB of base64 attachments in every row would make the list unusable. What comes back is\nthe envelope: to, from, subject, and what is going to happen to it."
          }
        },
        {
          "name": "Send a batch of messages",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/messages/batch",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "messages",
                "batch"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"from\": \"hello@yourdomain.com\",\n  \"subject\": \"Your weekly summary\",\n  \"template_id\": \"01JBT8XQ2M9WYC3K4F6R7S8T9V\",\n  \"messages\": [\n    {\n      \"to\": \"ada@example.com\",\n      \"variables\": {\n        \"first_name\": \"Ada\"\n      }\n    },\n    {\n      \"to\": \"grace@example.com\",\n      \"variables\": {\n        \"first_name\": \"Grace\"\n      }\n    }\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `messages:send`\n\nOne shared template and a list of recipients, each with their own `variables`.\nUp to 500 recipients per call.\n\n**A partial failure is not an error.** Every recipient is processed independently, so\none suppressed or malformed address does not stop the rest — the call still returns\n`200` and the per-recipient outcome is in `results`. Check `failed` rather than the\nstatus code, or you will silently lose mail you believe you sent.\n\nThis is for transactional mail going to many people at once. For marketing sends to a\nlist or segment, use [campaigns](/developer/api/campaigns) instead: they add\nunsubscribe handling, review and reporting that this endpoint deliberately does not."
          }
        },
        {
          "name": "Schedule a message",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/messages/scheduled",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "messages",
                "scheduled"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"to\": [\n    \"ada@example.com\"\n  ],\n  \"from\": \"hello@yourdomain.com\",\n  \"subject\": \"Your weekly summary\",\n  \"text\": \"Here is what happened this week.\",\n  \"send_at\": \"2026-09-21T09:00:00Z\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `messages:send`\n\nAccepts a message now and submits it at `send_at`. The body is exactly `POST /messages`,\nplus `send_at`.\n\n**It is a separate endpoint, and that is deliberate.** Other providers put the delivery time\non the send call, and the cost of that is a send endpoint whose response is a message on one\ncall and a schedule on the next — two object types from one operation. Here you get a\n`message` from `/messages` and a `scheduled_message` from `/messages/scheduled`, always.\n`POST /messages` **refuses** a `send_at` rather than ignoring it: a scheduling parameter\nthat is silently dropped delivers the message immediately, to everyone, at the wrong time,\nwith nothing said.\n\n**Everything that can be checked now is checked now** — the body, the recipients, the\nattachments, the limits, and that `from` is a verified Sender of yours. A scheduled send\nthat fails validation three days later is a message that silently never went, and you find\nout from the recipient.\n\n**Suppression and rate limits are checked when it leaves, not when you schedule it.** They\nare questions about the world at the moment of delivery: somebody who unsubscribes on\nTuesday must not receive a message you scheduled on Monday. When that happens the row ends\n`failed` with `failure_reason` set, so it says what happened rather than disappearing.\n\n`send_at` must be at least 60 seconds ahead — the sweep runs every minute and we will not\npromise a precision we do not have — and at most 30 days, because the whole message,\nattachments included, is stored here until it goes."
          }
        },
        {
          "name": "Retrieve a message",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/messages/scheduled/:scheduled",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "messages",
                "scheduled",
                ":scheduled"
              ]
            },
            "description": "Required scope: `messages:send`"
          }
        },
        {
          "name": "Cancel a scheduled message",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/messages/scheduled/:scheduled",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "messages",
                "scheduled",
                ":scheduled"
              ]
            },
            "description": "Required scope: `messages:send`\n\nStops a message that has not been sent.\n\n**Only while its status is `scheduled`.** Once the sweep has claimed it — status `sending` —\nthe message may already be on the wire, and there is no such thing as unsending. The cancel\nis then refused with a message naming the state it is actually in and, for one already sent,\nwhen it went. A success you could not act on would be worse than a refusal.\n\nThe cancel and the sweep are the same conditional update on one row, so exactly one of them\ncan win. You are never told a message was cancelled when it was not."
          }
        },
        {
          "name": "Retrieve a stored message",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains/:domain/messages/:messageId",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains",
                ":domain",
                "messages",
                ":messageId"
              ]
            },
            "description": "Required scope: `events:read`\n\nThe archived copy of a message, which is what a webhook's `storage.url` points at.\n\n`messageId` is the id **exactly as it arrived**, angle brackets included. Stripping\nthem returns `404`: the archive stores the id as it was received, and a bridge that\nhelpfully removed `<` and `>` is why every inbound message 404'd here until\n2026-09-14."
          }
        }
      ]
    },
    {
      "name": "Templates",
      "description": "Stored templates with variables, rendered at send time.",
      "item": [
        {
          "name": "List templates",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-templates",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-templates"
              ]
            },
            "description": "Required scope: `templates:read`\n\nEvery stored template in your organization, newest first."
          }
        },
        {
          "name": "Create a email template",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-templates",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-templates"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Order receipt\",\n  \"subject\": \"Your receipt for order {{order_number}}\",\n  \"html\": \"<p>Hi {{name}},</p><p>Thanks for your order {{order_number}}.</p>\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `templates:write`"
          }
        },
        {
          "name": "Retrieve a email template",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-templates/:email_template",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-templates",
                ":email_template"
              ]
            },
            "description": "Required scope: `templates:read`"
          }
        },
        {
          "name": "Preview a rendered template",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-templates/preview",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-templates",
                "preview"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"html\": \"<p>Hi {{name}}</p>\",\n  \"variables\": {\n    \"name\": \"Ada\"\n  }\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `templates:read`\n\nRenders a template with the variables you supply and returns the result without\nsending anything. Worth calling in your own test suite: it is the cheapest way to\ncatch a variable you renamed on one side and not the other."
          }
        },
        {
          "name": "Update a email template",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-templates/:email_template",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-templates",
                ":email_template"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Order receipt\",\n  \"subject\": \"Your receipt for order {{order_number}}\",\n  \"html\": \"<p>Hi {{name}},</p><p>Thanks for your order {{order_number}}.</p>\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `templates:write`"
          }
        },
        {
          "name": "Update a email template",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-templates/:email_template",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-templates",
                ":email_template"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Order receipt\",\n  \"subject\": \"Your receipt for order {{order_number}}\",\n  \"html\": \"<p>Hi {{name}},</p><p>Thanks for your order {{order_number}}.</p>\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `templates:write`"
          }
        },
        {
          "name": "Delete a email template",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-templates/:email_template",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-templates",
                ":email_template"
              ]
            },
            "description": "Required scope: `templates:write`"
          }
        }
      ]
    },
    {
      "name": "Events",
      "description": "What happened to a message after you submitted it.",
      "item": [
        {
          "name": "List delivery events",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-logs",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-logs"
              ]
            },
            "description": "Required scope: `events:read`\n\nEvery event recorded for your organization's mail: accepted, delivered, deferred,\nbounced, complained, opened, clicked, dropped.\n\nPolling this is the simple way to follow a send. Receiving\n[webhooks](/developer/webhooks) is the better one — it costs you no requests and tells\nyou sooner.\n\n**Opens and clicks are not reliable, by nature.** Open tracking depends on a remote\nimage loading, which privacy proxies fetch on the recipient's behalf and many clients\nblock entirely. Treat them as a weak signal about a population, never as proof about a\nperson."
          }
        },
        {
          "name": "Retrieve a email log",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-logs/:event",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-logs",
                ":event"
              ]
            },
            "description": "Required scope: `events:read`"
          }
        },
        {
          "name": "Messages (email log)",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-logs/messages",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-logs",
                "messages"
              ]
            },
            "description": "Required scope: `events:read`"
          }
        },
        {
          "name": "Delete a delivery event",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-logs/:event",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-logs",
                ":event"
              ]
            },
            "description": "Required scope: `suppressions:write`\n\nRemoves an event from the log. Requires a write scope: a key issued for reporting must not be able to erase the history it reports on."
          }
        },
        {
          "name": "Get a message timeline",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-logs/messages/:messageKey",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-logs",
                "messages",
                ":messageKey"
              ]
            },
            "description": "Required scope: `events:read`\n\nEvery event for one message, oldest first — the whole story of a single send in one call."
          }
        },
        {
          "name": "Resend a message",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-logs/:event/resend",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-logs",
                ":event",
                "resend"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"to\": \"corrected@example.com\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `messages:send`\n\nSubmits the stored copy of this message again. Requires `messages:send`, not\n`events:read` — it puts mail back on the wire.\n\nPass `to` to send it somewhere else. That is the usual reason to resend: the customer\ngave the wrong address, and reconstructing the message by hand to send it to the right\none loses whatever the original actually said.\n\nA redirected resend is not a privileged path — the new recipient is checked against\nyour suppression list and counted against your rate limit exactly like a fresh send."
          }
        }
      ]
    },
    {
      "name": "Suppressions",
      "description": "Addresses Mailyte will refuse to send to, and why.",
      "item": [
        {
          "name": "List suppressed addresses",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-suppressions",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-suppressions"
              ]
            },
            "description": "Required scope: `suppressions:read`\n\nAddresses Mailyte will refuse to send to, and why.\n\nSuppressions are enforced ahead of your own list logic — removing someone from your\ndatabase does not remove them from here, and adding them back in your database does\nnot resurrect them here. This is what keeps a hard bounce from being retried into a\nreputation problem."
          }
        },
        {
          "name": "Create a email suppression",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-suppressions",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-suppressions"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"reason\": \"unsubscribed\",\n  \"email\": \"ada@example.com\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `suppressions:write`"
          }
        },
        {
          "name": "Import suppressed addresses",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-suppressions/import",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-suppressions",
                "import"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"emails\": [\n    \"ada@example.com\",\n    \"tunde@example.com\"\n  ],\n  \"reason\": \"unsubscribed\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `suppressions:write`\n\nBlock up to 10,000 addresses in one request, for example the unsubscribes you are bringing\nover from another email service. Mailyte will not send to them again until you remove them.\n\nAn invalid address is skipped and counted, never fatal. An address that is already\nsuppressed, or appears twice in the request, is counted once. To block a whole domain, use\n`POST /email-suppressions` with `\"scope\": \"domain\"`.\n\n**Two ways to send addresses.** Send JSON with an `emails` array, as in the example below.\nOr upload a CSV file as a form (`multipart/form-data`) in a field called `file`, with one\naddress per row in the first column (a header row is fine):\n\n```bash\ncurl -X POST 'https://app.mailyte.com/api/v1/email-suppressions/import' \\\n  -H 'Authorization: Bearer mk_live_YOUR_API_KEY' \\\n  -F 'file=@unsubscribes.csv' \\\n  -F 'reason=unsubscribed'\n```\n\nSend `file` or `emails`, not both."
          }
        },
        {
          "name": "Remove a suppression",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-suppressions/:suppression",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-suppressions",
                ":suppression"
              ]
            },
            "description": "Required scope: `suppressions:write`\n\nAllows sending to this address again.\n\nWorth doing only when you know why it was suppressed and that the cause is gone — a\nfixed typo, a mailbox that has been recreated. Removing a spam complaint because you\nwould rather keep sending is how a sending reputation is lost."
          }
        }
      ]
    },
    {
      "name": "Webhooks",
      "description": "Receive delivery events at your own endpoint as they happen.",
      "item": [
        {
          "name": "List webhooks",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/webhooks",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "webhooks"
              ]
            },
            "description": "Required scope: `webhooks:read`"
          }
        },
        {
          "name": "Create a webhook endpoint",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/webhooks",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "webhooks"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Production events\",\n  \"events\": [\n    \"email.delivered\",\n    \"email.bounced\"\n  ],\n  \"url\": \"https://example.com/webhooks/mailyte\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `webhooks:write`\n\nRegisters a URL to receive delivery events as they happen.\n\nDelivery is **at least once**, so the same event can arrive twice — key your handling\non the event id and make it idempotent. Events can also arrive out of order; a\n`delivered` before the `accepted` that preceded it is normal and not a bug.\n\nVerify the signature on every request before trusting the body. See\n[Receiving webhooks](/developer/guides/receiving-webhooks) for the full list of events\nand their payloads.\n\n**What an `email.inbound` event carries.** The sender, the recipients and the subject of\nan email that arrived, and for some messages its body. It goes to every webhook in your\naccount that subscribes to it and whose filters it passes — so an unfiltered webhook gets\nthe incoming mail of every mailbox on every domain in your account, not only the mailbox\nyour integration uses. `domain` narrows it to one domain's mailboxes; there is no filter\nfor a single mailbox, so check the recipient on your side if you need one.\n\n**Incoming mail needs a domain when your account has more than one.** A webhook\nsubscribed to `email.inbound` must then set `domain` (one of yours, exact match). Leaving\nit out answers `422` on `domain` — on create, on an update that would remove it, and when\nturning an old webhook back on. With one domain it is optional; when you add a second\ndomain, a webhook without one is tied to the domain you had, so it keeps getting exactly\nwhat it got before.\n\n**Filters, three ways, one result.** The domain can be sent as `domain`,\n`filters.domain` or `targeting.domain`; the top-level `domain` wins when it is sent.\n`filters` uses the stored names (`senderIncludes`, `subjectContains`, `bodyContains`);\n`targeting` uses the names the response returns (`sender_includes`, ...), so you can send\nback what you read. Send one of the two, not both. Every call answers with `targeting`:\nread it back to confirm what is applied. **Anything unknown is a `422` that names it** —\na field, a filter key, or an event name — never a `200` that quietly ignored it.\n\n**`email.deferred` usually means we are still trying.** The receiving server asked us to\nwait, the message is in our queue, and we retry it for you. One is not ours to retry: when\na marketing SMTP key sends to a contact whose inbox is full and Bounce protection is\nholding marketing to them, the message is refused before it is queued (a `452` that names\na date). It is logged `deferred`, but Mailyte never queued it, so your app must send it\nagain after the date in the `reason`.\n\n**Three account events** are about your account, not about a message, so a webhook's\ndomain, sender, subject and body filters never hold them back. They are sent only once\nBounce protection is on for your account.\n\n- `contact.checked`: a contact's address was checked and the answer changed, once per\n  change. `{contact_id, email, email_status, reason, suggestion, checked_at,\n  email_full_until}`. `email_status` is the contact's new value; `reason` and\n  `suggestion` read as on a verification result (`suggestion` is the corrected address\n  for a misspelt domain, else null). `unknown` with a checker that could not confirm yet\n  is asked again later and may be announced again. `email_full_until` is the end of a\n  hold on marketing to a full inbox while it runs, else null.\n- `checks.running_low`: `{trigger, plan_left, bought, credit_fallback, forecast_days}`.\n  `trigger` is `forecast` (under 7 days of checks left at your recent pace) or `plan_80`\n  (80% of this month's plan checks used, and none bought). The counts are checks, as on\n  `GET /billing/usage`.\n- `checks.ran_out`: `{since, buy_path}`. A new contact could not be checked because no\n  checks were left; it was added as `not_checked`. `buy_path` is the dashboard page that\n  buys the checks we suggest.\n\nThe two `checks.*` events are sent at most once per cycle: a new month, a purchase or\nchecks added by us start a new one."
          }
        },
        {
          "name": "Update a webhook",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/webhooks/:webhook",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "webhooks",
                ":webhook"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Production events\",\n  \"events\": [\n    \"email.delivered\",\n    \"email.bounced\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `webhooks:write`\n\nChanges only the fields you send; everything you leave out stays as it is.\n\n`filters` (or `targeting`) replaces **all** of the webhook's filters: a list you leave out\nof it is cleared. Send `domain` on its own to change just the domain and keep the rest.\n`\"filters\": null` clears every filter, the domain included.\n\nThe same rules as create apply: an unknown field, filter key or event name is a `422` that\nnames it, and in an account with more than one domain an update that would leave an\n`email.inbound` webhook without a domain is refused. The response's `targeting` is what is\nnow applied."
          }
        },
        {
          "name": "Delete a webhook",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/webhooks/:webhook",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "webhooks",
                ":webhook"
              ]
            },
            "description": "Required scope: `webhooks:write`"
          }
        },
        {
          "name": "Toggle a webhook",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/webhooks/:webhook/toggle",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "webhooks",
                ":webhook",
                "toggle"
              ]
            },
            "description": "Required scope: `webhooks:write`\n\nThis endpoint takes no request body."
          }
        }
      ]
    },
    {
      "name": "SMTP credentials",
      "description": "Logins for applications that relay over SMTP rather than HTTP.",
      "item": [
        {
          "name": "List smtp credentials",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/smtp-credentials",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "smtp-credentials"
              ]
            },
            "description": "Required scope: `smtp:read`"
          }
        },
        {
          "name": "Create an SMTP credential",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/smtp-credentials",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "smtp-credentials"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Website contact form\",\n  \"domain_id\": \"01JBT8XQ2M9WYC3K4F6R7S8T9V\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `smtp:write`\n\nA username and password for relaying mail over SMTP, scoped to one domain.\n\n**The password is shown once.** It is stored only as a hash, so nobody — including\nMailyte — can read it back. If it is lost, rotate rather than recreate.\n\nUse SMTP when you have an existing application or library that speaks it. Use\n[`POST /messages`](/developer/api/sending/post-messages) when you are writing the\nintegration yourself: it gives you message ids, tags and per-message delivery events\nthat SMTP submission cannot.\n\n**A marketing key needs Bounce protection on.** A key with `stream: \"marketing\"` only\nsends to your contacts whose address has been checked, and Bounce protection is what\nchecks new contacts. Where Bounce protection is available and your account has it\nturned off, creating a marketing key answers `422` with\n`error_code: \"bounce_protection_required\"` and `data.setting_path`, the page where it\nis turned on, and nothing is created. A transactional key is never refused for this."
          }
        },
        {
          "name": "Update a smtp credential",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/smtp-credentials/:credential",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "smtp-credentials",
                ":credential"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Spring newsletter\",\n  \"expires_at\": \"2027-01-01T00:00:00Z\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `smtp:write`\n\nChange a credential's name, expiry, per-key limits, tracking or stream. Send only the\nfields you are changing.\n\n**Changing a key to `stream: \"marketing\"` needs Bounce protection on**, for the same\nreason as creating one: a marketing key only sends to your checked contacts. Where\nBounce protection is available and your account has it turned off, the change answers\n`422` with `error_code: \"bounce_protection_required\"` and `data.setting_path`, and the\nkey is left as it was. A key that is already on the marketing stream is never refused\nfor this.\n\n**While your marketing is paused, changing a marketing key to transactional can be\nrefused.** The change then answers `409` with `error_code: \"marketing_paused\"`, and\nthe key is left as it was. Try again when your marketing can send again."
          }
        },
        {
          "name": "Delete a smtp credential",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/smtp-credentials/:credential",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "smtp-credentials",
                ":credential"
              ]
            },
            "description": "Required scope: `smtp:write`"
          }
        },
        {
          "name": "Usage a smtp credential",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/smtp-credentials/:credential/usage",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "smtp-credentials",
                ":credential",
                "usage"
              ]
            },
            "description": "Required scope: `smtp:read`"
          }
        },
        {
          "name": "Enable a smtp credential",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/smtp-credentials/:credential/enable",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "smtp-credentials",
                ":credential",
                "enable"
              ]
            },
            "description": "Required scope: `smtp:write`\n\nThis endpoint takes no request body."
          }
        },
        {
          "name": "Resume a paused SMTP credential",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/smtp-credentials/:credential/resume",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "smtp-credentials",
                ":credential",
                "resume"
              ]
            },
            "description": "Required scope: `smtp:write`\n\nLifts a pause the mail server placed on the credential after it sent unlike itself —\nfar more recipients or domains in an hour than its own history, or from a sending host\nit had never used — and lets the mail it was holding go.\n\nA pause is not a revocation. The credential still authenticates and nothing was\nbounced: mail submitted during the pause was deferred, and delivers once the pause\nlifts. It also lifts on its own after the pause window (six hours by default) if nobody\nacts. The credential reads `state: \"paused\"` while it is held.\n\nUse this when the activity was yours. If it was not, `revoke` the credential instead\nand create a new one — resuming a stolen key resumes the theft. Calling this on a\ncredential that is not paused is harmless and returns it unchanged.\n\nA transactional credential paused because it kept sending newsletters cannot be resumed\nhere: it answers `409` with `error_code: \"newsletter_hold\"`, and only Mailyte support\nstarts it again. Newsletters and other bulk email go through a marketing credential.\n\nThis endpoint takes no request body."
          }
        },
        {
          "name": "Revoke a smtp credential",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/smtp-credentials/:credential/revoke",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "smtp-credentials",
                ":credential",
                "revoke"
              ]
            },
            "description": "Required scope: `smtp:write`\n\nThis endpoint takes no request body."
          }
        },
        {
          "name": "Rotate a smtp credential",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/smtp-credentials/:credential/rotate",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "smtp-credentials",
                ":credential",
                "rotate"
              ]
            },
            "description": "Required scope: `smtp:write`\n\nThis endpoint takes no request body."
          }
        },
        {
          "name": "Replace an SMTP credential's IP allowlist",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/smtp-credentials/:credential/ip-allowlist",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "smtp-credentials",
                ":credential",
                "ip-allowlist"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"allowed_ips\": [\n    \"203.0.113.10\",\n    \"203.0.113.11\"\n  ],\n  \"ip_allowlist_enabled\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `smtp:write`\n\nThe list REPLACES whatever is there — send the full set, not an addition. Enabling an allowlist that does not contain your sending host stops that host relaying immediately."
          }
        }
      ]
    },
    {
      "name": "Reports",
      "description": "Deliverability, engagement and volume reporting.",
      "item": [
        {
          "name": "List deliverabilitys",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/deliverability",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "deliverability"
              ]
            },
            "description": "Required scope: `reports:read`"
          }
        },
        {
          "name": "Domain Health (report)",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/reports/domain-health",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "reports",
                "domain-health"
              ]
            },
            "description": "Required scope: `reports:read`"
          }
        },
        {
          "name": "Email Delivery (report)",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/reports/email-delivery",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "reports",
                "email-delivery"
              ]
            },
            "description": "Required scope: `reports:read`"
          }
        },
        {
          "name": "Engagement (report)",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/reports/engagement",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "reports",
                "engagement"
              ]
            },
            "description": "Required scope: `reports:read`"
          }
        },
        {
          "name": "History (report)",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/reports/history",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "reports",
                "history"
              ]
            },
            "description": "Required scope: `reports:read`"
          }
        },
        {
          "name": "Security (report)",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/reports/security",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "reports",
                "security"
              ]
            },
            "description": "Required scope: `reports:read`"
          }
        },
        {
          "name": "Templates (report)",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/reports/templates",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "reports",
                "templates"
              ]
            },
            "description": "Required scope: `reports:read`"
          }
        },
        {
          "name": "Volume Trends (report)",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/reports/volume-trends",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "reports",
                "volume-trends"
              ]
            },
            "description": "Required scope: `reports:read`"
          }
        },
        {
          "name": "Generate (report)",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/reports/generate",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "reports",
                "generate"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"template_id\": \"email-delivery\",\n  \"format\": \"pdf\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `reports:read`"
          }
        }
      ]
    },
    {
      "name": "Sandbox inboxes",
      "description": "Operations for sandbox inboxes.",
      "item": [
        {
          "name": "List sandbox inboxes",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/inboxes",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "inboxes"
              ]
            },
            "description": "Required scope: `sandbox:read`\n\nA sandbox inbox catches mail and never delivers it. Point any SMTP client at `sandbox.smtp.mailyte.com` (port 2525 with STARTTLS, or 2465 with TLS) using an inbox's `username` and secret, or send through `POST /messages` with a **test-mode API key**, and the message lands here instead of anyone's mailbox. Nothing the sandbox does reaches your live event log, live webhooks, suppression list or sending credits."
          }
        },
        {
          "name": "Get sandbox usage",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/usage",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "usage"
              ]
            },
            "description": "Required scope: `sandbox:read`\n\nWhere your organization stands against the sandbox limits: inboxes used, messages accepted this month, and the per-inbox and per-message limits. The sandbox is free on every plan and never uses sending credits."
          }
        },
        {
          "name": "Create a sandbox inbox",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/inboxes",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "inboxes"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Spring newsletter\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `sandbox:write`\n\nReturns the inbox with its SMTP `secret`. Sandbox credentials stay viewable: read them again any time with `GET /sandbox/inboxes/{id}/credentials`. Your first inbox becomes the default, which is where test-mode API sends land. An organization may have 3 inboxes. Owners and admins only."
          }
        },
        {
          "name": "Get a sandbox inbox",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/inboxes/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "inboxes",
                ":id"
              ]
            },
            "description": "Required scope: `sandbox:read`"
          }
        },
        {
          "name": "Update a sandbox inbox",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/inboxes/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "inboxes",
                ":id"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Spring newsletter\",\n  \"max_messages\": 500\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `sandbox:write`\n\nRename it, change how many messages it keeps (at most 50) or for how long (at most 30 days), or make it the default. Setting `is_default` clears it on your other inboxes. Owners and admins only."
          }
        },
        {
          "name": "Delete a sandbox inbox",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/inboxes/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "inboxes",
                ":id"
              ]
            },
            "description": "Required scope: `sandbox:write`\n\nDeletes the inbox and every message in it. Its SMTP credential stops working at once. Owners and admins only."
          }
        },
        {
          "name": "Get a sandbox inbox's SMTP credentials",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/inboxes/:id/credentials",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "inboxes",
                ":id",
                "credentials"
              ]
            },
            "description": "Required scope: `sandbox:write`\n\nThe inbox's SMTP username and secret, with the host and ports to use them on. Unlike live SMTP credentials and API keys, sandbox credentials are always viewable: they can only drop mail into your own sandbox, never deliver it. `secret` is null for an inbox created before this was possible; reset its credentials to get one. Needs a key with `sandbox:write`, because it reveals a secret."
          }
        },
        {
          "name": "Get a sandbox inbox's public link and access code",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/inboxes/:id/share",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "inboxes",
                ":id",
                "share"
              ]
            },
            "description": "Required scope: `sandbox:write`\n\nEvery sandbox inbox has a public link that opens a read-only view of it, with no Mailyte account needed, so a teammate, a tester or a client can see what your app sent. By default the link asks for a 6-digit access code first. Visitors see the messages (HTML, text, headers, attachments, spam and client checks); they never see the SMTP credentials, webhooks, or anything they could change. The link and code are always viewable here. Needs `sandbox:write`, because the code opens the inbox to whoever you give it to."
          }
        },
        {
          "name": "Empty a sandbox inbox",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/inboxes/:id/empty",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "inboxes",
                ":id",
                "empty"
              ]
            },
            "description": "Required scope: `sandbox:write`\n\nDeletes every message in the inbox and keeps the inbox and its credentials.\n\nThis endpoint takes no request body."
          }
        },
        {
          "name": "Reset a sandbox inbox's SMTP credentials",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/inboxes/:id/reset-credentials",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "inboxes",
                ":id",
                "reset-credentials"
              ]
            },
            "description": "Required scope: `sandbox:write`\n\nIssues a new username and secret. The old ones stop working immediately, so update anything configured with them. Owners and admins only.\n\nThis endpoint takes no request body."
          }
        },
        {
          "name": "Turn a sandbox inbox's public link or access code on or off",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/inboxes/:id/share",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "inboxes",
                ":id",
                "share"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"enabled\": true,\n  \"code_required\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `sandbox:write`\n\nSend `enabled` to turn the link on or off (off: the link says \"not available\"), and `code_required` to ask for the code or open the link directly. Every change signs out everyone who was viewing. Owners and admins only."
          }
        },
        {
          "name": "Give a sandbox inbox a new access code",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/inboxes/:id/share/new-code",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "inboxes",
                ":id",
                "share",
                "new-code"
              ]
            },
            "description": "Required scope: `sandbox:write`\n\nIssues a new 6-digit code; the old one stops working and everyone who unlocked with it is signed out. The link stays the same. Owners and admins only.\n\nThis endpoint takes no request body."
          }
        },
        {
          "name": "Give a sandbox inbox a new public link",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/inboxes/:id/share/reset-link",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "inboxes",
                ":id",
                "share",
                "reset-link"
              ]
            },
            "description": "Required scope: `sandbox:write`\n\nIssues a new link; the old one stops working at once and everyone viewing is signed out. The access code stays the same. Owners and admins only.\n\nThis endpoint takes no request body."
          }
        }
      ]
    },
    {
      "name": "Sandbox messages",
      "description": "Operations for sandbox messages.",
      "item": [
        {
          "name": "Get a sandbox message",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/messages/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "messages",
                ":id"
              ]
            },
            "description": "Required scope: `sandbox:read`\n\nThe message in full: decoded text and HTML, headers, attachments, the simulated delivery events, and every sandbox webhook attempt it caused with your endpoint's response. The HTML is exactly what your code sent and is not sanitised — render it only in a sandboxed frame."
          }
        },
        {
          "name": "Mark a sandbox message read or unread",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/messages/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "messages",
                ":id"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"read\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `sandbox:write`"
          }
        },
        {
          "name": "Delete a sandbox message",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/messages/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "messages",
                ":id"
              ]
            },
            "description": "Required scope: `sandbox:write`"
          }
        },
        {
          "name": "List messages in a sandbox inbox",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/inboxes/:id/messages",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "inboxes",
                ":id",
                "messages"
              ]
            },
            "description": "Required scope: `sandbox:read`\n\nNewest first. An inbox keeps its newest 50 messages for 30 days; older ones are deleted automatically."
          }
        },
        {
          "name": "Download a sandbox message as .eml",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/messages/:id/raw",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "messages",
                ":id",
                "raw"
              ]
            },
            "description": "Required scope: `sandbox:read`"
          }
        },
        {
          "name": "Simulate a delivery event on a sandbox message",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/messages/:id/events",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "messages",
                ":id",
                "events"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"event\": \"clicked\",\n  \"url\": \"https://app.example.com/confirm/abc123\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `sandbox:write`\n\nRecords an open, click, bounce, soft bounce (`deferred`) or complaint on a caught message and fires your sandbox webhooks for it, as `email.opened`, `email.clicked`, `email.bounced`, `email.deferred` or `delivery.complaint` with `environment: \"sandbox\"`. Use it to exercise your webhook handler without a real recipient. `recipient` defaults to the first envelope recipient and must be one of them; `url` is the link reported on a click. Nothing reaches your suppression list or live events."
          }
        },
        {
          "name": "Wait for a sandbox message",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/inboxes/:id/messages/await",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "inboxes",
                ":id",
                "messages",
                "await"
              ]
            },
            "description": "Required scope: `sandbox:read`\n\nHolds the request open until a message matching your filters arrives in the inbox, then\nreturns it in full (the same object as `GET /sandbox/messages/{id}`). If nothing matches\nwithin `timeout` seconds the answer is **`204 No Content`** — \"not yet\", not an error —\nso a test can simply call again.\n\nThis is the call for end-to-end tests: trigger the action in your app, then wait for the\nemail it should have sent and assert on its subject, HTML or links.\n\n- Pass `since` (the time your test started) so a message from an earlier run never\n  satisfies this one. Only messages received **after** it are considered.\n- `to` matches any recipient, including Bcc. `subject` matches if it is contained in the\n  subject.\n- At most five waits can be open at once per organization; the sixth gets `429`.\n\nA CI step with `curl`, using a key with the `sandbox:read` scope:\n\n```bash\nSINCE=$(date -u +%Y-%m-%dT%H:%M:%SZ)\n./run-signup-test.sh \"ci+${GITHUB_RUN_ID}@example.com\"\n\nfor attempt in 1 2 3 4; do\n  STATUS=$(curl -s -o message.json -w '%{http_code}' -G \\\n    \"https://app.mailyte.com/api/v1/sandbox/inboxes/$INBOX_ID/messages/await\" \\\n    -H \"Authorization: Bearer $MAILYTE_API_KEY\" \\\n    --data-urlencode \"to=ci+${GITHUB_RUN_ID}@example.com\" \\\n    --data-urlencode \"subject=Confirm your email\" \\\n    --data-urlencode \"since=$SINCE\" \\\n    --data-urlencode \"timeout=30\")\n  [ \"$STATUS\" = \"200\" ] && break\n  [ \"$STATUS\" = \"204\" ] || { echo \"await failed: $STATUS\"; cat message.json; exit 1; }\ndone\n\n[ \"$STATUS\" = \"200\" ] || { echo \"no confirmation email in 2 minutes\"; exit 1; }\njq -r '.data.html' message.json | grep -o 'https://app.example.com/confirm/[^\"]*'\n```"
          }
        },
        {
          "name": "Download a sandbox message attachment",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/messages/:id/attachments/:index",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "messages",
                ":id",
                "attachments",
                ":index"
              ]
            },
            "description": "Required scope: `sandbox:read`"
          }
        }
      ]
    },
    {
      "name": "Sandbox webhooks",
      "description": "Operations for sandbox webhooks.",
      "item": [
        {
          "name": "List sandbox webhooks",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/webhooks",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "webhooks"
              ]
            },
            "description": "Required scope: `sandbox:read`\n\nSandbox webhooks are separate from your live webhooks: a live webhook never receives a sandbox event and a sandbox webhook never receives a live one. The payload is the same format as live, plus `environment: \"sandbox\"`, `sandbox_inbox_id` and an `X-Webhook-Environment: sandbox` header, so your handler needs no changes and can still tell them apart."
          }
        },
        {
          "name": "Create a sandbox webhook",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/webhooks",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "webhooks"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"url\": \"https://example.com/webhooks/mailyte\",\n  \"events\": [\n    \"email.delivered\",\n    \"email.bounced\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `sandbox:write`\n\nReturns the signing `secret` once. Omit `inbox_id` to receive events for every inbox. Addresses on private, loopback or internal networks are refused. Send to a simulator address (`bounce@sim.mailyte.com`, `softbounce@`, `complaint@`, `suppressed@`) to fire the failure events. Owners and admins only."
          }
        },
        {
          "name": "Update a sandbox webhook",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/webhooks/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "webhooks",
                ":id"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"url\": \"https://example.com/webhooks/mailyte\",\n  \"events\": [\n    \"email.accepted\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `sandbox:write`\n\nChange the URL, events, inbox or `status` (`active` / `disabled`). Owners and admins only."
          }
        },
        {
          "name": "Delete a sandbox webhook",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/webhooks/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "webhooks",
                ":id"
              ]
            },
            "description": "Required scope: `sandbox:write`"
          }
        },
        {
          "name": "List a sandbox webhook's delivery attempts",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/webhooks/:id/deliveries",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "webhooks",
                ":id",
                "deliveries"
              ]
            },
            "description": "Required scope: `sandbox:read`\n\nNewest first, each with the status code, time taken and the first 1 KB of your endpoint's response."
          }
        },
        {
          "name": "Send a test sandbox webhook",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/sandbox/webhooks/:id/test",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "sandbox",
                "webhooks",
                ":id",
                "test"
              ]
            },
            "description": "Required scope: `sandbox:write`\n\nQueues a signed `sandbox.test` event to the endpoint. The attempt appears in the webhook's deliveries. Owners and admins only.\n\nThis endpoint takes no request body."
          }
        }
      ]
    },
    {
      "name": "Mailboxes",
      "description": "Provision mailboxes, aliases and forwarding for a domain.",
      "item": [
        {
          "name": "List email accounts",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-accounts",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-accounts"
              ]
            },
            "description": "Required scope: `mailboxes:read`"
          }
        },
        {
          "name": "Create a mailbox",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-accounts",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-accounts"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"domain_id\": \"01JBT8XQ2M9WYC3K4F6R7S8T9V\",\n  \"name\": \"Ada Obi\",\n  \"username\": \"ada\",\n  \"account_type\": \"both\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `mailboxes:write`\n\nCreates a real mailbox — IMAP, SMTP and webmail — on one of your domains.\n\nThe domain must exist, but it does **not** need to be verified: you will usually want\nmailboxes in place before you cut MX over, not after. Provisioning happens on the mail\nserver and is asynchronous; a mailbox appears with a provisioning status and becomes\nusable when that completes.\n\nPasswords must be at least 12 characters. If you set a forced password change, note it\ngoverns webmail and the mobile apps only — IMAP and SMTP clients cannot present a\nchange-password prompt, so they keep working with the old password until it is changed\nelsewhere."
          }
        },
        {
          "name": "Retrieve a email account",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-accounts/:email_account",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-accounts",
                ":email_account"
              ]
            },
            "description": "Required scope: `mailboxes:read`"
          }
        },
        {
          "name": "Bulk Update (email account)",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-accounts/bulk-update",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-accounts",
                "bulk-update"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"account_ids\": [\n    \"01JBT8XQ2M9WYC3K4F6R7S8T9V\"\n  ],\n  \"action\": \"suspend\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `mailboxes:write`"
          }
        },
        {
          "name": "Update a email account",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-accounts/:email_account",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-accounts",
                ":email_account"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Ada Obi\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `mailboxes:write`"
          }
        },
        {
          "name": "Update a email account",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-accounts/:email_account",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-accounts",
                ":email_account"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Ada Obi\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `mailboxes:write`"
          }
        },
        {
          "name": "Delete a email account",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-accounts/:email_account",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-accounts",
                ":email_account"
              ]
            },
            "description": "Required scope: `mailboxes:write`"
          }
        },
        {
          "name": "Overview a email account",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-accounts/:account/overview",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-accounts",
                ":account",
                "overview"
              ]
            },
            "description": "Required scope: `mailboxes:read`"
          }
        },
        {
          "name": "Stats a email account",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-accounts/:account/stats",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-accounts",
                ":account",
                "stats"
              ]
            },
            "description": "Required scope: `mailboxes:read`"
          }
        },
        {
          "name": "Generate Password a email account",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-accounts/:account/generate-password",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-accounts",
                ":account",
                "generate-password"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"length\": 16,\n  \"include_symbols\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `mailboxes:write`"
          }
        },
        {
          "name": "Reset Password a email account",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-accounts/:account/reset-password",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-accounts",
                ":account",
                "reset-password"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"new_password\": \"new_password\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `mailboxes:write`"
          }
        },
        {
          "name": "Retry provisioning a mailbox",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-accounts/:account/retry-provisioning",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-accounts",
                ":account",
                "retry-provisioning"
              ]
            },
            "description": "Required scope: `mailboxes:write`\n\nThis endpoint takes no request body."
          }
        }
      ]
    },
    {
      "name": "Mailbox aliases & routing",
      "description": "Operations for mailbox aliases & routing.",
      "item": [
        {
          "name": "List a mailbox's aliases",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-accounts/:account/aliases",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-accounts",
                ":account",
                "aliases"
              ]
            },
            "description": "Required scope: `mailboxes:read`"
          }
        },
        {
          "name": "List forwarding rules",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-accounts/:account/forwarding-rules",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-accounts",
                ":account",
                "forwarding-rules"
              ]
            },
            "description": "Required scope: `mailboxes:read`"
          }
        },
        {
          "name": "Add an alias",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-accounts/:account/aliases",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-accounts",
                ":account",
                "aliases"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"email_account_id\": \"01JBT8XQ2M9WYC3K4F6R7S8T9V\",\n  \"alias_email\": \"sales@yourdomain.com\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `mailboxes:write`\n\nAn additional address delivering into this mailbox. Aliases cannot be used as SMTP logins; they receive only."
          }
        },
        {
          "name": "Create a forwarding rule",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-accounts/:account/forwarding-rules",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-accounts",
                ":account",
                "forwarding-rules"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"email_account_id\": \"01JBT8XQ2M9WYC3K4F6R7S8T9V\",\n  \"forward_to_email\": \"ada.personal@example.com\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `mailboxes:write`"
          }
        },
        {
          "name": "Update a forwarding rule",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-accounts/:account/forwarding-rules/:rule",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-accounts",
                ":account",
                "forwarding-rules",
                ":rule"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"forward_to_email\": \"ada.personal@example.com\",\n  \"condition_type\": \"all\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `mailboxes:write`"
          }
        },
        {
          "name": "Delete a mailbox alias",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-accounts/:account/aliases/:alias",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-accounts",
                ":account",
                "aliases",
                ":alias"
              ]
            },
            "description": "Required scope: `mailboxes:write`"
          }
        },
        {
          "name": "Delete a forwarding rule",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-accounts/:account/forwarding-rules/:rule",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-accounts",
                ":account",
                "forwarding-rules",
                ":rule"
              ]
            },
            "description": "Required scope: `mailboxes:write`"
          }
        },
        {
          "name": "Retry provisioning an alias",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/email-accounts/:account/aliases/:alias/retry-provisioning",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "email-accounts",
                ":account",
                "aliases",
                ":alias",
                "retry-provisioning"
              ]
            },
            "description": "Required scope: `mailboxes:write`\n\nThis endpoint takes no request body."
          }
        }
      ]
    },
    {
      "name": "Mailbox API",
      "description": "Everything the webmail does, for one mailbox. Takes a mailbox token, not an organization API key.",
      "item": [
        {
          "name": "List every file",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/files",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "files"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Every attachment in the mailbox, as one list you can search and filter: by name (`q`), `kind`, `person`, `direction` (received or sent), date range (`since`, `until`), size, and `sort`. Page with `cursor`: pass back `next_cursor` until it is null.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "Mailbox insights",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/insights",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "insights"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Patterns in the mailbox over a `window` (`30d`, `90d` default, `180d` or `365d`): what needs attention, how fast replies go out, when mail arrives, who you write to most, and clutter. Each block is left out when there is nothing to say. Results are cached; `refresh=true` recomputes.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `503` | Insights are busy on this server; try again shortly. |"
          }
        },
        {
          "name": "List labels in use",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/labels",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "labels"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "The labels on messages in this mailbox, for a filter or a label picker.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "Register a device for push",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/devices",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "devices"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"token\": \"fcm-or-apns-device-token\",\n  \"platform\": \"ios\",\n  \"app_version\": \"2.1.0\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "From a phone app, after sign-in: the push token from APNs or FCM. New mail then raises a notification on this device. Registering the same token again just updates it.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "Files at a glance",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/files/summary",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "files",
                "summary"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Totals for the mailbox's files: by kind, by month, top senders, and the largest.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "Stop push to this device",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/devices/current",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "devices",
                "current"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Unregisters the device this session belongs to. Call it on sign-out in your app.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        }
      ]
    },
    {
      "name": "Mailbox auth & security",
      "description": "Operations for mailbox auth & security.",
      "item": [
        {
          "name": "Read security settings",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/security",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "security"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Whether two-factor sign-in is on, and how many recovery codes are left.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "Get a mailbox token",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox-auth/login",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox-auth",
                "login"
              ]
            },
            "auth": {
              "type": "noauth"
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"email_address\": \"ada@yourdomain.com\",\n  \"password\": \"her-mailbox-password\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Exchanges a mailbox's own email address and password for a **token**. Send it as `Authorization: Bearer <token>` on every other Mailbox API call.\n\n**Two-factor.** If the mailbox has two-factor sign-in on, the first call answers `two_factor_required: true` and no token. Call again with the same email and password plus `two_factor_code` (or a recovery code).\n\n**How long it lasts.** A browser session lasts 8 hours idle and 7 days at most. An app that sends `X-Client-Platform` gets 30 days idle and 180 days at most. `expires_at` and `idle_timeout_seconds` say exactly.\n\n**Temporary password.** If an admin reset the password, you still get a token, with `must_change_password: true`. Until `POST /security/password` succeeds, every other call is refused, except logout.\n\nThe password is checked by the mail server itself, so it is always the same password a mail app uses.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | Wrong email or password, or a wrong two-factor code. The message is the same for both, on purpose: `Invalid email or password`. |\n| `422` | `email_address` or `password` is missing or too long. |\n| `429` | Too many failed attempts from this IP or for this address: `Too many failed attempts. Try again later.` |"
          }
        },
        {
          "name": "Sign out (revoke the token)",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox-auth/logout",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox-auth",
                "logout"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Ends the session: the token stops working at once. Calling it again is harmless. Send the token you want to revoke.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |"
          }
        },
        {
          "name": "List signed-in devices",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/security/sessions",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "security",
                "sessions"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Every session for this mailbox, newest first. `current` marks the one making the call.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "Change the password",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/security/password",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "security",
                "password"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"current_password\": \"old-password\",\n  \"new_password\": \"a-long-new-passphrase\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Changes the mailbox password. Every other session is signed out (the one making the call stays); mail apps need the new password.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `401` | `Current password is incorrect`. |\n| `409` | `New password must be different from the current one`. |\n| `422` | The new password is too weak or too long. |\n| `429` | Too many wrong current passwords. |"
          }
        },
        {
          "name": "Start two-factor setup",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/security/2fa/begin",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "security",
                "2fa",
                "begin"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "No body. Returns a secret and a QR code for an authenticator app, and one-time recovery codes. Show the codes once; then confirm with `POST /security/2fa/confirm`. Nothing changes until it is confirmed.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `400` | `Could not start enrolment` (for example, two-factor is already on). |"
          }
        },
        {
          "name": "Turn two-factor on",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/security/2fa/confirm",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "security",
                "2fa",
                "confirm"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"code\": \"492039\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Confirms setup with the current code from the authenticator app. From then on, sign-in needs a code.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `422` | The code is wrong or expired. |"
          }
        },
        {
          "name": "Turn two-factor off",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/security/2fa/disable",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "security",
                "2fa",
                "disable"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"code\": \"492039\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Needs a current code (or a recovery code), so a stolen session alone cannot turn it off.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `422` | The code is wrong. |"
          }
        },
        {
          "name": "Sign out another device",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/security/sessions/:session_id",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "security",
                "sessions",
                ":session_id"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Ends another session. To end your own, use `POST /mailbox-auth/logout`.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `404` | Session not found. |\n| `409` | `Use sign out to end the session you are using`. |"
          }
        }
      ]
    },
    {
      "name": "Mailbox messages",
      "description": "Operations for mailbox messages.",
      "item": [
        {
          "name": "List messages",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/messages",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "messages"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Messages in one folder, newest first, a page at a time. `folder` defaults to the inbox. `search` (or `q`) matches the sender, recipients, subject and body. Combine the filters freely. Page with `offset` and `limit` (default 50, at most 200) while `has_more` is true.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `404` | No folder by that name. |"
          }
        },
        {
          "name": "Read a message",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/messages/:message_id",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "messages",
                ":message_id"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "One message in full: headers, text and HTML bodies, attachments, and how it was authenticated. Reading it does not mark it read; call mark-read for that.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `404` | No message with that id (it may have been moved; ids change when a message moves). |"
          }
        },
        {
          "name": "List scheduled emails",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/messages/scheduled",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "messages",
                "scheduled"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Emails waiting to be sent at a set time, soonest first.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "Do one thing to many messages",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/messages/bulk",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "messages",
                "bulk"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"ids\": [\n    \"INBOX:4821\",\n    \"INBOX:4820\"\n  ],\n  \"action\": \"move\",\n  \"folder\": \"Clients\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Applies one action to up to 500 messages: `mark_read`, `mark_unread`, `star`, `unstar`, `move` (needs `folder`), `trash`, `delete` (only messages already in Trash) or `labels` (needs `add` or `remove`). Each message succeeds or fails on its own; `results` says which, in the order you sent them, with `new_id` for messages that moved.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `422` | `move needs a folder`, `labels needs add or remove`, or more than 500 ids. |\n| `404` | A message or the target folder was not found. |"
          }
        },
        {
          "name": "Save a draft",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/messages/draft",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "messages",
                "draft"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"to\": [\n    \"tunde@example.com\"\n  ],\n  \"subject\": \"The Q3 figures\",\n  \"body_html\": \"<p>Hi Tunde,</p>\",\n  \"replace_id\": \"Drafts:30\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Saves (or, with `replace_id`, replaces) a draft in Drafts. Same fields as a send, JSON or multipart. Autosave by sending `replace_id` each time: the old copy is removed and the new id returned.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `422` | A field is invalid, or `keep_attachments needs replace_id`. |"
          }
        },
        {
          "name": "Send an email as the mailbox holder",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/messages/send",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "messages",
                "send"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"to\": [\n    \"tunde@example.com\"\n  ],\n  \"subject\": \"The Q3 figures\",\n  \"body_text\": \"Hi Tunde,\\n\\nThe figures are below.\\n\\nAda\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Sends from this mailbox's own address and files a copy in **Sent**. Send JSON, or `multipart/form-data` when you attach files (repeat a field for each value: `to`, `cc`, `bcc`, `attachments`).\n\n**Retrying safely.** Send an `Idempotency-Key` header of the form `<app>-<ULID>` (for example `crm-01JBT8XQ2M9WYC3K4F6R7S8T9V`; one per email, saved before the first try). A retry with the same key within 24 hours returns the first answer, with `Idempotency-Replayed: true`, instead of sending again; while the first is still sending it answers `409` with `Retry-After`.\n\n**Scheduling.** With `send_at`, the message waits in the Scheduled folder and the answer carries `send_at`; cancel it with `DELETE /messages/scheduled/{id}`.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `403` | `You do not have permission to send from that address` (a `from` this mailbox may not use), or read-only access to a shared mailbox. |\n| `409` | A send with this `Idempotency-Key` is still in progress. Wait for `Retry-After`, then retry with the same key. |\n| `422` | `Add at least one valid recipient`, `The message has no content`, too many or too large attachments, an invalid `send_at`, an `Idempotency-Key` that is not `<app>-<ULID>`, or one reused for a different email. |"
          }
        },
        {
          "name": "Delete a message for good",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/messages/:message_id",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "messages",
                ":message_id"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Permanently deletes a message that is already in Trash. Cannot be undone. Anywhere else, move it to Trash first.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `404` | Message not found. |\n| `409` | `Move the message to Trash before deleting it permanently`. |"
          }
        },
        {
          "name": "List a message's attachments",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/messages/:message_id/attachments",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "messages",
                ":message_id",
                "attachments"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `404` | Message not found. |"
          }
        },
        {
          "name": "Who this message is with, and the shape of its conversation",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/messages/:message_id/context",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "messages",
                ":message_id",
                "context"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Header-only context for one message: the history with its correspondent and the thread it belongs to. Always available — no AI is involved and none is required. A message with no identifiable correspondent (a bounce, a self-note) omits the correspondent block."
          }
        },
        {
          "name": "Download the original message",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/messages/:message_id/raw",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "messages",
                ":message_id",
                "raw"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "The message exactly as received (RFC 822, `message/rfc822`), headers and all — for \"show original\" or archiving.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `404` | Message not found. |"
          }
        },
        {
          "name": "Read a conversation",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/messages/:message_id/thread",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "messages",
                ":message_id",
                "thread"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Every message in the conversation this one belongs to, oldest first, across folders (your replies in Sent included). Summaries only; read one in full with `GET /messages/{message_id}`.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "Add or remove labels",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/messages/:message_id/labels",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "messages",
                ":message_id",
                "labels"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"add\": [\n    \"invoices\"\n  ],\n  \"remove\": [\n    \"follow-up\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Adds and removes labels on one message in a single call. Labels are tidied: lower case, spaces become `_`, other symbols are dropped, 40 characters at most. System flags such as `\\Seen` are refused (use mark-read).\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `400` | Neither `add` nor `remove` has a valid label. |\n| `404` | Message not found. |"
          }
        },
        {
          "name": "Mark a message read",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/messages/:message_id/mark-read",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "messages",
                ":message_id",
                "mark-read"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "No body. Doing it twice is harmless. To change many at once, use `POST /messages/bulk`.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `404` | Message not found. |"
          }
        },
        {
          "name": "Mark a message unread",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/messages/:message_id/mark-unread",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "messages",
                ":message_id",
                "mark-unread"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "No body. Doing it twice is harmless. To change many at once, use `POST /messages/bulk`.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `404` | Message not found. |"
          }
        },
        {
          "name": "Move a message",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/messages/:message_id/move",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "messages",
                ":message_id",
                "move"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"folder\": \"Clients\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Moves the message to another folder. **Its id changes** (a new folder and uid): use the `id` in the answer from now on.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `400` | No folder by that name, or the message is already there. |\n| `404` | Message not found. |"
          }
        },
        {
          "name": "Star a message",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/messages/:message_id/star",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "messages",
                ":message_id",
                "star"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "No body. Doing it twice is harmless. To change many at once, use `POST /messages/bulk`.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `404` | Message not found. |"
          }
        },
        {
          "name": "Move a message to Trash",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/messages/:message_id/trash",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "messages",
                ":message_id",
                "trash"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "No body. The message's id changes; use the `id` in the answer. Already in Trash: nothing changes.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `404` | Message not found. |"
          }
        },
        {
          "name": "Unstar a message",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/messages/:message_id/unstar",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "messages",
                ":message_id",
                "unstar"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "No body. Doing it twice is harmless. To change many at once, use `POST /messages/bulk`.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `404` | Message not found. |"
          }
        },
        {
          "name": "Discard a draft",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/messages/draft/:message_id",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "messages",
                "draft",
                ":message_id"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Permanently removes a draft. Allowed outside Trash because a draft the author just discarded was never delivered mail — and for that reason refused (409 `not_a_draft`) for anything not in the Drafts folder.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `400` | The id is malformed or is not a draft. |"
          }
        },
        {
          "name": "Cancel a scheduled email",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/messages/scheduled/:message_id",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "messages",
                "scheduled",
                ":message_id"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Stops it from being sent and moves it to Drafts, where it can be edited and sent again.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `404` | `That message is not scheduled` (it may already have gone). |"
          }
        },
        {
          "name": "Download an attachment",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/messages/:message_id/attachments/:index",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "messages",
                ":message_id",
                "attachments",
                ":index"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "The file itself, not JSON: the body is the attachment's bytes, with its `Content-Type` and a `Content-Disposition` carrying the file name. `index` comes from the message's `attachments`.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `404` | `Message not found` or `Attachment not found`. |"
          }
        }
      ]
    },
    {
      "name": "Mailbox folders",
      "description": "Operations for mailbox folders.",
      "item": [
        {
          "name": "List folders",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/folders",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "folders"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Every folder in the mailbox, with message and unread counts. `role` marks the special ones (inbox, sent, drafts, trash, junk, archive); use `name` wherever another call takes a `folder`.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "Create a folder",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/folders",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "folders"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Clients\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Creates a folder and answers with the full folder list.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `400` | The mail server refused the name, for example because a folder by that name exists. |\n| `422` | The name is empty, longer than 255 characters, or contains `/`, `\\` or control characters. |"
          }
        },
        {
          "name": "Rename a folder",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/folders/:folder",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "folders",
                ":folder"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Clients (2026)\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "`{folder}` is the folder's `id` from `GET /folders`. Inbox and the special folders (Sent, Drafts, Junk, Trash, Archive) cannot be renamed.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `400` | The mail server refused the new name (for example, it is taken). |\n| `409` | A special folder: `error_code: cannot_rename_special_folder`. |"
          }
        },
        {
          "name": "Delete an empty folder",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/folders/:folder",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "folders",
                ":folder"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "`{folder}` is the folder's `id` from `GET /folders`. Empty it first: move or delete its messages and subfolders. Answers with the folder list that is left.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `409` | `error_code` says why: `cannot_delete_special_folder`, `folder_not_empty` or `folder_has_subfolders`. |"
          }
        }
      ]
    },
    {
      "name": "Mailbox contacts",
      "description": "Operations for mailbox contacts.",
      "item": [
        {
          "name": "Suggest recipients",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/contacts",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "contacts"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Addresses this mailbox has written to or heard from, most frequent first — for autocomplete. Saved contacts are under the address book (`/address-book/contacts`).\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "List address books",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/address-book/books",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "address-book",
                "books"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "The personal collection, plus anything shared with the mailbox.\n\n`read_only` is reported off the server's own privilege set rather than\nguessed from the name, so a UI can hide editing controls on a collection\nthe server would refuse to write anyway — the company directory being the\ncase that matters.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "List saved contacts",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/address-book/contacts",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "address-book",
                "contacts"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Contacts in one address book (`book`, default `default`).\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `404` | Address book not found. |"
          }
        },
        {
          "name": "Save a contact",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/address-book/contacts",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "address-book",
                "contacts"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"full_name\": \"Tunde Bello\",\n  \"emails\": [\n    {\n      \"address\": \"tunde@example.com\",\n      \"type\": \"work\"\n    }\n  ],\n  \"phones\": [\n    {\n      \"number\": \"+234 803 000 0000\",\n      \"type\": \"mobile\"\n    }\n  ],\n  \"organization\": \"Example Ltd\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Needs at least a name, an address or a number.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `400` | `Give the contact a name, an address or a number`. |\n| `409` | `That address book cannot be written to`. |"
          }
        },
        {
          "name": "Read a contact",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/address-book/contacts/:card_id",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "address-book",
                "contacts",
                ":card_id"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `404` | Contact not found. |"
          }
        },
        {
          "name": "Update a contact",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/address-book/contacts/:card_id",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "address-book",
                "contacts",
                ":card_id"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"full_name\": \"Tunde Bello\",\n  \"emails\": [\n    {\n      \"address\": \"tunde@example.com\",\n      \"type\": \"work\"\n    }\n  ],\n  \"phones\": [\n    {\n      \"number\": \"+234 803 000 0000\",\n      \"type\": \"mobile\"\n    }\n  ],\n  \"organization\": \"Example Ltd\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Replaces the contact. Send the `etag` you read as a query parameter so a change made elsewhere is not lost.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `400` | No name, address or number. |\n| `412` | `This contact changed elsewhere. Reopen it and try again.` |"
          }
        },
        {
          "name": "Delete a contact",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/address-book/contacts/:card_id",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "address-book",
                "contacts",
                ":card_id"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `404` | Contact not found. |"
          }
        }
      ]
    },
    {
      "name": "Mailbox calendars",
      "description": "Operations for mailbox calendars.",
      "item": [
        {
          "name": "List calendar subscription links",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/calendar-subscriptions",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "calendar-subscriptions"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Private links that let another calendar app (Google, Outlook, Apple) show this calendar, read-only.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "List calendars",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/calendars",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "calendars"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "Create a subscription link",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/calendar-subscriptions",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "calendar-subscriptions"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"calendar\": \"default\",\n  \"label\": \"My phone\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "List invitations to answer",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/calendar/invitations",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "calendar",
                "invitations"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Invitations other people sent that still need an answer.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "List rooms and equipment",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/calendar/rooms",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "calendar",
                "rooms"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Rooms (`ROOM`) and things (`RESOURCE`, e.g. a projector) you can add to an event like an attendee. Empty for most organizations.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "Check when people are busy",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/calendar/free-busy",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "calendar",
                "free-busy"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"attendees\": [\n    \"tunde@yourdomain.com\"\n  ],\n  \"start\": \"2026-10-14T08:00:00+01:00\",\n  \"end\": \"2026-10-14T18:00:00+01:00\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Busy periods for colleagues in `start`–`end` (at most 31 days). `known: false` means the server cannot see that person's calendar (usually someone outside the organization): treat it as unknown, never as free.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `400` | `end must be after start`, a range over 31 days, or `No valid addresses`. |"
          }
        },
        {
          "name": "Revoke a subscription link",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/calendar-subscriptions/:token",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "calendar-subscriptions",
                ":token"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "The link stops working at once.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `404` | Subscription link not found. |"
          }
        },
        {
          "name": "List events in a time range",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/calendars/:calendar/events",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "calendars",
                ":calendar",
                "events"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Events overlapping `start`–`end` (ISO 8601, at most 400 days apart). Repeating events come back once per occurrence in the range.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `400` | `end must be after start`, a range over 400 days, or an invalid time zone. |\n| `404` | No calendar by that name. |"
          }
        },
        {
          "name": "Create an event",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/calendars/:calendar/events",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "calendars",
                ":calendar",
                "events"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"summary\": \"Quarterly review\",\n  \"start\": \"2026-10-14T10:00:00+01:00\",\n  \"end\": \"2026-10-14T11:00:00+01:00\",\n  \"timezone_id\": \"Africa/Lagos\",\n  \"location\": \"Board room\",\n  \"reminders\": [\n    15\n  ],\n  \"attendees\": [\n    {\n      \"email\": \"tunde@example.com\",\n      \"name\": \"Tunde Bello\"\n    }\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Creates an event. Attendees are emailed an invitation.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "Read an event",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/calendars/:calendar/events/:event_id",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "calendars",
                ":calendar",
                "events",
                ":event_id"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `404` | Event not found. |"
          }
        },
        {
          "name": "Answer an invitation",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/calendar/invitations/:invitation_id/rsvp",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "calendar",
                "invitations",
                ":invitation_id",
                "rsvp"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"response\": \"accepted\",\n  \"calendar\": \"default\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Accepts, declines or tentatively accepts. The organizer is emailed the answer and, unless declined, the event goes in `calendar`.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `404` | `That invitation is no longer there`. |\n| `422` | `response` is not accepted, declined or tentative, or the invitation cannot be read. |"
          }
        },
        {
          "name": "Update an event",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/calendars/:calendar/events/:event_id",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "calendars",
                ":calendar",
                "events",
                ":event_id"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"summary\": \"Quarterly review\",\n  \"start\": \"2026-10-14T10:00:00+01:00\",\n  \"end\": \"2026-10-14T11:00:00+01:00\",\n  \"timezone_id\": \"Africa/Lagos\",\n  \"location\": \"Board room\",\n  \"reminders\": [\n    15\n  ],\n  \"attendees\": [\n    {\n      \"email\": \"tunde@example.com\",\n      \"name\": \"Tunde Bello\"\n    }\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Replaces the event. Send the `etag` you read (as a query parameter) so a change made elsewhere is not overwritten. Attendees are told of the change.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `404` | Event not found. |\n| `409` | `This event changed elsewhere. Reload and try again.` |"
          }
        },
        {
          "name": "Delete an event",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/calendars/:calendar/events/:event_id",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "calendars",
                ":calendar",
                "events",
                ":event_id"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Deletes the event; attendees are told it was cancelled. Pass `etag` to delete only the version you read.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        }
      ]
    },
    {
      "name": "Mailbox AI",
      "description": "Operations for mailbox ai.",
      "item": [
        {
          "name": "Read the AI consent",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/ai/consent",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "ai",
                "consent"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Current opt-in flags, the version accepted, when, the version currently in force, and the URL of the consent document. Deliberately available regardless of entitlement or org policy — reading one's own consent state is never gated.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "Read the AI terms",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/ai/terms",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "ai",
                "terms"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "The current AI assistant terms the holder is asked to accept, and their version.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "Sort emails into categories with AI",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/ai/classify",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "ai",
                "classify"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"items\": [\n    {\n      \"id\": \"INBOX:4821\",\n      \"subject\": \"Your invoice for October\",\n      \"preview\": \"Amount due: ₦84,000\"\n    }\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Labels a batch of messages as primary, newsletter, promotion, social, notification, finance, travel, action_required or other. Only when `capabilities.ai` is true and the holder has accepted the AI terms (`POST /ai/consent`).\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `502` | The AI service did not answer usefully. |"
          }
        },
        {
          "name": "Draft an email with AI",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/ai/compose",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "ai",
                "compose"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"instruction\": \"Thank Tunde for the figures and ask for the Q4 forecast by Friday.\",\n  \"existing_draft\": null\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Writes or rewrites a draft from an instruction. Only when `capabilities.ai` is true and the holder has accepted the AI terms (`POST /ai/consent`).\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `502` | The AI service did not answer usefully. |\n| `503` | No AI is set up on this server. |"
          }
        },
        {
          "name": "Accept the AI terms",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/ai/consent",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "ai",
                "consent"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"accept_assistant\": true,\n  \"accept_training\": false,\n  \"terms_version\": \"2026-09\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Records the holder's acceptance of the current terms (`terms_version` from `GET /ai/terms`). `accept_training` is a separate, optional choice.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `409` | The terms changed since they were read; show the current ones. |\n| `422` | `accept_assistant` must be true (withdraw with `DELETE /ai/consent`). |"
          }
        },
        {
          "name": "Withdraw AI consent",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/ai/consent",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "ai",
                "consent"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Withdraws both the assistant and training decisions and writes a 'revoked' ledger entry with its own receipt document. Idempotent: with nothing to withdraw it succeeds without writing anything.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "AI consent history",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/ai/consent/history",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "ai",
                "consent",
                "history"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Every consent decision, newest first.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "Summarise an email with AI",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/ai/summarize/:message_id",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "ai",
                "summarize",
                ":message_id"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "No body. Only when `capabilities.ai` is true and the holder has accepted the AI terms (`POST /ai/consent`).\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `422` | The message has no text to summarise. |\n| `502` | The AI service did not answer usefully. |\n| `503` | No AI is set up on this server. |"
          }
        },
        {
          "name": "Withdraw the training choice only",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/ai/consent/training",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "ai",
                "consent",
                "training"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Turns off use of this mailbox's requests for model improvement while leaving the assistant itself consented. Idempotent.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "Download a consent record",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/ai/consent/:consent_id/document",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "ai",
                "consent",
                ":consent_id",
                "document"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "The signed record of one decision, as a file.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `404` | Document not found. |"
          }
        },
        {
          "name": "Summarise a conversation with AI",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/ai/summarize/thread/:message_id",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "ai",
                "summarize",
                "thread",
                ":message_id"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "No body. Only when `capabilities.ai` is true and the holder has accepted the AI terms (`POST /ai/consent`).\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `404` | Message not found. |\n| `422` | The conversation has no text to summarise. |"
          }
        }
      ]
    },
    {
      "name": "Mailbox settings",
      "description": "Operations for mailbox settings.",
      "item": [
        {
          "name": "List blocked senders",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/blocked-senders",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "blocked-senders"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Mail from a blocked address is filed to the Junk folder at delivery, before any rule, forward or vacation reply runs. Nothing is discarded.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "What this mailbox can do",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/capabilities",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "capabilities"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Which features this mail server offers this mailbox, and the shared mailboxes it may use. Call it once after signing in and hide what is off.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "Read forwarding",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/forwarding",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "forwarding"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "Read filter rules",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/rules",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "rules"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "The rules applied to new mail, in order.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "Read settings",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/settings",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "settings"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "The mailbox holder's own settings, and storage used.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "Read the vacation reply",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/vacation",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "vacation"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "Block a sender",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/blocked-senders",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "blocked-senders"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"address\": \"spam@example.net\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Mail from this address goes straight to Junk. One full address per call (whole domains cannot be blocked); up to 500.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        },
        {
          "name": "Set forwarding",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/forwarding",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "forwarding"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"enabled\": true,\n  \"addresses\": [\n    \"ada.obi@gmail.com\"\n  ],\n  \"keep_copy\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Forwards new mail to up to 5 addresses. `keep_copy: false` forwards without keeping a copy here. Send `enabled: false` to stop.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `422` | No address while turning it on, more than 5 addresses, or the mailbox's own address. |"
          }
        },
        {
          "name": "Replace filter rules",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/rules",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "rules"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"rules\": [\n    {\n      \"name\": \"Invoices to Finance\",\n      \"match\": \"any\",\n      \"enabled\": true,\n      \"conditions\": [\n        {\n          \"field\": \"subject\",\n          \"operator\": \"contains\",\n          \"value\": \"invoice\"\n        }\n      ],\n      \"actions\": [\n        {\n          \"type\": \"move\",\n          \"value\": \"Finance\"\n        }\n      ]\n    }\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Replaces the whole list (up to 50 rules), in the order given. Send every rule you want to keep.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `422` | More than 50 rules, or a rule with an unknown field, operator or action. |"
          }
        },
        {
          "name": "Update settings",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/settings",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "settings"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Ada Obi\",\n  \"signature_on_reply\": true,\n  \"undo_send_seconds\": 10\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Send only what changes. `undo_send_seconds` is 5, 10, 20 or 30; `display_density` is `comfortable` or `compact`. Answers with all settings.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `422` | A blank display name, an unknown display density, or an undo window that is not 5, 10, 20 or 30. |"
          }
        },
        {
          "name": "Set the vacation reply",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/vacation",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "vacation"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"enabled\": true,\n  \"subject\": \"Out of office\",\n  \"message\": \"I'm away until 20 October and will reply then.\",\n  \"start_date\": \"2026-10-13\",\n  \"end_date\": \"2026-10-20\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "An automatic reply to people who write while you are away, optionally between two dates. Send `enabled: false` to stop it.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |\n| `422` | `Write the message to send, or turn the responder off`. |"
          }
        },
        {
          "name": "Unblock a sender",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{mailboxBaseUrl}}/api/v1/mailbox/blocked-senders/:address",
              "host": [
                "{{mailboxBaseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "mailbox",
                "blocked-senders",
                ":address"
              ]
            },
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{mailboxToken}}",
                  "type": "string"
                }
              ]
            },
            "description": "Removes one address. Unblocking an address that is not blocked is not an error. Mail already filed to Junk stays where it is.\n\n**Errors**\n\n| Status | When |\n|---|---|\n| `401` | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |\n| `403` | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |"
          }
        }
      ]
    },
    {
      "name": "Transport rules",
      "description": "Organization-wide rules applied to mail in transit.",
      "item": [
        {
          "name": "List transport rules",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/transport-rules",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "transport-rules"
              ]
            },
            "description": "Required scope: `transport_rules:read`"
          }
        },
        {
          "name": "Create a transport rule",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/transport-rules",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "transport-rules"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Flag mail from outside\",\n  \"conditions\": [\n    {\n      \"field\": \"sender\",\n      \"operator\": \"ends_with\",\n      \"value\": \"@example.com\"\n    }\n  ],\n  \"actions\": [\n    {\n      \"type\": \"modify_subject\",\n      \"params\": {\n        \"prefix\": \"[External] \"\n      }\n    }\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `transport_rules:write`"
          }
        },
        {
          "name": "Retrieve a transport rule",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/transport-rules/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "transport-rules",
                ":id"
              ]
            },
            "description": "Required scope: `transport_rules:read`"
          }
        },
        {
          "name": "Update a transport rule",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/transport-rules/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "transport-rules",
                ":id"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Flag mail from outside\",\n  \"conditions\": [\n    {\n      \"field\": \"sender\",\n      \"operator\": \"ends_with\",\n      \"value\": \"@example.com\"\n    }\n  ],\n  \"actions\": [\n    {\n      \"type\": \"modify_subject\",\n      \"params\": {\n        \"prefix\": \"[External] \"\n      }\n    }\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `transport_rules:write`"
          }
        },
        {
          "name": "Reorder (transport rule)",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/transport-rules/reorder",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "transport-rules",
                "reorder"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"rule_ids\": [\n    \"01JBT8XQ2M9WYC3K4F6R7S8T9V\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `transport_rules:write`"
          }
        },
        {
          "name": "Delete a transport rule",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/transport-rules/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "transport-rules",
                ":id"
              ]
            },
            "description": "Required scope: `transport_rules:write`"
          }
        },
        {
          "name": "Enable a transport rule",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/transport-rules/:id/enable",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "transport-rules",
                ":id",
                "enable"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"enabled\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `transport_rules:write`"
          }
        }
      ]
    },
    {
      "name": "Campaigns",
      "description": "Bulk sends to a list or segment, scheduled and reported on.",
      "item": [
        {
          "name": "List campaigns",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/campaigns",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "campaigns"
              ]
            },
            "description": "Required scope: `campaigns:read`"
          }
        },
        {
          "name": "Create a campaign",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/campaigns",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "campaigns"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"October newsletter\",\n  \"sender_id\": \"01JBT8XQ2M9WYC3K4F6R7S8T9V\",\n  \"subject\": \"Our October update\",\n  \"html\": \"<p>Hi {{name}},</p><p>Here is what is new this month.</p>\",\n  \"list_ids\": [\n    \"01JBT8XQ2M9WYC3K4F6R7S8T9V\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `campaigns:write`\n\nA campaign is a bulk send to a list or segment, with unsubscribe handling, reporting\nand — for organizations new to marketing sending — a review step.\n\nCreating one does not send it. Schedule or send it explicitly, and call\n`preflight` first: it checks the things that get a campaign stopped, and it is far\ncheaper to fail there than halfway through a list."
          }
        },
        {
          "name": "Retrieve a campaign",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/campaigns/:campaign",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "campaigns",
                ":campaign"
              ]
            },
            "description": "Required scope: `campaigns:read`"
          }
        },
        {
          "name": "Update a campaign",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/campaigns/:campaign",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "campaigns",
                ":campaign"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"October newsletter\",\n  \"subject\": \"Our October update\",\n  \"html\": \"<p>Hi {{name}},</p><p>Here is what is new this month.</p>\",\n  \"list_ids\": [\n    \"01JBT8XQ2M9WYC3K4F6R7S8T9V\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `campaigns:write`"
          }
        },
        {
          "name": "Update a campaign",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/campaigns/:campaign",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "campaigns",
                ":campaign"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"October newsletter\",\n  \"subject\": \"Our October update\",\n  \"html\": \"<p>Hi {{name}},</p><p>Here is what is new this month.</p>\",\n  \"list_ids\": [\n    \"01JBT8XQ2M9WYC3K4F6R7S8T9V\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `campaigns:write`"
          }
        },
        {
          "name": "Delete a campaign",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/campaigns/:campaign",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "campaigns",
                ":campaign"
              ]
            },
            "description": "Required scope: `campaigns:write`"
          }
        },
        {
          "name": "Recipients a campaign",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/campaigns/:campaign/recipients",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "campaigns",
                ":campaign",
                "recipients"
              ]
            },
            "description": "Required scope: `campaigns:read`"
          }
        },
        {
          "name": "Report a campaign",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/campaigns/:campaign/report",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "campaigns",
                ":campaign",
                "report"
              ]
            },
            "description": "Required scope: `campaigns:read`"
          }
        },
        {
          "name": "Stats a campaign",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/campaigns/:campaign/stats",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "campaigns",
                ":campaign",
                "stats"
              ]
            },
            "description": "Required scope: `campaigns:read`"
          }
        },
        {
          "name": "Cancel a campaign",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/campaigns/:campaign/cancel",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "campaigns",
                ":campaign",
                "cancel"
              ]
            },
            "description": "Required scope: `campaigns:write`\n\nThis endpoint takes no request body."
          }
        },
        {
          "name": "Pause a campaign",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/campaigns/:campaign/pause",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "campaigns",
                ":campaign",
                "pause"
              ]
            },
            "description": "Required scope: `campaigns:write`\n\nThis endpoint takes no request body."
          }
        },
        {
          "name": "Preflight a campaign",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/campaigns/:campaign/preflight",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "campaigns",
                ":campaign",
                "preflight"
              ]
            },
            "description": "Required scope: `campaigns:read`\n\nChecks a campaign for the problems that would stop it — unverified domain, missing\nunsubscribe, empty audience, insufficient allowance — without sending anything.\n\nOnce Bounce protection is on for your account it also says how many recipients were never\nchecked (`unchecked_count`, and about what share looks bad, `likely_bad_percent`) and how\nmany the send will skip because their inbox is full (`inbox_full_count`, with the latest\nend of those holds in `inbox_full_until`). Skipped recipients are still in\n`recipient_count`; their recipient status reads `skipped_inbox_full`.\n\nIf your marketing is stopped because too many emails bounced, the blocker `bounce_stop`\nsays so, and its `message` says how to start again.\n\nThis endpoint takes no request body."
          }
        },
        {
          "name": "Resend a campaign",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/campaigns/:campaign/resend",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "campaigns",
                ":campaign",
                "resend"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"audience\": \"non_openers\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `campaigns:write`"
          }
        },
        {
          "name": "Resume a campaign",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/campaigns/:campaign/resume",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "campaigns",
                ":campaign",
                "resume"
              ]
            },
            "description": "Required scope: `campaigns:write`\n\nThis endpoint takes no request body."
          }
        },
        {
          "name": "Schedule a campaign",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/campaigns/:campaign/schedule",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "campaigns",
                ":campaign",
                "schedule"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"scheduled_at\": \"2026-11-02T09:00:00+01:00\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `campaigns:write`"
          }
        },
        {
          "name": "Send a campaign now",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/campaigns/:campaign/send",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "campaigns",
                ":campaign",
                "send"
              ]
            },
            "description": "Required scope: `campaigns:write`\n\nBegins the send immediately.\n\nMarketing mail rides a different egress path from transactional mail, deliberately, so\na newsletter cannot damage the reputation that carries your password resets. New\nmarketing senders are rate-limited while they warm up, so a large first campaign will\ntake longer than you expect — that is the system working.\n\nThis endpoint takes no request body."
          }
        },
        {
          "name": "Send a test",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/campaigns/:campaign/test-send",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "campaigns",
                ":campaign",
                "test-send"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"emails\": [\n    \"you@yourdomain.com\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `campaigns:write`\n\nSends the campaign to addresses you name, so you can see it as a recipient would. Does not touch the audience and does not count against the campaign report."
          }
        }
      ]
    },
    {
      "name": "Automations",
      "description": "Journeys that run per contact: triggered by a list, a tag or an event your system records, with waits and emails in between.",
      "item": [
        {
          "name": "List automations",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/automations",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "automations"
              ]
            },
            "description": "Required scope: `automations:read`"
          }
        },
        {
          "name": "Create a automation",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/automations",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "automations"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Welcome series\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `automations:write`"
          }
        },
        {
          "name": "Retrieve a automation",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/automations/:automation",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "automations",
                ":automation"
              ]
            },
            "description": "Required scope: `automations:read`"
          }
        },
        {
          "name": "Node Types (automation)",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/automations/node-types",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "automations",
                "node-types"
              ]
            },
            "description": "Required scope: `automations:read`"
          }
        },
        {
          "name": "Recipes (automation)",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/automations/recipes",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "automations",
                "recipes"
              ]
            },
            "description": "Required scope: `automations:read`"
          }
        },
        {
          "name": "Settings (automation)",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/automations/settings",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "automations",
                "settings"
              ]
            },
            "description": "Required scope: `automations:read`"
          }
        },
        {
          "name": "Update a automation",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/automations/:automation",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "automations",
                ":automation"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Welcome series\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `automations:write`"
          }
        },
        {
          "name": "Settings (automation)",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/automations/settings",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "automations",
                "settings"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"max_marketing_per_day\": 2,\n  \"max_marketing_per_week\": 5\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `automations:write`"
          }
        },
        {
          "name": "Delete a automation",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/automations/:automation",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "automations",
                ":automation"
              ]
            },
            "description": "Required scope: `automations:write`"
          }
        },
        {
          "name": "Versions a automation",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/automations/:automation/versions",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "automations",
                ":automation",
                "versions"
              ]
            },
            "description": "Required scope: `automations:read`"
          }
        },
        {
          "name": "Archive an automation",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/automations/:automation/archive",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "automations",
                ":automation",
                "archive"
              ]
            },
            "description": "Required scope: `automations:write`\n\nStops an automation for good. Everyone inside leaves it and it cannot be published again; its history stays readable.\n\nThis endpoint takes no request body."
          }
        },
        {
          "name": "Preview an automation",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/automations/:automation/dry-run",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "automations",
                ":automation",
                "dry-run"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"deliver_to_sandbox\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `automations:write`\n\nWalks the current draft for up to three real contacts with the checks made for real and the waits skipped, and — where the start can be counted in advance — how many people would enter today. Sends nothing and writes nothing.\n\nPass `deliver_to_sandbox: true` to also put each email those contacts would receive into your **Sandbox**, built exactly as a real run builds it, so you can open the actual message. Nothing is delivered, no run is recorded and no credits are used; `sandbox_messages` in the response lists what landed. Refused with `422` when the Sandbox is not available."
          }
        },
        {
          "name": "Enrol a automation",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/automations/:automation/enrol",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "automations",
                ":automation",
                "enrol"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"contact_id\": \"01JBT8XQ2M9WYC3K4F6R7S8T9V\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `automations:write`"
          }
        },
        {
          "name": "Pause an automation",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/automations/:automation/pause",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "automations",
                ":automation",
                "pause"
              ]
            },
            "description": "Required scope: `automations:write`\n\nStops a live automation. Nobody new enters and nobody inside moves; resuming carries on where each person was, and waits that fell due meanwhile run straight away.\n\nThis endpoint takes no request body."
          }
        },
        {
          "name": "Publish an automation",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/automations/:automation/publish",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "automations",
                ":automation",
                "publish"
              ]
            },
            "description": "Required scope: `automations:write`\n\nValidates the draft and, when it passes, makes it the live version. People already inside finish the version they entered; new entrants get this one. A draft with problems answers `422` naming them.\n\nThis endpoint takes no request body."
          }
        },
        {
          "name": "Resume an automation",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/automations/:automation/resume",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "automations",
                ":automation",
                "resume"
              ]
            },
            "description": "Required scope: `automations:write`\n\nRestarts a paused automation. Refused with `422` when Mailyte paused it for unusual sending volume; that needs support.\n\nThis endpoint takes no request body."
          }
        }
      ]
    },
    {
      "name": "Automation runs",
      "description": "Operations for automation runs.",
      "item": [
        {
          "name": "Runs a automation",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/automations/:automation/runs",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "automations",
                ":automation",
                "runs"
              ]
            },
            "description": "Required scope: `automations:read`"
          }
        },
        {
          "name": "Retrieve a automation",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/automations/:automation/runs/:run",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "automations",
                ":automation",
                "runs",
                ":run"
              ]
            },
            "description": "Required scope: `automations:read`"
          }
        }
      ]
    },
    {
      "name": "Automation analytics",
      "description": "Operations for automation analytics.",
      "item": [
        {
          "name": "Report a automation",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/automations/:automation/report",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "automations",
                ":automation",
                "report"
              ]
            },
            "description": "Required scope: `automations:read`"
          }
        },
        {
          "name": "Stats a automation",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/automations/:automation/stats",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "automations",
                ":automation",
                "stats"
              ]
            },
            "description": "Required scope: `automations:read`"
          }
        }
      ]
    },
    {
      "name": "Automation AI & experiments",
      "description": "Operations for automation ai & experiments.",
      "item": [
        {
          "name": "Experiments a automation",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/automations/:automation/experiments",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "automations",
                ":automation",
                "experiments"
              ]
            },
            "description": "Required scope: `automations:read`"
          }
        },
        {
          "name": "Propose (automation)",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/automations/assistant/propose",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "automations",
                "assistant",
                "propose"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"intent\": \"Welcome new sign-ups with three emails over a week\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `automations:write`"
          }
        },
        {
          "name": "Create a automation",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/automations/:automation/assistant/email/:node",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "automations",
                ":automation",
                "assistant",
                "email",
                ":node"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"graph\": {\n    \"nodes\": [\n      \"node\"\n    ]\n  }\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `automations:write`"
          }
        },
        {
          "name": "Promote a automation",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/automations/:automation/experiments/:node/promote",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "automations",
                ":automation",
                "experiments",
                ":node",
                "promote"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"variant\": \"variant\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `automations:write`"
          }
        },
        {
          "name": "Explain (automation)",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/automations/:automation/runs/:run/assistant/explain",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "automations",
                ":automation",
                "runs",
                ":run",
                "assistant",
                "explain"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"question\": \"question\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `automations:write`"
          }
        }
      ]
    },
    {
      "name": "Contact events",
      "description": "Operations for contact events.",
      "item": [
        {
          "name": "Record contact events",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contact-events",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contact-events"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"events\": [\n    {\n      \"event\": \"checkout_started\",\n      \"email\": \"ada@example.com\",\n      \"occurred_at\": \"2026-09-23T10:04:11+01:00\",\n      \"unique_id\": \"checkout-81234\",\n      \"properties\": {\n        \"cart_value\": 45000,\n        \"currency\": \"NGN\",\n        \"items\": 3\n      }\n    },\n    {\n      \"event\": \"order_completed\",\n      \"email\": \"tunde@example.com\",\n      \"unique_id\": \"order-50917\",\n      \"properties\": {\n        \"total\": 12500,\n        \"category\": \"consumable\"\n      }\n    }\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `contact_events:write`\n\nTells Mailyte that something happened to a person in your own system — a checkout started,\nan order completed, an application submitted. Automations that start on that event, wait\nfor it or leave on it react within seconds. Read\n[Sending contact events](/developer/guides/sending-contact-events) before you integrate.\n\nSend up to **500 events** in `events`, or post a single event's fields at the top level.\nEach event is checked on its own: a bad one is listed in `rejected` with its position and\nthe reason, and the others are recorded. The request fails as a whole only when its shape\nis wrong — no events, more than 500, an item that is not an object — or the key lacks\n`contact_events:write`.\n\nFour things to know before you send the first one:\n\n1. **An event is not consent.** An `email` we have never seen creates a contact with the\n   status `unconfirmed`. It can enter automations, but no automated email reaches it until\n   the contact is subscribed. Record consent through the contacts endpoints, not here.\n2. **Send `unique_id`.** Repeating an event with the same `unique_id` is counted under\n   `duplicates` and changes nothing, which is what makes a retry safe. Without one, a\n   key is derived from the event's name, person, time and properties — which only\n   catches an exact repeat.\n3. **Old events never start anything.** An event whose `occurred_at` is more than 7 days\n   before we receive it is stored as historical and never starts, moves or ends a journey.\n   Events are kept for 90 days from `occurred_at`, so anything older is removed overnight.\n4. **The limit is 600 requests a minute** per organization, across all its keys. Batch\n   rather than sending one request per event."
          }
        },
        {
          "name": "List event names",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contact-events/names",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contact-events",
                "names"
              ]
            },
            "description": "Required scope: `automations:read`\n\nThe event names an automation can use: Mailyte's own (`built_in`, always listed), then every\nname your systems have sent in the window, most recently seen first, up to 100. This is\nwhat the automation builder's event list is made from, so a name appears there as soon as\nthe first event carrying it is received — historical ones included."
          }
        }
      ]
    },
    {
      "name": "Contacts",
      "description": "Contacts, lists, custom fields and segments.",
      "item": [
        {
          "name": "List contact tags",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contact-tags",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contact-tags"
              ]
            },
            "description": "Required scope: `contacts:read`"
          }
        },
        {
          "name": "List contacts",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contacts",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contacts"
              ]
            },
            "description": "Required scope: `contacts:read`\n\nYour contacts, newest first.\n\n**For a sync, use `since_last_changed`.** It answers the only question an integration\nkeeping its own copy actually has — what moved — and turns a nightly full-list crawl into a\nrequest that usually returns nothing. The value is an ISO 8601 timestamp; remember to\nURL-encode it, because the `+` in `+00:00` means a space in a query string.\n\nA `since_last_changed` we cannot parse is IGNORED and you get everything, rather than\nnothing. The two failures are not symmetrical: a sync handed zero rows concludes it is up to\ndate and stops, and silently misses every change from then on.\n\n**Filter on `state`, not `status`.** `status` is what the contact row says; `state` is what\nthe product will actually do, and reconciles that row against your organization's\nsuppression list. A contact whose row says `subscribed` but whose address you suppressed\nanswers `state: \"suppressed\"` and will never be mailed, even though `?status=subscribed`\nreturns it."
          }
        },
        {
          "name": "Create a contact tag",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contact-tags",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contact-tags"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"vip\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `contacts:write`"
          }
        },
        {
          "name": "Create a contact",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contacts",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contacts"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"email\": \"ada@example.com\",\n  \"name\": \"Ada Obi\",\n  \"list_ids\": [\n    \"01JBT8XQ2M9WYC3K4F6R7S8T9V\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `contacts:write`\n\n**Checks.** Once Bounce protection is on for your account, a new contact, or a contact whose address\nchanges, is checked in the background with one check: its `email_status` reads `pending` until the\nanswer lands, then `valid`, `risky`, `invalid` (and the contact becomes `bounced`) or `unknown`. With\nBounce protection switched off, or no checks left, the contact is still saved, as `not_checked`. A\ncontact from an event (`unconfirmed`) is checked when it becomes `subscribed`. The write never fails\nbecause of a check.\n\nSend `\"check\": \"wait\"` to have the address checked before we answer (up to about 8 seconds), so the\n`email_status` in the reply is already the answer. Any other value is ignored. If the checker is\nslow, the contact is saved and checked in the background; if no checks are left, it is saved as\n`not_checked`.\n\nThe reply carries `X-Mailyte-Checks-Remaining` and, when it applies, `X-Mailyte-Checks-Warning:\nrunning_low | ran_out`. Neither is sent until Bounce protection is on for your account."
          }
        },
        {
          "name": "Create or update a contact",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contacts",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contacts"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"email\": \"ada@example.com\",\n  \"name\": \"Ada Lovelace\",\n  \"status_if_new\": \"subscribed\",\n  \"attributes\": {\n    \"plan\": \"pro\"\n  },\n  \"check\": \"wait\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `contacts:write`\n\nCreates the contact if this email is new, updates it if it is not — the call to reach for\nwhen you are keeping your own database in step with ours.\n\nWithout it a sync needs a GET, a branch, and then a POST or a PATCH: three round trips, and\na race between the read and the write.\n\n**`status_if_new` is the one to understand.** It applies only when the contact is created.\nA nightly sync that sends `status: subscribed` for everybody in your CRM would resurrect\nevery unsubscribe it touched — the worst thing this API can do to you, because the person\nasked not to be mailed and then was. Send `status_if_new` to say \"subscribed as far as I\nknow\" without overriding what the contact themselves decided here; send `status` only when\nyou mean to change it.\n\nLists named in `list_ids` are added. The contact's other memberships are left alone.\n\n**Checks.** Once Bounce protection is on for your account, a new contact, or a contact whose address\nchanges, is checked in the background with one check: its `email_status` reads `pending` until the\nanswer lands, then `valid`, `risky`, `invalid` (and the contact becomes `bounced`) or `unknown`. With\nBounce protection switched off, or no checks left, the contact is still saved, as `not_checked`. A\ncontact from an event (`unconfirmed`) is checked when it becomes `subscribed`. The write never fails\nbecause of a check.\n\nSend `\"check\": \"wait\"` to have the address checked before we answer (up to about 8 seconds), so the\n`email_status` in the reply is already the answer. Any other value is ignored. If the checker is\nslow, the contact is saved and checked in the background; if no checks are left, it is saved as\n`not_checked`.\n\nThe reply carries `X-Mailyte-Checks-Remaining` and, when it applies, `X-Mailyte-Checks-Warning:\nrunning_low | ran_out`. Neither is sent until Bounce protection is on for your account."
          }
        },
        {
          "name": "Retrieve a contact",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contacts/:contact",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contacts",
                ":contact"
              ]
            },
            "description": "Required scope: `contacts:read`"
          }
        },
        {
          "name": "Attribute Keys (contact)",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contacts/attribute-keys",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contacts",
                "attribute-keys"
              ]
            },
            "description": "Required scope: `contacts:read`"
          }
        },
        {
          "name": "Import contacts",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contacts/import",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contacts",
                "import"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"list_id\": \"01JBT8XQ2M9WYC3K4F6R7S8T9V\",\n  \"contacts\": [\n    {\n      \"email\": \"ada@example.com\",\n      \"name\": \"Ada Obi\"\n    },\n    {\n      \"email\": \"tunde@example.com\",\n      \"name\": \"Tunde Bello\",\n      \"attributes\": {\n        \"city\": \"Lagos\",\n        \"plan\": \"pro\"\n      }\n    }\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `contacts:write`\n\nAdd up to 10,000 contacts in one request, each with a name and any custom fields. New\ncontacts are added as `subscribed`. An address that is already a contact is left exactly as\nit is (name, fields and status) and counted in `skipped_duplicate`: import never updates\nanyone, so it can never re-subscribe somebody who unsubscribed. To update people, use\n`PUT /contacts`.\n\nA bad row never fails the request. A row with no address, an invalid address, or no value\nfor a custom field your account marks required is skipped, and the reply's `errors` names\nit by row number. Everything else is imported.\n\n**Two ways to send contacts.** Send JSON with a `contacts` array, as in the example below.\nOr upload a CSV file as a form (`multipart/form-data`) in a field called `file`:\n\n```bash\ncurl -X POST 'https://app.mailyte.com/api/v1/contacts/import' \\\n  -H 'Authorization: Bearer mk_live_YOUR_API_KEY' \\\n  -F 'file=@contacts.csv' \\\n  -F 'list_id=01JBT8XQ2M9WYC3K4F6R7S8T9V'\n```\n\nThe file's first row should be a header with an `email` column and, optionally, a `name`\ncolumn. Every other column becomes a custom field named after its header (\"Signup Date\"\nbecomes `signup_date`). Without a header, the first column is read as the email and the\nsecond as the name. Send `file` or `contacts`, not both.\n\n**Checks.** Once Bounce protection is on for your account, each new address uses one\ncheck and is checked in the background: `email_status` reads `pending` until the answer\nlands, then `valid`, `risky`, `invalid` or `unknown`. Read it with `GET /contacts/{id}`, or\nsubscribe to the `contact.checked` webhook. If your checks run short, as many new contacts\nas there are checks for are checked and the rest are added as `not_checked`. With Bounce\nprotection switched off they are added as `not_checked`. Until then an import's addresses\nare checked free, as before.\n\nThe reply carries `X-Mailyte-Checks-Remaining` and, when it applies,\n`X-Mailyte-Checks-Warning: running_low | ran_out`, once Bounce protection is on."
          }
        },
        {
          "name": "Update a contact",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contacts/:contact",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contacts",
                ":contact"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Ada Obi\",\n  \"attributes\": {\n    \"city\": \"Abuja\"\n  }\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `contacts:write`\n\nChange a contact's details. Send only the fields you want to change.\n\n**Lists are not changed here.** To add someone to a list use `POST /contact-lists/{id}/members`, or `PUT /contacts` with `list_ids`.\n\n**Checks.** Once Bounce protection is on for your account, a new contact, or a contact whose address\nchanges, is checked in the background with one check: its `email_status` reads `pending` until the\nanswer lands, then `valid`, `risky`, `invalid` (and the contact becomes `bounced`) or `unknown`. With\nBounce protection switched off, or no checks left, the contact is still saved, as `not_checked`. A\ncontact from an event (`unconfirmed`) is checked when it becomes `subscribed`. The write never fails\nbecause of a check.\n\nSend `\"check\": \"wait\"` to have the address checked before we answer (up to about 8 seconds), so the\n`email_status` in the reply is already the answer. Any other value is ignored. If the checker is\nslow, the contact is saved and checked in the background; if no checks are left, it is saved as\n`not_checked`.\n\nThe reply carries `X-Mailyte-Checks-Remaining` and, when it applies, `X-Mailyte-Checks-Warning:\nrunning_low | ran_out`. Neither is sent until Bounce protection is on for your account."
          }
        },
        {
          "name": "Update a contact",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contacts/:contact",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contacts",
                ":contact"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Ada Obi\",\n  \"attributes\": {\n    \"city\": \"Abuja\"\n  }\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `contacts:write`\n\nChange a contact's details. Send only the fields you want to change.\n\n**Lists are not changed here.** To add someone to a list use `POST /contact-lists/{id}/members`, or `PUT /contacts` with `list_ids`.\n\n**Checks.** Once Bounce protection is on for your account, a new contact, or a contact whose address\nchanges, is checked in the background with one check: its `email_status` reads `pending` until the\nanswer lands, then `valid`, `risky`, `invalid` (and the contact becomes `bounced`) or `unknown`. With\nBounce protection switched off, or no checks left, the contact is still saved, as `not_checked`. A\ncontact from an event (`unconfirmed`) is checked when it becomes `subscribed`. The write never fails\nbecause of a check.\n\nSend `\"check\": \"wait\"` to have the address checked before we answer (up to about 8 seconds), so the\n`email_status` in the reply is already the answer. Any other value is ignored. If the checker is\nslow, the contact is saved and checked in the background; if no checks are left, it is saved as\n`not_checked`.\n\nThe reply carries `X-Mailyte-Checks-Remaining` and, when it applies, `X-Mailyte-Checks-Warning:\nrunning_low | ran_out`. Neither is sent until Bounce protection is on for your account."
          }
        },
        {
          "name": "Delete a contact tag",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contact-tags/:tag",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contact-tags",
                ":tag"
              ]
            },
            "description": "Required scope: `contacts:write`"
          }
        },
        {
          "name": "Delete a contact",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contacts/:contact",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contacts",
                ":contact"
              ]
            },
            "description": "Required scope: `contacts:write`"
          }
        },
        {
          "name": "Automation Runs a contact",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contacts/:contact/automation-runs",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contacts",
                ":contact",
                "automation-runs"
              ]
            },
            "description": "Required scope: `contacts:read`"
          }
        },
        {
          "name": "List a contact's events",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contacts/:contact/events",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contacts",
                ":contact",
                "events"
              ]
            },
            "description": "Required scope: `contacts:read`\n\nThe events recorded for one contact, newest first by `occurred_at`, including historical ones. The same list as the Events tab on the contact in the dashboard — the quickest way to check an integration is sending what you think it is."
          }
        }
      ]
    },
    {
      "name": "Contact lists",
      "description": "Operations for contact lists.",
      "item": [
        {
          "name": "List contact lists",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contact-lists",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contact-lists"
              ]
            },
            "description": "Required scope: `contacts:read`"
          }
        },
        {
          "name": "Create a contact list",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contact-lists",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contact-lists"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Newsletter subscribers\",\n  \"description\": \"Opted in via the footer form\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `contacts:write`"
          }
        },
        {
          "name": "Retrieve a contact list",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contact-lists/:contact_list",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contact-lists",
                ":contact_list"
              ]
            },
            "description": "Required scope: `contacts:read`"
          }
        },
        {
          "name": "Update a contact list",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contact-lists/:contact_list",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contact-lists",
                ":contact_list"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Newsletter subscribers (2026)\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `contacts:write`\n\nOnly `name` and `description` are editable. Membership is changed through the members routes, not by sending contacts here."
          }
        },
        {
          "name": "Update a contact list",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contact-lists/:contact_list",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contact-lists",
                ":contact_list"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Newsletter subscribers (2026)\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `contacts:write`\n\nOnly `name` and `description` are editable. Membership is changed through the members routes, not by sending contacts here."
          }
        },
        {
          "name": "Delete a contact list",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contact-lists/:contact_list",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contact-lists",
                ":contact_list"
              ]
            },
            "description": "Required scope: `contacts:write`"
          }
        },
        {
          "name": "Add contacts to a list",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contact-lists/:contactList/members",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contact-lists",
                ":contactList",
                "members"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"contact_ids\": [\n    \"01m2q1qc6skqy6k2sq88abm4pw\",\n    \"01m2r4sx6d2h67srjk6knwjczp\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `contacts:write`\n\nAdds existing contacts to a list. This does **not** create contacts — create them first with\n`POST /api/v1/contacts`, then add them here by id.\n\nAdding somebody who is already on the list is a no-op rather than an error or a duplicate, so\nthis is safe to call repeatedly with the same payload.\n\nIds that do not belong to your organization are ignored rather than rejected, and counted in\n`skipped`. They are not named: saying which ids were unknown would confirm which ids exist in\nsomebody else's account. If `skipped` comes back non-zero, check the ids you sent."
          }
        },
        {
          "name": "Remove a contact from a list",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contact-lists/:contactList/members/:contact",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contact-lists",
                ":contactList",
                "members",
                ":contact"
              ]
            },
            "description": "Required scope: `contacts:write`\n\nTakes one contact off a list. The contact itself is **not** deleted and its other list\nmemberships are untouched — to delete the contact entirely, use\n`DELETE /api/v1/contacts/{contact}`.\n\nRemoving somebody who was not on the list is a no-op, answering `removed: 0`."
          }
        }
      ]
    },
    {
      "name": "Contact fields",
      "description": "Operations for contact fields.",
      "item": [
        {
          "name": "List contact fields",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contact-fields",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contact-fields"
              ]
            },
            "description": "Required scope: `contacts:read`"
          }
        },
        {
          "name": "Create a contact field",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contact-fields",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contact-fields"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"label\": \"Company\",\n  \"type\": \"text\",\n  \"required\": true,\n  \"help_text\": \"The organisation they work for\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `contacts:write`\n\nDeclares one key of a contact's `fields` object: its label, its type, whether it is\nrequired, the value to fall back on and the hint to show beside it.\n\n**Declaring is optional.** A contact may carry any attribute key you write, declared or not,\nand an undeclared key works in content and in segment rules exactly the same. What a\ndeclaration adds is a label, a default at send time, a place in the field picker, and the\noption of requiring it. `declared` on the field object tells you which kind you are looking\nat.\n\n**`required` is enforced in two places and only two.** A contact being CREATED must supply\nit, and an update may not CLEAR a value that was already there. It is never checked\nretroactively, so marking a long-standing field required does not start rejecting contacts\nthat predate the decision — which is the only way anyone could safely turn it on for a live\naudience. In an import, a row with no value for a required field comes back in `errors[]`\nwith reason `missing_required_field`; the rest of the file still imports.\n\n**`default_value` does not satisfy `required`.** The default is substituted at render time\nfor a contact who has no value of their own and is never written to the contact. Accepting a\nplaceholder for a field you marked required would be the opposite of what you asked for.\n\nAn organization may hold 100 field definitions. The 101st is refused with the count and the\ncap in the message."
          }
        },
        {
          "name": "Update a contact field",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contact-fields/:field",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contact-fields",
                ":field"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"label\": \"label\",\n  \"required\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `contacts:write`"
          }
        },
        {
          "name": "Delete a contact field",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contact-fields/:field",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contact-fields",
                ":field"
              ]
            },
            "description": "Required scope: `contacts:write`"
          }
        }
      ]
    },
    {
      "name": "Contact tags & interests",
      "description": "Operations for contact tags & interests.",
      "item": [
        {
          "name": "List interest categorys",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/interest-categories",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "interest-categories"
              ]
            },
            "description": "Required scope: `contacts:read`"
          }
        },
        {
          "name": "Create a interest category",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/interest-categories",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "interest-categories"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"title\": \"What would you like to hear about?\",\n  \"interests\": [\n    \"Product updates\",\n    \"Events\"\n  ],\n  \"type\": \"checkboxes\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `contacts:write`"
          }
        },
        {
          "name": "Delete a interest category",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/interest-categories/:category",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "interest-categories",
                ":category"
              ]
            },
            "description": "Required scope: `contacts:write`"
          }
        },
        {
          "name": "Tags a contact",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contacts/:contact/tags",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contacts",
                ":contact",
                "tags"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"add\": [\n    \"vip\"\n  ],\n  \"remove\": [\n    \"trial\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `contacts:write`"
          }
        },
        {
          "name": "Interests a contact",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/contacts/:contact/interests",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "contacts",
                ":contact",
                "interests"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"interest_ids\": [\n    \"01JBT8XQ2M9WYC3K4F6R7S8T9V\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `contacts:write`"
          }
        }
      ]
    },
    {
      "name": "Segments",
      "description": "Operations for segments.",
      "item": [
        {
          "name": "List segments",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/segments",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "segments"
              ]
            },
            "description": "Required scope: `contacts:read`"
          }
        },
        {
          "name": "Create a segment",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/segments",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "segments"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"rules\": [\n    {\n      \"field\": \"city\",\n      \"op\": \"equals\",\n      \"value\": \"Lagos\"\n    }\n  ],\n  \"name\": \"Lagos customers\",\n  \"match\": \"all\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `contacts:write`"
          }
        },
        {
          "name": "Preview a segment",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/segments/preview",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "segments",
                "preview"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"rules\": [\n    {\n      \"field\": \"city\",\n      \"op\": \"equals\",\n      \"value\": \"Lagos\"\n    }\n  ],\n  \"name\": \"Lagos customers\",\n  \"match\": \"all\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `contacts:read`\n\nHow many contacts a set of rules currently matches, and a sample of them, without saving the\nsegment. Call this before sending to one.\n\n**Rules take one of four kinds of field:**\n\n| Kind | Fields | Example |\n|---|---|---|\n| Contact columns | `email`, `name`, `status` | `{\"field\": \"email\", \"op\": \"ends_with\", \"value\": \"@acme.com\"}` |\n| Custom fields | any key from `GET /contact-fields` | `{\"field\": \"plan\", \"op\": \"equals\", \"value\": \"pro\"}` |\n| Engagement | `opened`, `clicked`, `emailed` | `{\"field\": \"opened\", \"op\": \"within_days\", \"value\": \"90\"}` |\n| **Membership** | `tag`, `interest` | `{\"field\": \"tag\", \"op\": \"equals\", \"value\": \"vip\"}` |\n\n**`tag` matches by NAME, `interest` matches by ID.** That asymmetry is deliberate. A tag is\nwritten by name everywhere — created on first use, case-insensitively — so a rule holding a\nULID would break the moment somebody renamed it. An interest is an answer to a question the\n*contact* was asked and its name is form copy, so rewording \"Product updates\" must not\nsilently empty every segment built on it.\n\nMembership fields take `equals`, `not_equals`, `is_set` (has any) and `is_not_set` (has\nnone). Deliberately **not** `contains`: a tag is on a contact or it is not, and a substring\nmatch over a set would let `contains \"vip\"` quietly also match `vip-churn-risk`.\n\n**`not_equals` means \"does not carry it\", not \"carries something else\".** A contact with\nboth `vip` and `churn-risk` is EXCLUDED by `tag is not vip` — they carry it. A contact with\nno tags at all is included, because they do not.\n\nA rule we cannot evaluate — an unparseable number or date, a blank tag — matches **nothing**.\nWidening is the dangerous direction: it mails people who were never meant to be in the\naudience, and it does so quietly."
          }
        },
        {
          "name": "Update a segment",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/segments/:segment",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "segments",
                ":segment"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"rules\": [\n    {\n      \"field\": \"city\",\n      \"op\": \"equals\",\n      \"value\": \"Lagos\"\n    }\n  ],\n  \"name\": \"Lagos customers\",\n  \"match\": \"all\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `contacts:write`"
          }
        },
        {
          "name": "Delete a segment",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/segments/:segment",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "segments",
                ":segment"
              ]
            },
            "description": "Required scope: `contacts:write`"
          }
        }
      ]
    },
    {
      "name": "Verification",
      "description": "Check whether addresses exist before you send, without sending anything.",
      "item": [
        {
          "name": "List verifications",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/verifications",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "verifications"
              ]
            },
            "description": "Required scope: `verification:read`"
          }
        },
        {
          "name": "Verify a list of addresses",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/verifications",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "verifications"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"emails\": [\n    \"ada@example.com\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `verification:write`\n\nChecks whether each address has a mailbox — **without sending anything**. We ask the\nrecipient's mail server directly, the way a sending server would, and stop before any\nmessage is sent.\n\nUses **one check per unique address**, taken when the verification starts: this month's\nplan checks first, then checks you bought, then send credits bought before checks launched\n(10 credits a check). Duplicates and letter case are removed first, so `Ada@x.com` and\n`ada@x.com` are one address. If you have fewer checks than the list needs, nothing starts\nand nothing is used: a `402` whose `data.quote` says how many you need and which pack\ncovers the rest. An address we could not confirm gives its check back. The reply carries\n`X-Mailyte-Checks-Remaining`.\n\nBefore checks launch on your account, a list is paid in send credits instead, priced by its\nsize, after the list checks your plan includes this month; with too few credits nothing\nstarts (a `402`).\n\nMost answers arrive within seconds. Gmail mailboxes are checked at a steady pace, so a large\nlist can take a while; addresses still being checked read `pending`. Anything we cannot\nanswer within a day is refunded.\n\nSend an `Idempotency-Key` header so a retried request is never charged twice. Up to\n**50,000** addresses per verification, and up to 3 running at once."
          }
        },
        {
          "name": "Retrieve a verification",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/verifications/:verification",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "verifications",
                ":verification"
              ]
            },
            "description": "Required scope: `verification:read`"
          }
        },
        {
          "name": "Contact health",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/verifications/summary",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "verifications",
                "summary"
              ]
            },
            "description": "Required scope: `verification:read`\n\nHow your **subscribed** contacts stand — the ones a send would reach; unsubscribed, bounced,\ncomplained and unconfirmed contacts are not counted. Free, and never a probe.\n\n`by_status` splits `total_subscribed` by `email_status`, and its seven keys always add up to\nit: `never_checked` is a null `email_status` (from before Bounce protection launched),\n`not_checked` was added after it and not checked. A full inbox counts under `risky`.\n\n`safe_percent` is `valid` plus `risky`, less the contacts whose full inbox is being held,\nover `total_subscribed`, rounded down. It is **null when fewer than half are checked** — then\nsay how many are not checked yet instead of a percentage.\n\nThe two `look_bad_about` counts are free counts over the not-checked contacts and over the\nlast 7 days' new ones, rounded as `POST /verifications/peek` rounds them. `0` means fewer\nthan 10; null means we have no count yet (it is made in the background, so ask again in a\nminute), the checker could not be asked, or there are fewer than 10 addresses to count.\n\n`launch_check`: `running` while we check your existing contacts once, free, at launch;\n`done` after; null when that never ran for your account."
          }
        },
        {
          "name": "Check one address",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/verifications/check",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "verifications",
                "check"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"email\": \"ada@example.com\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `verification:write`\n\nChecks one address and answers in the same call when it can — a mailbox we have not seen\nbefore can take a few seconds. Use it at sign-up, before an address goes into your database.\n\nUses **one check**, and only when there is an answer: a `pending` result, \"couldn't confirm\"\nand \"not an email address\" cost nothing; for `pending`, ask again a little later. The\nanswer says which in `checks_used` (`1` when it used a check, `0` when it was free), and the\nreply carries `X-Mailyte-Checks-Remaining`. With no checks left it is a `402` naming the\npack that covers it.\n\nBefore checks launch on your account, an answer costs **10 send credits** (or one of the\nlist checks your plan includes this month) instead, charged only when there is an answer."
          }
        },
        {
          "name": "Verify your unchecked contacts",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/verifications/contacts",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "verifications",
                "contacts"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"max\": 2000\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `verification:write`\n\nChecks your contacts that have never been checked, newest first, up to `max` (at most\n50,000). Contacts whose address does not exist are marked `bounced` and are never mailed.\n\nOnce Bounce protection is on for your account, it uses **one check per address**, and new\ncontacts are checked as they arrive, so this is for contacts from before, or added while\nBounce protection was off or out of checks. If you have fewer checks than it needs, nothing\nstarts and nothing is used: a `402` whose `data.quote` covers it. An address Mailyte is\nalready asking again by itself (a check that could not confirm yet) is left out, so it is\nnever paid for twice. One such check runs at a time (a second is a `409`); if the checker\ncannot be reached, nothing is used (a `503`). The reply carries\n`X-Mailyte-Checks-Remaining` and, when it applies, `X-Mailyte-Checks-Warning`.\n\nBefore that, it is **free** and checks every never-checked contact; `max` is ignored."
          }
        },
        {
          "name": "Count how many addresses look bad (free)",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/verifications/peek",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "verifications",
                "peek"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"addresses\": [\n    \"ada@example.com\",\n    \"grace@example.org\",\n    \"…\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `verification:read`\n\nAbout how many of these addresses look bad — invalid, throwaway, or a full inbox we already\nknow of — **free, and never which ones**. Nothing is probed: the count comes from what we\nalready know and from checks that need no conversation with a mail server.\n\nThe answer is deliberately rough, so a free count never becomes a free answer:\n\n| `band` | When | Numbers |\n|---|---|---|\n| `too_few` | fewer than 10 distinct addresses | none; we do not look |\n| `fewer_than_10` | fewer than 10 look bad | none |\n| `about` | 10 or more look bad | `look_bad_about`: rounded down to tens, or to two significant figures from 1,000 (12,873 → 12,000); `look_bad_percent_about`, rounded down |\n\n`partial: true` means the checker could not be asked, so the count covers only broken\naddresses, misspelt domains and domains that cannot receive mail.\n\nAddresses are counted once, whatever their letter case. Up to **50,000** a request; more is\na `422`. Free, but limited to 30 counts an hour and 100 a UTC day per account (then `429`\nwith `Retry-After`); the same set again within 10 minutes is answered from memory and does\nnot count."
          }
        },
        {
          "name": "Get a verification's results",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/verifications/:verification/results",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "verifications",
                ":verification",
                "results"
              ]
            },
            "description": "Required scope: `verification:read`\n\nOne answer per address. `result` is what to do: send to `valid`, `risky` and `unknown`; mail\nto `invalid` is refused. `reason` says what was found, never how — an address known not to\nexist reads the same however we learned it.\n\n`risky` with reason `inbox_full` (and the flag `full`) means the mailbox has no space: mail\nwill bounce until the person clears it. Once Bounce protection is on for your account,\nmarketing to that contact is held for 7 days (`email_full_until` on the contact), then\nchecked again, free.\n\n`q` and `result` narrow the answers before they are paged, so a page is a page of the\nmatches: `?q=techies.africa` finds everyone on that domain, `?result=invalid,risky` keeps\nonly those two answers, and `offset` then counts the matches rather than the whole run.\n\nAdd `format=csv` to download the whole verification as a CSV file instead."
          }
        }
      ]
    },
    {
      "name": "Domains",
      "description": "Add a sending domain, publish its DNS, and verify it.",
      "item": [
        {
          "name": "List domains",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains"
              ]
            },
            "description": "Required scope: `domains:read`"
          }
        },
        {
          "name": "Add a domain",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"domain\": \"yourdomain.com\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `domains:write`\n\nRegisters a domain and returns the DNS records to publish. Nothing can be sent from it\nuntil those records are live and verification has passed.\n\nAdding a domain does **not** create any mailboxes. A domain with no mailboxes accepts\ninbound mail and then has nowhere to put it, so create at least one before pointing MX\nat us."
          }
        },
        {
          "name": "Retrieve a domain",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains/:domain",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains",
                ":domain"
              ]
            },
            "description": "Required scope: `domains:read`"
          }
        },
        {
          "name": "Update a domain",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains/:domain",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains",
                ":domain"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"domain\": \"yourdomain.com\",\n  \"description\": \"Everyone who signed up at GITEX\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `domains:write`"
          }
        },
        {
          "name": "Update a domain",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains/:domain",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains",
                ":domain"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"domain\": \"yourdomain.com\",\n  \"description\": \"Everyone who signed up at GITEX\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `domains:write`"
          }
        },
        {
          "name": "Delete a domain",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains/:domain",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains",
                ":domain"
              ]
            },
            "description": "Required scope: `domains:write`"
          }
        },
        {
          "name": "Limits a domain",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains/:domain/limits",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains",
                ":domain",
                "limits"
              ]
            },
            "description": "Required scope: `domains:read`"
          }
        },
        {
          "name": "Overview a domain",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains/:domain/overview",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains",
                ":domain",
                "overview"
              ]
            },
            "description": "Required scope: `domains:read`"
          }
        },
        {
          "name": "Disable a domain",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains/:domain/disable",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains",
                ":domain",
                "disable"
              ]
            },
            "description": "Required scope: `domains:write`\n\nThis endpoint takes no request body."
          }
        },
        {
          "name": "Enable a domain",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains/:domain/enable",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains",
                ":domain",
                "enable"
              ]
            },
            "description": "Required scope: `domains:write`\n\nThis endpoint takes no request body."
          }
        },
        {
          "name": "Retry Provisioning a domain",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains/:domain/retry-provisioning",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains",
                ":domain",
                "retry-provisioning"
              ]
            },
            "description": "Required scope: `domains:write`\n\nThis endpoint takes no request body."
          }
        },
        {
          "name": "Retrieve sending limits for one address",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains/:domain/limits/:email",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains",
                ":domain",
                "limits",
                ":email"
              ]
            },
            "description": "Required scope: `domains:read`"
          }
        }
      ]
    },
    {
      "name": "Domain verification",
      "description": "Operations for domain verification.",
      "item": [
        {
          "name": "Dkim a domain",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains/:domain/dkim",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains",
                ":domain",
                "dkim"
              ]
            },
            "description": "Required scope: `domains:read`"
          }
        },
        {
          "name": "Dns Provider a domain",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains/:domain/dns-provider",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains",
                ":domain",
                "dns-provider"
              ]
            },
            "description": "Required scope: `domains:read`"
          }
        },
        {
          "name": "Get the DNS records to publish",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains/:domain/dns-records",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains",
                ":domain",
                "dns-records"
              ]
            },
            "description": "Required scope: `domains:read`\n\nThe records this domain needs, with their current observed state.\n\nSending needs **SPF and DKIM**; MX is only needed to *receive*. Mailyte tracks those\nseparately (`dns_verified` and `mx_verified`) precisely so a customer who sends through\nus but keeps their mailboxes elsewhere is not blocked on an MX record they must not\npublish."
          }
        },
        {
          "name": "Verification Status a domain",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains/:domain/verification-status",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains",
                ":domain",
                "verification-status"
              ]
            },
            "description": "Required scope: `domains:read`"
          }
        },
        {
          "name": "Email the DNS records to somebody",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains/:domain/send-records",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains",
                ":domain",
                "send-records"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"email\": \"dns-admin@example.com\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `domains:write`\n\nSends this domain's DNS records to an address — usually whoever administers the DNS, who is rarely the person holding the API key."
          }
        },
        {
          "name": "Sync a domain",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains/:domain/sync",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains",
                ":domain",
                "sync"
              ]
            },
            "description": "Required scope: `domains:write`\n\nThis endpoint takes no request body."
          }
        },
        {
          "name": "Verify a domain",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains/:domain/verify",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains",
                ":domain",
                "verify"
              ]
            },
            "description": "Required scope: `domains:write`\n\nRe-checks this domain's DNS now rather than waiting for the scheduled sweep. Safe to\ncall repeatedly.\n\nDNS propagation is not instant and is not uniform — a record your own resolver can see\nmay not be visible to ours yet. If verification fails on a record you are certain is\npublished, wait and call again before assuming the value is wrong.\n\nThis endpoint takes no request body."
          }
        }
      ]
    },
    {
      "name": "Domain operations",
      "description": "Operations for domain operations.",
      "item": [
        {
          "name": "Delete several domains",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains/bulk-delete",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains",
                "bulk-delete"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"domain_ids\": [\n    \"01m2q1qc6skqy6k2sq88abm4pw\"\n  ],\n  \"force_delete\": false\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `domains:write`"
          }
        },
        {
          "name": "Bulk Update (domain)",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains/bulk-update",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains",
                "bulk-update"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"domain_ids\": [\n    \"01JBT8XQ2M9WYC3K4F6R7S8T9V\"\n  ],\n  \"action\": \"verify\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `domains:write`"
          }
        },
        {
          "name": "Verify several domains",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains/bulk-verify",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains",
                "bulk-verify"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"domain_ids\": [\n    \"01m2q1qc6skqy6k2sq88abm4pw\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `domains:write`"
          }
        }
      ]
    },
    {
      "name": "Domain analytics",
      "description": "Operations for domain analytics.",
      "item": [
        {
          "name": "Stats (domain)",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains/stats",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains",
                "stats"
              ]
            },
            "description": "Required scope: `domains:read`"
          }
        },
        {
          "name": "Analytics a domain",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains/:domain/analytics",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains",
                ":domain",
                "analytics"
              ]
            },
            "description": "Required scope: `reports:read`"
          }
        },
        {
          "name": "Health a domain",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains/:domain/health",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains",
                ":domain",
                "health"
              ]
            },
            "description": "Required scope: `reports:read`"
          }
        },
        {
          "name": "Stats a domain",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/domains/:domain/stats",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "domains",
                ":domain",
                "stats"
              ]
            },
            "description": "Required scope: `reports:read`"
          }
        }
      ]
    },
    {
      "name": "Senders",
      "description": "Verified identities a message may be sent as.",
      "item": [
        {
          "name": "List senders",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/senders",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "senders"
              ]
            },
            "description": "Required scope: `senders:read`"
          }
        },
        {
          "name": "Add a sending identity",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/senders",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "senders"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"domain_id\": \"01JBT8XQ2M9WYC3K4F6R7S8T9V\",\n  \"name\": \"Ada from Acme\",\n  \"email\": \"ada@yourdomain.com\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `senders:write`\n\nA sender is an identity you are allowed to send *as* — a name and address, like\n`Ada from Acme <ada@acme.com>`.\n\nThis is not the same as a mailbox, and not the same as an SMTP credential. A mailbox\nreceives; a credential authenticates; a sender is what appears in the `From:` header.\n`POST /messages` refuses a `from` address that is not a verified sender here."
          }
        },
        {
          "name": "Retrieve a sender",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/senders/:sender",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "senders",
                ":sender"
              ]
            },
            "description": "Required scope: `senders:read`"
          }
        },
        {
          "name": "Update a sender",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/senders/:sender",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "senders",
                ":sender"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Ada from Acme\",\n  \"email\": \"ada@yourdomain.com\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `senders:write`"
          }
        },
        {
          "name": "Update a sender",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/senders/:sender",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "senders",
                ":sender"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Ada from Acme\",\n  \"email\": \"ada@yourdomain.com\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Required scope: `senders:write`"
          }
        },
        {
          "name": "Delete a sender",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/senders/:sender",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "senders",
                ":sender"
              ]
            },
            "description": "Required scope: `senders:write`"
          }
        },
        {
          "name": "Verification a sender",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/senders/:sender/verification",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "senders",
                ":sender",
                "verification"
              ]
            },
            "description": "Required scope: `senders:read`"
          }
        },
        {
          "name": "Verify a sender",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/senders/:sender/verify",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "senders",
                ":sender",
                "verify"
              ]
            },
            "description": "Required scope: `senders:write`\n\nThis endpoint takes no request body."
          }
        }
      ]
    },
    {
      "name": "Account",
      "description": "Organization usage, limits, API keys and dedicated IPs.",
      "item": [
        {
          "name": "List API keys",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/api-keys",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "api-keys"
              ]
            },
            "description": "Required scope: `account:read`\n\nThe keys your organization holds, with their prefixes, scopes and last use.\n\nListing is available to a key; **creating and revoking are not.** A leaked key that\ncould mint its own replacement would outlive the revocation of the key that leaked,\nso those stay in the dashboard on purpose."
          }
        },
        {
          "name": "Get dedicated IP status",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/dedicated-ip",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "dedicated-ip"
              ]
            },
            "description": "Required scope: `account:read`\n\nYour dedicated sending address and its warm-up state. An organization on a shared IP gets a populated object whose `state` is `shared` and whose `address` is null — NOT a null result, and never an error. Reachable with an organization API key carrying `account:read`; a key without that scope is refused with 403."
          }
        },
        {
          "name": "Entitlements (billing)",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/billing/entitlements",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "billing",
                "entitlements"
              ]
            },
            "description": "Required scope: `account:read`"
          }
        },
        {
          "name": "Send Plan (billing)",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/billing/send-plan",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "billing",
                "send-plan"
              ]
            },
            "description": "Required scope: `account:read`"
          }
        },
        {
          "name": "Subscription (billing)",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/billing/subscription",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "billing",
                "subscription"
              ]
            },
            "description": "Required scope: `account:read`"
          }
        },
        {
          "name": "Get current usage",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/billing/usage",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "billing",
                "usage"
              ]
            },
            "description": "Required scope: `account:read`\n\nWhat your organization has sent this period, against its plan allowance and any purchased credits."
          }
        }
      ]
    }
  ]
}