Generate eSIMs Link for Sharing

Development

https://api-dev.getroamify.com

POST

/api/esim/link

Last modified:2026-06-09 18:06:54

Maintainer:Not configured

Generates a shareable installation link for an eSIM profile. Send this link to your customers so they can install the eSIM on their device. Requires either iccid or esimId — not both.

Body Parameters

Name	Type	Required	Description
`iccid`	`string`	one of	The ICCID of the eSIM.
`esimId`	`string`	one of	The eSIM ID provided by Roamify. Not needed if `iccid` is provided.

Request

Header Params

Body Params application/json

Examples

Responses

🟢200successfully / 200

text/plain

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api-dev.getroamify.com/api/esim/link' \
--header 'Authorization: Bearer roamify_4ECge13m8ZqFvGshLVLfdnFzi5hGuXkCBg2keWxVVKi7b2BGWmoXiv7bgVtNxY5Ruif7QKEthrLNrEkvnBV3Z7D3Fyj547NbnDnsDU7HgkRX8ggKD285dkXZHdNFM8npxoyr12nSzfpzqRuLvJj2d9eXgucEQmD9Gg4aKnUWvNaRbz1mKv7fAwdJe' \
--header 'Content-Type: application/json' \
--data '{
	"esimId": "c0b2d861-c5f2-47b6-b5c2-7f0435d0ef35"
	// OR
	// "iccid": "iccid here"
}'

Response Example

application/json; charset=utf-8 content type is not supported in the response body

Modified at 2026-06-09 18:06:54

Send SMS

Get eSIM Compatible Devices

Generate eSIMs Link for Sharing

Body Parameters#

Request

Responses

Body Parameters