Creates a reminder.
POSThttps://slack.com/api/reminders.add
application/x-www-form-urlencoded
application/json
token
Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.
xxxx-xxxxxxxxx-xxxx
Specify the repeating behavior of a reminder. Available options: daily
, weekly
, monthly
, or yearly
. If weekly
, may further specify the days of the week.
{ "frequency": "weekly", "weekdays": ["monday", "wednesday", "friday"] }
Retirement of API methods for interfacing with reminders began March 2023, and as such have become degraded or useless. Setting reminders for other users with reminders.add
can now only be done with a bot token. As an alternative, you can use workflow automations to add reminders via scheduled triggers.
See this changelog for more information.
This method creates a reminder.
Only non-recurring reminders will have time
and complete_ts
fields.
{
"ok": true,
"reminder": {
"id": "Rm12345678",
"creator": "U123ABC456",
"user": "U123ABC456",
"text": "eat a banana",
"recurring": false,
"time": 1602288000,
"complete_ts": 0
}
}
Typical error response
{
"ok": false,
"error": "invalid_auth"
}
This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok
params in the response.
Error | Description |
---|---|
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: |
missing_argument | An argument is missing. |
user_not_found | That user can't be found. |
access_denied | Access to a resource specified in the request is denied. |
account_inactive | Authentication token is for a deleted user or workspace when using a |
deprecated_endpoint | The endpoint has been deprecated. |
ekm_access_denied | Administrators have suspended the ability to post a message. |
enterprise_is_restricted | The method cannot be called from an Enterprise. |
invalid_auth | Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request. |
is_bot | This method cannot be called by a legacy bot. |
method_deprecated | The method has been deprecated. |
missing_scope | The token used is not granted the specific scope permissions required to complete this request. |
not_allowed_token_type | The token type used in this request is not allowed. |
not_authed | No authentication token provided. |
no_permission | The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to. |
org_login_required | The workspace is undergoing an enterprise migration and will not be available until migration is complete. |
token_expired | Authentication token has expired |
token_revoked | Authentication token is for a deleted user or workspace or the app has been removed when using a |
two_factor_setup_required | Two factor setup is required. |
team_access_not_granted | The token used is not granted the specific workspace access required to complete this request. |
accesslimited | Access to this method is limited on the current network |
fatal_error | The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised. |
internal_error | The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised. |
invalid_arg_name | The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than |
invalid_arguments | The method was either called with invalid arguments or some detail about the arguments passed is invalid, which is more likely when using complex arguments like blocks or attachments. |
invalid_array_arg | The method was passed an array as an argument. Please only input valid strings. |
invalid_charset | The method was called via a |
invalid_form_data | The method was called via a |
invalid_post_type | The method was called via a |
missing_post_type | The method was called via a |
ratelimited | The request has been ratelimited. Refer to the |
request_timeout | The method was called via a |
service_unavailable | The service is temporarily unavailable |
team_added_to_org | The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete. |
This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.
Warning | Description |
---|---|
missing_charset | The method was called via a |
superfluous_charset | The method was called via a |