Sign in

v1

latestOpenAPI 3.0.02026-07-24115101.2 MB
Contract

Start draft approval workflow of a contract

Use this endpoint to initiate the draft approval workflow of a contract.

post/contracts/{contract_id}/draft_approval_workflow/start

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

auto_publishboolean required

If <b>true</b>, the draft contract will be published automatically after draft approval.

subjectstring

Subject of the message for sending invitation for the contract.

messagestring

Message to be sent along with the invitation for the contract.

Example request

{
  "subject": "Contract subject",
  "message": "Contract sample message, use this space to additional message with the contract."
}

Response

Returns the draft approval contract response.

auto_publishboolean

A flag to indicate if the contract will be published automatically after draft approval.

idinteger required