Skip to main content
POST
/
porting_orders
/
{id}
/
actions
/
share
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.portingOrders.actions.share('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(response.data);
{
  "data": {
    "id": "03a35311-ad92-46b3-95d7-8ad6dccf2d7c",
    "porting_order_id": "fd4b86c8-497d-4c6d-9609-a789e4e14cfe",
    "expires_in_seconds": 3600,
    "permissions": [
      "porting_order.document.read",
      "porting_order.document.update"
    ],
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2ODk4OTQ2NzcsImlzdCI6MTY4OTg5MTA3NywicGVybWlzc2lvbnMiOlsicG9ydGluZ19vcmRlci5kb2N1bWVudC5yZWFkIl0sInBvcnRpbmdfb3JkZXJfaWQiOiJmZDRiODZjOC00OTdkLTRjNmQtOTYwOS1hNzg5ZTRlMTRjZmUifQ.CT0HRF6OLj7VPZ8p5Y_0S8rOL8SEUznwJJkR-YReKwc",
    "record_type": "porting_order_sharing_token",
    "expires_at": "2023-07-20T23:11:17Z",
    "created_at": "2023-07-20T22:11:17.292573Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

Porting Order id

Body

application/json
​
expires_in_seconds
integer

The number of seconds the token will be valid for

Required range: 1 <= x <= 172800
​
permissions
enum<string>

The permissions the token will have

Available options:
porting_order.document.read,
porting_order.document.update

Response

Successful response

​
data
object