---
title: "Create a reminder"
method: POST
path: "/reminders"
tags: ["Reminders"]
---

# Create a reminder

`POST /reminders`

## Request

- Base URL: `https://api.surense.com/api/v1`
- URL: `https://api.surense.com/api/v1/reminders`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.surense.com/oauth/token` scopes: `global:user`

Create a new reminder.

## Request body

- CreateReminderRequest: Request to create a reminder
  - `description` string, required: Reminder description
  - `notes` string: Reminder additional notes
  - `dueDate` string, required: Due date and time
  - `dueDateTimeSet` boolean, required: Whether the due date time is set
  - `delegatedId` string: Delegated user ID
  - `notifyMode` 'Disabled' | 'OnDueDate' | 'TenMinutesBefore' | 'OneHourBefore': Notification mode:<br/>Disabled - No notification<br/>OnDueDate - Notify on due date<br/>TenMinutesBefore - Notify 10 minutes before<br/>OneHourBefore - Notify 1 hour before
  - `customerId` string: Customer ID

## Response `200`

OK

- ReminderValue
  - `tenantId` string, uuid
  - `createdDate` string, date-time
  - `createdBy` string, uuid
  - `creatorName` string
  - `lastModifiedDate` string, date-time
  - `lastModifiedBy` string, uuid
  - `version` integer
  - `id` string, uuid
  - `description` string
  - `notes` string
  - `dueAt` string, date-time
  - `dueAtTimeSet` boolean
  - `delegatedId` string, uuid
  - `notifyMode` 'Disabled' | 'OnDueDate' | 'TenMinutesBefore' | 'OneHourBefore'
  - `done` boolean
  - `customerId` string, uuid

---

[API](https://skmtc.dev/surense/apis/reminder-api.md) - [All operations](https://skmtc.dev/surense/apis/reminder-api/llms.txt) - [OpenAPI document](https://skmtc.dev/surense/apis/reminder-api/revisions/a60f93d9dadf?raw)