{
  "opencollection": "1.0.0",
  "info": {
    "name": "Telnyx Access Tokens Number Portout API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Number Portout",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List portout requests",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/portouts",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Consolidated filter parameter (deepObject style). Originally: filter[carrier_name], filter[country_code], filter[country_code_in], filter[foc_date], filter[inserted_at], filter[phone_number], filter[pon], filter[ported_out_at], filter[spid], filter[status], filter[status_in], filter[support_key]"
              }
            ]
          },
          "docs": "Returns the portout requests according to filters"
        },
        {
          "info": {
            "name": "List all port-out events",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/portouts/events",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Consolidated filter parameter (deepObject style). Originally: filter[event_type], filter[portout_id], filter[created_at]"
              }
            ]
          },
          "docs": "Returns a list of all port-out events."
        },
        {
          "info": {
            "name": "Show a port-out event",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/portouts/events/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the port-out event."
              }
            ]
          },
          "docs": "Show a specific port-out event."
        },
        {
          "info": {
            "name": "Republish a port-out event",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/portouts/events/:id/republish",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the port-out event."
              }
            ]
          },
          "docs": "Republish a specific port-out event."
        },
        {
          "info": {
            "name": "List eligible port-out rejection codes for a specific order",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/portouts/rejections/:portout_id",
            "params": [
              {
                "name": "portout_id",
                "value": "",
                "type": "path",
                "description": "Identifies a port out order."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Consolidated filter parameter (deepObject style). Originally: filter[code], filter[code][in]"
              }
            ]
          },
          "docs": "Given a port-out ID, list rejection codes that are eligible for that port-out"
        },
        {
          "info": {
            "name": "List port-out related reports",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/portouts/reports",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Consolidated filter parameter (deepObject style). Originally: filter[report_type], filter[status]"
              }
            ]
          },
          "docs": "List the reports generated about port-out operations."
        },
        {
          "info": {
            "name": "Create a port-out related report",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/portouts/reports",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Generate reports about port-out operations."
        },
        {
          "info": {
            "name": "Retrieve a report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/portouts/reports/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies a report."
              }
            ]
          },
          "docs": "Retrieve a specific report generated."
        },
        {
          "info": {
            "name": "Get a portout request",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/portouts/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Portout id"
              }
            ]
          },
          "docs": "Returns the portout request based on the ID provided"
        },
        {
          "info": {
            "name": "List all comments for a portout request",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/portouts/:id/comments",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Portout id"
              }
            ]
          },
          "docs": "Returns a list of comments for a portout request."
        },
        {
          "info": {
            "name": "Create a comment on a portout request",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/portouts/:id/comments",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Portout id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a comment on a portout request."
        },
        {
          "info": {
            "name": "List supporting documents on a portout request",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/portouts/:id/supporting_documents",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Portout id"
              }
            ]
          },
          "docs": "List every supporting documents for a portout request."
        },
        {
          "info": {
            "name": "Create a list of supporting documents on a portout request",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/portouts/:id/supporting_documents",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Portout id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a list of supporting documents on a portout request."
        },
        {
          "info": {
            "name": "Update Status",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.telnyx.com/v2/portouts/:id/:status",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Portout id"
              },
              {
                "name": "status",
                "value": "",
                "type": "path",
                "description": "Updated portout status"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Authorize or reject portout request"
        }
      ]
    }
  ],
  "bundled": true
}