Create a hosted install link
/v1/esim/sims/{esim_id}/install-linksbird esim install-links create <esim-id>curl -X POST "https://us1.platform.bird.com/v1/esim/sims/{esim_id}/install-links" \
-H "Authorization: Bearer $TOKEN"{
"id": "eil_01krdgeqcxet5s7t44vh8rt9mg",
"esim_id": "esm_01krdgeqcxet5s7t44vh8rt9mg"
}
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.
参数
esim_idstringeSIM ID.
响应载荷
idesim_idurlPrivate 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_atWhen the link stops granting access to installation details.
created_atWhen the link was created.