Change mode of connectivity subscription

Changes the mode.

Path Parameters

• idType string required

  Possible values: [iccid, imsi, msisdn]

  The subscription's ID type which is used to identify the subscription.

• id string required

  Possible values: Value must match regular expression [0-9]{5,20}

  The ID used to identify the subscription. Depending on the ID type this will either be an MSISDN, IMSI or ICCID.

application/json

Request Body required

The mode to change to.

• mode string required

  Possible values: [ACTIVE, DEACTIVATED, PAUSED, TERMINATED]

  The mode of the subscription. This determines whether the subscription can connect to the network and how the subscription is billed.

Responses

• 202
• 400
• 401
• 403
• 404
• 429
• 500
• 504

---

Request to change mode successfully started.

BadRequest

Response Headers

• Access-Control-Allow-Origin string
• Access-Control-Allow-Methods string
• Access-Control-Allow-Headers string

application/json

• Schema
• Example (from schema)

---

Schema

• name string
• message string
• errors object[]

  message string

  errorCode string

  path string

  Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

Unauthorized. Your token is not valid.

Response Headers

• Access-Control-Allow-Origin string
• Access-Control-Allow-Methods string
• Access-Control-Allow-Headers string

application/json

• Schema
• Example (from schema)

---

Schema

• name string
• message string
• errors object[]

  message string

  errorCode string

  path string

  Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

Forbidden. You are not allowed to access the requested resource.

Response Headers

• Access-Control-Allow-Origin string
• Access-Control-Allow-Methods string
• Access-Control-Allow-Headers string

application/json

• Schema
• Example (from schema)

---

Schema

• name string
• message string
• errors object[]

  message string

  errorCode string

  path string

  Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

The specified resource was not found

Response Headers

• Access-Control-Allow-Origin string
• Access-Control-Allow-Methods string
• Access-Control-Allow-Headers string

application/json

• Schema
• Example (from schema)

---

Schema

• name string
• message string
• errors object[]

  message string

  errorCode string

  path string

  Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

RateLimitError. Too Many Requests.

Response Headers

• Access-Control-Allow-Origin string
• Access-Control-Allow-Methods string
• Access-Control-Allow-Headers string

application/json

• Schema
• Example (from schema)

---

Schema

• name string
• message string
• errors object[]

  message string

  errorCode string

  path string

  Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

Internal Server Error

Response Headers

• Access-Control-Allow-Origin string
• Access-Control-Allow-Methods string
• Access-Control-Allow-Headers string

application/json

• Schema
• Example (from schema)

---

Schema

• name string
• message string
• errors object[]

  message string

  errorCode string

  path string

  Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

Gateway Timeout: The communication with an underlying connectivity platform timed out. This error may be attributable to internal server issues or external network problems. As a result, the requested operation's status is currently indeterminate and may still be in progress. This means the subscription might eventually be updated according to the request, even if the operation appears to have initially failed. Please wait for a brief period before attempting to retry the operation.

Loading...