`bird email ip-pools workspaces assign`

Usage

Code example

bird email ip-pools workspaces assign <ip-pool-id> <workspace-id> [flags]

Let a workspace send through an organization IP pool, or make an assigned pool its default with is_default: true. For a workspace with no assigned pools, is_default: false keeps its current sending by making the shared pool its default beside this pool; omitting is_default makes this pool its default, and the workspace then sends only through its assigned pools. Repeating the request changes nothing.

Build the request from flags, a JSON IPPoolWorkspaceAssignmentUpdate 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 email ip-pools workspaces assign --example

# the body it prints:

Code example

{
  "is_default": true
}

Options

Assignment

Name Description

--is-default Set true to make this pool the workspace's default, replacing its current default. Omit it to keep the current default. For a workspace with no assigned pools, false keeps its current sending by making the shared pool its default, while omitting it makes this pool the default. A default is replaced, never cleared, so false is rejected for the current default and for the shared pool as a first assignment.

Name	Description
`--is-default`	Set true to make this pool the workspace's default, replacing its current default. Omit it to keep the current default. For a workspace with no assigned pools, false keeps its current sending by making the shared pool its default, while omitting it makes this pool the default. A default is replaced, never cleared, so false is rejected for the current default and for the shared pool as a first assignment.

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
`--response-schema`	Print the fields this command returns, then exit

Name	Description
`bird email ip-pools workspaces list`	List workspaces assigned an IP pool
`bird email ip-pools workspaces remove`	Remove an IP pool from a workspace

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

Get an implementation brief

Related resources