API de Calendário e Agendamentos
Como consultar horários disponíveis e criar agendamentos no módulo de Calendário do Omnifox via API.
O módulo de Calendário permite agendar compromissos (reuniões, demos, atendimentos) vinculados a um contato, um agente e, opcionalmente, uma conversa ou uma oportunidade do CRM. A API expõe o mesmo mecanismo usado pelos links públicos de agendamento.
Requisitos
- Token Bearer do workspace.
- Um
calendar_idexistente (GET /api/v1/calendar/calendars) e, se aplicável, umservice_id(GET /api/v1/calendar/services).
Endpoints principais
GET/POST /api/v1/calendar/calendars— calendários do workspace (um por agente ou recurso).GET/POST /api/v1/calendar/services— tipos de serviço/duração (ex.: "Demo de 30 min").GET /api/v1/calendar/slots— horários disponíveis para um calendário/serviço em um intervalo de datas.GET/POST /api/v1/calendar/appointments— listar ou criar agendamentos.PUT /api/v1/calendar/appointments/{id}— remarcar.POST /api/v1/calendar/appointments/{id}/cancel— cancelar.GET/POST /api/v1/calendar/booking-links— links públicos de autoagendamento.
Campos para criar um agendamento
{
"calendar_id": 3,
"service_id": 7,
"contact_id": 55,
"starts_at": "2026-07-20T15:00:00-05:00",
"ends_at": "2026-07-20T15:30:00-05:00",
"title": "Demo do Omnifox",
"notes": "Cliente interessado no módulo de CRM"
}
Apenas calendar_id e starts_at são obrigatórios; se enviar service_id, a duração é calculada automaticamente.
Exemplo: consultar horários livres antes de agendar
curl -X GET "https://app.omnifox.io/api/v1/calendar/slots?calendar_id=3&service_id=7&from=2026-07-20&to=2026-07-22" \
-H "Authorization: Bearer SEU_TOKEN"
Dicas
- Sempre consulte
/slotsantes dePOST /appointmentspara evitar choques de horário; o endpoint de criação também valida a disponibilidade no servidor. - Vincule
deal_idouconversation_idao agendamento para que fique registrado no histórico do contato e na linha do tempo do CRM.
Solução de problemas
- 422 ao criar o agendamento: o intervalo
starts_at/ends_atse sobrepõe a outro compromisso do mesmo calendário. - O horário parecia livre mas a criação falhou: pode ter sido reservado entre a consulta e o envio; consulte
/slotsnovamente. - O agendamento não mostra o contato: confirme que
contact_idpertence ao workspace correto.
Artigos relacionados
-
Como conectar integrações e apps externos
Conecte o Omnifox às suas ferramentas favoritas a partir do catálogo de integrações em poucos passos.
-
Gerar e usar API keys e webhooks
Crie chaves de API para acessar o Omnifox por código e configure webhooks para receber eventos em tempo real.
-
Introdução às integrações (webhook / OAuth / chave de API)
Conecte o Omnifox às suas outras ferramentas. Aprenda quando usar um webhook, uma conexão OAuth da galeria ou uma chave de API.
-
A API REST do Omnifox: introdução e requisitos de plano
O que é a API REST do Omnifox, qual plano você precisa (a partir do Crece), como autenticar com o cabeçalho X-API-Key e onde fica a documentação.
-
Criar uma chave de API pessoal (PAT)
Saiba como gerar sua primeira chave de API pessoal no Omnifox para conectar integracoes, scripts ou ferramentas externas ao seu workspace.