Skip to main content
PATCH
Update a receptionist task
Safety
  • Writes data: Yes. Changes the fields you send; the rest stay as they are.
  • Safe to retry: Yes. Sending the same change again leaves the task the same.
  • Contacts an outside system: None
  • Dry run: Not available.
Rolling out: this endpoint is on staging first and not yet on api.healos.ai.
Resolve a task with { "status": "done" }, or hide it from the default inbox view with archived. Send null to clear an optional field such as due_date or linked_call_id. The ids you link are checked the same way as on create. Guide: Calls and inbox. Errors: Error catalog.

Authorizations

X-API-Key
string
header
required

API key obtained from /api/v1/ext-api-keys

Path Parameters

taskId
string
required

Task identifier, from GET /receptionist/tasks.

Example:

"7a5c0000-0000-4000-8000-000000000001"

Body

application/json
title
string
Maximum string length: 500
Example:

"Call back about a refill request"

category
enum<string> | null

One of: action, communicate, coordinate, document, order, call_followup, billing, insurance, refill, records, referral, appointment.

Available options:
action,
communicate,
coordinate,
document,
order,
call_followup,
billing,
insurance,
refill,
records,
referral,
appointment
Example:

"refill"

status
enum<string>

todo (open), done (resolved) or archived (hidden from the default inbox view).

Available options:
todo,
done,
archived
Example:

"todo"

notes
string | null
Maximum string length: 10000
Example:

"Caller asked for a 90-day supply."

due_date
string | null
Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-10-30"

patient_id
string | null

A patient in your organization (GET /patients). Another organization's patient is a 404.

Pattern: ^\d{1,19}$
Example:

"700000000000000001"

patient_label
string | null

The patient name the inbox row shows.

Maximum string length: 300
Example:

"Pat Example"

assigned_provider_calendar_id
string | null

Assign the task to one of your organization's AI Receptionist provider calendars.

Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$
linked_call_id
string | null

The call this task came from (GET /receptionist/calls). Another organization's call is a 404.

Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$
Example:

"c0a80101-0000-4000-8000-000000000001"

Response

The updated task

data
object
required