Create a template from a contract

post https://{hostname}/v1/contracts/{contract_id}/copy_to_template

Use this endpoint to create a template from an existing contract.

Responses

Response body

object

_links

object

Links to related endpoints.

comments

object

contracts

object

contract

object

create

object

data_field

object

data_fields

object

events

object

event

object

files

object

file

object

parties

object

party

object

publish

object

self

object

template_types

object

template_type

object

template

object

templates

object

workspaces

object

workspace

object

available_options

object

required

Available options in the contract. See Available options.

can_receive_attachments

boolean

required

can_receive_expanded_pdf

boolean

required

can_receive_products

boolean

required

delivery_channels

array of objects

required

delivery_channels*

object

name

string

required

One of the contract delivery channels.

email sms email_and_sms same_device none unknown

preferred

boolean

required

required_participant_attributes

array of strings

required

required_participant_attributes*

sign_methods

array of objects

required

sign_methods*

object

name

string

required

One of the sign methods.

standard_esign sms swedish_bankid norwegian_bankid danish_mitid finnish_bankid handwritten_signature eid_sign unknown

preferred

boolean

required

two_step_authentication_methods

array of objects

required

two_step_authentication_methods*

object

name

string

required

One of the two step authentication methods.

email sms personal_identification none unknown

preferred

boolean

required

required_participant_attributes

array of strings

required

required_participant_attributes*

attachment_file_groups

array of objects

required

A list of attachment type file groups in the contract.

attachment_file_groups*

object

_private_ownerside

object | null

required

File group data that is private to the ownerside.

files

array of objects

required

files*

object

_private_ownerside

object | null

required

File data that is private to the ownerside.

extension

string | null

required

The file extension.

integer

required

name

string | null

required

The name of the file.

size

integer | null

required

The size of the file in bytes.

integer

required

type

string

required

The file group type of the file group sections. There are only two types available, attachment and pdf.

attachment pdf

configuration

object | null

required

Default configuration details of a template

default_creator_roles

object

required

Roles of a default contract creator who creates contracts using a specific template.

default_counterparty_type

string

Default counterpaty type in the template.

company individual

created_time

string

required

draft_approval_workflow

object | null

Draft approval work flow details.

status

string | null

integer

required

name

string

required

length between 1 and 130

parties

array

required

The parties involved in this template.

parties*

pdf_file_groups

array of objects

required

A list of expanded pdf type file groups in the contract.

pdf_file_groups*

object

_private_ownerside

object | null

required

File group data that is private to the ownerside.

files

array of objects

required

files*

object

_private_ownerside

object | null

required

File data that is private to the ownerside.

extension

string | null

required

The file extension.

integer

required

name

string | null

required

The name of the file.

size

integer | null

required

The size of the file in bytes.

integer

required

type

string

required

The file group type of the file group sections. There are only two types available, attachment and pdf.

attachment pdf

product_groups

array of objects

required

A list of product groups.

product_groups*

object

_private_ownerside

object | null

required

Product group data that is private to the ownerside.

configuration

object

required

Updated product group configuration

created_from

integer | null

This will be only available in the contract create response.

enabled_columns

array of objects

required

enabled_columns*

object

enabled

boolean

required

key

string

required

length between 0 and 80

integer

required

products

array of objects

required

products*

object

_private_ownerside

object | null

required

Product data that is private to the ownerside.

counterparty_lock

boolean

created_from

integer | null

This will be only available in the contract create response.

description

string

length between 0 and 3000

integer

required

name

string

required

length between 0 and 80

price_1

object | null

required

An object that holds all price related information for an individual product.

price_2

object | null

required

An object that holds all price related information for an individual product.

quantity

object

required

The object holds information about the quantity of an individual product. The default quantity type is multiple_choice. If the quantity type is single_choice or multiple_choice, the amount must be set to 0 or 1. If the quantity type is set to single_choice, the amount must be set to 1 at least for one product, and 0 for the rest of the products in the same product group with the quantity type single_choice.

sign_later

boolean

A flag to indicate if the template has postponed signing.

sign_order

array of objects

Sign order of the participants.

sign_order

object

participant_id

integer

required

participant ID

order

integer

required

1 to 1000

Sign order

source_contract_id

integer

200Returns the created template.