Sign inGet Started

Update the eSIM settings

PATCH
/v1/esim/settings
bird esim settings update --credential-delivery-enabled=false
Response200
{
  "credential_delivery_enabled": false
}

Applies partial changes to your workspace's eSIM settings and returns the effective result. Omit a field to leave it as it is. Automatic delivery is disabled initially. Enabling it applies to new eSIM purchases; disabling it also stops queued automatic sends. Manual sends are independent of this setting.

Request Payload

credential_delivery_enabled
boolean

Whether Bird automatically sends an install link after a new eSIM purchase with a linked contact. Uses the contact's email address, or SMS when only a phone number is available. Omit this field to retain the current value; a workspace without saved settings starts with false. Manual install-link sends remain available regardless of this setting.

Response Payload

credential_delivery_enabled
boolean
required

Whether Bird automatically sends an install link after a new eSIM purchase with a linked contact. Uses the contact's email address, or SMS when only a phone number is available. Defaults to false. Manual install-link sends remain available regardless of this setting.

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