Skip to main content

Create a list of additional documents

POST 
/porting_orders/:id/additional_documents

Creates a list of additional documents for a porting order.

Request ​

Path Parameters

    id uuidrequired

    Porting Order id

Body

required

A list of additional document parameters

    additional_documents

    object[]

    Possible values: <= 100

  • Array [

    • document_type string

    Possible values: [loa, invoice, csr, other]

    The type of document being created.

    document_id uuid

    The document identification

  • ]

Responses ​

201: Successful response

Schema

    data

    object[]

  • Array [

    • id uuid

    Uniquely identifies this additional document

    document_type string

    Possible values: [loa, invoice, csr, other]

    Identifies the type of additional document

    document_id uuid

    Identifies the associated document

    filename string

    The filename of the related document.

    content_type string

    The content type of the related document.

    porting_order_id uuid

    Identifies the associated porting order

    record_type string

    Identifies the type of the resource.

    created_at date-time

    ISO 8601 formatted date indicating when the resource was created.

    updated_at date-time

    ISO 8601 formatted date indicating when the resource was updated.

  • ]

401: Unauthorized

404: Resource not found

422: Unprocessable entity. Check message field in response for details.

Request samples

curl -L 'https://api.telnyx.com/v2/porting_orders/:id/additional_documents' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "additional_documents": [
    {
      "document_id": "22771a52-c43a-4539-80db-9dd9ec36e237",
      "document_type": "loa"
    },
    {
      "document_id": "d91474e6-4ebc-4ec1-b379-c596eeb405d6",
      "document_type": "invoice"
    }
  ]
}'

Response samples

{
  "data": [
    {
      "id": "2acd1061-33cb-49b8-8014-beb6dc3fedbf",
      "document_id": "40bc547a-7f96-4cd5-926a-da4842671e88",
      "document_type": "loa",
      "porting_order_id": "9d7b3b8e-4e67-4837-9c44-d110cd2c82a1",
      "record_type": "porting_additional_document",
      "created_at": "2023-06-01T10:00:00.00000Z",
      "updated_at": "2023-06-01T10:00:00.00000Z"
    }
  ]
}