Servicos
Catalogo de servicos agendalveis. Cada servico define duracao, preco padrao e templates de lembrete automatico que sao materializados no momento do agendamento.
Feature Flag
Requer appointments_module habilitado na conta.
Templates de Lembrete
Cada servico pode ter N templates de lembrete configurados (ex: "1 dia antes", "3 horas antes"). Ao criar um atendimento, esses templates sao materializados em appointment_reminders e enviados automaticamente via WhatsApp.
Os templates suportam variaveis Liquid: {{paciente}}, {{profissional}}, {{servico}}, {{data}}, {{hora}}, {{valor}}, {{empresa}}.
/api/v1/accounts/{account_id}/servicesLista todos os servicos do catalogo. Qualquer membro da conta pode visualizar.
Parametros de Query
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
active(query) | boolean | Nao | Filtrar por status ativo (default true) |
online_available(query) | boolean | Nao | Filtrar por disponibilidade no widget publico |
page(query) | integer | Nao | Pagina (padrao 1) |
curl -s "https://chat.seudominio.com/api/v1/accounts/1/services" \
-H "api_access_token: YOUR_TOKEN" | jq .{
"data": [
{
"id": 7,
"name": "Limpeza Dental",
"description": "Profilaxia e polimento dental completo.",
"duration_minutes": 60,
"default_price_cents": 20000,
"currency": "BRL",
"color": "#10B981",
"online_available": true,
"active": true
}
]
}/api/v1/accounts/{account_id}/servicesCria novo servico no catalogo. Apenas administradores.
Body (service)
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
name | string | Sim | Nome do servico |
duration_minutes | integer | Sim | Duracao em minutos (minimo 1) |
description | string | Nao | Descricao do servico |
default_price_cents | integer | Nao | Preco padrao em centavos (padrao 0) |
currency | string | Nao | Moeda (3 letras, padrao BRL) |
color | string | Nao | Cor hex para o calendario |
online_available | boolean | Nao | Disponivel no widget publico (padrao true) |
curl -X POST "https://chat.seudominio.com/api/v1/accounts/1/services" \
-H "api_access_token: YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"service": {
"name": "Clareamento Dental",
"duration_minutes": 90,
"default_price_cents": 45000,
"currency": "BRL",
"online_available": true
}
}'{ "data": { "id": 8, "name": "Clareamento Dental", "duration_minutes": 90 } }/api/v1/accounts/{account_id}/services/{id}Retorna detalhes de um servico incluindo templates de lembrete.
curl -s "https://chat.seudominio.com/api/v1/accounts/1/services/7" \
-H "api_access_token: YOUR_TOKEN" | jq ./api/v1/accounts/{account_id}/services/{id}Atualiza dados do servico. Apenas administradores.
curl -X PATCH "https://chat.seudominio.com/api/v1/accounts/1/services/7" \
-H "api_access_token: YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "service": { "duration_minutes": 75, "default_price_cents": 22000 } }'/api/v1/accounts/{account_id}/services/{id}Remove o servico (soft-delete). Historico de atendimentos e preservado. Apenas administradores.
curl -X DELETE "https://chat.seudominio.com/api/v1/accounts/1/services/7" \
-H "api_access_token: YOUR_TOKEN"Templates de Lembrete
Configure os lembretes automaticos que serao materializados ao agendar um atendimento. Apenas administradores podem criar, atualizar ou remover templates.
/api/v1/accounts/{account_id}/services/{id}/reminder_templatesLista todos os templates de lembrete do servico.
curl -s "https://chat.seudominio.com/api/v1/accounts/1/services/7/reminder_templates" \
-H "api_access_token: YOUR_TOKEN" | jq .{
"data": [
{
"id": 5,
"label": "1 dia antes",
"days_before": 1,
"hours_before": 0,
"minutes_before": 0,
"body_template": "Ola {{paciente}}, lembrando do seu {{servico}} com {{profissional}} amanha as {{hora}}.",
"send_via": "whatsapp",
"active": true
}
]
}/api/v1/accounts/{account_id}/services/{id}/reminder_templatesCria novo template de lembrete. Ao menos um dos campos days_before, hours_before ou minutes_before deve ser > 0.
Body (reminder_template)
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
body_template | string | Sim | Corpo do lembrete com variaveis Liquid |
label | string | Nao | Label descritivo (ex: 1 dia antes) |
days_before | integer | Nao | Dias antes do atendimento (padrao 0) |
hours_before | integer | Nao | Horas antes do atendimento (padrao 0) |
minutes_before | integer | Nao | Minutos antes do atendimento (padrao 0) |
send_via | string | Nao | Canal: whatsapp | email | sms (padrao whatsapp) |
whatsapp_template_id | integer | Nao | ID do template Meta aprovado (Fase 1.6) |
curl -X POST "https://chat.seudominio.com/api/v1/accounts/1/services/7/reminder_templates" \
-H "api_access_token: YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"reminder_template": {
"label": "3 horas antes",
"hours_before": 3,
"body_template": "Ola {{paciente}}! Seu {{servico}} com {{profissional}} e hoje as {{hora}}. Clinica: {{empresa}}",
"send_via": "whatsapp"
}
}'/api/v1/accounts/{account_id}/services/{id}/reminder_templates/{rid}Atualiza um template de lembrete existente.
curl -X PATCH "https://chat.seudominio.com/api/v1/accounts/1/services/7/reminder_templates/5" \
-H "api_access_token: YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "reminder_template": { "active": false } }'/api/v1/accounts/{account_id}/services/{id}/reminder_templates/{rid}Remove o template de lembrete. Lembretes ja materializados em atendimentos nao sao afetados.
curl -X DELETE "https://chat.seudominio.com/api/v1/accounts/1/services/7/reminder_templates/5" \
-H "api_access_token: YOUR_TOKEN"