Skip to main content
POST
Launch a package from a template

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
templateId
string
required
Minimum string length: 1
recipients
object[]
required
Minimum array length: 1
externalId
string
Required string length: 1 - 255
status
enum<string>
default:draft
Available options:
draft,
sent
scheduledAt
string<date-time>
fields
object
workflowAnswers
object
documentAnswers
object
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