{
  "opencollection": "1.0.0",
  "info": {
    "name": "Telnyx Access Tokens SIM Card Groups API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "SIM Card Groups",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get all SIM card groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/sim_card_groups",
            "params": [
              {
                "name": "page[number]",
                "value": "",
                "type": "query",
                "description": "The page number to load."
              },
              {
                "name": "page[size]",
                "value": "",
                "type": "query",
                "description": "The size of the page."
              },
              {
                "name": "filter[name]",
                "value": "",
                "type": "query",
                "description": "A valid SIM card group name."
              },
              {
                "name": "filter[private_wireless_gateway_id]",
                "value": "",
                "type": "query",
                "description": "A Private Wireless Gateway ID associated with the group."
              },
              {
                "name": "filter[wireless_blocklist_id]",
                "value": "",
                "type": "query",
                "description": "A Wireless Blocklist ID associated with the group."
              }
            ]
          },
          "docs": "Get all SIM card groups belonging to the user that match the given filters."
        },
        {
          "info": {
            "name": "Create a SIM card group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/sim_card_groups",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new SIM card group object"
        },
        {
          "info": {
            "name": "Get SIM card group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/sim_card_groups/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the SIM group."
              },
              {
                "name": "include_iccids",
                "value": "",
                "type": "query",
                "description": "It includes a list of associated ICCIDs."
              }
            ]
          },
          "docs": "Returns the details regarding a specific SIM card group"
        },
        {
          "info": {
            "name": "Update a SIM card group",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.telnyx.com/v2/sim_card_groups/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the SIM group."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a SIM card group"
        },
        {
          "info": {
            "name": "Delete a SIM card group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.telnyx.com/v2/sim_card_groups/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the SIM group."
              }
            ]
          },
          "docs": "Permanently deletes a SIM card group"
        },
        {
          "info": {
            "name": "Request Private Wireless Gateway removal from SIM card group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/sim_card_groups/:id/actions/remove_private_wireless_gateway",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the SIM group."
              }
            ]
          },
          "docs": "This action will asynchronously remove an existing Private Wireless Gateway definition from a SIM card group. Completing this operation defines that all SIM cards in the SIM card group will get their traffic handled by Telnyx's default mobile network configuration."
        },
        {
          "info": {
            "name": "Request Wireless Blocklist removal from SIM card group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/sim_card_groups/:id/actions/remove_wireless_blocklist",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the SIM group."
              }
            ]
          },
          "docs": "This action will asynchronously remove an existing Wireless Blocklist to all the SIMs in the SIM card group."
        },
        {
          "info": {
            "name": "Request Private Wireless Gateway assignment for SIM card group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/sim_card_groups/:id/actions/set_private_wireless_gateway",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the SIM group."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This action will asynchronously assign a provisioned Private Wireless Gateway to the SIM card group. Completing this operation defines that all SIM cards in the SIM card group will get their traffic controlled by the associated Private Wireless Gateway. This operation will also imply that new SIM cards assigned to a group will inherit its network definitions. If it's moved to a different group that doesn't have a Private Wireless Gateway, it'll use Telnyx's default mobile network configuration."
        },
        {
          "info": {
            "name": "Request Wireless Blocklist assignment for SIM card group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/sim_card_groups/:id/actions/set_wireless_blocklist",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the SIM group."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This action will asynchronously assign a Wireless Blocklist to all the SIMs in the SIM card group."
        }
      ]
    }
  ],
  "bundled": true
}