Skip to main content
POST
Update a Reminder

Authorizations

Authorization
string
header
required

A static Affinity API key, presented as a bearer token.

Path Parameters

reminderId
integer<int64>
required

Reminder ID

Required range: 1 <= x <= 9007199254740991

Body

application/json

Partial-update request body for a reminder. Only provided properties are updated. recurrence may only be sent when the reminder's existing type is recurring. Setting completedAt to a non-null value marks the reminder complete (for recurring reminders, this advances dueDate by recurrence.periodDays and completedAt remains null on the resource). Setting completedAt to null marks the reminder incomplete and is rejected for recurring reminders.

content
string | null

Free-form note attached to the reminder. Send null to clear.

Example:

"Follow up about the funding round"

dueDate
string<date-time>

New due date for the reminder.

Example:

"2026-06-01T17:00:00Z"

owner
object

The new owner of the reminder. Must reference an internal user.

completedAt
string<date-time> | null

Set a value to mark the reminder complete. Send null to mark it incomplete (one-time reminders only). completer is populated from the API key's owning user.

Example:

"2026-05-11T17:00:00Z"

recurrence
object

Update recurrence configuration. Only valid when the reminder's existing type is recurring. Send only the fields you want to change.

Response

No Content