For the complete documentation index, see llms.txt. This page is also available as Markdown.

📅 Agendamentos E Lembretes

AppointmentCreate

post
Autorizações
AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota
apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo
titlestringOpcionalExample: Reunião de Vendas
descriptionstringOpcionalExample: Reunião sobre proposta comercial
contactIdstringOpcionalExample: {{contactId}}
contactNamestringOpcionalExample: João Silva
contactPhonestringOpcionalExample: 5511999999999
whatsappIdstringOpcionalExample: {{whatsappId}}
startAtstringOpcionalExample: 2026-04-15T14:00:00.000Z
endAtstringOpcionalExample: 2026-04-15T15:00:00.000Z
statusstringOpcionalExample: pending
notesstringOpcionalExample: Levar proposta impressa
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
post/v2/api/external/{apiId}/appointment/create
POST /v2/api/external/{apiId}/appointment/create HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 322

{
  "title": "Reunião de Vendas",
  "description": "Reunião sobre proposta comercial",
  "contactId": "{{contactId}}",
  "contactName": "João Silva",
  "contactPhone": "5511999999999",
  "whatsappId": "{{whatsappId}}",
  "startAt": "2026-04-15T14:00:00.000Z",
  "endAt": "2026-04-15T15:00:00.000Z",
  "status": "pending",
  "notes": "Levar proposta impressa"
}
{}

AppointmentDelete

post
Autorizações
AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota
apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

idstringObrigatório

Identificador do recurso na rota.

Corpo
objectOpcional
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
post/v2/api/external/{apiId}/appointment/delete/{id}
POST /v2/api/external/{apiId}/appointment/delete/{id} HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{}

AppointmentList

get
Autorizações
AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota
apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Parâmetros de consulta
pageintegerOpcionalExample: 1
limitintegerOpcionalExample: 20
statusstringOpcional

pending | confirmed | cancelled | completed

Example: pending
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
get/v2/api/external/{apiId}/appointment/list
GET /v2/api/external/{apiId}/appointment/list HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{}

AppointmentShow

get
Autorizações
AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota
apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

idstringObrigatório

Identificador do recurso na rota.

Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
get/v2/api/external/{apiId}/appointment/show/{id}
GET /v2/api/external/{apiId}/appointment/show/{id} HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{}

AppointmentUpdate

post
Autorizações
AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota
apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

idstringObrigatório

Identificador do recurso na rota.

Corpo
titlestringOpcionalExample: Reunião de Vendas (atualizada)
descriptionstringOpcionalExample: Descrição atualizada
contactIdstringOpcionalExample: {{contactId}}
contactNamestringOpcionalExample: João Silva
contactPhonestringOpcionalExample: 5511999999999
whatsappIdstringOpcionalExample: {{whatsappId}}
startAtstringOpcionalExample: 2026-04-15T15:00:00.000Z
endAtstringOpcionalExample: 2026-04-15T16:00:00.000Z
statusstringOpcionalExample: confirmed
notesstringOpcionalExample: Cliente confirmou presença
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
post/v2/api/external/{apiId}/appointment/update/{id}
POST /v2/api/external/{apiId}/appointment/update/{id} HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 330

{
  "title": "Reunião de Vendas (atualizada)",
  "description": "Descrição atualizada",
  "contactId": "{{contactId}}",
  "contactName": "João Silva",
  "contactPhone": "5511999999999",
  "whatsappId": "{{whatsappId}}",
  "startAt": "2026-04-15T15:00:00.000Z",
  "endAt": "2026-04-15T16:00:00.000Z",
  "status": "confirmed",
  "notes": "Cliente confirmou presença"
}
{}

ScheduleReminderCreate

post
Autorizações
AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota
apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo
namestringOpcionalExample: Lembrete 24h antes
descriptionstringOpcionalExample: Envia mensagem ao contato 24h antes do agendamento
hoursBeforeEventintegerOpcionalExample: 24
messageTypestringOpcionalExample: message
messageContentstringOpcionalExample: Olá {{nome}}, lembrete da sua reunião amanhã!
whatsappIdstringOpcionalExample: {{whatsappId}}
activebooleanOpcionalExample: true
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
post/v2/api/external/{apiId}/scheduleReminder/create
POST /v2/api/external/{apiId}/scheduleReminder/create HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 254

{
  "name": "Lembrete 24h antes",
  "description": "Envia mensagem ao contato 24h antes do agendamento",
  "hoursBeforeEvent": 24,
  "messageType": "message",
  "messageContent": "Olá {{nome}}, lembrete da sua reunião amanhã!",
  "whatsappId": "{{whatsappId}}",
  "active": true
}
{}

ScheduleReminderDelete

post
Autorizações
AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota
apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

idstringObrigatório

Identificador do recurso na rota.

Corpo
objectOpcional
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
post/v2/api/external/{apiId}/scheduleReminder/delete/{id}
POST /v2/api/external/{apiId}/scheduleReminder/delete/{id} HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{}

ScheduleReminderList

get
Autorizações
AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota
apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
get/v2/api/external/{apiId}/scheduleReminder/list
GET /v2/api/external/{apiId}/scheduleReminder/list HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{}

ScheduleReminderToggle

post
Autorizações
AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota
apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

idstringObrigatório

Identificador do recurso na rota.

Corpo
objectOpcional
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
post/v2/api/external/{apiId}/scheduleReminder/toggle/{id}
POST /v2/api/external/{apiId}/scheduleReminder/toggle/{id} HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{}

ScheduleReminderUpdate

post
Autorizações
AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota
apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

idstringObrigatório

Identificador do recurso na rota.

Corpo
namestringOpcionalExample: Lembrete 48h antes
descriptionstringOpcionalExample: Envia mensagem 48h antes do evento
hoursBeforeEventintegerOpcionalExample: 48
messageTypestringOpcionalExample: message
messageContentstringOpcionalExample: Olá {{nome}}, sua reunião é em 2 dias!
whatsappIdstringOpcionalExample: {{whatsappId}}
activebooleanOpcionalExample: true
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
post/v2/api/external/{apiId}/scheduleReminder/update/{id}
POST /v2/api/external/{apiId}/scheduleReminder/update/{id} HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 231

{
  "name": "Lembrete 48h antes",
  "description": "Envia mensagem 48h antes do evento",
  "hoursBeforeEvent": 48,
  "messageType": "message",
  "messageContent": "Olá {{nome}}, sua reunião é em 2 dias!",
  "whatsappId": "{{whatsappId}}",
  "active": true
}
{}

Atualizado

Isto foi útil?