Skip to main content

Usage and limits

Required permission: Usage → Read.
This is the call to make before acting, not after being refused. Sending is capped per day, and without this the only way to learn the cap is to hit it — which for a batch means finding out halfway through that half the mail went. remaining is reported next to every pair so the decision (“can I send these 40?”) is a comparison rather than a subtraction you have to get right.
Advisory, not a reservation.The limits are enforced by the database, not by this endpoint. Two callers asking at once both see the same room and only one gets it. Treat a 402 quota_exceeded as the authority and this as the thing that stops you provoking one.remaining never goes below zero, so an organization over its limit — which happens after a downgrade — reads 0 rather than a negative number.
sent_today counts the UTC day, because that is the day the send path counts. A local day would disagree with the number you are actually measured against for several hours, every day.

Members

Required permission: Members → Read.
Both id and email come back because a task’s assignee accepts either, and you should not have to know which one works.
Read only, deliberately.There is no invite, no remove and no role change. Adding somebody to an organization gives them a real person’s access to real mail, and removing somebody takes it away — those belong behind a signed-in human who can be held to them, not behind a key that may be sitting in a repository. The dashboard does it.

Errors

See Errors for the full response shape.