`bird esim update`

Usage

Code example

bird esim update <esim-id> [flags]

Description

Update an eSIM

Updates the eSIM's display name, tags, or metadata. Lifecycle and connectivity are managed through the dedicated endpoints.

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

# the body it prints:

Code example

{
  "tags": [
    {
      "name": "category",
      "value": "welcome"
    }
  ]
}

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
`--display-name`	Free-text label for your own reference. Null clears it.
`--tags <key=value>`	Replaces the eSIM's tags.
`--metadata`	Replaces the eSIM's metadata. Maximum 2 KB serialized.
`--response-schema`	Print the fields this command returns, then exit

Name	Description
`bird esim compatible-offers`	List offers an eSIM can take
`bird esim get`	Get an eSIM
`bird esim list`	List eSIMs
`bird esim release`	Release an eSIM
`bird esim resume`	Resume an eSIM
`bird esim suspend`	Suspend an eSIM

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

Get an implementation brief

Related resources