mail

PUT `/v1/mail/mailboxes/{mailboxId}`

Change a mailbox's size, or its send/receive switches.

ავტორიზაცია

API გასაღები გაგზავნეთ როგორც მატარებელი ტოკენი (bearer token). გასაღებს უნდა ჰქონდეს mail.manage ნებართვა; ამის გარეშე გასაღები უარყოფილი იქნება 403 და არა 404 სტატუსით.

ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.

სცადეთ

შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.

curl -X PUT https://api.zinndigital.com/v1/mail/mailboxes/{mailboxId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

შესული ხართ? თქვენი სამართავ პანელში არსებული API კონსოლი ავტომატურად ამატებს თქვენი რეალური ორგანიზაციის ID-სა და საკუთარ გასაღებს და ატარებს მოთხოვნას ცოცხალ API-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი API კონსოლში

დეტალები

Every field is optional; a request that sets only `receive` leaves the size alone. **The size half is what makes the quota warning honest.** `mail.mailbox_quota_warning` tells a customer their mailbox is filling up, and until this existed the only truthful advice it could give was "delete things" — the mail backend could always resize a mailbox, but nothing exposed it (#932, #662). `quota_mb` is bounded by the **plan allowance captured on the service at purchase**, so a later plan change cannot retroactively shrink what a customer was sold. Above that sits the backend package's own ceiling; both refusals answer **422** with the same customer-facing sentence, because the customer's next action is identical either way. Requires `mail.manage`.

პარამეტრები

სახელი	ტიპი	სავალდებულო	რა არის ეს
`mailboxId (path)`	`Uuid`	დიახ	Mailbox ID (UUIDv7).

მოთხოვნის სხეული

სახელი	ტიპი	სავალდებულო	რა არის ეს
`quota_mb`	`integer`	არა	New mailbox size in MB. Capped by the plan allowance captured on the service, and above that by the backend package ceiling.
`send`	`boolean`	არა	Whether the mailbox may send.
`receive`	`boolean`	არა	Whether the mailbox may receive.

პასუხი

სახელი	ტიპი	სავალდებულო	რა არის ეს
`id`	`Uuid`	დიახ	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`address`	`string`	დიახ	The full address.
`local`	`string`	დიახ	The part before the `@`.
`quota_mb`	`integer`	დიახ	This mailbox's size in MB. `0` means no cap.
`used_mb`	`integer`	დიახ	How much of it is used, as the mail backend last reported it (#932). Refreshed by the hourly reconcile, so it is a recent figure rather than a live one.
`percent_used`	`integer`	დიახ	How full, 0-100. Always `0` for an uncapped mailbox — a percentage of "no limit" is meaningless, not zero-ish. Read `usage_checked_at` before showing it: this is also `0` for a…
`usage_checked_at`	`string`	არა	When the backend was last asked. `null` until the first sweep sees it.
`send_enabled`	`boolean`	დიახ	—
`receive_enabled`	`boolean`	დიახ	—
`status`	`MailboxStatus`	დიახ	One mailbox's state.
`system_managed`	`boolean`	დიახ	We created this mailbox when the domain was provisioned; the customer did not ask for it. It is the address the site itself sends from, so `deleteMailbox` and `renameMailbox…
`created_at`	`string`	დიახ	—

შეცდომები, რომლებიც ამ ენდპოინტს შეუძლია დააბრუნოს

401 · 403 · 404 · 422 · 429 · 503

PUT /v1/mail/mailboxes/{mailboxId}