---
title: "bird esim settings update"
description: "Update the eSIM settings"
canonical: "https://bird.com/docs/cli/reference/esim-settings-update"
---

# `bird esim settings update`

## Usage

```bash
bird esim settings update [flags]
```

## Description

Update the eSIM settings

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

```bash
# print the body shape (no credentials needed)
bird esim settings update --example

# the body it prints:
```

```json
{
  "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                                                                                                                        |

## Related

| Name                                                              | Description           |
| ----------------------------------------------------------------- | --------------------- |
| [`bird esim settings get`](/docs/cli/reference/esim-settings-get) | Get the eSIM settings |

## Related resources

- [Should I use a Bird SDK or call the API directly?](/explained/platform/should-i-use-an-sdk-or-call-the-api-directly) (answer)
- [Build your first integration](/learn/paths/integration) (course)
- [Send your first email](/docs/get-started/send-your-first-email) (docs)

[Get an implementation brief](/learn/workspace?topic=api-basics)