v1

latestOpenAPI 3.0.02026-07-24115101.2 MB

Contract - Reminders

Create a reminder

Use this endpoint to create a internal reminder to the owner side participants on the contract.

post/contracts/{contract_id}/reminders

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

date_timestring datetime required

The date and time the reminder should send. It should be a future date and time.

messagestring required

The message of the reminder.

subjectstring required

The subject of the reminder.

Example request

{
  "date_time": "2023-05-10T12:00:00+05:30",
  "message": "sample reminder message",
  "subject": "sample reminder subject",
  "reminder_recipients": [
    {
      "id": 190001
    }
  ]
}

Response

Reminder is created successfully.