Skip to main content
POST
Add
The /packages/add endpoint allows you to create a new package within the application. A package typically contains one or more documents and signers who are required to review and sign those documents.
In production it is recommended to upload files using the Files upload API and reference them by fileId when adding your documents to a package.

Request

Request

Body

string
required
Name of the package.
string
Description of the package.
string
Message to be shared with all signers.
string
default:"Sequential"
Type of package signing workflow.
string
default:"open"
State of the package.
string
Category of the package.
string
Client number associated with the package.
string
Matter number associated with the package.
string
Date by which the document should be signed. After this date, the package will expire and can no longer be signed unless extended.
If not specified, the default value is 7 days from the current date.
The date should be in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
object
Details about the meeting associated with the package.
This is only applicable for packages with the video_closing_room signing workflow type.
string
Locale to create the package in.
If not provided, the package will be created in the organization’s default locale.
string
Member ID to create the package under.
If not provided, the package will be created under the current member.
You require Sign Editor or Package Editor role to create a package on behalf of another member.
string
Team ID to create the package under.
If not provided, the package will be created under the given member, or under the current member if none is provided.
string
Folder ID to create the package under.
If not provided, the package will be created in the root folder.
Set to true to return links for integrating document signing workflows.See the Embed signing guide for more information.
Set to true to return a link for integrating document editing workflows.See the Embed editor guide for more information.
object
Additional options for the package.
object[]
List of signers for the package.
object[]
List of recipients for the package.
object[]
List of documents for the package.

Response

string
Unique identifier for the package.
object
Full package object, returned when returnPackage is set to true on the request.
object[]
List of contacts created during package creation, returned when addSignersToContacts is set to true on the request.