Slack. Web. Reminders
(SlackKit v1.0.0-alpha.0)
View Source
Summary
Functions
Creates a reminder.
Marks a reminder as complete.
Deletes a reminder.
Gets information about a reminder.
Lists all reminders created by or for a given user.
Functions
Creates a reminder.
API reference
Rate limit: Tier 2: 20+ per minute
Scopes:
- User token:
reminders:write
Required Params
text- The content of the reminder ex:eat a bananatime- Can also take a type of integer. When this reminder should happen: 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") ex:1602288000
Optional Params
recurrence- Specify the repeating behavior of a reminder. Available options:daily,weekly,monthly, oryearly. Ifweekly, may further specify the days of the week. ex:{ "frequency": "weekly", "weekdays": ["monday", "wednesday", "friday"] }team_id- Encoded team id, required if org token is useduser- No longer supported - reminders cannot be set for other users. Previously, was the user who would receive the reminder. ex:U18888888
Errors the API can return:
cannot_add_bot- Reminders can't be sent to bots.cannot_add_others- Guests can't set reminders for other team members.cannot_add_others_recurring- Recurring reminders can't be set for other team members.cannot_add_profile_only_user- Reminders can't be sent to profile only users.cannot_add_slackbot- Reminders can't be sent to Slackbot.cannot_parse- The phrasing of the timing for this reminder is unclear. You must include a complete time description. Some examples that work:1458678068,20,in 5 minutes,tomorrow,at 3:30pm,on Tuesday, ornext week.missing_argument- An argument is missing.user_not_found- That user can't be found.
See the Common Errors guide for errors returned by every Web API method.
Marks a reminder as complete.
API reference
Rate limit: Tier 2: 20+ per minute
Scopes:
- User token:
reminders:write
Required Params
reminder- The ID of the reminder to be marked as complete ex:Rm12345678
Optional Params
team_id- Encoded team id, required if org token is used
Errors the API can return:
cannot_complete_others- Reminders for other team members can't be marked complete.cannot_complete_recurring- Recurring reminders can't be marked complete.missing_argument- An argument is missing.not_found- That reminder can't be found.
See the Common Errors guide for errors returned by every Web API method.
Deletes a reminder.
API reference
Rate limit: Tier 2: 20+ per minute
Scopes:
- User token:
reminders:write
Required Params
reminder- The ID of the reminder ex:Rm12345678
Optional Params
team_id- Encoded team id, required if org token is used
Errors the API can return:
missing_argument- An argument is missing.not_found- That reminder can't be found.
See the Common Errors guide for errors returned by every Web API method.
Gets information about a reminder.
API reference
Rate limit: Tier 2: 20+ per minute
Scopes:
- User token:
reminders:read
Required Params
reminder- The ID of the reminder ex:Rm23456789
Optional Params
team_id- Encoded team id, required if org token is passed
Errors the API can return:
missing_argument- An argument is missing.not_found- That reminder can't be found.
See the Common Errors guide for errors returned by every Web API method.
Lists all reminders created by or for a given user.
API reference
Rate limit: Tier 2: 20+ per minute
Scopes:
- User token:
reminders:read
Optional Params
team_id- Encoded team id, required if org token is passed
Errors the API can return:
missing_argument- An argument is missing.
See the Common Errors guide for errors returned by every Web API method.