Update a mailbox
Edit a mailbox: name, limits, window, gap, days, timezone, password, warm-up (enabled, target per day, ramp days, reply rate, rescue from spam).
PATCH/api/v1/mailboxes/{id}
Parameters
Path
| Name | In | Description |
|---|---|---|
idrequired | path | The record's id. |
No body. Send the fields you want to change as a JSON object; the record's own fields apply.
Example
curl
curl -X PATCH "https://crm.ashwanth.dev/api/v1/mailboxes/{id}" \
-H "Authorization: Bearer $SALES_ENGINE_API_KEY"CLI
sales-engine mailboxes update <id>Response
A 200 with the result under data, on creation too. Errors come back as an error object with a stable code; see Errors.
Shape
{
"data": { ... }
}Run it below to see the live shape for your workspace.
Try it
Runs against this server, as the workspace behind the key. Kept in this page while you browse the docs, gone on reload, never stored. Signed in to the app? Leave it blank and the call runs as you.
Path
requiredThe record's id.
Request
PATCH /api/v1/mailboxes/%7Bid%7D
Fill the path first.