Create a contract

post

https://{hostname}/v1/contracts/create

Use this endpoint to create a new contract based on the selected template.

Body Params

Request body parameters for creating a contract.

workspace_id

integer

required

The unique ID of the workspace.

template_id

integer

required

The unique ID of the template.

data_fields

array of objects

The data fields to be included in the contract.

data_fields

folder_id

integer

The unique ID of the folder.

my_party

object

Legal entity representing the party of the current user's Oneflow account (the owner side party).

name

string

length between 0 and 130

parties

array of objects

length between 0 and 40

The list of parties in the contract, representing companies, organizations, government departments, etc. Each party object must follow the object representation of either the individual or the company type of party.

parties

product_groups

array of objects

The list of product groups (product tables) in the template or contract. It is possible to add products to multiple product groups if these product groups exist in the template. Ensure that the template for your contract contains at least one product table. Otherwise, the product_groups setting will fail. Note that if your template contains only one product table, it is not mandatory to include the product group id in the request. Note that by default, the limit for products per contract is 150 (includes all product tables). This can be increased for your account if desired by contacting Oneflow support.

product_groups

200Returns the created contract.