---
title: "POST /reminder"
method: POST
path: "/reminder"
tags: ["reminder"]
---

# POST /reminder

`POST /reminder`

## Request

- Base URL: `https://www.weclapp.com/api/nullapi/v2`
- URL: `https://www.weclapp.com/api/nullapi/v2/reminder`
- Auth: API key in header `AuthenticationToken`
- TypeScript: <https://skmtc.dev/weclapp/apis/weclapp-api/docs/reminder/post.ts> (a function with typed inputs; its response is checked against the schema)

create a reminder

## Query parameters

- `dryRun` boolean

## Request body

- Reminder
  - `id` string
  - `version` string
  - `additionalRecipients` OnlyId[]
    - `id` string
  - `ccMail` string
  - `createdDate` integer
  - `entityId` string
  - `entityName` string
  - `lastModifiedDate` integer
  - `lastReminderSentDate` integer
  - `message` string
  - `recurringEvent` ReminderRecurringEvent
    - `endsOnDate` integer
    - `eventInterval` integer
    - `eventOccurrenceCount` integer
    - `eventType` 'DAILY' | 'MONTHLY' | 'WEEKLY' | 'YEARLY'
    - `repeatOn` string
  - `reminderDate` integer
  - `sendType` 'MAIL' | 'NOTIFICATION', required
  - `subject` string, required
  - `userId` string

## Response `201`

reminder create response

- Reminder
  - `id` string
  - `version` string
  - `additionalRecipients` OnlyId[]
    - `id` string
  - `ccMail` string
  - `createdDate` integer
  - `entityId` string
  - `entityName` string
  - `lastModifiedDate` integer
  - `lastReminderSentDate` integer
  - `message` string
  - `recurringEvent` ReminderRecurringEvent
    - `endsOnDate` integer
    - `eventInterval` integer
    - `eventOccurrenceCount` integer
    - `eventType` 'DAILY' | 'MONTHLY' | 'WEEKLY' | 'YEARLY'
    - `repeatOn` string
  - `reminderDate` integer
  - `sendType` 'MAIL' | 'NOTIFICATION', required
  - `subject` string, required
  - `userId` string

## Other responses

- `default`: error response

## Changes

- **2026-11-07** `0e021229755d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/weclapp/apis/weclapp-api/changes/reminder/post.md)

---

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