Namespace: microsoft.graph
Postpone a reminder for an event in a user calendar until a new time.
This API is available in the following national cloud deployments.
Global service |
US Government L4 |
US Government L5 (DOD) |
China operated by 21Vianet |
✅ |
✅ |
✅ |
✅ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type |
Least privileged permissions |
Higher privileged permissions |
Delegated (work or school account) |
Calendars.ReadWrite |
Not available. |
Delegated (personal Microsoft account) |
Calendars.ReadWrite |
Not available. |
Application |
Calendars.ReadWrite |
Not available. |
HTTP request
POST /me/events/{id}/snoozeReminder
POST /users/{id | userPrincipalName}/events/{id}/snoozeReminder
POST /me/calendar/events/{id}/snoozeReminder
POST /users/{id | userPrincipalName}/calendar/events/{id}/snoozeReminder
POST /me/calendars/{id}/events/{id}/snoozeReminder
POST /users/{id | userPrincipalName}/calendars/{id}/events/{id}/snoozeReminder
POST /me/calendarGroups/{id}/calendars/{id}/events/{id}/snoozeReminder
POST /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}/events/{id}/snoozeReminder
Name |
Type |
Description |
Authorization |
string |
Bearer {token}. Required. Learn more about authentication and authorization. |
Content-Type |
string |
Nature of the data in the body of an entity. Required. |
Request body
In the request body, provide a JSON object with the following parameters.
Parameter |
Type |
Description |
newReminderTime |
DateTimeTimeZone |
The new date and time to trigger the reminder. |
Response
If successful, this method returns 200 OK
response code. It doesn't return anything in the response body.
Example
Here is an example of how to call this API.
Request
The following example shows a request.
POST https://graph.microsoft.com/v1.0/me/events/{id}/snoozeReminder
Content-type: application/json
{
"newReminderTime": {
"dateTime": "dateTime-value",
"timeZone": "timeZone-value"
}
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Me.Events.Item.SnoozeReminder;
using Microsoft.Graph.Models;
var requestBody = new SnoozeReminderPostRequestBody
{
NewReminderTime = new DateTimeTimeZone
{
DateTime = "dateTime-value",
TimeZone = "timeZone-value",
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Me.Events["{event-id}"].SnoozeReminder.PostAsync(requestBody);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
mgc users events snooze-reminder post --user-id {user-id} --event-id {event-id} --body '{\
"newReminderTime": {\
"dateTime": "dateTime-value",\
"timeZone": "timeZone-value"\
}\
}\
'
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphusers "github.com/microsoftgraph/msgraph-sdk-go/users"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
//other-imports
)
requestBody := graphusers.NewItemSnoozeReminderPostRequestBody()
newReminderTime := graphmodels.NewDateTimeTimeZone()
dateTime := "dateTime-value"
newReminderTime.SetDateTime(&dateTime)
timeZone := "timeZone-value"
newReminderTime.SetTimeZone(&timeZone)
requestBody.SetNewReminderTime(newReminderTime)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Me().Events().ByEventId("event-id").SnoozeReminder().Post(context.Background(), requestBody, nil)
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.users.item.events.item.snoozereminder.SnoozeReminderPostRequestBody snoozeReminderPostRequestBody = new com.microsoft.graph.users.item.events.item.snoozereminder.SnoozeReminderPostRequestBody();
DateTimeTimeZone newReminderTime = new DateTimeTimeZone();
newReminderTime.setDateTime("dateTime-value");
newReminderTime.setTimeZone("timeZone-value");
snoozeReminderPostRequestBody.setNewReminderTime(newReminderTime);
graphClient.me().events().byEventId("{event-id}").snoozeReminder().post(snoozeReminderPostRequestBody);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
const options = {
authProvider,
};
const client = Client.init(options);
const snoozeReminder = {
newReminderTime: {
dateTime: 'dateTime-value',
timeZone: 'timeZone-value'
}
};
await client.api('/me/events/{id}/snoozeReminder')
.post(snoozeReminder);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Users\Item\Events\Item\SnoozeReminder\SnoozeReminderPostRequestBody;
use Microsoft\Graph\Generated\Models\DateTimeTimeZone;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new SnoozeReminderPostRequestBody();
$newReminderTime = new DateTimeTimeZone();
$newReminderTime->setDateTime('dateTime-value');
$newReminderTime->setTimeZone('timeZone-value');
$requestBody->setNewReminderTime($newReminderTime);
$graphServiceClient->me()->events()->byEventId('event-id')->snoozeReminder()->post($requestBody)->wait();
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
Import-Module Microsoft.Graph.Calendar
$params = @{
newReminderTime = @{
dateTime = "dateTime-value"
timeZone = "timeZone-value"
}
}
# A UPN can also be used as -UserId.
Invoke-MgSnoozeUserEventReminder -UserId $userId -EventId $eventId -BodyParameter $params
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.users.item.events.item.snooze_reminder.snooze_reminder_post_request_body import SnoozeReminderPostRequestBody
from msgraph.generated.models.date_time_time_zone import DateTimeTimeZone
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = SnoozeReminderPostRequestBody(
new_reminder_time = DateTimeTimeZone(
date_time = "dateTime-value",
time_zone = "timeZone-value",
),
)
await graph_client.me.events.by_event_id('event-id').snooze_reminder.post(request_body)
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
Response
The following example shows the response.
HTTP/1.1 200 OK