Current section
Files
Jump to
Current section
Files
priv/docs/methods/reminders.add.json
{
"args": {
"recurrence": {
"desc": "Specify the repeating behavior of a reminder. Available options: `daily`, `weekly`, `monthly`, or `yearly`. If `weekly`, may further specify the days of the week.",
"example": "{ \"frequency\": \"weekly\", \"weekdays\": [\"monday\", \"wednesday\", \"friday\"] }",
"required": false,
"type": "object"
},
"team_id": {
"desc": "Encoded team id, required if org token is used",
"required": false,
"type": "string"
},
"text": {
"desc": "The content of the reminder",
"example": "eat a banana",
"required": true,
"type": "string"
},
"time": {
"desc": "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\")",
"example": "1602288000",
"required": true,
"type": "string"
},
"user": {
"desc": "No longer supported - reminders cannot be set for other users. Previously, was the user who would receive the reminder.",
"example": "U18888888",
"required": false,
"type": "string"
}
},
"desc": "Creates a reminder.",
"errors": {
"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`, or `next week`.",
"missing_argument": "An argument is missing.",
"user_not_found": "That user can't be found."
},
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"user": [
{
"name": "reminders:write",
"url": "https://docs.slack.dev/reference/scopes/reminders.write"
}
]
}
}