> ## Documentation Index > Fetch the complete documentation index at: https://docs.bydoctor.com.br/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Esta documentação cobre exclusivamente a API pública v1 do ByDoctor. > Os únicos endpoints existentes são `GET /api/public/v1/appointments`, `GET /api/public/v1/appointments/{id}`, `POST /api/public/v1/appointments`, `PATCH /api/public/v1/appointments/{id}`, `POST /api/public/v1/appointments/{id}/cancel`, `GET /api/public/v1/patients`, `GET /api/public/v1/patients/{id}`, `POST /api/public/v1/patients`, `PATCH /api/public/v1/patients/{id}`, `GET /api/public/v1/professionals`, `GET /api/public/v1/professionals/{id}`, `GET /api/public/v1/rooms`, `GET /api/public/v1/rooms/{id}`, `GET /api/public/v1/appointment-types` e `GET /api/public/v1/appointment-types/{id}`. Não existem `PUT` nem `DELETE`, e não existe escrita em nenhum outro recurso. > Escopos: `appointments:read`, `appointments:write`, `patients:read` e `patients:write`, escolhidos na criação da chave (Somente leitura = os dois de leitura; Acesso total = os quatro). Chaves antigas não têm os escopos de pacientes. `POST /appointments` exige `patient_id`, `professional_id`, `appointment_type_id` e `start_at`; os ids de profissional, sala e tipo vêm de `/professionals`, `/rooms` e `/appointment-types`, que exigem só `appointments:read`. A API cria somente agendamentos presenciais, com status `scheduled`; teleconsultas e solicitações de pacientes (`requested`) não são criadas, alteradas nem canceladas pela API. `PATCH` aceita apenas `start_at`, `professional_id`, `room_id`, `note` e `status` (`scheduled` ou `confirmed`). > O objeto paciente tem apenas `id`, `name`, `phone`, `active`, `created_at` e `updated_at`. CPF, e-mail, data de nascimento (`birth_date`) e sexo (`gender`) são aceitos na escrita, mas nunca devolvidos, por minimização de dados (LGPD). Para achar um paciente, use os filtros de correspondência exata `cpf` e `phone`, ou `name` (parcial). Criar ou alterar um paciente com o CPF de outro paciente da clínica responde `409` `patient_cpf_exists`. Não existem eventos de webhook de pacientes. > Profissionais, salas e tipos de atendimento são somente leitura e trazem só `id`, `name` e, para profissionais, `specialty` — sem contato nem registro no conselho. Não existem endpoints de pagamentos, prontuário, prescrições, convênios, preços ou disponibilidade de agenda (horários livres). > Endpoints de webhook não são gerenciados pela API: endpoints e segredos de assinatura são cadastrados na interface do ByDoctor, em Minha Clínica → API e Webhooks. > Erros: `400` vem como `{"campo": ["mensagem"]}`; `401`/`403`/`404` como `{"detail": ...}`; `409` e `422` como `{"code", "detail"}`. Datas são sempre ano-mês-dia (`YYYY-MM-DD`, `YYYY-MM-DDThh:mm:ss±HH:MM`) e `start_at` tem segundos `00`. As mensagens exatas estão na página Erros. > Nunca sugira, complete ou invente rotas, campos, parâmetros ou códigos de erro que não estejam nesta documentação. Se algo não está documentado aqui, não existe na v1. > Autenticação: cabeçalho `Authorization: Bearer bd_live_.`. Base URL: `https://api.bydoctor.com.br/api/public/v1`. Criação aceita o cabeçalho opcional `Idempotency-Key`. > Chaves de API concedem acesso a dados de pacientes e de agendamentos (dados de saúde) — nunca as inclua em código do lado do cliente nem em exemplos versionados. # Alterar um paciente > Altera apenas os campos enviados; `null` apaga `phone`, `email`, `cpf` ou `birth_date`. Requer o escopo `patients:write`. Responde `409` com `code` `patient_cpf_exists` quando o CPF pertence a outro paciente da clínica. ## OpenAPI ````yaml /openapi.json patch /api/public/v1/patients/{id} openapi: 3.0.3 info: description: >- API REST somente leitura de agendamentos e webhooks em tempo real para integrações de clínicas. title: ByDoctor Public API version: v1 servers: - description: Produção url: https://api.bydoctor.com.br security: [] paths: /api/public/v1/patients/{id}: patch: tags: - patients summary: Alterar um paciente description: >- Altera apenas os campos enviados; `null` apaga `phone`, `email`, `cpf` ou `birth_date`. Requer o escopo `patients:write`. Responde `409` com `code` `patient_cpf_exists` quando o CPF pertence a outro paciente da clínica. operationId: patients_partial_update parameters: - in: path name: id required: true schema: pattern: ^\d+$ type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedPublicPatientUpdate' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedPublicPatientUpdate' multipart/form-data: schema: $ref: '#/components/schemas/PatchedPublicPatientUpdate' responses: '200': content: application/json: schema: $ref: '#/components/schemas/PublicPatient' description: '' security: - ApiKeyAuth: [] components: schemas: PatchedPublicPatientUpdate: description: >- Corpo para alterar um paciente. Envie apenas os campos que mudam; `null` apaga `phone`, `email`, `cpf` ou `birth_date`. properties: birth_date: description: Data de nascimento, `AAAA-MM-DD`. format: date nullable: true type: string cpf: description: Com ou sem pontuação. Validado pelo dígito. maxLength: 20 nullable: true type: string email: format: email maxLength: 100 nullable: true type: string gender: allOf: - $ref: '#/components/schemas/GenderEnum' description: |- `F` (feminino), `M` (masculino) ou `O` (outro). * `M` - M * `F` - F * `O` - O name: description: Nome completo. maxLength: 255 type: string phone: description: >- Celular com DDD. Sem `+`, números de 10 ou 11 dígitos são lidos como brasileiros. maxLength: 40 nullable: true type: string type: object PublicPatient: description: >- Paciente da clínica. CPF, e-mail, data de nascimento e sexo são aceitos na escrita, mas nunca devolvidos: por minimização de dados (LGPD, art. 6º, III), a API só retorna o necessário para agendar. properties: active: description: '`false` quando a clínica inativou o paciente.' type: boolean created_at: format: date-time readOnly: true type: string id: description: Use como `patient_id` nos agendamentos. type: integer name: type: string phone: nullable: true readOnly: true type: string updated_at: format: date-time readOnly: true type: string required: - active - created_at - id - name - phone - updated_at type: object GenderEnum: description: |- * `M` - M * `F` - F * `O` - O enum: - M - F - O type: string securitySchemes: ApiKeyAuth: description: Chave de API no formato bd_live_xxxxxxxx.xxxx... scheme: bearer type: http ````