Skip to main content
POST
Create

Authorizations

Authorization
string
header
required

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

Headers

X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Body

application/json
templateId
string<uuid>
required
Example:

"8ef9a712-cdae-4110-b1ea-9ba95abbee6e"

personId
string<uuid>
required
Example:

"8ef9a712-cdae-4110-b1ea-9ba95abbee6e"

sender
object
required
suppressNotification
boolean
default:false

Whether to suppress email notifications (optional, defaults to false)

Response

create contract response

id
string<uuid>
Example:

"8ef9a712-cdae-4110-b1ea-9ba95abbee6e"

name
string

Contract name

personId
string<uuid>
Example:

"8ef9a712-cdae-4110-b1ea-9ba95abbee6e"

signatures
object[]

List of signatures required for the contract

status
string

Contract status

subject
string

Contract email subject

templateId
string<uuid>
Example:

"8ef9a712-cdae-4110-b1ea-9ba95abbee6e"

title
string

Contract title