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

Loading...