Skip to main content
POST
Create a Reminder

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for creating a one-time reminder. dueDate is required.

owner
PersonReference · object
required

The person responsible for the reminder. Must reference an internal user.

entity
reminders.TaggedCompany · object
required

The entity the reminder is attached to. Exactly one of company, person, or opportunity can be tagged on a reminder — the variant is selected by the type discriminator.

type
string
required

Discriminator. Always one-time for this variant.

Allowed value: "one-time"
Example:

"one-time"

dueDate
string<date-time>
required

When the reminder is due.

Example:

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

content
string | null

Free-form text attached to the reminder.

Example:

"Follow up about the funding round"

Response

Created

A reminder that fires once on dueDate.

id
integer<int64>
required

The reminder's unique identifier

Required range: 1 <= x <= 9007199254740991
Example:

1

content
string | null
required

Free-form text attached to the reminder.

Example:

"Follow up about the funding round"

dueDate
string<date-time>
required

When the reminder is next due.

Example:

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

creator
PersonReference · object
required

The person who created the reminder.

owner
PersonReference · object
required

The person responsible for acting on the reminder.

completer
PersonReference · object | null
required

The person who completed the reminder. null when the reminder is not completed. May be set on a recurring reminder even when completedAt is null.

company
CompanyReference · object | null
required

The tagged company. At most one of company, person, or opportunity is non-null on any given reminder.

person
PersonReference · object | null
required

The tagged person. At most one of company, person, or opportunity is non-null on any given reminder.

opportunity
OpportunityReference · object | null
required

The tagged opportunity. At most one of company, person, or opportunity is non-null on any given reminder.

createdAt
string<date-time>
required

When the reminder was created.

Example:

"2023-01-01T00:00:00Z"

updatedAt
string<date-time> | null
required

When the reminder was last updated. null if the reminder has never been updated.

Example:

"2023-01-01T00:00:00Z"

type
string
required

Discriminator. Always one-time for this variant.

Allowed value: "one-time"
Example:

"one-time"

status
enum<string>
required

Derived state. active if not completed and due in the future. overdue if not completed and due in the past. completed if completedAt is set.

Available options:
active,
overdue,
completed
Example:

"active"

completedAt
string<date-time> | null
required

When the reminder was completed. null if the reminder is not yet completed.

Example:

"2023-01-01T00:00:00Z"

recurrence
null
required

Always null for one-time reminders.