COcoevera
Activity

TaskReminders.update

Changes fields of the TaskReminder record with the given id; fields left out keep their values.

patch/entities/TaskReminders/{id}

Request

Path parameters

idstring uuid required

Id of the TaskReminder record to update.

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

owner_idstring uuid

Id of the user who set the reminder.

set_datestring date-time

Timestamp when the reminder should fire.

status0 | 1 | 2

Current state of the reminder: Scheduled to fire at its set time, Snoozed until snooze_date, or Dismissed.

Integer enum value: 0 - Snoozed, 1 - Scheduled, 2 - Dismissed

task_idstring uuid

Id of the task this reminder belongs to.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "owner_id": "01234567-abcd-dcba-ffff-000000000000",
  "set_date": "2019-01-01T00:00:00",
  "task_id": "01234567-abcd-dcba-ffff-000000000000",
  "revision": 1
}

Response

The changed TaskReminder record.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "set_date": "2019-01-01T00:00:00",
    "task_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.