bird email ip-pools update

Usage

Code example

bird email ip-pools update <ip-pool-id> [flags]

Rename an IP pool or make it the organization default. Setting is_default to true moves the default to this pool; setting it to false on the current default is rejected. Pass ipp_shared to restore the shared default.

Build the request from flags, a JSON IPPoolUpdate 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 update --example

# the body it prints:

Code example

{
  "name": "Marketing"
}

Options

Pool

Name	Description
--name	The pool's name, unique within the organization. Returns IPPoolNameTaken (E11002) if another pool already uses it. Immutable on the protected shared pool.
--is-default	Make this pool the organization's default. The default moves to this pool; it is never cleared.

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 create	Create an IP pool
bird email ip-pools delete	Delete an IP pool
bird email ip-pools get	Get an IP pool
bird email ip-pools list	List IP pools

Related resources

Continue with the documentation, guides and examples for this topic. Resources are in English.

Watch the guideGetting started with email Explore the capabilityEmail Follow the learning pathBuild your first integration Implementation guideSend your first email

Try the practice and get an implementation brief