Create a batch of documents
This request creates a batch of new documents.
POST: <BaseURL>/api/v2/documents
Parameters
Parameter | Description | Requirement | Supported Value | In |
---|---|---|---|---|
x-api-token
|
The API access_token generated for the Access Key | Required | String | Header |
schema
|
Document configuration information | Required | String | Body |
Schema
Parameter | Description | Requirement | Supported Value | In |
---|---|---|---|---|
templateUid
|
Unique template id (for example TPL-79 ) |
Required | String | Body |
clientid
|
Client Identifier | Required | Integer | Body |
title
|
Name of the document | Required | String | Body |
Request Format
cURL
curl --location --request POST '<BaseURL>/api/v2/documents/' \ --header 'x-access-token: <your_API_Access_Token>' --header 'content-type: application/json' \ --data-raw ' { "templateUid": "string", "clientid": integer, "title": "string", }'
Program
URL (POST) | |
---|---|
<BaseURL>/api/v2/documents | |
Header Key | Header Value |
x-access-token
|
<your_API_Access_Token>
|
Body (raw / JSON) | |
templateUid
|
<ID for the template>
|
clientId
|
<Leave blank when adding documents>
|
title
|
<Document title>
|
Response Format
{ "success": true }