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

# Update the eSIM settings

`PATCH /v1/esim/settings`

Applies partial changes to your workspace's eSIM settings and returns the effective result. Omit a field to leave it as it is. The change applies to the next send immediately.

## Code samples

**CLI**

```sh
bird esim settings update --credential-delivery-enabled=false
```

Examples: [CLI](/docs/api/reference/update-esim-settings.cli.md) · [MCP](/docs/api/reference/update-esim-settings.mcp.md) · [cURL](/docs/api/reference/update-esim-settings.curl.md)

## Example response `200`

```json
{
  "credential_delivery_enabled": true
}
```

## Request body

- `credential_delivery_enabled` (boolean): 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 body

- `credential_delivery_enabled` (boolean, required): Whether Bird sends eSIM install credentials to travelers for this workspace. When `false`, sending an eSIM's credentials by email or SMS is refused; reading them from the API still works, so you can deliver them yourself. This governs the install message only. Your workspace's other email and SMS sending is unaffected. Defaults to `true`.

## 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)