POST api/reminder/remindme

Sets a reminder Processes this reminder API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The set reminder command data contract supplied with the request.

SetReminderCommandDataContract

Name	Description	Type	Additional information
Title	The title value.	string	None.
Date	The date, expressed as a date and time.	date	None.
Type	The type value.	EnumDataContract	None.
Priority	The priority value.	EnumDataContract	None.
SnoozeCount	The snooze count value.	integer	None.
Data	The collection of data.	Dictionary of string [key] and Object [value]	None.
ReferenceDate	The reference date, expressed as a date and time.	date	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "Title": "sample string 1",
  "Date": "2026-08-05T00:20:39.5435069Z",
  "Type": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Priority": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "SnoozeCount": 3,
  "Data": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "ReferenceDate": "2026-08-05T00:20:39.5435069Z"
}

Response Information

Resource Description

The response returned after the operation completes.

JobInvocationDetailsDataContract

Name	Description	Type	Additional information
SupportsCancellation	Indicates whether supports cancellation is true.	boolean	None.
ReportsProgress	Indicates whether reports progress is true.	boolean	None.
InitialStatusText	The initial status text value.	string	None.
JobReference	The job reference globally unique identifier.	globally unique identifier	None.
Success	Indicates whether success is true.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "SupportsCancellation": true,
  "ReportsProgress": true,
  "InitialStatusText": "sample string 3",
  "JobReference": "e3ff96c0-32d0-49fa-92aa-870111887834",
  "Success": true
}