FOfolk
Reminders

Update a reminder

Update an existing reminder in the workspace.<br/><Warning>This endpoint is deprecated since August 13, 2026 and will be removed on February 13, 2027. Please use the Update a task endpoint instead.</Warning>

patch/v1/reminders/{reminderId}

Request

  • Base URL
    https://api.folk.app
  • URL
    https://api.folk.app/v1/reminders/{reminderId}
  • Auth
    HTTP bearer

Path parameters

reminderIdstring required

The ID of the reminder to update.

Headers

Idempotency-Keystring

A unique key, such as a UUID, that makes retrying this request safe: a retry with the same key and body returns the original response without running the operation again. Keys are kept for 24 hours after the request completes.

Example:8e03978e-40d5-43e8-bc93-6894a57f9324

Request body

namestring

The name of the reminder.

recurrenceRulestring

The recurrence rule of the reminder. The recurrence rule is a string that follows the iCalendar format specified in RFC 5545. We support only a subset of the iCalendar format:

DTSTART;TZID=<timezone>:<date>T<time>
RRULE:<recurrence parameters>

Only the following recurrence parameters are supported:

  • No repeat: RRULE:COUNT=1
  • Every weekday: RRULE:FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR;INTERVAL=1
  • Every week: RRULE:FREQ=WEEKLY;INTERVAL=1
  • Every 2 weeks: RRULE:FREQ=WEEKLY;INTERVAL=2
  • Every month: RRULE:FREQ=MONTHLY;INTERVAL=1
  • Every quarter: RRULE:FREQ=MONTHLY;INTERVAL=3
  • Every year: RRULE:FREQ=YEARLY;INTERVAL=1

Supplying any other type of recurrence will result in a validation error.

visibility'public' | 'private'

The visibility of the reminder.

  • public: The reminder is visible to all users in the workspace.
  • private: The reminder is visible only to the current user.

Example request

{
  "name": "Reminder on John Doe",
  "recurrenceRule": "DTSTART;TZID=Europe/Paris:20250717T090000\nRRULE:FREQ=WEEKLY;INTERVAL=1",
  "assignedUsers": [
    {
      "id": "usr_a45c30d8-19fc-4939-94c7-17dc5e46f476"
    },
    {
      "email": "john.doe@example.com"
    }
  ]
}

Response

The updated reminder in the workspace.

deprecationsstring[]

Example response

{
  "data": {
    "id": "rmd_91118b73-5a75-480b-b8e3-a33671c35cdc",
    "name": "Reminder on John Doe",
    "entity": {
      "id": "per_55175e81-9a52-4ac3-930e-82792c23499b",
      "entityType": "person",
      "fullName": "John Doe"
    },
    "recurrenceRule": "DTSTART;TZID=Europe/Paris:20250717T090000\nRRULE:FREQ=WEEKLY;INTERVAL=1",
    "visibility": "public",
    "assignedUsers": [
      {
        "id": "usr_a45c30d8-19fc-4939-94c7-17dc5e46f476",
        "fullName": "John Doe",
        "email": "john.doe@example.com"
      }
    ],
    "nextTriggerTime": "2025-07-17T09:00:00.000Z",
    "lastTriggerTime": "2025-05-17T09:00:00.000Z",
    "createdBy": {
      "id": "usr_bc984b3f-0386-434d-82d7-a91eb6badd71",
      "fullName": "John Doe",
      "email": "john.doe@example.com"
    },
    "createdAt": "2021-01-01T00:00:00.000Z"
  },
  "deprecations": [
    "This field is deprecated"
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.