Sign in

v1

latestOpenAPI 3.0.02026-07-24115101.2 MB
Contract - Reminders

Update a reminder by ID

Use this endpoint to update an internal reminder which is already existing on a contract.

put/contracts/{contract_id}/reminders/{reminder_id}

Path parameters

contract_idinteger required

The unique ID of the contract.

reminder_idinteger required

The unique ID of the contract reminder.

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

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

messagestring

The message of the reminder.

subjectstring

The subject of the reminder.

Example request

{
  "reminder_recipients": [
    {
      "id": 190001
    }
  ]
}

Response

Returned a updated reminder.

contract_idinteger required

The id of the contract.

date_timestring datetime required

The date and time the reminder should send.

idinteger required

The id of the reminder.

messagestring required

The message of the reminder.

subjectstring required

The subject of the reminder.