Apply a Bundle to an eSIM with eSIM auto-assign
POST /esims/apply
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
Request Body required
Details of Bundle to apply to eSIM
object
ICCID of target eSIM to apply Bundle to. If not provided, a new eSIM will be assigned to you.
Name of Bundle to apply
List of names of Bundles to apply
When the Bundle should start (if left empty, Bundle will start immediately)
Note: This is only applicable to a Bundle with autostart: false
Format as defined in RFC 3339, section 5.6. Timezone is UTC (ends with ‘Z’).
Example: 2006-01-02T15:04:05Z
How many eSIMs will be assigned with this bundle applied (if left empty Bundle will assign to one eSIM)
object
object
Name of Bundle to apply
When the Bundle should start (if left empty, Bundle will start immediately)
Note: This is only applicable to a Bundle with autostart: false
Format as defined in RFC 3339, section 5.6. Timezone is UTC (ends with ‘Z’).
Example: 2006-01-02T15:04:05Z
How many eSIMs will be assigned with this bundle applied (if left empty Bundle will assign to one eSIM)
Examples
Responses
200
Success message
object
object
Newly assinged eSIM ICCID
Status of Bundle
Apply Reference
400
Bad Request - returned when request format is not accepted
object
Status of api functions which do not return data
403
Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user
object
Status of api functions which do not return data
500
Server Error
object
Status of api functions which do not return data
503
Processing - Please come back later or use the Retry-After (seconds) header
object
Status of api functions which do not return data