Outlook
Visão geral
Seção intitulada “Visão geral”O Outlook é a plataforma de e-mail e calendário da Microsoft que integra contatos, agendamento e comunicação em um workspace unificado. Com a integração no SquadOS, seus agentes podem enviar e-mails, criar e atualizar eventos de calendário, gerenciar contatos, mover mensagens entre pastas e criar tarefas no Microsoft To Do — tudo diretamente pelo Microsoft Graph API.
- Site oficial: https://outlook.microsoft.com/
- Documentação na Composio: docs.composio.dev/toolkits/outlook
Autenticação
Seção intitulada “Autenticação”Esta ferramenta utiliza OAuth 2.0 (OAUTH2) para conectar. Também suporta S2S_OAUTH2 para autenticação de aplicativo (server-to-server) em contextos de produção com permissões de aplicativo.
Você vai precisar autorizar o acesso à sua conta Microsoft. O fluxo OAuth é gerenciado pela Composio.
Como obter a credencial
Seção intitulada “Como obter a credencial”- Acesse https://composio.dev/auth/outlook para um guia passo a passo de como criar e configurar credenciais OAuth personalizadas para o Microsoft Outlook.
- Faça login com sua conta Microsoft e autorize os escopos solicitados.
- Para uso com S2S (permissões de aplicativo), registre um aplicativo no Azure Portal e configure os escopos de API necessários.
Como conectar no SquadOS
Seção intitulada “Como conectar no SquadOS”- Acesse Ferramentas no menu lateral (
/admin/tools). - Abra a aba Disponíveis e procure por
Outlook. - Clique no card para abrir o modal de detalhes e em Conectar.
- Você é levado para a página de conexão segura hospedada pela Composio, onde autoriza o acesso à sua conta Microsoft via OAuth.
- Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)
Perguntas frequentes
Seção intitulada “Perguntas frequentes”Como configuro credenciais OAuth personalizadas para o Microsoft (Outlook)?
Seção intitulada “Como configuro credenciais OAuth personalizadas para o Microsoft (Outlook)?”Para um guia passo a passo sobre como criar e configurar suas próprias credenciais OAuth do Microsoft (Outlook) com a Composio, consulte Como criar credenciais OAuth para o Microsoft (Outlook).
Por que o gatilho de nova mensagem do Outlook retorna apenas um ID de mensagem?
Seção intitulada “Por que o gatilho de nova mensagem do Outlook retorna apenas um ID de mensagem?”Os webhooks do Outlook enviam apenas o ID da mensagem nos eventos de gatilho. Para obter a mensagem completa (assunto, corpo, cabeçalhos), chame a ação OUTLOOK_GET_MESSAGE com esse ID de mensagem.
Por que OUTLOOK_SEND_EMAIL não retorna os detalhes da mensagem?
Seção intitulada “Por que OUTLOOK_SEND_EMAIL não retorna os detalhes da mensagem?”O endpoint de envio do Microsoft Graph retorna HTTP 202 sem detalhes da mensagem. Para obter o ID da mensagem e o ID da conversa, crie um rascunho primeiro com OUTLOOK_CREATE_DRAFT e depois envie-o com OUTLOOK_SEND_DRAFT.
O que é a URL @odata.context?
Seção intitulada “O que é a URL @odata.context?”A URL @odata.context fornece metadados sobre a resposta (conjunto de entidades, versão do serviço e informações de schema) para ajudar os clientes a interpretar a estrutura do payload. É usada principalmente para paginação e análise de dados — não é uma URL direta para o recurso em si.
Ações disponíveis
Seção intitulada “Ações disponíveis”Enviar e-mail
Seção intitulada “Enviar e-mail”OUTLOOK_SEND_EMAIL
Envia um e-mail com assunto, corpo, destinatários e anexos opcionais via Microsoft Graph API. Suporta múltiplos destinatários separados por vírgula no campo to. Aceita um único arquivo ou uma lista de arquivos como anexos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
to | string | Sim | Endereço(s) de e-mail do(s) destinatário(s) principal(is). Aceita um único e-mail ou múltiplos separados por vírgula. |
body | string | Sim | Conteúdo do corpo do e-mail como string simples (texto simples ou HTML conforme is_html). |
subject | string | Sim | Linha de assunto do e-mail. |
is_html | boolean | Não | Especifica se o corpo do e-mail é HTML; true para HTML, false para texto simples. |
to_name | string | Não | Nome de exibição do destinatário principal. |
user_id | string | Não | Endereço de e-mail do usuário ou alias me para o usuário autenticado. |
cc_emails | array | Não | Lista de endereços de e-mail para destinatários em CC. |
bcc_emails | array | Não | Lista de endereços de e-mail para destinatários em BCC. |
attachment | string | Não | Arquivo(s) a anexar. Aceita um único arquivo ou uma lista. |
from_address | string | Não | Endereço De opcional para enviar em nome de outro usuário. Requer permissões adequadas na caixa de entrada. |
save_to_sent_items | boolean | Não | Indica se o e-mail deve ser salvo em “Itens Enviados”. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar rascunho de e-mail
Seção intitulada “Criar rascunho de e-mail”OUTLOOK_CREATE_DRAFT
Cria um novo rascunho de e-mail no Outlook com assunto, corpo, destinatários e anexo opcional. Use esta ação para novas conversas. Para criar um rascunho de resposta a uma mensagem existente, use OUTLOOK_CREATE_DRAFT_REPLY.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
body | string | Sim | Conteúdo do rascunho; use is_html para especificar se é HTML ou texto simples. |
subject | string | Sim | Linha de assunto do rascunho. |
is_html | boolean | Não | Especifica se body é HTML. Se false, o corpo é texto simples. |
to_recipients | array | Não | Lista de endereços de e-mail dos destinatários “Para”. Forneça como array de strings. |
cc_recipients | array | Não | Lista de endereços de e-mail para CC. |
bcc_recipients | array | Não | Lista de endereços de e-mail para BCC. |
attachment | string | Não | Arquivo(s) a anexar ao rascunho. |
user_id | string | Não | ID do usuário ou nome principal para autenticação S2S. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Enviar rascunho
Seção intitulada “Enviar rascunho”OUTLOOK_SEND_DRAFT
Envia uma mensagem rascunho existente. Use após criar um rascunho para entregá-lo aos destinatários imediatamente.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
message_id | string | Sim | Identificador único da mensagem rascunho a enviar. |
user_id | string | Não | Endereço de e-mail do usuário ou me para o usuário autenticado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Responder e-mail
Seção intitulada “Responder e-mail”OUTLOOK_REPLY_EMAIL
Envia uma resposta a uma mensagem de e-mail do Outlook com formatação HTML opcional, identificada por message_id, permitindo destinatários CC e BCC opcionais.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
message_id | string | Sim | ID da mensagem do Microsoft Graph (string Base64 iniciando com AAMk). Obtenha das ações OUTLOOK_LIST_MESSAGES ou OUTLOOK_GET_MESSAGE. |
comment | string | Sim | Conteúdo do corpo da resposta. Pode ser texto simples ou HTML conforme o flag is_html. |
is_html | boolean | Não | Se o corpo da resposta deve ser renderizado como HTML. |
user_id | string | Não | Endereço de e-mail do usuário ou me para o usuário autenticado. |
cc_emails | array | Não | Lista de endereços de e-mail para CC. |
bcc_emails | array | Não | Lista de endereços de e-mail para BCC. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Encaminhar mensagem
Seção intitulada “Encaminhar mensagem”OUTLOOK_FORWARD_MESSAGE
Encaminha uma mensagem para novos destinatários.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
message_id | string | Sim | Identificador único da mensagem a encaminhar (string Base64, ex.: AAMkAGI2TAAA=). |
to_recipients | array | Sim | Lista de endereços de e-mail para os quais encaminhar a mensagem. |
comment | string | Não | Comentário opcional a incluir com a mensagem encaminhada. |
user_id | string | Não | Endereço de e-mail do usuário ou me para o usuário autenticado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar mensagens
Seção intitulada “Listar mensagens”OUTLOOK_LIST_MESSAGES
Recupera uma lista de mensagens de e-mail de uma pasta de correio especificada, com opções de filtragem, paginação e ordenação. Suporta filtro por conversationId para obter todas as mensagens de um thread.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
folder | string | Não | ID ou nome bem conhecido da pasta de correio (ex.: inbox, sentitems, drafts, deleteditems). |
top | integer | Não | Número máximo de mensagens a retornar (1–1000). Verifique @odata.nextLink para paginação. |
filter | string | Não | Expressão de filtro OData para filtrar mensagens. |
select | array | Não | Propriedades da mensagem a incluir na resposta. |
orderby | array | Não | Propriedades para ordenar os resultados. |
user_id | string | Não | E-mail do usuário alvo ou me para o usuário autenticado. |
is_read | boolean | Não | Filtrar por status de leitura: true para lidas, false para não lidas. |
subject | string | Não | Filtrar por correspondência exata do assunto. |
from_address | string | Não | Filtrar pelo endereço de e-mail exato do remetente. |
received_date_time_ge | string | Não | Filtrar mensagens recebidas a partir desta data/hora ISO 8601. |
received_date_time_lt | string | Não | Filtrar mensagens recebidas antes desta data/hora ISO 8601. |
response_detail | string | Não | Nível de detalhe: minimal (padrão, sem corpo) ou full (payload completo incluindo HTML). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter mensagem de e-mail
Seção intitulada “Obter mensagem de e-mail”OUTLOOK_GET_MESSAGE
Recupera uma mensagem de e-mail específica pelo seu ID da caixa de entrada do Outlook do usuário.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
message_id | string | Sim | ID único da mensagem de e-mail do Outlook a recuperar. |
select | array | Não | Lista de propriedades da mensagem a incluir na resposta. |
user_id | string | Não | Endereço de e-mail do usuário, UPN ou me para o usuário autenticado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Pesquisar mensagens do Outlook
Seção intitulada “Pesquisar mensagens do Outlook”OUTLOOK_SEARCH_MESSAGES
Pesquisa mensagens do Outlook usando a sintaxe KQL avançada. Suporta filtros por remetente, destinatário, assunto, datas e anexos. Funciona apenas com contas Microsoft 365/Enterprise (não suporta @hotmail.com/@outlook.com).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
query | string | Não | String de consulta KQL (ex.: from:user@example.com AND received>=2025-10-01, subject:invoice AND hasattachment:yes). |
user_id | string | Não | Caixa de entrada alvo: me para o usuário autenticado, ou e-mail/UPN para caixa compartilhada. |
size | integer | Não | Número de resultados por página (1–25). |
from_index | integer | Não | Índice base 0 para paginação (máx. 999). |
subject | string | Não | Texto a buscar no assunto da mensagem (parâmetro legado; prefira usar subject:texto no campo query). |
fromEmail | string | Não | Filtrar mensagens pelo endereço de e-mail ou domínio do remetente (parâmetro legado). |
hasAttachments | boolean | Não | Filtrar mensagens com ou sem anexos (parâmetro legado). |
enable_top_results | boolean | Não | Se true, ordena por relevância; caso contrário, ordena por data descendente. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Consultar e-mails
Seção intitulada “Consultar e-mails”OUTLOOK_QUERY_EMAILS
Consulta e-mails do Outlook em uma ÚNICA pasta usando filtros OData. Ideal para consultas estruturadas em metadados de mensagens dentro de uma pasta específica. Retorna até 100 mensagens por requisição com suporte a paginação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
folder | string | Não | Pasta de correio única a pesquisar (ex.: inbox, sentitems). Para busca em todas as pastas, use OUTLOOK_SEARCH_MESSAGES. |
filter | string | Não | String de filtro OData (ex.: isRead eq false, receivedDateTime ge 2025-01-01T00:00:00Z). |
top | integer | Não | Número máximo de mensagens a retornar por requisição (1–1000). Padrão: 100. |
select | array | Não | Propriedades da mensagem a incluir na resposta. |
orderby | string | Não | Ordenação como string separada por vírgulas (ex.: receivedDateTime desc). |
user_id | string | Não | E-mail do usuário alvo ou me para o usuário autenticado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Mover mensagem para pasta
Seção intitulada “Mover mensagem para pasta”OUTLOOK_MOVE_MESSAGE
Move uma mensagem para outra pasta dentro da caixa de entrada do usuário. Cria uma nova cópia na pasta de destino e remove o original. O message_id muda após uma movimentação bem-sucedida.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
message_id | string | Sim | ID único da mensagem de e-mail do Outlook a mover. |
destination_id | string | Sim | ID da pasta de destino ou nome bem conhecido (ex.: inbox, deleteditems, drafts). |
user_id | string | Não | Endereço de e-mail do usuário, UPN ou me para o usuário autenticado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar pastas de correio
Seção intitulada “Listar pastas de correio”OUTLOOK_LIST_MAIL_FOLDERS
Lista as pastas de correio de nível superior do usuário. Use para descobrir IDs de pastas antes de mover, filtrar ou organizar mensagens.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
user_id | string | Não | ID do usuário, UPN ou me para o usuário autenticado. |
top | integer | Não | Número máximo de itens a retornar por página. |
include_hidden_folders | boolean | Não | Incluir pastas de correio ocultas quando true. |
filter | string | Não | Expressão de filtro OData para filtrar pastas de correio. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Baixar anexo do Outlook
Seção intitulada “Baixar anexo do Outlook”OUTLOOK_DOWNLOAD_OUTLOOK_ATTACHMENT
Baixa um arquivo anexado específico de uma mensagem de e-mail. O data.file.s3url retornado é temporário — baixe o arquivo imediatamente após chamar esta ação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
message_id | string | Sim | ID único da mensagem de e-mail que contém o anexo. |
attachment_id | string | Sim | ID do anexo no Microsoft Graph API (string Base64 opaca, obtida de OUTLOOK_LIST_OUTLOOK_ATTACHMENTS). |
file_name | string | Sim | Nome de arquivo desejado para o anexo baixado. |
user_id | string | Não | UPN do usuário ou me para o usuário autenticado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter configurações da caixa de entrada
Seção intitulada “Obter configurações da caixa de entrada”OUTLOOK_GET_MAILBOX_SETTINGS
Recupera as configurações da caixa de entrada, como respostas automáticas, fuso horário e horário de trabalho do usuário.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
user_id | string | Não | Identificador único do usuário ou nome principal. Use me para o usuário autenticado. |
select | array | Não | Propriedades de configuração da caixa de entrada a incluir. Valores válidos: archiveFolder, automaticRepliesSetting, dateFormat, language, timeFormat, timeZone, userPurpose, workingHours. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar evento de calendário
Seção intitulada “Criar evento de calendário”OUTLOOK_CALENDAR_CREATE_EVENT
Cria um novo evento no calendário do Outlook, garantindo que start_datetime seja cronologicamente anterior a end_datetime.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
subject | string | Sim | Assunto do evento de calendário. |
start_datetime | string | Sim | Data e hora de início do evento no formato ISO 8601. |
end_datetime | string | Sim | Data e hora de término do evento no formato ISO 8601. |
time_zone | string | Sim | Fuso horário para os horários de início e término (ex.: Pacific Standard Time ou America/Los_Angeles). |
body | string | Não | Corpo do evento em texto simples ou HTML conforme is_html. |
is_html | boolean | Não | Especifica se o conteúdo de body é HTML. |
location | string | Não | Localização física do evento. |
attendees_info | array | Não | Lista de participantes. Aceita strings de e-mail ou objetos com campos email, name e type. |
calendar_id | string | Não | ID de um calendário específico. Se omitido, o evento é criado no calendário padrão. |
is_online_meeting | boolean | Não | true para indicar que é uma reunião online (gera link do Teams se online_meeting_provider for definido). |
online_meeting_provider | string | Não | Provedor de reunião online. Atualmente, apenas teamsForBusiness é suportado. |
user_id | string | Não | Identificador do usuário proprietário do calendário. Use me ou um UPN do Microsoft 365. |
importance | string | Não | Importância do evento: low, normal ou high. |
show_as | string | Não | Status a mostrar no calendário: free, tentative, busy, oof, workingElsewhere. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar eventos do calendário
Seção intitulada “Listar eventos do calendário”OUTLOOK_LIST_EVENTS
Recupera eventos do calendário do Outlook via Microsoft Graph API. Suporta calendários primários, secundários e compartilhados, paginação, filtros e especificação de fuso horário.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
user_id | string | Não | Endereço de e-mail do usuário alvo ou me para o usuário autenticado. |
calendar_id | string | Não | ID de um calendário específico. Se não fornecido, usa o calendário padrão. |
filter | string | Não | String de filtro OData. Use start/dateTime e end/dateTime para filtrar por data. |
top | integer | Não | Número máximo de eventos a recuperar por página. |
select | array | Não | Lista de nomes de propriedades de eventos a retornar. |
orderby | array | Não | Lista de propriedades para ordenar os resultados. |
timezone | string | Não | Fuso horário preferido para os horários de início/término dos eventos. |
expand_recurring_events | boolean | Não | Quando true, expande eventos recorrentes para mostrar ocorrências reais. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar evento de calendário
Seção intitulada “Atualizar evento de calendário”OUTLOOK_UPDATE_CALENDAR_EVENT
Atualiza campos especificados de um evento de calendário existente. Busca o evento existente, mescla apenas os campos fornecidos e aplica o PATCH — campos não especificados permanecem inalterados.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
event_id | string | Sim | Identificador único do evento de calendário a atualizar. |
subject | string | Não | Novo assunto do evento. |
start_datetime | string | Não | Nova data e hora de início do evento. |
end_datetime | string | Não | Nova data e hora de término do evento. |
time_zone | string | Não | Fuso horário para start_datetime e/ou end_datetime. |
location | string | Não | Localização do evento. |
attendees | array | Não | Lista de participantes. Se fornecida, substitui os participantes existentes. |
body | object | Não | Corpo do evento com tipo de conteúdo (Text ou HTML) e o conteúdo. |
show_as | string | Não | Status de disponibilidade: free, tentative, busy, oof. |
user_id | string | Não | Identificador do usuário. Use me para o usuário autenticado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Aceitar convite de evento do calendário
Seção intitulada “Aceitar convite de evento do calendário”OUTLOOK_ACCEPT_EVENT
Aceita ou aceita provisoriamente um convite de reunião de calendário em nome do usuário. O organizador receberá uma notificação de aceitação, a menos que send_response seja false.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
event_id | string | Sim | Identificador único do evento de calendário a responder. |
response_type | string | Não | Tipo de resposta: accept para aceitar, tentative para aceitar provisoriamente. |
send_response | boolean | Não | Se deve enviar a resposta ao organizador. |
comment | string | Não | Mensagem de texto opcional a incluir com a resposta. |
user_id | string | Não | ID ou UPN do proprietário do calendário. Se não fornecido, usa o usuário autenticado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Recusar evento do calendário
Seção intitulada “Recusar evento do calendário”OUTLOOK_DECLINE_EVENT
Recusa um convite para um evento de calendário. A API retorna 202 Accepted sem conteúdo em caso de sucesso.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
event_id | string | Sim | Identificador único do evento de calendário a recusar. |
comment | string | Não | Mensagem de texto opcional para incluir na resposta ao organizador. |
sendResponse | boolean | Não | Se true, envia a recusa ao organizador. Padrão: true. |
user_id | string | Não | Endereço SMTP principal do usuário, UPN ou me para o usuário autenticado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar calendários do Outlook
Seção intitulada “Listar calendários do Outlook”OUTLOOK_LIST_CALENDARS
Lista os calendários na caixa de entrada do usuário autenticado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
user_id | string | Não | ID do usuário ou UPN. Use me para o usuário autenticado. |
top | integer | Não | Número máximo de calendários a retornar. |
filter | string | Não | Expressão de filtro OData. |
select | array | Não | Propriedades a incluir. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Encontrar horários de reunião
Seção intitulada “Encontrar horários de reunião”OUTLOOK_FIND_MEETING_TIMES
Sugere horários de reunião com base na disponibilidade do organizador e dos participantes, restrições de tempo e requisitos de duração.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
attendees | array | Não | Lista de participantes ou recursos para a reunião. |
meetingDuration | string | Não | Duração da reunião no formato ISO 8601 (ex.: PT1H para 1 hora, PT30M para 30 minutos). Padrão: 30 minutos. |
timeConstraint | object | Não | Restrições de tempo para a reunião. |
maxCandidates | integer | Não | Número máximo de sugestões de horário a retornar. |
isOrganizerOptional | boolean | Não | Se true, o organizador não precisa estar presente. |
user_id | string | Não | ID do usuário ou UPN. Use me para o usuário autenticado. |
prefer_timezone | string | Não | Fuso horário preferido para a resposta. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter agenda
Seção intitulada “Obter agenda”OUTLOOK_GET_SCHEDULE
Recupera informações de livre/ocupado para endereços de e-mail especificados dentro de uma janela de tempo definida. Somente leitura — não reserva tempo nem impede conflitos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
schedules | array | Sim | Lista de endereços de e-mail SMTP (máx. 20) para os quais recuperar as agendas. |
startTime | object | Sim | Data, hora e fuso horário de início do período. Objeto com dateTime (ISO 8601) e timeZone. |
endTime | object | Sim | Data, hora e fuso horário de término do período. O período pode ter até 62 dias. |
availabilityViewInterval | string | Não | Duração de cada slot de tempo em minutos (mín.: 5, máx.: 1440). Padrão: 30. |
userId | string | Não | ID do usuário ou UPN. Necessário para autenticação S2S. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar contato
Seção intitulada “Criar contato”OUTLOOK_CREATE_CONTACT
Cria um novo contato na pasta de contatos do usuário no Microsoft Outlook.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
givenName | string | Não | Nome próprio do contato. |
surname | string | Não | Sobrenome do contato. |
displayName | string | Não | Nome de exibição do contato. |
emailAddresses | array | Não | Lista de endereços de e-mail. Cada item deve ser um objeto com campo address e opcionalmente name. |
mobilePhone | string | Não | Número de telefone celular do contato. |
businessPhones | array | Não | Lista de números de telefone comercial. |
jobTitle | string | Não | Cargo do contato. |
companyName | string | Não | Nome da empresa do contato. |
notes | string | Não | Notas pessoais sobre o contato. |
userId | string | Não | Identificador do usuário. Use me para o usuário autenticado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar tarefa no To Do
Seção intitulada “Criar tarefa no To Do”OUTLOOK_CREATE_TASK
Cria uma nova tarefa no Microsoft To Do dentro de uma lista de tarefas especificada.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
title | string | Sim | Título da tarefa. |
todo_task_list_id | string | Sim | Identificador único da lista de tarefas onde a tarefa será criada. Use OUTLOOK_LIST_TO_DO_LISTS para obter os IDs disponíveis. |
importance | string | Não | Nível de importância: low, normal ou high. Padrão: normal. |
dueDateTime | object | Não | Data/hora com informações de fuso horário para o prazo da tarefa. |
reminderDateTime | object | Não | Data/hora com informações de fuso horário para o lembrete da tarefa. |
body | object | Não | Conteúdo do corpo da tarefa com tipo de conteúdo. |
categories | array | Não | Lista de categorias para organizar a tarefa. |
user_id | string | Não | ID do usuário ou UPN. Use me para o usuário autenticado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar listas de tarefas do To Do
Seção intitulada “Listar listas de tarefas do To Do”OUTLOOK_LIST_TO_DO_LISTS
Lista as listas de tarefas do Microsoft To Do para o usuário autenticado. Use para descobrir listas disponíveis antes de listar ou criar tarefas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
user_id | string | Não | ID do usuário ou UPN. Use me para o usuário autenticado. |
top | integer | Não | Número máximo de listas a retornar. |
filter | string | Não | Expressão de filtro OData. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter perfil do Outlook
Seção intitulada “Obter perfil do Outlook”OUTLOOK_GET_PROFILE
Recupera o perfil do Microsoft Outlook para um usuário especificado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
user_id | string | Não | Identificador único ou nome principal do usuário. Use me para obter o perfil do usuário autenticado. |
include_proxy_addresses | boolean | Não | Se deve incluir endereços proxy na resposta. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir mensagem
Seção intitulada “Excluir mensagem”OUTLOOK_DELETE_MESSAGE
Exclui permanentemente uma mensagem de e-mail do Outlook pelo seu message_id. Use para remover mensagens indesejadas, limpar rascunhos ou realizar manutenção na caixa de entrada.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
message_id | string | Sim | Identificador único da mensagem a excluir. |
user_id | string | Não | UPN ou ID do usuário; use me para o usuário autenticado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar mensagem de e-mail
Seção intitulada “Atualizar mensagem de e-mail”OUTLOOK_UPDATE_EMAIL
Atualiza propriedades especificadas de uma mensagem de e-mail existente.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
message_id | string | Sim | Identificador único da mensagem de e-mail a atualizar. |
subject | string | Não | Nova linha de assunto. Se omitido, o assunto existente permanece inalterado. |
is_read | boolean | Não | Marca a mensagem como lida (true) ou não lida (false). |
body | object | Não | Novo conteúdo do corpo (Text ou HTML). Deve incluir contentType e content. |
importance | string | Não | Novo nível de importância (low, normal, high). |
categories | array | Não | Categorias associadas à mensagem. |
to_recipients | array | Não | Lista de destinatários “Para”; substitui todos os existentes. |
cc_recipients | array | Não | Lista de destinatários CC; substitui todos os existentes. |
user_id | string | Não | UPN do usuário ou me para o usuário autenticado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |