v1

latestOpenAPI 3.0.02026-07-24115101.2 MB

Contract

Update a contract by ID

Use this endpoint to update a specific contract by its ID. Note that many fields are only editable before the contract is signed.

put/contracts/{contract_id}

Path parameters

contract_idinteger required

The unique ID of the contract.

Headers

x-oneflow-api-tokenstring required

The API key of your Oneflow account.

x-oneflow-user-emailstring email required

Example:john.doe@oneflow.com

The email address of a registered Oneflow user.

Request body

sign_laterboolean

If set to <b>true</b>, the contract signing will postpone until the contract is ready.

Example request

{
  "_private": {
    "signing_period_expiration": {
      "type": "never"
    },
    "value": {
      "amount": "500.10"
    }
  },
  "sign_order": [
    {
      "participant_id": 180224,
      "order": 2
    }
  ],
  "tags": [
    {
      "id": 380001
    }
  ]
}

Response

Returns the updated 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

One of the contract states.

state_updated_timestring datetime required

updated_timestring datetime nullable required