Create a list of additional documents
Creates a list of additional documents for a porting order.
POST
/
porting_orders
/
{id}
/
additional_documents
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const additionalDocument = await client.portingOrders.additionalDocuments.create(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);
console.log(additionalDocument.data);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
additional_document = client.porting_orders.additional_documents.create(
id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(additional_document.data)package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
additionalDocument, err := client.PortingOrders.AdditionalDocuments.New(
context.TODO(),
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
telnyx.PortingOrderAdditionalDocumentNewParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", additionalDocument.Data)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.portingorders.additionaldocuments.AdditionalDocumentCreateParams;
import com.telnyx.sdk.models.portingorders.additionaldocuments.AdditionalDocumentCreateResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
AdditionalDocumentCreateResponse additionalDocument = client.portingOrders().additionalDocuments().create("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
additional_document = telnyx.porting_orders.additional_documents.create("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
puts(additional_document)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$additionalDocument = $client->portingOrders->additionalDocuments->create(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
additionalDocuments: [
[
'documentID' => '22771a52-c43a-4539-80db-9dd9ec36e237',
'documentType' => 'loa',
],
[
'documentID' => 'd91474e6-4ebc-4ec1-b379-c596eeb405d6',
'documentType' => 'invoice',
],
],
);
var_dump($additionalDocument);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx porting-orders:additional-documents create \
--api-key 'My API Key' \
--id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26ecurl --request POST \
--url https://api.telnyx.com/v2/porting_orders/{id}/additional_documents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"additional_documents": [
{
"document_id": "22771a52-c43a-4539-80db-9dd9ec36e237",
"document_type": "loa"
},
{
"document_id": "d91474e6-4ebc-4ec1-b379-c596eeb405d6",
"document_type": "invoice"
}
]
}
'{
"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"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Porting Order id
Body
application/json
A list of additional document parameters
Maximum array length:
100Show child attributes
Show child attributes
Response
Successful response
Show child attributes
Show child attributes
Was this page helpful?
⌘I
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const additionalDocument = await client.portingOrders.additionalDocuments.create(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);
console.log(additionalDocument.data);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
additional_document = client.porting_orders.additional_documents.create(
id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(additional_document.data)package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
additionalDocument, err := client.PortingOrders.AdditionalDocuments.New(
context.TODO(),
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
telnyx.PortingOrderAdditionalDocumentNewParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", additionalDocument.Data)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.portingorders.additionaldocuments.AdditionalDocumentCreateParams;
import com.telnyx.sdk.models.portingorders.additionaldocuments.AdditionalDocumentCreateResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
AdditionalDocumentCreateResponse additionalDocument = client.portingOrders().additionalDocuments().create("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
additional_document = telnyx.porting_orders.additional_documents.create("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
puts(additional_document)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$additionalDocument = $client->portingOrders->additionalDocuments->create(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
additionalDocuments: [
[
'documentID' => '22771a52-c43a-4539-80db-9dd9ec36e237',
'documentType' => 'loa',
],
[
'documentID' => 'd91474e6-4ebc-4ec1-b379-c596eeb405d6',
'documentType' => 'invoice',
],
],
);
var_dump($additionalDocument);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx porting-orders:additional-documents create \
--api-key 'My API Key' \
--id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26ecurl --request POST \
--url https://api.telnyx.com/v2/porting_orders/{id}/additional_documents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"additional_documents": [
{
"document_id": "22771a52-c43a-4539-80db-9dd9ec36e237",
"document_type": "loa"
},
{
"document_id": "d91474e6-4ebc-4ec1-b379-c596eeb405d6",
"document_type": "invoice"
}
]
}
'{
"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"
}
]
}