API v2.5 / eSIMs / Suspend or unsuspend an eSIM

Server eSIMGo API - https://api.esim-go.com/v2.5

POST

/esims/{iccid}/suspend

• eSIMGo API

This endpoint allows you to suspend or unsuspend an eSIM using its ICCID.

When an eSIM is suspended, it will not be able to connect to the network. This can be useful for temporarily disabling an eSIM without revoking it entirely.

To suspend an eSIM, set suspend to true. To unsuspend an eSIM, set suspend to false.

Authorizations

• apiKeyAuth

Parameters

Path Parameters

iccid

required

string

(Required) The ICCID of the eSIM

Example

8944123456789012000

Request Body ^required

Suspend or unsuspend the eSIM

object

suspend

required

boolean

Example

{
  "suspend": true
}

Responses

201

Suspend status set successfully

object

status

Status message of api request

string

Example

{
  "status": "eSIM suspended successfully"
}

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 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