Apply Bundle to an eSIM

POST

/esims/apply

eSIMGo API

This endpoint enables you to receive a new eSIM with the specified Bundle pre-applied. Usage:

Either provide Bundle or Bundles.
If an ICCID is provided as well as only a Bundle, the Bundle will be applied to the eSIM for that ICCID.
If no ICCID is provided, a new eSIM will be assigned to you, and the Bundle applied.
If no ICCID is provided, as well as only providing a Bundle, Repeat can be provided to assign Repeat eSIMs to you with the Bundle applied.
If Bundles is provided, seperate new eSIMs will be provided to you for each bundle.
The ICCID is always returned in the response.
An ICCID cannot be provided in conjunction with the Repeat field.
Bundle names are case sensitive and should be typed like the following “esim_1GB_7D_IM_U”. Notes:
In order to use this you must first have already purchased Bundles and have them available in your inventory on your account.
Bundle assignments to an eSIM are usually instant but please allow for up to 10 minutes for the bundle to fully process. While the bundle is processing the eSIM can be successfully installed and the eSIM will register onto a network if within coverage.
The Bundle Status can be checked through Get the Status of a bundle assigned to an eSIM

Authorizations

apikeyAuth

Request Body

object

{
  "iccid": "<string>",
  "bundle": "<string>",
  "bundles": [
    "<string>",
    "<string>"
  ],
  "startTime": "<string>",
  "repeat": "<integer>",
  "allowReassign": "<boolean>"
}

Responses

200

object

Example

{
  "esims": [
    {
      "iccid": "<string>",
      "status": "<string>"
    },
    {
      "iccid": "<string>",
      "status": "<string>"
    }
  ],
  "applyReference": "<string>"
}

400

Bad Request

object

Example

{
  "message": "<string>"
}

403

Forbidden

object

Example

{
  "message": "<string>"
}

500

Internal Server Error

object

Example

{
  "message": "<string>"
}

503

Service Unavailable

object

Example

{
  "message": "<string>"
}