---
title: "Update a referral"
method: PUT
path: "/referrals/{referralId}"
tags: ["referrals"]
---

# Update a referral

`PUT /referrals/{referralId}`

## Path parameters

- `referralId` string, required

## Request body

- Referral — A Referral tracks a patient being referred to a provider or facility for care, following the referral from creation through outreach, scheduling, and completion. It captures the referring and schedulable providers, status and status reason, scheduling window, and any related fax, upload, or appointment records used in referral management workflows.
  - `_id` string — Luma's internal ID of an object.
  - `user` string — The ID of the root account user.
  - `deleted` 0 | 1 — Flag for logical deletion where 1 means deleted.
  - `createdBy` string — The ID of the user who created this object.
  - `updatedBy` string — The ID of the user who updated this object.
  - `createdAt` string, date-time — The date/time when this object was created.
  - `updatedAt` string, date-time — The date/time when this object was updated.
  - `name` string
  - `facility` string
  - `provider` string
  - `patient` string
  - `referringProviderId` string
  - `referringProvider` string
  - `duration` number
  - `statusReason` 'patient-cancelled' | 'invalid-insurance' | 'missing-data' | 'other'
  - `statusReasonDescription` string
  - `source` 'upload' | 'patient-referral-form' | 'ui' | 'integrator' | 'followup' | 'manual'
  - `status` 'active' | 'called' | 'called-late' | 'scheduled' | 'scheduled-late' | 'incomplete' | 'expired' | 'cancelled' | 'pending' | 'closed'
  - `startOn` string, date-time
  - `expireAt` string, date-time
  - `attempt` number
  - `lastAttemptSentAt` string, date-time
  - `calledAt` string, date-time
  - `acceptedAt` string, date-time
  - `scheduledAt` string, date-time
  - `notes` string
  - `customerNotes` string
  - `appointmentType` string
  - `reason` string
  - `departmentOrFacility` string
  - `scheduledByAppointment` string
  - `scheduledByOffer` string
  - `processedReferralFollowup` 'pending' | 'skipped' | 'failed' | 'success'
  - `upload` string
  - `faxUpload` string
  - `faxSentAt` string, date-time
  - `scheduleStartOn` string, date-time
  - `referringProviderFaxNumberOverride` string

## Response `200`

Updated referral

- Referral — A Referral tracks a patient being referred to a provider or facility for care, following the referral from creation through outreach, scheduling, and completion. It captures the referring and schedulable providers, status and status reason, scheduling window, and any related fax, upload, or appointment records used in referral management workflows.
  - `_id` string — Luma's internal ID of an object.
  - `user` string — The ID of the root account user.
  - `deleted` 0 | 1 — Flag for logical deletion where 1 means deleted.
  - `createdBy` string — The ID of the user who created this object.
  - `updatedBy` string — The ID of the user who updated this object.
  - `createdAt` string, date-time — The date/time when this object was created.
  - `updatedAt` string, date-time — The date/time when this object was updated.
  - `name` string
  - `facility` string
  - `provider` string
  - `patient` string
  - `referringProviderId` string
  - `referringProvider` string
  - `duration` number
  - `statusReason` 'patient-cancelled' | 'invalid-insurance' | 'missing-data' | 'other'
  - `statusReasonDescription` string
  - `source` 'upload' | 'patient-referral-form' | 'ui' | 'integrator' | 'followup' | 'manual'
  - `status` 'active' | 'called' | 'called-late' | 'scheduled' | 'scheduled-late' | 'incomplete' | 'expired' | 'cancelled' | 'pending' | 'closed'
  - `startOn` string, date-time
  - `expireAt` string, date-time
  - `attempt` number
  - `lastAttemptSentAt` string, date-time
  - `calledAt` string, date-time
  - `acceptedAt` string, date-time
  - `scheduledAt` string, date-time
  - `notes` string
  - `customerNotes` string
  - `appointmentType` string
  - `reason` string
  - `departmentOrFacility` string
  - `scheduledByAppointment` string
  - `scheduledByOffer` string
  - `processedReferralFollowup` 'pending' | 'skipped' | 'failed' | 'success'
  - `upload` string
  - `faxUpload` string
  - `faxSentAt` string, date-time
  - `scheduleStartOn` string, date-time
  - `referringProviderFaxNumberOverride` string

## Other responses

- `401` — Not authenticated
- `403` — Access token does not have the required scope

---

[API](https://skmtc.net/lumahealth/apis/rest-service.md) · [All operations](https://skmtc.net/lumahealth/apis/rest-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lumahealth/rest-service/revisions/d3c75c2a2f1d/schema)