import Mobilerun from '@mobilerun/sdk';
const client = new Mobilerun({
apiKey: process.env['MOBILERUN_CLOUD_API_KEY'], // This is the default and can be omitted
});
const response = await client.esims.install('550e8400-e29b-41d4-a716-446655440000');
console.log(response.data);import os
from mobilerun_sdk import Mobilerun
client = Mobilerun(
api_key=os.environ.get("MOBILERUN_CLOUD_API_KEY"), # This is the default and can be omitted
)
response = client.esims.install(
id="550e8400-e29b-41d4-a716-446655440000",
)
print(response.data)curl --request POST \
--url https://api.mobilerun.ai/v1/numbers/esims/{id}/install \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"deviceId": "physedge-dev-8f3a2c"
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mobilerun.ai/v1/numbers/esims/{id}/install",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'deviceId' => 'physedge-dev-8f3a2c'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.mobilerun.ai/v1/numbers/esims/{id}/install"
payload := strings.NewReader("{\n \"deviceId\": \"physedge-dev-8f3a2c\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.mobilerun.ai/v1/numbers/esims/{id}/install")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"deviceId\": \"physedge-dev-8f3a2c\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mobilerun.ai/v1/numbers/esims/{id}/install")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"deviceId\": \"physedge-dev-8f3a2c\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"carrierName": "<string>",
"countryCode": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"deviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deviceUuid": "<string>",
"iccid": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"msisdn": "<string>",
"name": "<string>",
"networkStatus": "degraded",
"source": "stocked",
"status": "in_stock",
"subscriptionId": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"cancellationScheduled": true,
"checkoutUrl": "<string>",
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"exempt": true,
"rentStatus": "not_applicable"
}
}{
"data": {
"esim": {
"carrierName": "<string>",
"countryCode": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"deviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deviceUuid": "<string>",
"iccid": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"msisdn": "<string>",
"name": "<string>",
"networkStatus": "degraded",
"source": "stocked",
"status": "in_stock",
"subscriptionId": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"cancellationScheduled": true,
"checkoutUrl": "<string>",
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"exempt": true,
"rentStatus": "not_applicable"
},
"operationId": "<string>",
"statusUrl": "<string>"
}
}{
"data": {
"checkoutUrl": "<string>",
"esim": {
"carrierName": "<string>",
"countryCode": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"deviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deviceUuid": "<string>",
"iccid": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"msisdn": "<string>",
"name": "<string>",
"networkStatus": "degraded",
"source": "stocked",
"status": "in_stock",
"subscriptionId": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"cancellationScheduled": true,
"checkoutUrl": "<string>",
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"exempt": true,
"rentStatus": "not_applicable"
},
"rentStatus": "awaiting_payment"
}
}{
"error": "<string>"
}{
"message": "<string>",
"reason": "out_of_stock",
"success": false
}{
"message": "<string>",
"reason": "out_of_stock",
"success": false
}Install a physical eSIM on a device
Installs the eSIM’s activation code onto a device. deviceId is optional — omit it to use an available device from the pool. This call is asynchronous: it returns 202 with {esim, operationId, statusUrl} immediately, and the result is available by polling GET /esims/{id}/install-status. Retrying with the same request is safe if a response is lost.
Returns 409 when the eSIM is not in the owned state, or when no device is currently available (see reason). When rent-first billing is enabled, a BYO eSIM whose rent isn’t active returns 402 with {esim, rentStatus, checkoutUrl} instead.
import Mobilerun from '@mobilerun/sdk';
const client = new Mobilerun({
apiKey: process.env['MOBILERUN_CLOUD_API_KEY'], // This is the default and can be omitted
});
const response = await client.esims.install('550e8400-e29b-41d4-a716-446655440000');
console.log(response.data);import os
from mobilerun_sdk import Mobilerun
client = Mobilerun(
api_key=os.environ.get("MOBILERUN_CLOUD_API_KEY"), # This is the default and can be omitted
)
response = client.esims.install(
id="550e8400-e29b-41d4-a716-446655440000",
)
print(response.data)curl --request POST \
--url https://api.mobilerun.ai/v1/numbers/esims/{id}/install \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"deviceId": "physedge-dev-8f3a2c"
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mobilerun.ai/v1/numbers/esims/{id}/install",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'deviceId' => 'physedge-dev-8f3a2c'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.mobilerun.ai/v1/numbers/esims/{id}/install"
payload := strings.NewReader("{\n \"deviceId\": \"physedge-dev-8f3a2c\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.mobilerun.ai/v1/numbers/esims/{id}/install")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"deviceId\": \"physedge-dev-8f3a2c\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mobilerun.ai/v1/numbers/esims/{id}/install")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"deviceId\": \"physedge-dev-8f3a2c\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"carrierName": "<string>",
"countryCode": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"deviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deviceUuid": "<string>",
"iccid": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"msisdn": "<string>",
"name": "<string>",
"networkStatus": "degraded",
"source": "stocked",
"status": "in_stock",
"subscriptionId": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"cancellationScheduled": true,
"checkoutUrl": "<string>",
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"exempt": true,
"rentStatus": "not_applicable"
}
}{
"data": {
"esim": {
"carrierName": "<string>",
"countryCode": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"deviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deviceUuid": "<string>",
"iccid": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"msisdn": "<string>",
"name": "<string>",
"networkStatus": "degraded",
"source": "stocked",
"status": "in_stock",
"subscriptionId": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"cancellationScheduled": true,
"checkoutUrl": "<string>",
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"exempt": true,
"rentStatus": "not_applicable"
},
"operationId": "<string>",
"statusUrl": "<string>"
}
}{
"data": {
"checkoutUrl": "<string>",
"esim": {
"carrierName": "<string>",
"countryCode": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"deviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deviceUuid": "<string>",
"iccid": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"msisdn": "<string>",
"name": "<string>",
"networkStatus": "degraded",
"source": "stocked",
"status": "in_stock",
"subscriptionId": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"cancellationScheduled": true,
"checkoutUrl": "<string>",
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"exempt": true,
"rentStatus": "not_applicable"
},
"rentStatus": "awaiting_payment"
}
}{
"error": "<string>"
}{
"message": "<string>",
"reason": "out_of_stock",
"success": false
}{
"message": "<string>",
"reason": "out_of_stock",
"success": false
}Authorizations
Bearer token via Authorization header
Path Parameters
"550e8400-e29b-41d4-a716-446655440000"
Body
physedge device id to install the eSIM onto; omit for a random pool device
1"physedge-dev-8f3a2c"
Response
eSIM installed (the device resolved active)
Show child attributes
Show child attributes
Was this page helpful?