reminders.add

Creates a reminder.

Facts

Method URL: https://slack.com/api/reminders.add

Preferred HTTP method: POST

Accepted content types: application/x-www-form-urlencoded, application/json

Rate limiting: Tier 2

Works with:

Token type	Required scope(s)
workspace	`reminders:write:user`
user	`reminders:write`

This method creates a reminder.

Arguments

Argument	Example	Required	Description
`token`	`xxxx-xxxxxxxxx-xxxx`	Required	Authentication token bearing required scopes.
`text`	`eat a banana`	Required	The content of the reminder
`time`	`1602288000`	Required	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")
`user`	`U18888888`	Optional	The user who will receive the reminder. If no user is specified, the reminder will go to user who created it.

This method supports application/json via HTTP POST. Present your token in your request's Authorization header. Learn more.

Response

(Note: only non-recurring reminders will have time and complete_ts field.)

{
    "ok": true,
    "reminder": {
        "id": "Rm12345678",
        "creator": "U18888888",
        "user": "U18888888",
        "text": "eat a banana",
        "recurring": false,
        "time": 1602288000,
        "complete_ts": 0
    }
}

Errors

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_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`.
`user_not_found`	That user can't be found.
`cannot_add_bot`	Reminders can't be sent to bots.
`cannot_add_slackbot`	Reminders can't be sent to Slackbot.
`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.
`not_authed`	No authentication token provided.
`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.
`account_inactive`	Authentication token is for a deleted user or workspace.
`token_revoked`	Authentication token is for a deleted user or workspace or the app has been removed.
`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.
`user_is_bot`	This method cannot be called by a bot user.
`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 `_`. If you get this error, it is typically an indication that you have made a very malformed API call.
`invalid_array_arg`	The method was passed a PHP-style array argument (e.g. with a name like `foo[7]`). These are never valid with the Slack API.
`invalid_charset`	The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.
`invalid_form_data`	The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.
`invalid_post_type`	The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.
`missing_post_type`	The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.
`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.
`request_timeout`	The method was called via a `POST` request, but the `POST` data was either missing or truncated.
`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.

Warnings

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 `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.
`superfluous_charset`	The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous.