curl --request POST \
--url https://my.flowsign.app/api/v1/packages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"recipients": [
{
"name": "<string>",
"email": "[email protected]",
"action": "<string>",
"delay": 1
}
],
"documents": [
{
"fileName": "<string>",
"pageCount": 2,
"nonce": "<string>"
}
],
"description": "<string>",
"signingOrder": true,
"emailSubject": "<string>",
"emailMessage": "<string>",
"sendReminders": true,
"scheduledAt": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"metadata": {}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
recipients: [{name: '<string>', email: '[email protected]', action: '<string>', delay: 1}],
documents: [{fileName: '<string>', pageCount: 2, nonce: '<string>'}],
description: '<string>',
signingOrder: true,
emailSubject: '<string>',
emailMessage: '<string>',
sendReminders: true,
scheduledAt: '2023-11-07T05:31:56Z',
tags: ['<string>'],
metadata: {}
})
};
fetch('https://my.flowsign.app/api/v1/packages', 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"
payload = {
"title": "<string>",
"recipients": [
{
"name": "<string>",
"email": "[email protected]",
"action": "<string>",
"delay": 1
}
],
"documents": [
{
"fileName": "<string>",
"pageCount": 2,
"nonce": "<string>"
}
],
"description": "<string>",
"signingOrder": True,
"emailSubject": "<string>",
"emailMessage": "<string>",
"sendReminders": True,
"scheduledAt": "2023-11-07T05:31:56Z",
"tags": ["<string>"],
"metadata": {}
}
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");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"title\": \"<string>\",\n \"recipients\": [\n {\n \"name\": \"<string>\",\n \"email\": \"[email protected]\",\n \"action\": \"<string>\",\n \"delay\": 1\n }\n ],\n \"documents\": [\n {\n \"fileName\": \"<string>\",\n \"pageCount\": 2,\n \"nonce\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"signingOrder\": true,\n \"emailSubject\": \"<string>\",\n \"emailMessage\": \"<string>\",\n \"sendReminders\": true,\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"tags\": [\n \"<string>\"\n ],\n \"metadata\": {}\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": {}
}Create a package
Creates a DRAFT package (or SCHEDULED when scheduledAt is set) with the given recipients and documents. metadata sets custom field values; unknown keys are rejected with 422, and so are missing required values when scheduledAt is set. Requires canSendPackages. Each document comes back with an uploadUrl: PUT the file’s bytes to it to attach them. The URL is single-use and expires after two hours. Sending is a separate PATCH call.
curl --request POST \
--url https://my.flowsign.app/api/v1/packages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"recipients": [
{
"name": "<string>",
"email": "[email protected]",
"action": "<string>",
"delay": 1
}
],
"documents": [
{
"fileName": "<string>",
"pageCount": 2,
"nonce": "<string>"
}
],
"description": "<string>",
"signingOrder": true,
"emailSubject": "<string>",
"emailMessage": "<string>",
"sendReminders": true,
"scheduledAt": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"metadata": {}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
recipients: [{name: '<string>', email: '[email protected]', action: '<string>', delay: 1}],
documents: [{fileName: '<string>', pageCount: 2, nonce: '<string>'}],
description: '<string>',
signingOrder: true,
emailSubject: '<string>',
emailMessage: '<string>',
sendReminders: true,
scheduledAt: '2023-11-07T05:31:56Z',
tags: ['<string>'],
metadata: {}
})
};
fetch('https://my.flowsign.app/api/v1/packages', 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"
payload = {
"title": "<string>",
"recipients": [
{
"name": "<string>",
"email": "[email protected]",
"action": "<string>",
"delay": 1
}
],
"documents": [
{
"fileName": "<string>",
"pageCount": 2,
"nonce": "<string>"
}
],
"description": "<string>",
"signingOrder": True,
"emailSubject": "<string>",
"emailMessage": "<string>",
"sendReminders": True,
"scheduledAt": "2023-11-07T05:31:56Z",
"tags": ["<string>"],
"metadata": {}
}
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");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"title\": \"<string>\",\n \"recipients\": [\n {\n \"name\": \"<string>\",\n \"email\": \"[email protected]\",\n \"action\": \"<string>\",\n \"delay\": 1\n }\n ],\n \"documents\": [\n {\n \"fileName\": \"<string>\",\n \"pageCount\": 2,\n \"nonce\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"signingOrder\": true,\n \"emailSubject\": \"<string>\",\n \"emailMessage\": \"<string>\",\n \"sendReminders\": true,\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"tags\": [\n \"<string>\"\n ],\n \"metadata\": {}\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.
Body
11Show child attributes
Show child attributes
1Show child attributes
Show child attributes
No expiry, 7 days, 14 days, 30 days, 60 days, 90 days, 6 months, 1 year Custom field values keyed by custom field key. Every key must be a live custom field that applies to this package. An empty string clears a value.
Show child attributes
Show child attributes
Response
Success
Show child attributes
Show child attributes
Was this page helpful?

