Get the eSIM settings

GET

/v1/esim/settings

bird esim settings get

curl -X GET "https://us1.platform.bird.com/v1/esim/settings" \
  -H "Authorization: Bearer $TOKEN"

Response200

{
  "credential_delivery_enabled": true
}

Returns your workspace’s eSIM settings, including defaults for fields you have not changed. Use the update operation to change them.

Response Payload

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.

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

Get an implementation brief

bird esim settings get

curl -X GET "https://us1.platform.bird.com/v1/esim/settings" \
  -H "Authorization: Bearer $TOKEN"

Response200

{
  "credential_delivery_enabled": true
}

Get the eSIM settings

Response Payload

Related resources