📅 Agendamentos e Lembretes

AppointmentCreate

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/appointment/create

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

titlestringOpcional

descriptionstringOpcional

contactIdstringOpcional

startAtstringOpcional

endAtstringOpcional

statusstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/appointment/create

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/appointment/create HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 189

{
  "title": "Reunião de Vendas",
  "description": "Reunião sobre proposta",
  "contactId": "{{contactId}}",
  "startAt": "2026-04-15T14:00:00.000Z",
  "endAt": "2026-04-15T15:00:00.000Z",
  "status": "pending"
}

200

Successful response

AppointmentDelete

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/appointment/delete/{id}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

idstringObrigatório

Corpo

application/json

objectOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/appointment/delete/{id}

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/appointment/delete/{id} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

Successful response

AppointmentList

get

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/appointment/list

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Parâmetros de consulta

pageintegerOpcionalExample: 1

limitintegerOpcionalExample: 20

statusstringOpcionalExample: pending

Respostas

200

Successful response

application/json

get/v2/api/external/{ApiID}/appointment/list

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/appointment/list HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

AppointmentShow

get

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/appointment/show/{id}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

idstringObrigatório

Respostas

200

Successful response

application/json

get/v2/api/external/{ApiID}/appointment/show/{id}

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/appointment/show/{id} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

AppointmentUpdate

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/appointment/update/{id}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

idstringObrigatório

Corpo

application/json

statusstringOpcional

notesstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/appointment/update/{id}

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/appointment/update/{id} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "status": "confirmed",
  "notes": "Cliente confirmou presença"
}

200

Successful response

ScheduleReminderCreate

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/scheduleReminder/create

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

namestringOpcional

hoursBeforeEventnumberOpcional

messageTypestringOpcional

messageContentstringOpcional

activebooleanOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/scheduleReminder/create

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/scheduleReminder/create HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 155

{
  "name": "Lembrete 24h antes",
  "hoursBeforeEvent": 24,
  "messageType": "message",
  "messageContent": "Olá {nome}, lembrete da sua reunião amanhã!",
  "active": true
}

200

Successful response

ScheduleReminderDelete

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/scheduleReminder/delete/{id}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

idstringObrigatório

Corpo

application/json

objectOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/scheduleReminder/delete/{id}

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/scheduleReminder/delete/{id} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

Successful response

ScheduleReminderList

get

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/scheduleReminder/list

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Respostas

200

Successful response

application/json

get/v2/api/external/{ApiID}/scheduleReminder/list

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/scheduleReminder/list HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

ScheduleReminderToggle

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/scheduleReminder/toggle/{id}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

idstringObrigatório

Corpo

application/json

objectOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/scheduleReminder/toggle/{id}

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/scheduleReminder/toggle/{id} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

Successful response

ScheduleReminderUpdate

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/scheduleReminder/update/{id}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

idstringObrigatório

Corpo

application/json

namestringOpcional

hoursBeforeEventnumberOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/scheduleReminder/update/{id}

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/scheduleReminder/update/{id} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "name": "Lembrete 48h antes",
  "hoursBeforeEvent": 48
}

200

Successful response