Add documents to a package
curl --request POST \
--url https://my.flowsign.app/api/v1/packages/{packageId}/documents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"documents": [
{
"fileName": "<string>",
"pageCount": 2,
"nonce": "<string>"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({documents: [{fileName: '<string>', pageCount: 2, nonce: '<string>'}]})
};
fetch('https://my.flowsign.app/api/v1/packages/{packageId}/documents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.flowsign.app/api/v1/packages/{packageId}/documents"
payload = { "documents": [
{
"fileName": "<string>",
"pageCount": 2,
"nonce": "<string>"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://my.flowsign.app/api/v1/packages/{packageId}/documents");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"documents\": [\n {\n \"fileName\": \"<string>\",\n \"pageCount\": 2,\n \"nonce\": \"<string>\"\n }\n ]\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
{
"data": {
"packageId": "<string>",
"documents": [
{
"id": "<string>",
"nonce": "<string>",
"filePath": "<string>",
"uploadUrl": "<string>"
}
]
}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}Packages
Add documents to a package
Adds documents to a DRAFT package; any other status is a 400. Each document comes back with its nonce and an uploadUrl: PUT the file’s bytes to it to attach them. The URL is single-use and expires after two hours. Requires canSendPackages.
POST
/
api
/
v1
/
packages
/
{packageId}
/
documents
Add documents to a package
curl --request POST \
--url https://my.flowsign.app/api/v1/packages/{packageId}/documents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"documents": [
{
"fileName": "<string>",
"pageCount": 2,
"nonce": "<string>"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({documents: [{fileName: '<string>', pageCount: 2, nonce: '<string>'}]})
};
fetch('https://my.flowsign.app/api/v1/packages/{packageId}/documents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.flowsign.app/api/v1/packages/{packageId}/documents"
payload = { "documents": [
{
"fileName": "<string>",
"pageCount": 2,
"nonce": "<string>"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://my.flowsign.app/api/v1/packages/{packageId}/documents");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"documents\": [\n {\n \"fileName\": \"<string>\",\n \"pageCount\": 2,\n \"nonce\": \"<string>\"\n }\n ]\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
{
"data": {
"packageId": "<string>",
"documents": [
{
"id": "<string>",
"nonce": "<string>",
"filePath": "<string>",
"uploadUrl": "<string>"
}
]
}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The workspace to act in, from GET /api/v1/workspaces. Omit to act in the organisation's default workspace. A workspace the key's user cannot act in is treated as omitted.
Path Parameters
Body
application/json
Minimum array length:
1Show child attributes
Show child attributes
Response
Success
Show child attributes
Show child attributes
Was this page helpful?

