Skip to main content

@slack/web-api / RemindersAddArguments

Interface: RemindersAddArguments

Defined in: packages/web-api/src/types/request/reminders.ts:17

Extends​

  • TokenOverridable.OptionalTeamAssignable

Properties​

recurrence?​

optional recurrence?: ReminderRecurrence;

Defined in: packages/web-api/src/types/request/reminders.ts:37

Description​

Specify the repeating behavior of a reminder. If you set the sub-property frequency to weekly, you must also set the weekdays array to specify which days of the week to recur on.


team_id?​

optional team_id?: string;

Defined in: packages/web-api/src/types/request/common.ts:70

Description​

If using an org token, team_id is required.

Inherited from​

OptionalTeamAssignable.team_id

text​

text: string;

Defined in: packages/web-api/src/types/request/reminders.ts:19

Description​

The content of the reminder.


time​

time: string | number;

Defined in: packages/web-api/src/types/request/reminders.ts:26

Description​

When this reminder should happen, one of:

  • the Unix timestamp (up to five years from now),
  • the number of seconds until the reminder (if within 24 hours), or
  • a natural language description (Ex. "in 15 minutes," or "every Thursday").

token?​

optional token?: string;

Defined in: packages/web-api/src/types/request/common.ts:43

Description​

Overridable authentication token bearing required scopes.

Inherited from​

TokenOverridable.token

user?​

optional user?: string;

Defined in: packages/web-api/src/types/request/reminders.ts:32

Description​

No longer supported - reminders cannot be set for other users.

Deprecated​

See​

Changes to `reminders.*` APIs announcement.