Cancelar evento agendado no Calendly, por uma API
Cancela uma reunião agendada para todos os convidados e retorna o cancelamento. Um evento em grupo é cancelado por inteiro: não dá para cancelar um só convidado de um evento em grupo pela API.
- Identificador
- calendly_cancel_scheduled_event
A chamada
POST https://connect.reportei.com/api/tools/calendly_cancel_scheduled_event/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"uuid": "<uuid>"
}
}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 |
|---|---|---|---|
| uuid | string | Sim | UUID of the scheduled event: the last segment of its uri, from List scheduled events. |
| reason | string | Não | Reason for the cancellation. |
Conexões possíveis
O seu cliente conecta a conta do Calendly 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/calendly, 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/calendly_cancel_scheduled_event. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Calendly
- Obter usuário atualGETRetorna o usuário Calendly conectado: uri, a URI do usuário que Listar tipos de evento, Listar eventos agendados e Criar tipo de evento pedem, e current_organization, a URI da organização, com name, email, scheduling_url e timezone.
- Listar tipos de eventoGETLista os tipos de evento de um usuário ou de uma organização: envie user ou organization. Cada item tem uri, name, duration em minutos, scheduling_url e active. A resposta tem collection e pagination: passe pagination.next_page_token como page_token para ler a próxima página.
- Obter tipo de eventoGETRetorna um tipo de evento, com name, duration em minutos, duration_options, locations, custom_questions (as perguntas de agendamento que Criar convidado do evento responde), scheduling_url e active.
- Criar tipo de eventoPOSTCria um tipo de evento individual (one-on-one) para um usuário e o retorna. Só esse tipo (solo) pode ser criado pela API, e ele nasce inativo, a menos que active seja true.
- Atualizar tipo de eventoPATCHAtualiza um tipo de evento individual e o retorna. Só os campos enviados mudam. Só tipos de evento do tipo solo podem ser atualizados pela API.
- Listar horários livres do tipo de eventoGETLista os horários de início livres de um tipo de evento em um intervalo de até 31 dias no futuro. Cada item tem start_time em UTC, invitees_remaining e scheduling_url. Não há paginação: peça um intervalo menor quando precisar.
- Listar eventos agendadosGETLista as reuniões agendadas de um usuário ou de uma organização: envie user ou organization. Cada item tem uri, name, status, start_time e end_time em UTC, event_type e invitees_counter. A resposta tem collection e pagination: passe pagination.next_page_token como page_token para ler a próxima página.
- Obter evento agendadoGETRetorna uma reunião agendada, com name, status, start_time e end_time em UTC, event_type, location, invitees_counter, event_memberships (os anfitriões) e, se foi cancelada, cancellation.
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.
