Field Providers
Field API — Visits

Complete a visit

Marks the visit completed. If no visit exists yet (exit without a recorded entry), synthesizes a start from this same event first, so a start always precedes an end. Idempotent: an already-completed visit is a no-op.

post/api/v1/field-providers/appointments/{appointment_id}/complete/

Request

  • Base URL
    https://api.cloverhealth.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.cloverhealth.com/api/v1/field-providers/appointments/{appointment_id}/complete/
  • Auth
    HTTP bearer

Path parameters

appointment_idstring required

Request body

triggerstring required
occurred_atstring date-time required
latitudenumber nullable
longitudenumber nullable
client_event_idstring required

Response

OK

appointment_idstring required
statusstring required
started_atstring date-time nullable
completed_atstring date-time nullable

Changes

No recorded changes to this operation across all 22 revisions of this API.