v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Porting Orders

Share a porting order

Creates a sharing token for a porting order. The token can be used to share the porting order with non-Telnyx users.

post/porting_orders/{id}/actions/share

Path parameters

idstring uuid required

Porting Order id

Request body

expires_in_secondsinteger

The number of seconds the token will be valid for

permissions'porting_order.document.read' | 'porting_order.document.update'

The permissions the token will have

Example request

{
  "expires_in_seconds": 3600,
  "permissions": "porting_order.document.read"
}

Response

Successful response

Example response

{
  "data": {
    "created_at": "2021-03-19T10:07:15.527000Z",
    "expires_at": "2021-03-19T10:07:15.527000Z",
    "expires_in_seconds": 3600,
    "id": "0a4b78a0-d416-4761-94f7-46c72ec56547",
    "permissions": [
      "porting_order.document.read",
      "porting_order.document.update"
    ],
    "porting_order_id": "f1486bae-f067-460c-ad43-73a92848f902",
    "record_type": "porting_order_sharing_token",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2ODk4OTQ2NzcsImlzdCI6MTY4OTg5MTA3NywicGVybWlzc2lvbnMiOlsicG9ydGluZ19vcmRlci5kb2N1bWVudC5yZWFkIl0sInBvcnRpbmdfb3JkZXJfaWQiOiJmZDRiODZjOC00OTdkLTRjNmQtOTYwOS1hNzg5ZTRlMTRjZmUifQ.CT0HRF6OLj7VPZ8p5Y_0S8rOL8SEUznwJJkR-YReKwc"
  }
}