Documentação

Appointment

Informações relacionadas ao agendamento realizado.

Campo
Tipo
Descrição

id

string

ID único do agendamento.

status

string

Status atual do agendamento. Ex: "Confirmed", "Cancelled", "Rescheduled".

start_time

objeto

Horário de início do agendamento.

end_time

objeto

Horário de término do agendamento.

created_at

objeto

Data e hora da criação do agendamento.

updated_at

objeto

Última data e hora em que o agendamento foi atualizado.

cancel_url

string

URL para o cliente cancelar o agendamento.

reschedule_url

string

URL para o cliente reagendar.

reason_cancel

string

Motivo do cancelamento (preenchido se o status for cancelado).

location

string

Pode ser um endereço físico, ou um link de reunião (como Google Meet, Zoom, etc.)

utm_params

objeto

Informações de rastreamento de marketing (UTM).

Subcampos de tempo (start_time, end_time, etc):

Campo
Tipo
Descrição

iso

string

Data/hora no formato ISO 8601 (UTC).

date

string

Data no formato DD/MM/AAAA.

time

string

Horário no formato HH:mm.


Client

Informações sobre o cliente que realizou o agendamento.

Campo
Tipo
Descrição

id

string

ID único do cliente.

full_name

string

Nome completo do cliente.

first_name

string

Primeiro nome.

last_name

string

Sobrenome.

email

string

E-mail do cliente.

phone

string

Telefone no formato internacional (+55).

utm_params

objeto

Parâmetros de rastreamento UTM.


Professional

Informações sobre o profissional com quem o agendamento foi feito.

Campo
Tipo
Descrição

id

string

ID único do profissional.

full_name

string

Nome completo.

first_name

string

Primeiro nome.

last_name

string

Sobrenome.

email

string

E-mail profissional.

phone

string

Telefone profissional.


Service

Informações sobre o serviço agendado.

Campo
Tipo
Descrição

id

string

ID único do serviço.

service_type

string

Tipo de serviço. Ex: "in-person", "google-meet", "zoom-video".

name

string

Nome do serviço.

description

string

Descrição do serviço.

duration_minutes

string

Duração do serviço (em minutos).

price

string

Preço do serviço.

currency

string

Moeda (ex: "BRL" para real brasileiro).

Atualizado

Isto foi útil?