{"_id":"5845a4aa9f6fbb1b0043082d","user":"55bafe141b0d663700781682","parentDoc":null,"version":{"_id":"5845a4a89f6fbb1b004307b7","project":"54d3007669578e0d002730c9","__v":2,"createdAt":"2016-12-05T17:32:24.708Z","releaseDate":"2016-12-05T17:32:24.708Z","categories":["5845a4a89f6fbb1b004307b8","5845a4a89f6fbb1b004307b9","5845a4a89f6fbb1b004307ba","5845a4a89f6fbb1b004307bb","5845a4a89f6fbb1b004307bc","5845a4a89f6fbb1b004307bd","5845a4a89f6fbb1b004307be","5845a4a89f6fbb1b004307bf","5845a4a89f6fbb1b004307c0","592deb23644f060f008e5aa6"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"25.0.0","version":"25"},"category":{"_id":"5845a4a89f6fbb1b004307be","project":"54d3007669578e0d002730c9","__v":0,"version":"5845a4a89f6fbb1b004307b7","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-07-30T07:08:52.789Z","from_sync":false,"order":6,"slug":"domains","title":"Domains (Deprecated)"},"project":"54d3007669578e0d002730c9","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-05T15:29:32.023Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":true,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":19,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Domains are being deprecated\",\n  \"body\": \"Domains are being deprecated. If you're currently using domains, please consider using our new [Prebuilt Agents](https://docs.api.ai/docs/prebuilt-agents).\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"This domain is supported in the following languages:\\n* English\\n* Italian\"\n}\n[/block]\n* [Reminders: Add](#reminders-add)\n* [Reminders: Get](#reminders-get)\n* [Reminders: Remove](#reminders-remove)\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Reminders: Add\"\n}\n[/block]\n## Action\n\nName| Description  \n---|---  \nnotifications.add| Requests to add new notifications  \n  \n## Data\n\nName| Parent| Data type| Required / Optional| Description| Request examples  \n---|---|---|---|---|---  \nsummary| _data_| string| optional| Defines the summary.| Remind about running. (summary=running)  \nlocation| _data_| string| optional| Defines the location.| Remind me to call Tom when I get home. (location=home)  \nrecurrence| _data_| list| optional| Defines the recurrence. _Available values:_ _1_, _2_, _3_, _4_, _5_, _6_, _7_ Note: Monday is 1.| Remind about running every day. (recurrence=[1,2,3,4,5,6,7])  \ndate| _data_| string| optional| Defines the date.| Reminder for today. (date=[])  \ntime| _data_| string| optional| Defines the time.| Set reminder to 5 pm. (time=[]) \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Reminders: Get\"\n}\n[/block]\n## Action\n\nName| Description  \n---|---  \nnotifications.search| Requests to get the list of notifications  \n  \n## Data\n\nName| Parent| Data type| Required / Optional| Description| Request examples  \n---|---|---|---|---|---  \nsummary| _data_| string| optional| Defines the summary.| Do you plan to remind me about running? (summary=running)  \nlocation| _data_| string| optional| Defines the location.| Reminders scheduled for when I come home. (location=home)  \nrecurrence| _data_| list| optional| Defines the recurrence. _Available values:_ _1_, _2_, _3_, _4_, _5_, _6_, _7_ Note: Monday is 1.| Do I have reminders for every weekend? (recurrence=[6,7])  \nall| _data_| string| optional| Specifies that all events was requested. Available values: _true_ | Show all notifications. (all=true)  \ndate| _data_| string| optional| Defines the date.| Reminders scheduled for 10 October. (date=[])  \ntime| _data_| string| optional| Defines the time.| Are you supposed to remind me about something at 7 pm? (time=[])  \nsize| _data_| string| optional| Defines the number of notifications.| How many notifications do I have? (size=true) \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Reminders: Remove\"\n}\n[/block]\n## Action\n\nName| Description  \n---|---  \nnotifications.remove| Requests to remove notifications  \n  \n## Data\n\nName| Data type| Parent| Required / Optional| Description| Request examples  \n---|---|---|---|---|---  \nsummary| string| data| optional| Defines the summary.| Don't remind me about meeting with John (summary=meeting with John)  \nlocation| string| data| optional| Defines the location.| Remove reminders scheduled for when I come home. (location=home)  \nrecurrence| list| data| optional| Defines the recurrence. _Available values:_ _1_, _2_, _3_, _4_, _5_, _6_, _7_ Note: Monday is 1.| Remove my every Wednesday reminder. (recurrence=[3])  \nall| string| data| optional| Specifies that all events was requested. Available values: _true_ | Remove all my reminders. (all=true)  \ndate| string| data| optional| Defines the date.| Remove reminders set for tomorrow. (date=[])  \ntime| string| data| optional| Defines the time.| Cancel the 5 pm reminder. (time=[])","excerpt":"","slug":"reminders-and-notifications","type":"basic","title":"Reminders and Notifications"}

Reminders and Notifications


[block:callout] { "type": "warning", "title": "Domains are being deprecated", "body": "Domains are being deprecated. If you're currently using domains, please consider using our new [Prebuilt Agents](https://docs.api.ai/docs/prebuilt-agents)." } [/block] [block:callout] { "type": "info", "body": "This domain is supported in the following languages:\n* English\n* Italian" } [/block] * [Reminders: Add](#reminders-add) * [Reminders: Get](#reminders-get) * [Reminders: Remove](#reminders-remove) [block:api-header] { "type": "basic", "title": "Reminders: Add" } [/block] ## Action Name| Description ---|--- notifications.add| Requests to add new notifications ## Data Name| Parent| Data type| Required / Optional| Description| Request examples ---|---|---|---|---|--- summary| _data_| string| optional| Defines the summary.| Remind about running. (summary=running) location| _data_| string| optional| Defines the location.| Remind me to call Tom when I get home. (location=home) recurrence| _data_| list| optional| Defines the recurrence. _Available values:_ _1_, _2_, _3_, _4_, _5_, _6_, _7_ Note: Monday is 1.| Remind about running every day. (recurrence=[1,2,3,4,5,6,7]) date| _data_| string| optional| Defines the date.| Reminder for today. (date=[]) time| _data_| string| optional| Defines the time.| Set reminder to 5 pm. (time=[]) [block:api-header] { "type": "basic", "title": "Reminders: Get" } [/block] ## Action Name| Description ---|--- notifications.search| Requests to get the list of notifications ## Data Name| Parent| Data type| Required / Optional| Description| Request examples ---|---|---|---|---|--- summary| _data_| string| optional| Defines the summary.| Do you plan to remind me about running? (summary=running) location| _data_| string| optional| Defines the location.| Reminders scheduled for when I come home. (location=home) recurrence| _data_| list| optional| Defines the recurrence. _Available values:_ _1_, _2_, _3_, _4_, _5_, _6_, _7_ Note: Monday is 1.| Do I have reminders for every weekend? (recurrence=[6,7]) all| _data_| string| optional| Specifies that all events was requested. Available values: _true_ | Show all notifications. (all=true) date| _data_| string| optional| Defines the date.| Reminders scheduled for 10 October. (date=[]) time| _data_| string| optional| Defines the time.| Are you supposed to remind me about something at 7 pm? (time=[]) size| _data_| string| optional| Defines the number of notifications.| How many notifications do I have? (size=true) [block:api-header] { "type": "basic", "title": "Reminders: Remove" } [/block] ## Action Name| Description ---|--- notifications.remove| Requests to remove notifications ## Data Name| Data type| Parent| Required / Optional| Description| Request examples ---|---|---|---|---|--- summary| string| data| optional| Defines the summary.| Don't remind me about meeting with John (summary=meeting with John) location| string| data| optional| Defines the location.| Remove reminders scheduled for when I come home. (location=home) recurrence| list| data| optional| Defines the recurrence. _Available values:_ _1_, _2_, _3_, _4_, _5_, _6_, _7_ Note: Monday is 1.| Remove my every Wednesday reminder. (recurrence=[3]) all| string| data| optional| Specifies that all events was requested. Available values: _true_ | Remove all my reminders. (all=true) date| string| data| optional| Defines the date.| Remove reminders set for tomorrow. (date=[]) time| string| data| optional| Defines the time.| Cancel the 5 pm reminder. (time=[])