ONoneflow
Contract

Publish a contract by ID

Changed on

Use this endpoint to send contract to participants.

post/contracts/{contract_id}/publish

Request

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

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

subjectstring required

Subject of the message for sending invitation for the contract.

messagestring required

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 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