Skip to content
eSIM Go Developer Docs

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:

  • If an ICCID is provided, 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.
  • 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.
  • In some cases, it may take up to 5 minutes for your eSIM bundles to be delivered

Authorizations

Request Body required

Details of Bundle to apply to eSIM

object
iccid

ICCID of target eSIM to apply Bundle to. If not provided, a new eSIM will be assigned to you.

string
name
required

Name of Bundle to apply

string
startTime

When the Bundle should start (if left empty, Bundle will start immediately)

Note: This is only applicable to bundles with autostart=false

string
repeat

How many bundles should be applied (each returns a new eSIM)

integer

Responses

200

Success message

object
esims
Array<object>
object
iccid

Newly assinged eSIM ICCID

string
status

Status of Bundle

string
applyReference

Apply Reference

string

400

Bad Request - returned when request format is not accepted

object
message

Status of api functions which do not return data

string

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
message

Status of api functions which do not return data

string

500

Server Error

object
message

Status of api functions which do not return data

string