Sign in
Esims

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.

post/numbers/esims/{id}/install

Path parameters

idstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000

Request body

deviceIdstring

physedge device id to install the eSIM onto; omit for a random pool device

Example request

{
  "deviceId": "physedge-dev-8f3a2c"
}

Response

eSIM installed (the device resolved active)

Changes