`bird esim credentials deliver`

Usage

Code example

bird esim credentials deliver <esim-id> [flags]

Description

Send install credentials to the traveler

Send an eSIM's install credentials to the traveler by email or SMS, in English. Use after purchase or to resend installation details.

Build the request from flags, a JSON EsimDelivery 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.

Procedure

Step 8 of 8 of "Buy and install an eSIM data package". Previous: bird esim credentials get.

Examples

Code example

# print the body shape (no credentials needed)
bird esim credentials deliver --example

# the body it prints:

Code example

{
  "channel": "sms",
  "locale": "nl",
  "to": "+31612345678"
}

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
`--to`	Recipient address. An email address for the email channel, an E.164 phone number for the sms channel. (required; or in --body-file)
`--channel`	Channel the install credentials are delivered over. Possible values: email, sms. (required; or in --body-file)
`--locale`	Language for the message. Falls back to the closest available language, then English.
`--response-schema`	Print the fields this command returns, then exit

Name	Description
`bird esim credentials get`	Get eSIM install credentials

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

Get an implementation brief

Related resources