# 📅 Agendamentos e Lembretes

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

> AppointmentCreate

```json
{"openapi":"3.0.0","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"📅 Agendamentos e Lembretes"}],"servers":[{"url":"https://{{baseurl}}"},{"url":"https://{{BaseUrl}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/appointment/create":{"post":{"tags":["📅 Agendamentos e Lembretes"],"summary":"AppointmentCreate","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"contactId":{"type":"string"},"startAt":{"type":"string"},"endAt":{"type":"string"},"status":{"type":"string"}}}}}},"parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

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

> AppointmentDelete

```json
{"openapi":"3.0.0","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"📅 Agendamentos e Lembretes"}],"servers":[{"url":"https://{{baseurl}}"},{"url":"https://{{BaseUrl}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/appointment/delete/{id}":{"post":{"tags":["📅 Agendamentos e Lembretes"],"summary":"AppointmentDelete","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true},{"name":"id","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

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

> AppointmentList

```json
{"openapi":"3.0.0","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"📅 Agendamentos e Lembretes"}],"servers":[{"url":"https://{{baseurl}}"},{"url":"https://{{BaseUrl}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/appointment/list":{"get":{"tags":["📅 Agendamentos e Lembretes"],"summary":"AppointmentList","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"limit","in":"query","schema":{"type":"integer"}},{"name":"status","in":"query","schema":{"type":"string"}},{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

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

> AppointmentShow

```json
{"openapi":"3.0.0","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"📅 Agendamentos e Lembretes"}],"servers":[{"url":"https://{{baseurl}}"},{"url":"https://{{BaseUrl}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/appointment/show/{id}":{"get":{"tags":["📅 Agendamentos e Lembretes"],"summary":"AppointmentShow","parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true},{"name":"id","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

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

> AppointmentUpdate

```json
{"openapi":"3.0.0","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"📅 Agendamentos e Lembretes"}],"servers":[{"url":"https://{{baseurl}}"},{"url":"https://{{BaseUrl}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/appointment/update/{id}":{"post":{"tags":["📅 Agendamentos e Lembretes"],"summary":"AppointmentUpdate","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"notes":{"type":"string"}}}}}},"parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true},{"name":"id","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

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

> ScheduleReminderCreate

```json
{"openapi":"3.0.0","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"📅 Agendamentos e Lembretes"}],"servers":[{"url":"https://{{baseurl}}"},{"url":"https://{{BaseUrl}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/scheduleReminder/create":{"post":{"tags":["📅 Agendamentos e Lembretes"],"summary":"ScheduleReminderCreate","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"hoursBeforeEvent":{"type":"number"},"messageType":{"type":"string"},"messageContent":{"type":"string"},"active":{"type":"boolean"}}}}}},"parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

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

> ScheduleReminderDelete

```json
{"openapi":"3.0.0","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"📅 Agendamentos e Lembretes"}],"servers":[{"url":"https://{{baseurl}}"},{"url":"https://{{BaseUrl}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/scheduleReminder/delete/{id}":{"post":{"tags":["📅 Agendamentos e Lembretes"],"summary":"ScheduleReminderDelete","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true},{"name":"id","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

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

> ScheduleReminderList

```json
{"openapi":"3.0.0","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"📅 Agendamentos e Lembretes"}],"servers":[{"url":"https://{{baseurl}}"},{"url":"https://{{BaseUrl}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/scheduleReminder/list":{"get":{"tags":["📅 Agendamentos e Lembretes"],"summary":"ScheduleReminderList","parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

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

> ScheduleReminderToggle

```json
{"openapi":"3.0.0","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"📅 Agendamentos e Lembretes"}],"servers":[{"url":"https://{{baseurl}}"},{"url":"https://{{BaseUrl}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/scheduleReminder/toggle/{id}":{"post":{"tags":["📅 Agendamentos e Lembretes"],"summary":"ScheduleReminderToggle","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true},{"name":"id","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

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

> ScheduleReminderUpdate

```json
{"openapi":"3.0.0","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"📅 Agendamentos e Lembretes"}],"servers":[{"url":"https://{{baseurl}}"},{"url":"https://{{BaseUrl}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/scheduleReminder/update/{id}":{"post":{"tags":["📅 Agendamentos e Lembretes"],"summary":"ScheduleReminderUpdate","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"hoursBeforeEvent":{"type":"number"}}}}}},"parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true},{"name":"id","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://ajuda.zdg.com.br/central-do-assinante/referencia-da-api/agendamentos-e-lembretes.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.