Add Order Document

Request

This operation allows you to add a document to an existing order.

Security

basicAuth or bearerAuth

Path

orderIdnumberrequired

Order Identifier

Bodyapplication/jsonrequired

Add Order Document

documentNamestring

The name of the document.

descriptionstring

A description of the contents of the document.

fileContentstring

Base64-encoded content representing the file contents.

curl -i -X POST \
  -u '<username>:<password>' \
  'https://porting.api.sinch.com/v1/projects/YOUR_project_id/orders/portIns/{orderId}/documents' \
  -H 'Content-Type: application/json' \
  -d '{
    "documentName": "string",
    "description": "string",
    "fileContent": "string"
  }'

Responses

Successful operation, the file name/description would be returned, but the content would not be returned in the response.

Bodyapplication/json

idnumberread-only

The ID of the order document.

documentNamestring

The name of the document.

descriptionstring

A description of the contents of the document.

Response

{
  "id": 0,
  "documentName": "string",
  "description": "string"
}