Attach library documents to a package
curl --request POST \
--url https://my.flowsign.app/api/v1/packages/{packageId}/library-documents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"documents": [
{
"documentId": "<string>",
"roleMap": {}
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({documents: [{documentId: '<string>', roleMap: {}}]})
};
fetch('https://my.flowsign.app/api/v1/packages/{packageId}/library-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}/library-documents"
payload = { "documents": [
{
"documentId": "<string>",
"roleMap": {}
}
] }
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}/library-documents");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"documents\": [\n {\n \"documentId\": \"<string>\",\n \"roleMap\": {}\n }\n ]\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
{
"data": {
"attached": 1
}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}Packages
Attach library documents to a package
Copies documents from the library into a DRAFT package, with their fields. roleMap maps each of the document’s library role ids (from GET /api/v1/library/documents) to a recipient id on this package; a role left out or mapped to null leaves its fields unassigned. The package keeps its own copy, so later edits never reach the library. Requires canSendPackages.
POST
/
api
/
v1
/
packages
/
{packageId}
/
library-documents
Attach library documents to a package
curl --request POST \
--url https://my.flowsign.app/api/v1/packages/{packageId}/library-documents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"documents": [
{
"documentId": "<string>",
"roleMap": {}
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({documents: [{documentId: '<string>', roleMap: {}}]})
};
fetch('https://my.flowsign.app/api/v1/packages/{packageId}/library-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}/library-documents"
payload = { "documents": [
{
"documentId": "<string>",
"roleMap": {}
}
] }
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}/library-documents");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"documents\": [\n {\n \"documentId\": \"<string>\",\n \"roleMap\": {}\n }\n ]\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
{
"data": {
"attached": 1
}
}{
"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
Required array length:
1 - 50 elementsShow child attributes
Show child attributes
Response
Success
Show child attributes
Show child attributes
Was this page helpful?

