Request bulk setting of network preferences for SIM cards.

POST 
/sim_cards/actions/bulk_set_network_preferences

This API triggers an asynchronous operation to set network preferences for each of the specified SIM cards.
For each SIM Card a SIM Card Action will be generated. The status of the SIM Card Action can be followed through the List SIM Card Action API.

Request

application/json

Body

sim_card_ids uuid[]required

Responses

202: Successful Response

application/json

• Schema
• Example (from schema)

Schema

data

object

This object represents a bulk SIM card action. It groups SIM card actions created through a bulk endpoint under a single resource for further lookup.

id uuid

Identifies the resource.

record_type string

action_type string

Possible values: [bulk_set_public_ips]

The operation type. It can be one of the following:


• bulk_set_public_ips - set a public IP for each specified SIM card

settings object

A JSON object representation of the bulk action payload.

created_at CreatedAt (string)

ISO 8601 formatted date-time indicating when the resource was created.

updated_at UpdatedAt (string)

ISO 8601 formatted date-time indicating when the resource was updated.

This object represents a bulk SIM card action. It groups SIM card actions created through a bulk endpoint under a single resource for further lookup.

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "bulk_sim_card_action",
    "action_type": "bulk_set_public_ips",
    "settings": {},
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z"
  }
}

422: Unprocessable entity. Check the 'detail' field in response for details.

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code intrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/sim_cards/actions/bulk_set_network_preferences' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "sim_card_ids": [
    "6b14e151-8493-4fa1-8664-1cc4e6d14158"
  ]
}'

Response samples

• 202
• 422

---

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "bulk_sim_card_action",
    "action_type": "bulk_set_public_ips",
    "settings": {},
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z"
  }
}

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}