org · MachineMail Docs

org get

Get organization.

The organization of the credential, with inbox and domain counts and usage. inbox_count and usage count what the credential can see (a pod key: its pod).

machinemail org get [flags]

Examples

machinemail org get

API


org members

List members.

The people who sign in to the dashboard for this organization, with their role in it, oldest first. Organization-scoped credentials only: pod and inbox credentials get 403.

machinemail org members [flags]

Flags

Field Description
--limit <n> Maximum number of items to return. Default 50, maximum 500; larger values are capped.
--page-token <value> next_page_token from the previous page.
--ascending Sort oldest first.
--all Follow next_page_token and return every page.

Examples

machinemail org members
machinemail org members --all --json | jq '.members | length'

API


org update

Update organization.

Rename the organization, turn undo send in the dashboard on or off (—undo-send), or change the default inbox (—default-inbox-id).

The organization slug is fixed when it is created and never changes: a different —slug in the body is 400 (the current value is accepted and ignored). The slug reserves {slug}@ on the shared domain for this organization.

Organization-scoped credentials only: pod and inbox credentials get 403.

machinemail org update [flags]

Flags

Field Description
--name <value> New name. Must not be blank.
--slug <value> Immutable: the slug is fixed when the organization is created. Only the current value is accepted (a client echoing the organization back); any other value is a 400.
--undo-send Undo send in the dashboard: when true (the default), a message sent from the MachineMail dashboard waits 5 seconds before it goes out, so it can be undone. Only the dashboard reads it: the API, the MCP server and the CLI always send at once.
--default-inbox-id <id> Make this inbox (an inbox_id of the organization) the default inbox, or null to have none. An unknown inbox is a 404. null clears the value.
`-d, --data <json @file

Examples

machinemail org update
machinemail org update --data @body.json
machinemail org update --default-inbox-id null   # clears default-inbox-id

API


org usage

Get plan usage.

The plan of the organization, its allowances and its usage in the current period: a calendar month in UTC, with the daily cap resetting at UTC midnight.

Inbound messages count once each; outbound messages count once per distinct recipient (to, cc and bcc). Spam and quarantined mail never count (mail your own receive lists block does). Storage includes drafts and held mail. Deleting mail frees storage but does not give back messages already counted.

On the Free plan, inbound mail past an allowance is held (held) and delivered when the allowance resets or after an upgrade; sends past it are refused with 402 plan_limit_exceeded. Paid plans are never blocked: usage past an allowance is billed as overage.

Organization-wide whatever the credential: Organization-scoped credentials only: pod and inbox credentials get 403.

machinemail org usage [flags]

Examples

machinemail org usage

API