`bird esim subscribers create`

Usage

Code example

bird esim subscribers create [flags]

Create or return a subscriber for a workspace contact. Requires email_marketing read and esim write. Does not buy or assign an eSIM. The association blocks contact deletion and cannot currently be removed, including after the service ends.

Build the request from flags, a JSON EsimSubscriberCreate 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 subscribers create --example

# the body it prints:

Code example

{
  "contact_id": "con_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
`--contact-id`	Existing contact in this workspace; requires Contacts read permission. (required; or in --body-file)
`--response-schema`	Print the fields this command returns, then exit

Name	Description
`bird esim subscribers get`	Get an eSIM subscriber
`bird esim subscribers list`	List eSIM subscribers

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

Get an implementation brief

Related resources