API v2.4 / eSIMs / Update eSIM Details

Server eSIM Go API - https://api.esim-go.com/v2.4

PUT

/esims

• eSIM Go API

A feature that enables the association of a unique identifier with an eSIM. This functionality allows for the integration of relevant operational data, such as customer order IDs.

Authorizations

• apikeyAuth

Parameters

Query Parameters

iccid

string

(Required) ICCID of eSIM

Example

8944123456789012000

customerRef

string

(Required) New Customer Reference

Example

Test

Request Body

object

iccid

ICCID of eSIM

string

customerRef

New Customer Reference

string

Example

{
  "iccid": "8944123456789012345",
  "customerRef": "ref-123"
}

Responses

200

OK

object

status

Status message of api request

string

Example

{
  "status": "success"
}

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

429

Too Many Requests

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

503

Processing - Please come back later or use the Retry-After (seconds) header

object

message

Status of api functions which do not return data

string