`bird esim settings update`

Usage

Code example

bird esim settings update [flags]

Change the workspace's eSIM settings and return the effective result. Turning credential_delivery_enabled off stops Bird sending install credentials to travelers over either channel; the credentials stay readable from the API. Omitted fields keep their current value.

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

# the body it prints:

Code example

{
  "credential_delivery_enabled": false
}

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
`--credential-delivery-enabled`	Send false to stop Bird sending eSIM install credentials to travelers for this workspace, or true to allow it again. Credentials stay readable from the API either way.
`--response-schema`	Print the fields this command returns, then exit

Name	Description
`bird esim settings get`	Get the eSIM settings

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

Get an implementation brief

Related resources