Referência da API REST de Calendário do Outlook (versão 1.0)

Artigo
06/30/2018

Observação

A versão 1.0 da API REST do Outlook está sendo preterida. A partir de 1º de novembro de 2018, os aplicativos não poderão mais usar a Autenticação Básica com o ponto de extremidade REST v1.0. Em 1º de novembro de 2019, o ponto de extremidade REST da v1.0 será totalmente desativado e a documentação da v1.0 será removida logo em seguida. Comece a fazer a migração do seu aplicativo para usar a API REST do Outlook na v1.0 do Microsoft Graph. Veja mais detalhes em nosso anúncio.

A API de Calendário fornece acesso a dados de eventos, calendários e grupos de calendários protegidos pelo Active Directory do Azure no Office 365 e a dados semelhantes nas contas da Microsoft especificamente nestes domínios: Hotmail.com, Live.com, MSN.com, Outlook.com e Passport.com.

Observação

A exceção é a API para encontrar horários de reunião, que se aplica somente a caixas de correio do Office 365 (no Azure AD) e não a contas da Microsoft.
Para simplificar a referência, o restante deste artigo usa o Outlook.com para incluir esses domínios de conta da Microsoft.

Não tem interesse na v1.0 da API? No sumário à esquerda, vá para a seção Referência da API REST do Office 365 e selecione a versão que deseja.

Todas as operações da API de Calendário

Operações de evento

Um evento representa um compromisso ou reunião no calendário do usuário. Um evento pode ser um mestre de série (para eventos recorrentes), uma ocorrência, uma única instância ou uma exceção.

Obter eventos
Sincronizar eventos
Criar eventos
Atualizar eventos
Responder a eventos
Excluir eventos
Obter anexos
Criar anexos
Excluir anexos
Receber lembretes
Adiar lembretes
Ignorar lembretes

Operações de calendário

Um calendário funciona como um contêiner para eventos. Um usuário pode ter vários calendários. No Office 365, cada calendário pode ser atribuído a um grupo de calendários.

Obter calendários
Criar calendários
Atualizar calendários
Excluir calendários

Operações de grupo de calendários

Grupos de calendários são uma maneira de organizar vários calendários. Os usuários podem adicionar vários calendários em um único grupo de calendários no Outlook ou no Outlook Web App. Isso facilita a exibição rápida de todos os calendários no grupo.

Observação

O Outlook.com tem suporte apenas para o grupo de calendários padrão que é acessível pelo atalho ../me/calendars. Você não pode excluir esse grupo de calendários ou criar outro grupo de calendários.

Obter grupos de calendários
Criar grupos de calendários
Atualizar grupos de calendários
Excluir grupos de calendários

Ver também

Uso da API REST de Calendário

Autenticação

Como outra API REST do Outlook, para cada solicitação à API de Calendário, você deve incluir um token de acesso válido. A obtenção de um token de acesso exige que você se registre e identifique seu aplicativo, e obtenha a autorização adequada.

Você pode saber mais sobre algumas opções simplificadas de registro e autorização. Tenha isso em mente ao prosseguir com as operações específicas na API de Calendário.

Escopos para acessar calendários compartilhados

Os calendários do Office 365 e do Outlook.com são compatíveis com o compartilhamento. Um usuário que criou um calendário pode compartilhar o calendário com outros usuários. Os seguintes escopos são necessários para acessar um calendário compartilhado com esse usuário:

Para acesso de leitura: https://outlook.office.com/calendars.read.shared
Para acesso de leitura/gravação: https://outlook.office.com/calendars.readwrite.shared

Versão da API

A API REST de Calendário é suportada em todas as versões da API REST do Outlook. A funcionalidade pode variar dependendo da versão específica.

Usuário de destino

As solicitações da API de Calendário são sempre realizadas em nome do usuário atual.

Veja Usar a API REST do Outlook para obter mais informações comuns a todos os subconjuntos da API REST do Outlook.

Obter eventos

Obtenha uma coleção de eventos ou um evento.

Um corpo de evento pode estar em texto ou HTML. No momento, a operação GET retorna corpos de eventos somente no formato HTML.

Obter uma visão de calendário
Obter eventos mestre de série e únicos
Obter instâncias de evento)
Obter um evento

Obter uma visão de calendário

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obtenha as ocorrências, exceções e instâncias únicas de eventos em uma visão de calendário definida por um intervalo de tempo, a partir do calendário principal do usuário (../me/calendarview) ou de um calendário diferente.

GET https://outlook.office.com/api/v1.0/me/calendarview?start={start_datetime}&end={end_datetime}
GET https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
calendar_id	sequência de caracteres	ID do calendário, se você obtiver uma visão de um calendário específico.
start_datetime	datetimeoffset	A data e o horário em que o evento inicia.
end_datetime	datetimeoffset	A data e o horário em que o evento termina.

Observação

Por padrão, cada evento na resposta inclui todas as suas propriedades. Use $select para especificar somente as propriedades necessárias para um melhor desempenho. A propriedade Id é sempre retornada. Confira Parâmetros de consulta do OData para ver parâmetros de filtragem, classificação e paginação.

Por exemplo, obtenha a visão de calendário para o mês de outubro, retornando apenas a propriedade Subject para cada evento:

GET https://outlook.office.com/api/v1.0/me/calendarview?startDateTime=2014-10-01T01:00:00Z&endDateTime=2014-10-31T23:00:00Z&$select=Subject

Tipo de resposta

Os eventos expandidos no intervalo de tempo especificado.

Obter eventos mestre de série e únicos

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obter uma coleção de eventos mestre de série e de instância única do calendário principal do usuário (../me/events) ou de um calendário diferente. Para obter instâncias de evento expandidas, você pode obter a visão de calendário ou obter as instâncias de um evento.

GET https://outlook.office.com/api/v1.0/me/events
GET https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}/events

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
calendar_id	sequência de caracteres	ID do calendário, se você estiver obtendo eventos de um calendário específico.

Observação

Cada evento na resposta inclui todas as suas propriedades. Use $select para especificar somente as propriedades necessárias para um melhor desempenho. A propriedade Id é sempre retornada. Veja o próximo exemplo. Confira Parâmetros de consulta do OData para ver parâmetros de filtragem, classificação e paginação.

O exemplo a seguir mostra como usar $select para especificar retornando apenas as propriedades Subject, Organizer, Start e End de cada evento na resposta. Veja a primeira resposta de amostra em Obter um evento (REST) para obter uma lista completa das propriedades que serão retornadas para um evento se você não usar $select.

Solicitação de amostra

GET https://outlook.office.com/api/v1.0/me/events?$select=Subject,Organizer,Start,End

Resposta de amostra

Código de status: 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events(Subject,Organizer,Start,End)",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAA/LpDWw==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAD8tEyDAAA=",
            "Subject": "Scrum",
            "Start": "2015-11-02T17:00:00Z",
            "End": "2015-11-02T17:30:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "user0TestUser",
                    "Address": "user0@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAA/LpDWg==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAD8tEyCAAA=",
            "Subject": "team lunch",
            "Start": "2015-11-02T00:00:00Z",
            "End": "2015-11-03T00:00:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "user0TestUser",
                    "Address": "user0@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x49w==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG93AAA=",
            "Subject": "Weekly Meeting on Contoso Project",
            "Start": "2014-10-13T21:00:00Z",
            "End": "2014-10-13T22:00:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x49g==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG92AAA=",
            "Subject": "Daily Team Meeting",
            "Start": "2014-10-13T18:00:00Z",
            "End": "2014-10-13T18:30:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x47Q==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG91AAA=",
            "Subject": "Rob:Alex 1:1",
            "Start": "2014-10-15T16:30:00Z",
            "End": "2014-10-15T17:30:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x46g==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG90AAA=",
            "Subject": "Thanksgiving Holiday",
            "Start": "2015-11-26T00:00:00Z",
            "End": "2015-11-27T00:00:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x46Q==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9zAAA=",
            "Subject": "Thanksgiving Holiday",
            "Start": "2014-11-27T00:00:00Z",
            "End": "2014-11-28T00:00:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x49Q==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAA=",
            "Subject": "New Year's Day Holiday",
            "Start": "2015-01-01T00:00:00Z",
            "End": "2015-01-02T00:00:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x45w==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9xAAA=",
            "Subject": "Christmas Holiday",
            "Start": "2014-12-25T00:00:00Z",
            "End": "2014-12-26T00:00:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        }
    ]
}

Obter instâncias de evento

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Você pode obter as instâncias (ocorrências) de um evento para um intervalo de tempo especificado. Se o evento for do tipo SeriesMaster, isso retornará as ocorrências e exceções do evento no intervalo de tempo especificado.

GET https://outlook.office.com/api/v1.0/me/events/{event_id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
event_id	sequência de caracteres	ID do evento.
start_datetime	datetimeoffset	A data e o horário em que o evento inicia.
end_datetime	datetimeoffset	A data e o horário em que o evento termina.

Tipo de resposta

A coleção de eventos solicitada.

Observação

Por exemplo, obtenha as instâncias de um evento específico para o mês de outubro e inclua apenas as propriedades Subject, Start e End de cada instância:

GET https://outlook.office.com/api/v1.0/me/events/AAMkAGE0MGM1Y2M5LWEAAA=/instances?startDateTime=2014-10-01T01:00:00Z&endDateTime=2014-10-31T23:00:00Z&$select=Subject,Start,End

Obter um evento

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obtenha um evento por ID.

GET https://outlook.office.com/api/v1.0/me/events/{event_id}

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
event_id	sequência de caracteres	ID do evento.

Solicitação de amostra

GET https://outlook.office.com/api/v1.0/me/events/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG93AAA=

Resposta de amostra

Código de status: 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events/$entity",
    "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
    "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x49w==\"",
    "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG93AAA=",
    "DateTimeCreated": "2014-10-19T23:13:47.3959685Z",
    "DateTimeLastModified": "2014-10-23T20:23:47.0735997Z",
    "ChangeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x49w==",
    "Categories": [],
    "StartTimeZone": "Pacific Standard Time",
    "EndTimeZone": "Pacific Standard Time",
    "ResponseStatus": {
        "Response": "Organizer",
        "Time": "0001-01-01T00:00:00Z"
    },
    "iCalUId": "040000008200E00074C5B7101A82E0080000000005F3F755F2EBCF010000000000000000100000007547017C91509D42A5B60C97141AA3DD",
    "Reminder": 15,
    "HasAttachments": false,
    "Subject": "Weekly Meeting on Contoso Project",
    "Body": {
        "ContentType": "HTML",
        "Content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n</head>\r\n<body>\r\nSetting up some time to review the budget and planning on the Contoso Project\r\n</body>\r\n</html>\r\n"
    },
    "BodyPreview": "Setting up some time to review the budget and planning on the Contoso Project",
    "Importance": "Normal",
    "Sensitivity": "Normal",
    "Start": "2014-10-13T21:00:00Z",
    "End": "2014-10-13T22:00:00Z",
    "Location": {
        "DisplayName": "Alex's Office"
    },
    "IsAllDay": false,
    "IsCancelled": false,
    "IsOrganizer": true,
    "Recurrence": {
        "Pattern": {
            "Type": "Weekly",
            "Interval": 1,
            "Month": 0,
            "DayOfMonth": 0,
            "DaysOfWeek": [
                "Monday"
            ],
            "FirstDayOfWeek": "Sunday",
            "Index": "First"
        },
        "Range": {
            "Type": "NoEnd",
            "StartDate": "2014-10-13T00:00:00-07:00",
            "EndDate": "0001-01-01T00:00:00Z",
            "NumberOfOccurrences": 0
        }
    },
    "ResponseRequested": true,
    "SeriesMasterId": null,
    "ShowAs": "Busy",
    "Type": "SeriesMaster",
    "Attendees": [
        {
            "Status": {
                "Response": "None",
                "Time": "0001-01-01T00:00:00Z"
            },
            "Type": "Required",
            "EmailAddress": {
                "Name": "Janet Schorr",
                "Address": "janets@a830edad9050849NDA1.onmicrosoft.com"
            }
        },
        {
            "Status": {
                "Response": "None",
                "Time": "0001-01-01T00:00:00Z"
            },
            "Type": "Required",
            "EmailAddress": {
                "Name": "Pavel Bansky",
                "Address": "pavelb@a830edad9050849NDA1.onmicrosoft.com"
            }
        }
    ],
    "Organizer": {
        "EmailAddress": {
            "Name": "Alex D",
            "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
        }
    }

Tipo de resposta

O evento solicitado.

Observação

Por padrão, a resposta inclui todas as propriedades do evento. Use $select para especificar somente as propriedades necessárias para um melhor desempenho. A propriedade Id é sempre retornada. Confira Parâmetros de consulta do OData para ver parâmetros de filtragem, classificação e paginação.

O exemplo a seguir mostra como usar $select para especificar retornando apenas as propriedades Subject, Organizer, Start e End do evento.

Solicitação de amostra

GET https://outlook.office.com/api/v1.0/me/events/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG93AAA=?$select=Subject,Organizer,Start,End

Resposta de amostra

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events(Subject,Organizer,Start,End)/$entity",
    "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
    "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x49w==\"",
    "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG93AAA=",
    "Subject": "Weekly Meeting on Contoso Project",
    "Start": "2014-10-13T21:00:00Z",
    "End": "2014-10-13T22:00:00Z",
    "Organizer": {
        "EmailAddress": {
            "Name": "Alex D",
            "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
        }
    }
}

Sincronizar eventos

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Sincronize e obtenha eventos novos, atualizados ou excluídos em um intervalo de tempo especificado a partir do calendário principal do usuário (../me/calendarview) ou de um calendário diferente. Esse conjunto de eventos em um intervalo de tempo também é conhecido como visão de calendário. Os eventos retornados podem incluir ocorrências e exceções de uma série recorrente e instâncias únicas.

A sincronização de uma visão de calendário normalmente requer uma série de duas ou mais solicitações de sincronização, cada qual definida como uma chamada GET. Para sincronizar uma visão de calendário, use o método GET da mesma forma que você obtém uma visão de calendário, com a diferença que você deve incluir determinados cabeçalhos de solicitação e deltaToken ou um skipToken quando for apropriado.

Cabeçalhos de solicitação

Você deve especificar o cabeçalho "Prefer: odata.track-changes" em todas as solicitações de sincronização, exceto naquelas que incluem um skipToken que é retornado de uma solicitação de sincronização anterior. Na primeira resposta, procure o cabeçalho Preference-Applied: odata.track-changes para confirmar que o recurso suporta a sincronização antes de continuar. (Mais informações sobre um skipToken nos dados de exemplo de segunda resposta abaixo.)
Você pode especificar o cabeçalho "Prefer: odata.maxpagesize={x}" para indicar o número máximo de eventos que a solicitação de sincronização retorna.

Veja uma típica série de sincronização de eventos em uma visão de calendário:

Faça a solicitação GET inicial com o cabeçalho obrigatório Prefer: odata.track-changes. A resposta inicial a uma solicitação de sincronização sempre retorna um deltaToken. (A segunda solicitação GET e as solicitações seguintes diferem da primeira solicitação GET, incluindo um deltaToken ou um skipToken recebido em uma resposta anterior.)
Se a primeira resposta retornar o cabeçalho Preference-Applied: odata.track-changes, você poderá prosseguir com a sincronização.
- Faça uma segunda solicitação GET. Especifique o cabeçalho Prefer: odata.track-changes e o deltaToken retornado do primeiro GET para determinar se há algum evento adicional. A segunda solicitação retornará eventos adicionais e um skipToken se houver mais eventos disponíveis, ou um deltaToken se o último evento tiver sido sincronizado. Nesse caso, você pode parar.
- Continue a sincronização enviando uma chamada GET e incluindo um skipToken retornado da chamada anterior. Pare quando você obtiver uma resposta final que contenha o cabeçalho @odata.deltaLink com um deltaToken novamente, indicando que a sincronização está concluída.

Veja a sintaxe das chamadas iniciais e seguintes em uma série de sincronização.

Sincronizar no calendário padrão

Solicitação inicial:

GET https://outlook.office.com/api/v1.0/{user_context}/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}

Segunda ou primeira solicitação de uma série seguinte:

GET https://outlook.office.com/api/v1.0/{user_context}/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}&$deltatoken={delta_token}

Terceira ou seguinte solicitação na mesma série:

GET https://outlook.office.com/api/v1.0/{user_context}/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}&$skiptoken={skip_token}

Sincronizar em um calendário específico

Solicitação inicial:

GET https://outlook.office.com/api/v1.0/{user_context}/calendars('{calendar_id}')/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}

Segunda ou primeira solicitação de uma série seguinte:

GET https://outlook.office.com/api/v1.0/{user_context}/calendars('{calendar_id}')/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}&$deltatoken={delta_token}

Terceira ou seguinte solicitação na mesma série:

GET https://outlook.office.com/api/v1.0/{user_context}/calendars('{calendar_id}')/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}&$skiptoken={skip_token}

Parâmetros

Parâmetro	Tipo	Descrição
Parâmetros de URL
user_context	sequência de caracteres	O contexto do usuário. Você pode usar o valor 'me' para indicar o contexto do usuário atual. Você também pode usar o formato users/{upn}, no qual upn é o nome principal do usuário. Geralmente, é o endereço de email do usuário.
calendar_id	sequência de caracteres	ID do calendário, se você obtiver uma visão de um calendário específico.
start_datetime	datetimeoffset	A data e o horário em que o evento inicia.
end_datetime	datetimeoffset	A data e o horário em que o evento termina.
delta_token	sequência de caracteres	A sequência de caracteres `deltaToken` retornada como parte do valor de @odata.deltaLink na resposta de sincronização anterior.
skip_token	sequência de caracteres	A sequência de caracteres `skipToken` retornada como parte do valor de @odata.nextLink na resposta de sincronização anterior.

Observação

Ao especificar "Prefer: odata.track-changes" na solicitação inicial, se a resposta suportar a sincronização, a resposta incluirá "Preference-applied: odata.track-changes" no cabeçalho.
Se você tentar sincronizar um recurso que não é suportado ou se essa não for a solicitação de sincronização inicial, você não verá o cabeçalho "Preference-applied" na resposta.
Você pode alterar a janela de tempo de mudança alterando os parâmetros de consulta startdatetime e enddatetime.
Cada evento na resposta inclui todas as suas propriedades.
Para uma série recorrente, uma resposta de sincronização inclui todo o evento para os eventos mestre e de exceção recorrentes.
As instâncias de uma série recorrente são abreviadas e contêm apenas as propriedades Start e End. Você pode capturar o restante das informações do evento de ocorrência do evento mestre recorrente. Veja Recurso de evento para obter informações de referência.
Não é possível usar os parâmetros de consulta $filter, $count, $select, $skip, $top, e $search.

Tipo de resposta

Os eventos expandidos e eventos abreviados no intervalo de tempo especificado.

Exemplo

O exemplo a seguir mostra as solicitações de sincronização iniciais e secundárias para sincronizar o calendário padrão do usuário. Cada solicitação especifica o retorno de apenas um evento completo de cada vez:

A resposta inicial retorna um evento, um deltaLink e deltaToken.
A segunda solicitação usa deltatoken. A segunda resposta retorna um evento, um nextLink e skipToken.

Para concluir a sincronização, use o skipToken retornado da solicitação de sincronização anterior até que a resposta de sincronização retorne um deltaLink e deltaToken. Nesse caso, esta série de sincronização está concluída. Salve o deltaToken para a próxima série de sincronização.

Para mais informações, veja Sincronizar eventos em uma visão de calendário do Outlook.

Solicitação inicial de exemplo

    GET https://outlook.office.com/api/v1.0/me/calendarview?startdatetime=2015-01-01T00:00:00Z&enddatetime=2015-04-10T00:00:00Z HTTP/1.1
    Authorization: Bearer <token>
    Prefer: odata.track-changes
    Prefer: odata.maxpagesize=1

Amostra de dados da resposta inicial

Preference-Applied: odata.track-changes

    {
        "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/CalendarView",
        "value": [
            {
                "@odata.id": "https://outlook.office.com/api/v1.0/Users('user0@contoso.com')/Events('asdas==')",
                "@odata.etag": "W/\"L8Z+4Y4u7k+97uRKg==\"",
                "Id": "AQMkANJAAAAA==",
                "ChangeKey": "L8Z+AAAAARKg==",
                "Categories": [
                ],
                "DateTimeCreated": "2015-04-10T17:54:49.2725912Z",
                "DateTimeLastModified": "2015-04-10T17:54:49.3038538Z",
                "Subject": "Discuss the Calendar REST API",
                "BodyPreview": "I think it will meet our requirements!",
                "Body": {
                    "ContentType": "HTML",
                    "Content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n</head>\r\n<body>\r\nI think it will meet our requirements!\r\n</body>\r\n</html>\r\n"
                },
                "Importance": "Normal",
                "HasAttachments": false,
                "Start": "2015-04-05T18:00:00Z",
                "StartTimeZone": "Pacific Standard Time",
                "End": "2015-04-05T19:00:00Z",
                "EndTimeZone": "Pacific Standard Time",
                "Reminder": 15,
                "Location": {
                    "DisplayName": "",
                    "Address": null
                },
                "ResponseStatus": {
                    "Response": "Organizer",
                    "Time": "0001-01-01T00:00:00Z"
                },
                "ShowAs": "Busy",
                "IsAllDay": false,
                "IsCancelled": false,
                "IsOrganizer": true,
                "ResponseRequested": true,
                "Type": "SingleInstance",
                "SeriesMasterId": null,
                "Attendees": [
                ],
                "Recurrence": null,
                "Organizer": {
                    "EmailAddress": {
                        "Address": "user0@contoso.com",
                        "Name": "user0"
                    }
                },
                "iCalUId": "040000008200E9888E07599CCFA23",
                "WebLink": "https://outlook.office.com/owa/?ItemID=AAAINJAAAAA%3D%3D&exvsurl=1&viewmodel=ICalendarItemDetailsViewModelFactory"
            }
        ],
        "@odata.deltaLink": "https://outlook.office.com/api/v1.0/me/calendarview/?startdatetime=2015-01-01T00%3a00%3a00Z&enddatetime=2015-04-10T00%3a00%3a00Z&%24deltatoken=v2%2cH4roCAAA%3d%2c1.0%2cFalse%2cA00%2c"
    }

Segundo exemplo de solicitação

    GET https://outlook.office.com/api/v1.0/me/calendarview?startdatetime=2015-01-01T00:00:00Z&enddatetime=2015-04-10T00:00:00Z&$deltatoken=v2%2cH4roCAAA%3d%2c1.0%2cFalse%2cA00%2c
    Authorization: Bearer <token>
    Prefer: odata.track-changes
    Prefer: odata.maxpagesize=1

Amostra de dados da segunda resposta

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/CalendarView/$delta",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('user0@contoso.com')/Events('AAMkAD0jAAA=')",
            "@odata.etag": "W/\"P2fd7QAAAAAVFA==\"",
            "Id": "AAMkADNkNmVlOTITVAAAAAA0jAAA=",
            "ChangeKey": "P2fdmIU1QAAAAAVFA==",
            "Categories": [
            ],
            "DateTimeCreated": "2015-04-15T18:59:11.0226221Z",
            "DateTimeLastModified": "2015-04-15T18:59:11.0694979Z",
            "Subject": "1 hour",
            "BodyPreview": "\u200b",
            "Body": {
                "ContentType": "HTML",
                "Content": "<html><body>content</body></html>"
            },
            "Importance": "Normal",
            "HasAttachments": false,
            "Start": "2015-04-16T18:00:00Z",
            "StartTimeZone": "Pacific Standard Time",
            "End": "2015-04-16T19:00:00Z",
            "EndTimeZone": "Pacific Standard Time",
            "Reminder": 15,
            "Location": {
                "DisplayName": "",
                "Address": {
                    "Street": "",
                    "City": "",
                    "State": "",
                    "CountryOrRegion": "",
                    "PostalCode": ""
                }
            },
            "ResponseStatus": {
                "Response": "Organizer",
                "Time": "0001-01-01T00:00:00Z"
            },
            "ShowAs": "Busy",
            "IsAllDay": false,
            "IsCancelled": false,
            "IsOrganizer": true,
            "ResponseRequested": true,
            "Type": "SingleInstance",
            "SeriesMasterId": null,
            "Attendees": [
            ],
            "Recurrence": null,
            "Organizer": {
                "EmailAddress": {
                    "Address": "user0@contoso.com",
                    "Name": "user0"
                }
            },
            "iCalUId": "040000008200E09BB89A316862",
            "WebLink": "https://outlook.office.com/owa/?ItemID=AAMkADNkNmVlOAA%3D&exvsurl=1&viewmodel=ICalendarItemDetailsViewModelFactory"
        }
    ],
    "@odata.nextLink": "https://outlook.office.com/api/v1.0/me/calendarview/?startdatetime=2015-01-01T00%3a00%3a00Z&enddatetime=2015-08-10T00%3a00%3a00Z&%24skipToken=530c9d02ae1a4d96804538bd4d381546"
}

Localizar horários de reunião

Este recurso está atualmente disponível nas versões v 2.0 e beta.

Obter salas de reunião (versão prévia)

No momento, este recurso está disponível apenas na versão beta.

Criar eventos

Criar um evento no calendário

Criar um evento no calendário

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Crie um evento no calendário principal do usuário ou em um calendário específico postando no ponto de extremidade events do calendário. Ao criar o evento, o servidor envia convites para todos os participantes.

Por padrão, os valores de horário de Start e End estão em UTC. Você pode especificar fusos horários para Start e End, expressar o horário no fuso horário correspondente e incluir uma diferença de horário do UTC.

O exemplo abaixo mostra como atribuir valores de horário na Hora Oficial do Pacífico. Observe que, se você especificar um fuso horário, também deverá especificar um valor para o outro.

POST https://outlook.office.com/api/v1.0/me/events
POST https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}/events

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
calendar_id	sequência de caracteres	ID do calendário.

Solicitação de amostra

POST https://outlook.office.com/api/v1.0/me/events

Content-Type: application/json

{
  "Subject": "Discuss the Calendar REST API",
  "Body": {
    "ContentType": "HTML",
    "Content": "I think it will meet our requirements!"
  },
  "Start": "2014-02-02T18:00:00-08:00",
  "StartTimeZone": "Pacific Standard Time",
  "End": "2014-02-02T19:00:00-08:00",
  "EndTimeZone": "Pacific Standard Time",
  "Attendees": [
    {
      "EmailAddress": {
        "Address": "janets@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Janet Schorr"
      },
      "Type": "Required"
    }
  ]
}

Resposta de amostra

Código do status: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"Jj9S59cHB0Wq4jXUzBgDvQAAFeNheA==\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAENAAAmP1Ln1wcHRariNdTMGAO9AAAV4v1RAAA=",
  "ChangeKey": "Jj9S59cHB0Wq4jXUzBgDvQAAFeNheA==",
  "Categories": [],
  "DateTimeCreated": "2014-01-22T20:56:10.1058291Z",
  "DateTimeLastModified": "2014-01-22T20:56:10.3402186Z",
  "Subject": "Discuss the Calendar REST API",
  "BodyPreview": "I think it will meet our requirements!",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n</head>\r\n<body>\r\nI think it will meet our requirements!\r\n</body>\r\n</html>\r\n"
  },
  "Importance": "Normal",
  "HasAttachments": false,
  "Start": "2014-02-02T18:00:00-08:00",
  "StartTimeZone": "Pacific Standard Time",
  "End": "2014-02-02T19:00:00-08:00",
  "EndTimeZone": "Pacific Standard Time",
  "Location": {
    "DisplayName": ""
  },
  "ShowAs": "Busy",
  "IsAllDay": false,
  "IsCancelled": false,
  "IsOrganizer": true,
  "ResponseRequested": true,
  "Type": "SingleInstance",
  "SeriesMasterId": null,
  "Attendees": [
    {
      "EmailAddress": {
        "Address": "janets@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Janet Schorr"
      },
      "Status": {
        "Response": "None",
        "Time": "0001-01-01T00:00:00Z"
      },
      "Type": "Required"
    }
  ],
  "Recurrence": null,
  "Organizer": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "alexd"
    }
  }
}

Tipo de resposta

O novo evento.

Por padrão, a resposta inclui todas as propriedades do novo evento. Use $select para especificar somente as propriedades necessárias para um melhor desempenho. A propriedade Id é sempre retornada.

A seguir, veja um exemplo que inclui apenas as propriedades Start e End do novo evento na resposta.

POST https://outlook.office.com/api/v1.0/me/events?$Select=Start,End

Atualizar eventos

Atualizar um evento do calendário

Atualizar um evento do calendário

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Altere um evento. Apenas as propriedades especificadas são alteradas. Se o usuário for o organizador, o servidor enviará atualizações de reunião para todos os participantes.

PATCH https://outlook.office.com/api/v1.0/me/events/{event_id}

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
event_id	sequência de caracteres	ID do evento.

Especifique qualquer propriedade de evento gravável no corpo da solicitação.

Solicitação de amostra

PATCH https://outlook.office.com/api/v1.0/me/events/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAENAAAmP1Ln1wcHRariNdTMGAO9AAAV4v1OAAA=

Content-Type: application/json

{
  "Location": {
    "DisplayName": "Your office"
  }
}

Resposta de amostra

Código de status: 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"Jj9S59cHB0Wq4jXUzBgDvQAAFeNheQ==\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAENAAAmP1Ln1wcHRariNdTMGAO9AAAV4v1OAAA=",
  "ChangeKey": "Jj9S59cHB0Wq4jXUzBgDvQAAFeNheQ==",
  "Categories": [],
  "DateTimeCreated": "2014-01-22T20:49:05.5657528Z",
  "DateTimeLastModified": "2014-01-22T21:14:17.4886416Z",
  "Subject": "Discuss the Calendar REST API",
  "BodyPreview": "I think it will meet our requirements!",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n</head>\r\n<body>\r\nI think it will meet our requirements!\r\n</body>\r\n</html>\r\n"
  },
  "Importance": "Normal",
  "HasAttachments": false,
  "Start": "2014-02-02T18:00:00-08:00",
  "StartTimeZone": "Pacific Standard Time",
  "End": "2014-02-02T19:00:00-08:00",
  "EndTimeZone": "Pacific Standard Time",
  "Location": {
    "DisplayName": "Your office"
  },
  "ShowAs": "Busy",
  "IsAllDay": false,
  "IsCancelled": false,
  "IsOrganizer": true,
  "ResponseRequested": true,
  "Type": "SingleInstance",
  "SeriesMasterId": null,
  "Attendees": [],
  "Recurrence": null,
  "Organizer": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "alexd"
    }
  }
}

Tipo de resposta

O evento atualizado. Se o usuário for o organizador, o servidor enviará atualizações de reunião para todos os participantes.

Por padrão, a resposta inclui todas as propriedades do evento atualizado. Use $select para especificar somente as propriedades necessárias para um melhor desempenho. A propriedade Id é sempre retornada.

PATCH https://outlook.office.com/api/v1.0/me/events/AAMkAGE1MFKPQWAAA=?$select=Location

Aceitar o evento

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Aceitar o evento especificado.

POST https://outlook.office.com/api/v1.0/me/events/{event_id}/accept

Parâmetro	Tipo	Descrição
Parâmetros de URL
event_id	sequência de caracteres	ID do evento. Obrigatório.
Parâmetros de corpo
Comentário	sequência de caracteres	Texto incluído na resposta. Opcional.
SendResponse	booliano	`true` se uma resposta deve ser enviada ao organizador; caso contrário, `false`. Opcional. O padrão é `true`.

Solicitação de amostra

POST https://outlook.office.com/api/v1.0/me/events('AAMkAGE1M2IyNGNmLTI5MT_bs88AAAXDJwEAAA=')/accept

Content-Type: application/json

{
  "Comment": "Great idea!",
  "SendResponse": "true"
}

Resposta

Uma resposta bem-sucedida é indicada por um código de resposta aceita HTTP 202.

Aceitar provisoriamente o evento

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Aceitar provisoriamente o evento especificado.

POST https://outlook.office.com/api/v1.0/me/events/{event_id}/tentativelyaccept

Parâmetro	Tipo	Descrição
Parâmetros de URL
event_id	sequência de caracteres	ID do evento. Obrigatório.
Parâmetros de corpo
Comentário	sequência de caracteres	Texto incluído na resposta. Opcional.
SendResponse	booliano	`true` se uma resposta deve ser enviada ao organizador; caso contrário, `false`. Opcional. O padrão é `true`.

Solicitação de amostra

POST https://outlook.office.com/api/v1.0/me/events('AAMkAGE1M2IyNGNmLTI5MT_bs88AAAXDJwEAAA=')/tentativelyaccept

Content-Type: application/json

{
  "Comment": "I'll confirm later!",
  "SendResponse": "true"
}

Resposta

Uma resposta bem-sucedida é indicada por um código de resposta aceita HTTP 202.

Recusar evento

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Recusar o convite para o evento especificado.

POST https://outlook.office.com/api/v1.0/me/events/{event_id}/decline

Parâmetro	Tipo	Descrição
Parâmetros de URL
event_id	sequência de caracteres	ID do evento. Obrigatório.
Parâmetros de corpo
Comentário	sequência de caracteres	Texto incluído na resposta. Opcional.
SendResponse	booliano	`true` se uma resposta deve ser enviada ao organizador; caso contrário, `false`. Opcional. O padrão é `true`.

Solicitação de amostra

POST https://outlook.office.com/api/v1.0/me/events('AAMkAGE1M2IyNGNmLTI5MT_bs88AAAXDJwEAAA=')/decline

Content-Type: application/json

{
  "Comment": "Sorry, maybe next time!",
  "SendResponse": "true"
}

Resposta

Uma resposta bem-sucedida é indicada por um código de resposta aceita HTTP 202.

Encaminhar eventos (versão prévia)

No momento, este recurso está disponível apenas na versão beta.

Excluir eventos

Excluir um evento do calendário

Excluir um evento do calendário

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Mova um evento para a pasta Itens Excluídos do usuário conectado. Se o evento for uma reunião e o usuário conectado for o organizador, o servidor enviará cancelamentos a todos os participantes.

DELETE https://outlook.office.com/api/v1.0/me/events/{event_id}

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
event_id	sequência de caracteres	ID do evento.

Solicitação de amostra

DELETE https://outlook.office.com/api/v1.0/me/events/AAMkAGE0M4v1OAAA=

Resposta de amostra

Status code: 204

Cancelar eventos (versão prévia)

No momento, este recurso está disponível apenas na versão beta.

Obter anexos

Você pode obter uma coleção de anexos ou um único anexo.

Obter uma coleção de anexos
Obter um anexo

Obter uma coleção de anexos

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obtenha os anexos de um evento específico.

Observação

Confira Parâmetros de consulta do OData para ver parâmetros de filtragem, classificação e paginação.

GET https://outlook.office.com/api/v1.0/me/events/{event_id}/attachments

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
event_id	sequência de caracteres	ID do evento.

Tipo de resposta

Uma coleção de anexos que pode ser do tipo FileAttachment ou ItemAttachment.

Solicitação de amostra

GET https://outlook.office.com/api/v1.0/me/events/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAA=/attachments

Resposta de amostra

Código de status: 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events('AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAA%3D')/Attachments",
    "value": [
        {
            "@odata.type": "#Microsoft.OutlookServices.FileAttachment",
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2NGTG9yAAA=')/Attachments('AAMkAGI2NGLwydGuOzcHf1FBlo=')",
            "Id": "AAMkAGI2NGLwydGuOzcHf1FBlo=",
            "DateTimeLastModified": "2014-10-22T00:30:26Z",
            "Name": "Company Party.docx",
            "ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
            "Size": 11647,
            "IsInline": false,
            "ContentId": null,
            "ContentLocation": null,
            "ContentBytes": "UEsDBBQABgAIAAAAIQDfpNJs...AAF4pAAAAAA=="
            "IsContactPhoto": false
        }
    ]
}

Obter um anexo

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obter um anexo de um evento específico.

GET https://outlook.office.com/api/v1.0/me/events/{event_id}/attachments/{attachment_id}

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
event_id	sequência de caracteres	ID do evento.
attachment_id	sequência de caracteres	A ID do anexo.

Observação

Confira Parâmetros de consulta do OData para ver parâmetros de filtragem, classificação e paginação.

Tipo de resposta

O anexo de arquivo ou anexo de item solicitado.

Solicitação de amostra

GET https://outlook.office.com/api/v1.0/me/events/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAA=/attachments/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAABEgAQALxJtn1LwydGuOzcHf1FBlo=

Resposta de amostra

Código de status: 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events('AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAA%3D')/Attachments/$entity",
    "@odata.type": "#Microsoft.OutlookServices.FileAttachment",
    "@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2WRAAADTG9yAAA=')/Attachments('AAMkAGI2TG9yAAABEgAQALxJtn1LwydGuOzcHf1FBlo=')",
    "Id": "AAMkAGI2TG9yAAABEgAQALxJtn1LwydGuOzcHf1FBlo="
    "DateTimeLastModified": "2014-10-22T00:30:26Z",
    "Name": "Company Party.docx",
    "ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "Size": 11647,
    "IsInline": false,
    "ContentId": null,
    "ContentLocation": null,
    "ContentBytes": "UEsDBBQABgAIAAAAIQD...AAF4pAAAAAA==",
    "IsContactPhoto": false
}

Criar anexos

Você pode criar um anexo de arquivo ou criar um anexo de item para um evento.

Criar um anexo de arquivo
Criar um anexo de item
Criar um anexo de referência

Criar um anexo de arquivo

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Adicionar um anexo de arquivo a um evento.

POST https://outlook.office.com/api/v1.0/me/events/{event_id}/attachments

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
event_id	sequência de caracteres	ID do evento.
Parâmetros de corpo
@odata.type	sequência de caracteres	#Microsoft.OutlookServices.FileAttachment
Nome	sequência de caracteres	O nome do anexo.
ContentBytes	binário	O arquivo a ser anexado.

Tipo de resposta

O novo anexo de arquivo.

Criar um anexo de item

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Adicionar um anexo de item a um evento.

POST https://outlook.office.com/api/v1.0/me/events/{event_id}/attachments

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
event_id	sequência de caracteres	ID do evento.
Parâmetros de corpo
@odata.type	sequência de caracteres	#Microsoft.OutlookServices.ItemAttachment
Nome	sequência de caracteres	O nome do anexo.
Item	Uma entidade Mensagem, Evento ou Contato.	O item a ser anexado.

Tipo de resposta

O novo anexo de item.

Criar um anexo de referência

Escopo mínimo necessário

https://outlook.office.com/calendars.readwrite

Adicione um anexo de referência a um evento.

No momento, este recurso está disponível apenas na versão beta.

Excluir anexos

Excluir um anexo de evento

Excluir um anexo de evento

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Exclua o anexo especificado de um evento. O anexo pode ser um anexo de arquivo ou anexo de item.

DELETE https://outlook.office.com/api/v1.0/me/events/{event_id}/attachments/{attachment_id}

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
event_id	sequência de caracteres	ID do evento.
attachment_id	sequência de caracteres	A ID do anexo.

Solicitação de amostra

DELETE https:/outlook.office.com/api/v1.0/me/events/AAMkAGE0MG4v1OAAA=/attachments/AAMkAGITG9yAAA=

Resposta de amostra

Status code: 204

Receber lembretes

Obtenha uma lista de lembretes de eventos entre duas datas e horários de um calendário.

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Este recurso está atualmente disponível nas versões v 2.0 e beta.

Adiar lembretes

Adie um lembrete até um novo horário.

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Este recurso está atualmente disponível nas versões v 2.0 e beta.

Ignorar lembretes

Ignorar um lembrete acionado.

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Este recurso está atualmente disponível nas versões v 2.0 e beta.

Obter calendários

Você pode obter uma coleção de calendários ou obter um calendário.

Obter uma coleção de calendários
Obter um calendário

Obter uma coleção de calendários

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obter todos os calendários do usuário (calendars) ou obter os calendários de um grupo de calendários específico.

GET https://outlook.office.com/api/v1.0/me/calendars
GET https://outlook.office.com/api/v1.0/me/calendargroups/{calendar_group_id}/calendars

Observação

Confira Parâmetros de consulta do OData para ver parâmetros de filtragem, classificação e paginação.

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
calender_group_id	sequência de caracteres	ID do grupo de calendários.

Solicitação de amostra

GET https://outlook.office.com/api/v1.0/me/calendars

Resposta de amostra

Código de status: 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Calendars",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuLAAA=",
            "Name": "Calendar",
            "Color": "Auto",
            "ChangeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x0+w=="
        }
    ]
}

Tipo de resposta

A coleção de calendário solicitada.

Obter um calendário

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obter um calendário por ID. Você pode obter o calendário principal do usuário usando o ponto de extremidade ../me/calendar.

GET https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}

Observação

Confira Parâmetros de consulta do OData para ver parâmetros de filtragem, classificação e paginação.

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
calendar_id	sequência de caracteres	ID do calendário.

Solicitação de amostra

GET https://outlook.office.com/api/v1.0/me/calendars/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuLAAA=

Resposta de amostra

Código de status: 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Calendars/$entity",
    "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
    "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuLAAA=",
    "Name": "Calendar",
    "Color": "Auto",
    "ChangeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x0+w=="
}

Tipo de resposta

O calendário solicitado.

Criar calendários

Criar um calendário

Criar um calendário

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Crie um calendário no grupo de calendários padrão usando o atalho ../me/calendars ou em um determinado grupo de calendários ao publicar no ponto de extremidade calendars do grupo.

POST https://outlook.office.com/api/v1.0/me/calendars
POST https://outlook.office.com/api/v1.0/me/calendargroups/{calendar_group_id}/calendars

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
calender_group_id	sequência de caracteres	ID do grupo de calendários, se você estiver obtendo calendários de um grupo específico.
Parâmetros de corpo
Nome	sequência de caracteres	O nome do novo calendário.

Solicitação de amostra

POST https://outlook.office.com/api/v1.0/me/calendars

Content-Type: application/json

{
  "Name": "Social"
}

Resposta de amostra

Código do status: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Calendars/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"Jj9S59cHB0Wq4jXUzBgDvQAAFeN/SQ==\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLHAAA=",
  "Name": "Social",
  "ChangeKey": "Jj9S59cHB0Wq4jXUzBgDvQAAFeN/SQ=="
}

Tipo de resposta

O novo calendário.

Atualizar calendários

Atualizar um calendário

Atualizar um calendário

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Altere as propriedades graváveis de um calendário.

PATCH https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
calendar_id	sequência de caracteres	ID do calendário.
Parâmetros de corpo
Nome	sequência de caracteres	O novo nome do calendário.

Solicitação de amostra

PATCH https://outlook.office.com/api/v1.0/me/calendars/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLIAAA=

Content-Type: application/json

{
  "Name": "Social events"
}

Resposta de amostra

Código de status: 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Calendars/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"Jj9S59cHB0Wq4jXUzBgDvQAAFeN/Sw==\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLIAAA=",
  "Name": "Social events",
  "ChangeKey": "Jj9S59cHB0Wq4jXUzBgDvQAAFeN/Sw=="

Tipo de resposta

O calendário atualizado.

Excluir calendários

Excluir um calendário

Excluir um calendário

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

DELETE https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
calendar_id	sequência de caracteres	ID do calendário.

Solicitação de amostra

DELETE https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}

Resposta de amostra

Status code: 204

Obter grupos de calendários

Você pode obter uma coleção de grupos de calendários ou obter um grupo calendários.

Obter uma coleção de grupos de calendários
Obter um grupo de calendários

Observação

O Outlook.com tem suporte apenas para o grupo de calendários padrão que é acessível pelo atalho ../me/calendars.

Obter uma coleção de grupos de calendários

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obtenha os grupos de calendários em uma caixa de correio.

GET https://outlook.office.com/api/v1.0/me/calendargroups

Observação

Confira Parâmetros de consulta do OData para ver parâmetros de filtragem, classificação e paginação.

Solicitação de amostra

GET https://outlook.office.com/api/v1.0/me/calendargroups

Resposta de amostra

Código de status: 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/CalendarGroups",
  "value": [
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
      "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x0+g==\"",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuKAAA=",
      "Name": "My Calendars",
      "ChangeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x0+g==",
      "ClassId": "0006f0b7-0000-0000-c000-000000000046"
    },
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
      "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x0/A==\"",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuMAAA=",
      "Name": "Other Calendars",
      "ChangeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x0/A==",
      "ClassId": "0006f0b8-0000-0000-c000-000000000046"
    }
  ]
}

Tipo de resposta

A coleção de grupos de calendários solicitada.

Obter um grupo de calendários

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obtenha um grupo de calendários por ID.

GET https://outlook.office.com/api/v1.0/me/calendargroups/{calendar_group_id}

Observação

Confira Parâmetros de consulta do OData para ver parâmetros de filtragem, classificação e paginação.

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
calendar_group_id	sequência de caracteres	ID do grupo de calendários.

Solicitação de amostra

GET https://outlook.office.com/api/v1.0/me/calendargroups/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuKAAA=

Resposta de amostra

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/CalendarGroups/$entity",
    "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
    "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuKAAA=",
    "Name": "My Calendars",
    "ClassId": "0006f0b7-0000-0000-c000-000000000046",
    "ChangeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x0+g=="
}

Tipo de resposta

O grupo de calendários solicitado.

Criar grupos de calendários

Criar um grupo de calendários. Name é a única propriedade gravável para um grupo de calendários.

Criar um grupo de calendários

Observação

O Outlook.com tem suporte apenas para o grupo de calendários padrão que é acessível pelo atalho ../me/calendars. Você não pode criar outro grupo de calendários no Outlook.com.

Criar um grupo de calendários

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

POST https://outlook.office.com/api/v1.0/me/calendargroups

Parâmetro obrigatório	Tipo	Descrição
Parâmetro de URL
Parâmetros de corpo
Nome	sequência de caracteres	O nome do grupo de calendários.

POST https://outlook.office.com/api/v1.0/me/calendargroups

Content-Type: application/json

{
  "Name": "Birthdays"
}

Resposta de amostra

Código do status: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/CalendarGroups/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"Jj9S59cHB0Wq4jXUzBgDvQAAFeN/Rw==\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLGAAA=",
  "Name": "Birthdays",
  "ChangeKey": "Jj9S59cHB0Wq4jXUzBgDvQAAFeN/Rw==",
  "ClassId": "4d969bba-8942-42a0-ae33-c7d4410d1e11"
}

Tipo de resposta

O novo grupo de calendários.

Atualizar grupos de calendários

Atualizar um grupo de calendários

Atualizar um grupo de calendários

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Altere o nome de um grupo de calendários. Name é a única propriedade gravável do grupo de calendários.

PATCH https://outlook.office.com/api/v1.0/me/calendargroups/{calendar_group_id}

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
calendar_group_id	sequência de caracteres	ID do grupo de calendários.
Parâmetros de corpo
Nome	sequência de caracteres	O nome do grupo de calendários atualizado.

PATCH https://outlook.office.com/api/v1.0/me/calendargroups/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLGAAA=

{
  "Name": "Holidays"
}

Resposta de amostra

Código de status: 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/CalendarGroups/$entity",
  "@odata.id": "https://https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"Jj9S59cHB0Wq4jXUzBgDvQAAFeN/SA==\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLGAAA=",
  "Name": "Holidays",
  "ChangeKey": "Jj9S59cHB0Wq4jXUzBgDvQAAFeN/SA==",
  "ClassId": "4d969bba-8942-42a0-ae33-c7d4410d1e11"
}

Tipo de resposta

O grupo de calendários atualizado.

Excluir grupos de calendários

Excluir um grupo de calendários

Observação

O Outlook.com tem suporte apenas para o grupo de calendários padrão que é acessível pelo atalho ../me/calendars. Não exclua este grupo de calendários.

Excluir um grupo de calendários

Escopo mínimo necessário

Uma das seguintes opções:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

DELETE https://outlook.office.com/api/v1.0/me/calendargroups/{calendar_group_id}

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
calendar_group_id	sequência de caracteres	ID do grupo de calendários.

Solicitação de amostra

DELETE https://outlook.office.com/api/v1.0/me/calendargroups/AAMkAGE0MGM4xLGAAA=

Resposta de amostra

Status code: 204

Próximas etapas

Se você estiver pronto para começar a criar um aplicativo ou apenas quiser aprender mais, temos tudo o que você precisa.

Comece com as APIs REST de Email, Calendário e Contatos.
Quer exemplos? Nós temos.

Se preferir, aprenda mais sobre como usar a plataforma do Office 365:

Partilhar via

Referência da API REST de Calendário do Outlook (versão 1.0)

Todas as operações da API de Calendário

Operações de evento

Operações de calendário

Operações de grupo de calendários

Ver também

Uso da API REST de Calendário

Autenticação

Escopos para acessar calendários compartilhados

Versão da API

Usuário de destino

Obter eventos

Obter uma visão de calendário

Escopo mínimo necessário

Tipo de resposta

Obter eventos mestre de série e únicos

Escopo mínimo necessário

Solicitação de amostra

Resposta de amostra

Obter instâncias de evento

Escopo mínimo necessário

Tipo de resposta

Obter um evento

Escopo mínimo necessário

Solicitação de amostra

Resposta de amostra

Tipo de resposta

Solicitação de amostra

Resposta de amostra

Sincronizar eventos

Escopo mínimo necessário

Cabeçalhos de solicitação

Sincronizar no calendário padrão

Sincronizar em um calendário específico

Parâmetros

Tipo de resposta

Exemplo

Localizar horários de reunião

Obter salas de reunião (versão prévia)

Criar eventos

Criar um evento no calendário

Escopo mínimo necessário

Solicitação de amostra

Resposta de amostra

Tipo de resposta

Atualizar eventos

Atualizar um evento do calendário

Escopo mínimo necessário

Solicitação de amostra

Resposta de amostra

Tipo de resposta

Responder a eventos

Aceitar o evento

Escopo mínimo necessário

Solicitação de amostra

Resposta

Aceitar provisoriamente o evento

Escopo mínimo necessário

Solicitação de amostra

Resposta

Recusar evento

Escopo mínimo necessário

Solicitação de amostra

Resposta

Encaminhar eventos (versão prévia)

Excluir eventos

Excluir um evento do calendário

Escopo mínimo necessário

Solicitação de amostra

Resposta de amostra

Cancelar eventos (versão prévia)

Obter anexos

Obter uma coleção de anexos

Escopo mínimo necessário

Tipo de resposta

Solicitação de amostra

Resposta de amostra

Obter um anexo

Escopo mínimo necessário