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 esim = await client.esims.update('550e8400-e29b-41d4-a716-446655440000');
console.log(esim.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
)
esim = client.esims.update(
id="550e8400-e29b-41d4-a716-446655440000",
)
print(esim.data)curl --request PATCH \
--url https://api.mobilerun.ai/v1/numbers/esims/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"msisdn": "+33612345678",
"name": "Mom's phone"
}
EOF<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mobilerun.ai/v1/numbers/esims/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'msisdn' => '+33612345678',
'name' => 'Mom\'s phone'
]),
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}"
payload := strings.NewReader("{\n \"msisdn\": \"+33612345678\",\n \"name\": \"Mom's phone\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.mobilerun.ai/v1/numbers/esims/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"msisdn\": \"+33612345678\",\n \"name\": \"Mom's phone\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mobilerun.ai/v1/numbers/esims/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"msisdn\": \"+33612345678\",\n \"name\": \"Mom's phone\"\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"
}
}{
"error": "<string>"
}{
"message": "<string>",
"reason": "out_of_stock",
"success": false
}Update a physical eSIM's self-reported MSISDN and/or display name
Updates the eSIM’s self-reported msisdn and/or display name. Both fields are optional, but the request body itself is required. Omitting a field leaves it unchanged; setting it to null or an empty string clears it. name is capped at 15 characters. Available regardless of the eSIM’s current status.
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 esim = await client.esims.update('550e8400-e29b-41d4-a716-446655440000');
console.log(esim.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
)
esim = client.esims.update(
id="550e8400-e29b-41d4-a716-446655440000",
)
print(esim.data)curl --request PATCH \
--url https://api.mobilerun.ai/v1/numbers/esims/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"msisdn": "+33612345678",
"name": "Mom's phone"
}
EOF<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mobilerun.ai/v1/numbers/esims/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'msisdn' => '+33612345678',
'name' => 'Mom\'s phone'
]),
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}"
payload := strings.NewReader("{\n \"msisdn\": \"+33612345678\",\n \"name\": \"Mom's phone\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.mobilerun.ai/v1/numbers/esims/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"msisdn\": \"+33612345678\",\n \"name\": \"Mom's phone\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mobilerun.ai/v1/numbers/esims/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"msisdn\": \"+33612345678\",\n \"name\": \"Mom's phone\"\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"
}
}{
"error": "<string>"
}{
"message": "<string>",
"reason": "out_of_stock",
"success": false
}Authorizations
Bearer token via Authorization header
Path Parameters
"550e8400-e29b-41d4-a716-446655440000"
Body
Self-reported E.164 MSISDN for this eSIM's line. Omit to leave unchanged; null/empty clears it. An unverified label — never used for routing.
20"+33612345678"
User-defined display label — NFC-normalized, up to 15 GRAPHEMES (not UTF-16 code units; an emoji/flag may span several). Omit to leave unchanged; null/empty/whitespace-only clears it.
"Mom's phone"
Response
eSIM updated
Show child attributes
Show child attributes
Was this page helpful?