Skip to main content

Share a porting order

POST 
/porting_orders/:id/actions/share

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

Request​

Path Parameters

    id uuidrequired

    Porting Order id

Body

required

    expires_in_seconds integer

    Possible values: >= 1 and <= 172800

    The number of seconds the token will be valid for

    permissions string

    Possible values: [porting_order.document.read, porting_order.document.update]

    The permissions the token will have

Responses​

201: Successful response

Schema

    data

    object

    id uuid

    Uniquely identifies this sharing token

    porting_order_id uuid

    Identifies the porting order resource being shared

    expires_in_seconds integer

    Possible values: >= 1

    The number of seconds until the sharing token expires

    permissions string[]

    Possible values: [porting_order.document.read, porting_order.document.update]

    The permissions granted to the sharing token

    token string

    A signed JWT token that can be used to access the shared resource

    expires_at date-time

    ISO 8601 formatted date indicating when the sharing token expires.

    record_type string

    Identifies the type of the resource.

    created_at date-time

    ISO 8601 formatted date indicating when the resource was created.

401: Unauthorized

404: Porting Order not found

Request samples

curl -L 'https://api.telnyx.com/v2/porting_orders/:id/actions/share' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "expires_in_seconds": 3600,
  "permissions": [
    "porting_order.document.read",
    "porting_order.document.update"
  ]
}'

Response samples

{
  "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"
}