v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Activity

TaskReminders.update

Modifies TaskReminder or TaskReminders with given id(s)

patch/entities/TaskReminders/{id}

Path parameters

idstring uuid required

ID of TaskReminder to update

Query parameters

validation-levelinteger

Specify validation level of TaskReminder on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

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 (e.g. NotSent, Sent, Snoozed, Dismissed).

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

task_idstring uuid

Id of the task.

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

Modification confirmation. Returns resulting TaskReminder

successboolean

True when response 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
  }
}