Criar evento no Outlook Calendar, por uma API
Cria um evento em um calendário e o retorna com id e webLink. Com attendees, o Outlook envia os convites por e-mail na hora, e isso não pode ser desativado.
- Identificador
- outlook_calendar_create_event
A chamada
POST https://connect.reportei.com/api/tools/outlook_calendar_create_event/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"calendar_id": "<calendar_id>",
"start": {},
"end": {}
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| calendar_id | string | Sim | Calendar id from List calendars. The one with isDefaultCalendar true is the main calendar. |
| subject | string | Não | Title of the event. |
| body | object | Não | Description of the event. contentType is text or html. |
| start | object | Sim | When the event starts. An all-day event starts at midnight. |
| end | object | Sim | When the event ends. An all-day event ends at midnight of the next day, in the same time zone as start. |
| isAllDay | boolean | Não | true for an all-day event, with start and end at midnight. |
| location | object | Não | Where the event happens. |
| attendees | array | Não | People, rooms or equipment invited. Outlook emails them the invitation. |
| isOnlineMeeting | boolean | Não | true adds an online meeting, together with onlineMeetingProvider. |
| onlineMeetingProvider | string | Não | teamsForBusiness adds a Microsoft Teams link. It needs a work or school account.Valores: teamsForBusiness |
| showAs | string | Não | How the time shows in the calendar. oof is out of office.Valores: free, tentative, busy, oof, workingElsewhere |
| importance | string | Não | Importance of the event.Valores: low, normal, high |
| sensitivity | string | Não | Privacy of the event.Valores: normal, personal, private, confidential |
| isReminderOn | boolean | Não | true sets a reminder. |
| reminderMinutesBeforeStart | integer | Não | Minutes before the start that the reminder shows. |
| categories | array | Não | Category names of the user. The list replaces the current one. |
| recurrence | object | Não | Repetition. Besides type and interval, pattern needs: weekly, daysOfWeek and firstDayOfWeek; absoluteMonthly, dayOfMonth; relativeMonthly, daysOfWeek; absoluteYearly, dayOfMonth and month; relativeYearly, daysOfWeek and month. range.startDate is the date of start; range.type endDate needs endDate, and numbered needs numberOfOccurrences. |
| allowNewTimeProposals | boolean | Não | false stops invitees from proposing another time. The default is true. |
| responseRequested | boolean | Não | false asks invitees for no response. The default is true. |
Conexões possíveis
O seu cliente conecta a conta do Outlook Calendar uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
OAuth com o app do seu produto
Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/outlook_calendar, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/outlook_calendar_create_event. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Outlook Calendar
- Listar calendáriosGETLista os calendários do usuário, com id, name, isDefaultCalendar, canEdit e owner. Use o id como calendar_id. Só a primeira página volta.
- Listar eventosGETLista os eventos de um calendário entre dois horários, com eventos recorrentes expandidos em ocorrências que têm seu próprio id. start e end vêm em UTC. Só a primeira página volta: quando a resposta traz @odata.nextLink, consulte de novo com uma janela menor.
- Consultar eventoGETRetorna um evento com o corpo em texto simples, start e end em UTC, local, participantes com suas respostas, organizador, onlineMeeting com o link de entrada, recorrência e webLink.
- Atualizar eventoPATCHAltera um evento e o retorna. Só os campos enviados mudam. Em uma reunião organizada pelo usuário, o Outlook envia a alteração por e-mail aos participantes. Não envie um novo body para uma reunião online: os dados de entrada ficam no corpo e seriam perdidos.
- Excluir eventoDELETEExclui um evento do calendário. Quando o usuário organiza a reunião, o Outlook envia um cancelamento por e-mail aos participantes.
- Aceitar eventoPOSTAceita um convite de reunião e, a menos que sendResponse seja false, envia a resposta por e-mail ao organizador. A resposta é 202 sem corpo.
- Recusar eventoPOSTRecusa um convite de reunião, opcionalmente propondo outro horário, e, a menos que sendResponse seja false, envia a resposta por e-mail ao organizador. A resposta é 202 sem corpo.
- Aceitar evento provisoriamentePOSTAceita provisoriamente um convite de reunião, opcionalmente propondo outro horário, e, a menos que sendResponse seja false, envia a resposta por e-mail ao organizador. A resposta é 202 sem corpo.
Toolkits da mesma categoria
Ver os 100 toolkitsVeja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
