Skip to main content
POST
Create a signable template after upload

Authorizations

Authorization
string
header
required

API key authentication. Obtain your API key from the dashboard.

X-Environment
string
header
required

Target environment for the request. Must be "test" or "live".

Body

application/json
category
enum<string>
required
Available options:
privacy_notice,
nda,
contract,
declaration,
other
name
string
required
Minimum string length: 1
filename
string
required
Minimum string length: 1
storagePath
string
required
Minimum string length: 1
sha256
string
required
Pattern: ^[a-f0-9]{64}$
size
integer
required
Required range: -9007199254740991 < x <= 9007199254740991
id
string<uuid>
required
scope
string
default:MX
description
string
places
object[]
Maximum array length: 50

Response

200 - application/json

OK

id
string<uuid>
required
organizationId
string
required
environment
enum<string>
required
Available options:
test,
live
category
enum<string>
required
Available options:
privacy_notice,
nda,
contract,
declaration,
other
scope
string
required
name
string
required
description
string | null
required
filename
string
required
storagePath
string
required
sha256
string
required
size
integer
required
Required range: -9007199254740991 < x <= 9007199254740991
version
integer
required
Required range: -9007199254740991 < x <= 9007199254740991
status
enum<string>
required
Available options:
active,
superseded,
archived
activeFrom
string<date-time>
required
supersededAt
string<date-time> | null
required
supersededByTemplateId
string<uuid> | null
required
places
object[]
required
Maximum array length: 50
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
archivedAt
string<date-time> | null
required
archivedBy
string | null
required
isDeleted
boolean
required
deletedAt
string<date-time> | null
required