Update SIM card

PATCH 
/wireless/sim_cards/:id

Updates a specific SIM card.

Request

Path Parameters

id uuidrequired

The unique identifier of the SIM card

application/json

Body

required

SIM card update request

tags string[]

A list of tags for the given SIM card.

enabled boolean

Whether the SIM card should be enabled or disabled.

Responses

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object

enabled boolean

Whether the SIM card is currently enabled or not

iccid string

The ICCID of the given card

id string

The id of the SIM card

sim_card_group

object

The SIM card group associated with the given card

id string

The id of the SIM card group

data_allocation string

The total data allocation for the group in GB

ingress_site_id string

The id of the site where data will enter the network

egress_site_id string

The id of the site where data will exit the network

created_at string

Timestamp for when the order was created

updated_at string

Timestamp for when the order was last updated

The SIM card group associated with the given card

tags string[]

The searchable tags associated with the SIM card

updated_at string

Timestamp for when the SIM card was last updated

{
  "data": {
    "enabled": true,
    "iccid": "string",
    "id": "string",
    "sim_card_group": {
      "id": "string",
      "data_allocation": "string",
      "ingress_site_id": "string",
      "egress_site_id": "string",
      "created_at": "string",
      "updated_at": "string"
    },
    "tags": [
      "string"
    ],
    "updated_at": "string"
  }
}

401: Authentication error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code string

an application-specific error code, expressed as a stringified integer.

title string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer string

JSON pointer to the field which is causing the error.

]

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

403: Authorization error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code string

an application-specific error code, expressed as a stringified integer.

title string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer string

JSON pointer to the field which is causing the error.

]

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

Request samples

• cURL

---

curl -L -X PATCH 'https://api.telnyx.com/wireless/sim_cards/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "tags": [
    "string"
  ],
  "enabled": true
}'

Response samples

• 200
• 401
• 403

---

{
  "data": {
    "enabled": true,
    "iccid": "string",
    "id": "string",
    "sim_card_group": {
      "id": "string",
      "data_allocation": "string",
      "ingress_site_id": "string",
      "egress_site_id": "string",
      "created_at": "string",
      "updated_at": "string"
    },
    "tags": [
      "string"
    ],
    "updated_at": "string"
  }
}

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}