esims

Create a hosted install link

Creates a link to a hosted installation page for one eSIM. The recipient can open the page without a Bird account. The returned url grants access to installation details: share it privately and retain it securely if needed, because later reads do not return it.

The link expires after seven days. Creating another link leaves earlier links valid. Use Revoke a hosted install link to disable a link before expiry. A matching retry with the same Idempotency-Key returns the original response while it is retained; after that, a retry creates a new link.

The eSIM must be installable. Returns 409 when the profile cannot be installed, 503 when credentials are temporarily unavailable, or 501 when new hosted links are unavailable. A retained successful response can still be replayed while new links are unavailable.

post/v1/esim/sims/{esim_id}/install-links

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/esim/sims/{esim_id}/install-links
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Path parameters

esim_idstring required
Example:esm_01krdgeqcxet5s7t44vh8rt9mg

eSIM ID.

Headers

Idempotency-Keystring

Client-supplied key. On operations supporting request deduplication, a retained response is replayed for duplicate requests with the same key within the idempotency window (3 hours by default). This protection requires a workspace, organization, or staff-account scope. User-only and unscoped unauthenticated operations, streams, and operations with a separate replay contract do not use this response replay.

On a supported operation, if idempotency protection is unavailable before execution, the API returns 503 IdempotencyUnavailable (E01033) without executing this attempt. Retry with backoff using the same key and request. An operation that takes effect before its response is retained can still execute again on retry.

Two distinct 409 errors signal misuse:

  • request_in_progress (E01004): The same key is currently being processed by a concurrent request. Wait briefly and retry. The lock expires within 30 seconds.
  • idempotency_key_reuse (E01005): The same key has already completed against a different request body or method. Generate a new key.

Recommended key format is <event-type>/<entity-id> (for example welcome-user/usr_abc123).

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

The link was minted. Its url appears here and in no later read.

idstring required
esim_idstring required
urlstring uri required

Private installation URL. Anyone holding it can access installation details until expiry or revocation. Store or share it securely when created; later reads do not return it.

expires_atstring date-time required

When the link stops granting access to installation details.

created_atstring date-time required

When the link was created.

Example response

{
  "id": "eil_01krdgeqcxet5s7t44vh8rt9mg",
  "esim_id": "esm_01krdgeqcxet5s7t44vh8rt9mg"
}

Changes

No recorded changes to this operation across all 3 revisions of this API.