Update the eSIM settings
PATCH
/v1/esim/settingsbird esim settings update --credential-delivery-enabled=falsecurl -X PATCH "https://us1.platform.bird.com/v1/esim/settings" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"credential_delivery_enabled": false
}'Response200
{
"credential_delivery_enabled": true
}
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.
Request Payload
credential_delivery_enabledboolean
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 Payload
credential_delivery_enabledboolean
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
Continue with the documentation, guides and examples for this topic.