Generate eSIMs Link for Sharing

Development

https://api-dev.getroamify.com

POST

/api/esim/link

Last modified:2026-01-07 20:55:42

Maintainer:Not configured

After you have created an eSIM profile, you can generate a link to share with your customers. This link will allow them to install the eSIM profile on their devices.

To generate an eSIM link, you will need to send a POST request to the /api/esim/link endpoint.

The request body should contain the either the following parameters:

iccid: The ICCID of the eSIM. This is a required field of type string.

esimId: The ID of the eSIM. This is a required field of type string, no need to provide if you included the iccid.

Request

Header Params

Body Params application/json

Example

{
	"esimId": "c0b2d861-c5f2-47b6-b5c2-7f0435d0ef35"
	// OR
	// "iccid": "iccid here"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

Responses

🟢200successfully / 200

text/plain

Example

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

Modified at 2026-01-07 20:55:42

Get eSIMs

Get eSIM Compatible Devices