Skip to main content
POST
Create 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
name
string
required
Minimum string length: 1
roles
object[]
required
Minimum array length: 1
description
string
status
enum<string>
Available options:
DRAFT,
ACTIVE,
ARCHIVED
tags
string[]
reminderDaysAfterSend
integer
Required range: x >= 0
expirationDays
integer
Required range: x >= 0
expiryWarningDays
integer
Required range: x >= 0
emailSubject
string
emailMessage
string
lockDocuments
boolean
lockRoles
boolean
lockFields
boolean
signingMode
enum<string>
Available options:
PARALLEL,
SEQUENTIAL,
WORKFLOW
brandColor
string
questions
object[]
mergeFields
object[]

Response

Success

data
object
required