`bird esim assignment create`

Usage

Code example

bird esim assignment create <esim-id> [flags]

Assigns an existing, allocated eSIM to a subscriber in the same workspace. Unavailable profile states return 409. Identification guidance does not gate assignment; customers handle identification collection and compliance. Repeating the same assignment returns its existing record; assigning a different person returns 409. This does not change paid packages, deliver credentials, or grant access to them.

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

Examples

Code example

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

# the body it prints:

Code example

{
  "subscriber_id": "esub_01krdgeqcxet5s7t44vh8rt9mg"
}

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
`--subscriber-id`	Subscriber in this workspace to assign to the eSIM. (required; or in --body-file)
`--response-schema`	Print the fields this command returns, then exit

Name	Description
`bird esim assignment get`	Get an eSIM assignment

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

Get an implementation brief

Related resources