Sign in

v1

latestOpenAPI 3.0.02026-07-24115101.2 MB
Contract - Comments

Create a comment.

Use this endpoint to add a comment to a specific contract. See Comment for more information.

post/contracts/{contract_id}/comments

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

The email address of a registered Oneflow user.

Request body

bodystring required

The actual message of a comment.

parent_idinteger nullable

The id of the parent comment. It should not be an id of a reply comment.

privateboolean

Indicates this comment is private or not.

Example request

{
  "body": "This is the first comment.",
  "participants": [
    {
      "participant_id": 230001
    }
  ]
}

Response

Returns the created comment.

bodystring required

The actual message of a comment.

created_timestring datetime required

The time when the comment was created.

idinteger required

The id of a comment.

parent_idinteger nullable

The id of the parent comment. It should not be an id of a reply comment.

privateboolean required

Indicates this comment is private or not.

updated_timestring datetime nullable

The time when the comment was updated.