Skip to main content
POST
Create a package

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-workspace-id
string

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

application/json
title
string
required
Minimum string length: 1
recipients
object[]
required
Minimum array length: 1
documents
object[]
required
Minimum array length: 1
description
string
signingOrder
boolean
emailSubject
string
emailMessage
string
sendReminders
boolean
scheduledAt
string<date-time>
expiresIn
enum<string>
Available options:
No expiry,
7 days,
14 days,
30 days,
60 days,
90 days,
6 months,
1 year
tags
string[]
metadata
object

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.

Response

Success

data
object
required