Update Patient — PATCH /patients/{id}

The Update Patient endpoint performs a partial update on an existing patient record. You only need to include the fields you want to change — any field omitted from the request body is left untouched. On success, the API returns the complete updated patient object. The updated_at timestamp is automatically refreshed to the current UTC time.

Endpoint

PATCH https://api.bydoctor.com.br/v1/patients/{id}

Authentication

Authorization: Bearer YOUR_API_KEY

Path Parameters

string

required

The UUID of the patient record you want to update.

Request Body

Send a JSON body with Content-Type: application/json containing only the fields you wish to update. All body fields are optional.

string

Patient’s full name. Must be between 2 and 255 characters.

string

Contact phone number in E.164 format, e.g. +5511999999999. Pass null to remove a previously stored phone number.

string

Patient’s email address. Pass null to remove a previously stored email.

string

Brazilian individual taxpayer identifier in the format 123.456.789-00. The CPF is re-validated for correct format and check digits. Pass null to remove a previously stored CPF.

string

Date of birth in YYYY-MM-DD format. The date must be in the past.

string

Name of the patient’s health insurance plan. Pass null to clear the field.

Updating a patient’s cpf will fail with a 409 Conflict error if another patient record in your clinic already holds the same CPF value. Resolve the conflict by first checking whether the CPF belongs to a duplicate profile that should be merged or deleted before retrying the update.

Response Fields (200 OK)

string

required

UUID of the patient record.

string

required

Identifier of the clinic this patient belongs to.

string

required

Patient’s full name after the update.

string

CPF after the update, or null if not set.

string

Phone number after the update, or null if not set.

string

Email address after the update, or null if not set.

string

Date of birth after the update, or null if not set.

string

Health plan name after the update, or null if not set.

boolean

required

Current WhatsApp opt-out status. This field is managed by the patient consent flow and cannot be overridden via this endpoint.

string

required

ISO 8601 UTC timestamp of when the patient record was originally created. Unchanged by updates.

string

required

ISO 8601 UTC timestamp reflecting the moment this update was applied.

Error Responses

Status	Code	Description
`400 Bad Request`	`invalid_cpf_format`	The `cpf` value does not match the expected format or fails check-digit validation.
`401 Unauthorized`	`unauthorized`	Your API key is missing or invalid.
`404 Not Found`	`patient_not_found`	No patient with the given UUID exists in your clinic.
`409 Conflict`	`cpf_already_exists`	Another patient in your clinic already has the same CPF.

Example Request

curl --request PATCH \
  --url "https://api.bydoctor.com.br/v1/patients/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "phone": "+5511911112222",
    "health_plan": "SulAmérica"
  }'

Example Response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "clinic_id": "clinic_01HXZ9QWERTY",
  "name": "Ana Paula Ferreira",
  "cpf": "321.654.987-00",
  "phone": "+5511911112222",
  "email": "ana.ferreira@email.com",
  "date_of_birth": "1990-03-15",
  "health_plan": "SulAmérica",
  "whatsapp_opt_out": false,
  "created_at": "2024-06-01T10:22:00Z",
  "updated_at": "2025-01-20T15:30:00Z"
}

Appointments

Patients

Schedules & Availability

Payments

Webhooks

Update Patient — PATCH /patients/{id} | ByDoctor API

Endpoint

Authentication

Path Parameters

Request Body

Response Fields (200 OK)

Error Responses

Example Request

Example Response

​Endpoint

​Authentication

​Path Parameters

​Request Body

​Response Fields (200 OK)

​Error Responses

​Example Request

​Example Response

Endpoint

Authentication

Path Parameters

Request Body

Response Fields (200 OK)

Error Responses

Example Request

Example Response