Pular para o conteúdo
Agenda

Agendar reunião

v1.0.0
POSThttps://api.staging.growthaisystem.com/api/v1/appointments
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escoposcalendars.write

Fluxo: chame GET /calendars/:id/slots, pegue um horário livre e passe seu startAt + assigneeUserId (o vendedor que a distribuição resolveu) aqui. endAt ausente = startAt + duração da agenda. A trava anti-double-booking e o teto por dia valem — horário ocupado ou acima do teto responde 400/409/422. Aceita Idempotency-Key.

Corpo da requisição

application/jsonobrigatório
  • calendarIdstringobrigatório
    • tamanho mín. 1
  • contactIdstringobrigatório
    • tamanho mín. 1
  • opportunityIdstring | nullopcional
  • startAtstring (date-time)obrigatório
    • regex "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579]…
  • endAtstring (date-time) | nullopcional
    • regex "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579]…
  • assigneeUserIdstringobrigatório
    • tamanho mín. 1
  • titlestringopcional
    • tamanho 1–200
  • locationstring | nullopcional
    • tamanho máx. 500
  • withConferencebooleanopcional

Respostas

12 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

A Idempotency-Key repetiu um agendamento anterior: devolve a MESMA reunião, com idempotency_replay: true. Nenhum horário novo foi ocupado.

V1AppointmentCriada

  • idstring
  • startAtstring | null
  • endAtstring | null
  • assigneeUserIdstring | null
  • conferenceUrlstring | null
  • calendarKeystring | null
  • idempotency_replaybooleanpode faltar

    Só presente (e sempre true) quando a Idempotency-Key repetiu um agendamento anterior.