`bird organization workspaces quotas update`

Usage

Code example

bird organization workspaces quotas update <workspace-id> <quota-key> [flags]

Set or replace a workspace's own limit for one resource or value quota. The limit is a ceiling, not reserved capacity: the organization limit still applies, and a workspace limit can exceed it. A limit below the workspace's current usage needs force. A zero ceiling can block new work, and a mailbox storage ceiling below current usage can stop outbound sends immediately when the storage check succeeds. An unreadable workspace ceiling is skipped; readable organization limits and other send checks still apply. If the storage total cannot be read, this storage check allows the send. Existing resources remain. Fails with a conflict when workspace limits cannot be set yet; read the workspace's quotas for its configuration status.

Build the request from flags, a JSON WorkspaceQuotaUpdate body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Examples

Code example

# print the body shape (no credentials needed)
bird organization workspaces quotas update --example

# the body it prints:

Code example

{
  "reason": "Keep the staging workspace to three mailboxes.",
  "value": 3
}

Options

Request

Name	Description
`--body-file`	Read the JSON request body from this file; "-" reads stdin
`--example`	Print a complete example request body, then exit
`--dry-run`	Print the resolved request without sending it, then exit
`--idempotency-key`	Deduplication key; a retry with the same key won't act twice

Options

Name	Description
`--value <n>`	The workspace limit, in the quota's unit. It can exceed the organization limit; both limits apply. Each quota's maximum_value is the largest it accepts. (required; or in --body-file)
`--reason`	Why the workspace limit is being set. (required; or in --body-file)
`--expires-at`	When the workspace limit stops applying. Must be in the future. null or omitted means no expiry.
`--force`	Set true to save a limit below the workspace's current usage. Nothing is removed; the workspace cannot add more until its usage falls below the limit.
`--response-schema`	Print the fields this command returns, then exit

Name	Description
`bird organization workspaces quotas delete`	Remove a workspace quota limit
`bird organization workspaces quotas list`	List quotas for a workspace in the organization

Continue with the documentation, guides and examples for this topic.

Get an implementation brief

Related resources