Skip to main content
POST
JavaScript
Returns the newly installed subscription — keep its subId for later enable, delete, and APN calls. With enable: true the profile is activated in the same call; otherwise enable it later with enable-esim. smDpAddr is the bare SM-DP+ address, not a full activation code. Given LPA:1$smdp.example.com$MATCH-123, pass smdp.example.com as smDpAddr and MATCH-123 as matchingId; a fourth segment would be confirmationCode. eSIM operations run one at a time per device — a concurrent call fails instead of queueing.

Authorizations

Authorization
string
header
required

Bearer token via Authorization header

Headers

X-Device-Display-ID
integer<int64>
default:0
Required range: x >= 0

Path Parameters

deviceId
string
required

Body

application/json
enable
boolean
required
smDpAddr
string
required
confirmationCode
string

Optional carrier-issued confirmation code (the 4th LPA segment). Required only for plans whose SM-DP+ challenges the device for one. Requires matchingId — the LPA spec only interprets segment 4 when segment 3 is present.

matchingId
string

Response

OK

carrier
string
required
displayName
string
required
iccid
string
required
isEmbedded
boolean
required
slot
integer<int64>
required
subId
integer<int64>
required
type
string
required
$schema
string<uri>
read-only

A URL to the JSON Schema for this object.

Example:

"https://example.com/schemas/ESimSubscription.json"