Slack Web API

/reminders.add

POST

/reminders.add

reminders

Creates a reminder.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://slack.com/api/reminders.add' \
--header 'token;' \
--data-urlencode 'text=' \
--data-urlencode 'time='

Response Example

200 - response

{
    "ok": true
}

Request

Header Params

token

string

required

Authentication token. Requires scope: reminders:write

Body Params application/x-www-form-urlencoded

text

string

required

The content of the reminder

time

string

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

string

optional

The user who will receive the reminder. If no user is specified, the reminder will go to user who created it.

Responses

🟢200Typical success response

application/json

Body

Schema for successful response from reminders.add method

enum<boolean>

required

Allowed value:

true

reminder

object (objs_reminder)

required

complete_ts

integer

optional

creator

string

required

Match pattern:

^[UW][A-Z0-9]{2,}$

string

required

Match pattern:

^Rm[A-Z0-9]{8,}$

recurring

boolean

required

text

string

required

time

integer

optional

user

string

required

Match pattern:

^[UW][A-Z0-9]{2,}$

🔴500Typical error response

/reactions.remove

/reminders.complete