ONoneflow
Contract

Create a contract

Changed on

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

post/contracts/create

Request

  • Base URL
    https://api.oneflow.com/v1
  • Auth
    none declared. Required headers: x-oneflow-api-token, x-oneflow-user-email

Headers

x-oneflow-api-tokenstring required

The API key of your Oneflow account.

x-oneflow-user-emailstring email required

The email address of a registered Oneflow user.

Request body

workspace_idinteger required

The unique ID of the workspace.

template_idinteger required

The unique ID of the template.

folder_idinteger

The unique ID of the folder.

namestring

Example request

{
  "workspace_id": 130001,
  "template_id": 170001,
  "data_fields": [
    {
      "custom_id": "custom_id_first_name",
      "value": "First Name"
    }
  ],
  "my_party": {
    "participants": [
      {
        "email": "own@email.com"
      }
    ]
  },
  "parties": [
    {
      "participant": {
        "name": "Firstname Lastname"
      }
    }
  ],
  "tags": [
    {
      "id": 380001
    }
  ],
  "value": {
    "amount": "500.10"
  }
}

Response

Returns the created contract.

idinteger required
importedboolean nullable

A flag denoting whether the contract has been imported or not.

marked_as_signedboolean nullable

A flag denoting whether the contract has been marked as signed or not.

published_timestring datetime nullable required
sign_laterboolean

A flag to indicate if the contract signing is postponed.

signing_period_expiry_timestring datetime nullable required
state'draft' | 'pending' | 'overdue' | 'signed' | 'declined' | 'unknown' required

One of the contract states.

state_updated_timestring datetime required
updated_timestring datetime nullable required

Changes

  • 0a4e1e88ac45Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the required property /// to the response with the status