Tools do Calendly
As 12 operações do Calendly que o seu produto executa na conta do cliente pelo Connect. Todas usam o mesmo endpoint, POST /api/tools/{tool}/execute.
- 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.
- Cancelar evento agendadoPOSTCancela 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.
- Listar convidados do eventoGETLista os convidados de uma reunião agendada, com name, email, status, questions_and_answers, tracking (os parâmetros UTM do agendamento), no_show, cancel_url e reschedule_url. A resposta tem collection e pagination: passe pagination.next_page_token como page_token para ler a próxima página.
- Criar convidado do eventoPOSTAgenda uma reunião em um horário livre de um tipo de evento e retorna o convidado, com event (a URI do evento agendado), cancel_url e reschedule_url. O Calendly envia as confirmações e convites de calendário como quando o convidado agenda na página de agendamento. Só usuários de plano pago podem agendar pela API: o plano Free recebe 403.
- Criar link de agendamentoPOSTCria um link de agendamento de uso único para um tipo de evento e retorna seu booking_url, para enviar a uma só pessoa. O link vale para um agendamento, e um link não usado expira em 90 dias.
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.
