Skip to main content
PUT
Edit a draft 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

One of the workspaces the key was issued for, as returned by GET /api/v1/workspaces. Required on a key that acts for members. On any other key it is optional and omitting it acts in the key's default workspace. Any id outside the key's workspaces is rejected with 401.

x-act-as
string

Required on a key that acts for members, refused on any other key. Names the member the call runs as, as key=value: email=jane@acme.com, employee_id=E-1001, scim_external_id=… or a custom identifier. Keys are lowercase and matched case-insensitively. The call fails with 403 when no active member of the workspace matches.

Path Parameters

packageId
string
required

Body

application/json
title
string

The package's title, shown to recipients.

Minimum string length: 1
Example:

"Employment agreement for Jane Ahu"

description
string

A description of the package. An empty string clears it.

Example:

"Jane's signed agreement ahead of her 12 October start."

signingMode
enum<string>

How recipients are walked through signing. WORKFLOW is a 422 unless the draft already has a workflow, since a workflow is drawn in the app or comes from a template. A recipient's delay is only kept while this is SEQUENTIAL.

Available options:
PARALLEL,
SEQUENTIAL,
WORKFLOW
Example:

"SEQUENTIAL"

emailSubject
string

The subject line of the invitation email. An empty string restores the default.

Example:

"Please sign your employment agreement"

emailMessage
string

A message from the sender included in the invitation email.

Example:

"Kia ora Jane, please review and sign before your start date. Tom"

recipients
object[]

Replaces the recipients, in signing order. Carry a recipient's id to keep them and the fields assigned to them; a recipient left out is removed along with their fields' assignment. An id the package does not have is a 422.

Required array length: 1 - 100 elements
accessCode
string | null

A password every signing recipient must enter before signing, 4 to 64 characters. Null removes it; leaving it out keeps the current one.

Required string length: 4 - 64
Example:

"harbour-4821"

reminderIntervalDays
integer | null

Days between automatic reminders to each recipient who hasn't finished, counted from their invitation. Null or absent sends none.

Required range: x >= 1
Example:

3

expirationDays
integer | null

Days the package stays open for signing, counted from when it is sent. Null or absent means it never expires.

Required range: x >= 1
Example:

30

expiryWarningDays
integer | null

Days before expiry at which recipients who haven't finished are warned. MUST be fewer than expirationDays.

Required range: x >= 1
Example:

5

tags
string[]

Replaces the package's tags. Tags the organisation does not have yet are created.

Minimum string length: 1
Example:
metadata
object

Custom field values keyed by custom field key, merged over the current values. Every key must be a live custom field that applies to this package; an unknown key is a 422. An empty string clears a value.

Example:
mergeValues
object

Values for the package's merge fields, keyed by merge field key. Each is checked against the field's type and list options, and a bad value is a 422.

Example:

Response

Success

data
object
required