Endpoint

Attendees

Attendees are the patients on a clinic’s waiting list. Create one to add somebody to the list Brightloom offers slots to.

POST/v1/attendees

Parameters

NameTypeRequiredDescription
clinic_idstringRequiredThe clinic this attendee is waiting at.
namestringRequiredDisplay name. Never included in outbound patient messages.
phonestringRequiredE.164 format, for example +18285550142.
urgencyintegerOptional1 to 5, where 5 is most urgent. Defaults to 3.
provider_idsarrayOptionalProviders this attendee may see. Empty means any provider.
travel_minutesintegerOptionalTypical travel time to the clinic. Used in ranking.
contact_hoursobjectOptionalPer-attendee override of the clinic’s no-contact window.

Request

curl https://api.brightloom.dev/v1/attendees \
  -H "Authorization: Bearer blk_live_8fk2Qz7mR4tPvXc1" \
  -H "Content-Type: application/json" \
  -d '{
    "clinic_id": "cln_4t7q",
    "name": "R. Alvarez",
    "phone": "+18285550142",
    "urgency": 4,
    "provider_ids": ["prv_5k2n"],
    "travel_minutes": 18
  }'

Response

{
  "id": "att_2m8v",
  "clinic_id": "cln_4t7q",
  "name": "R. Alvarez",
  "phone": "+1828555••42",
  "urgency": 4,
  "provider_ids": ["prv_5k2n"],
  "travel_minutes": 18,
  "status": "waiting",
  "opted_out": false,
  "created_at": "2026-07-29T09:20:11Z"
}

Gotchas

  • Phone numbers are returned masked. Store your own copy if you need the full value.
  • Creating the same phone at the same clinic_id twice returns the existing attendee with 200, not a duplicate.
  • If a patient replies STOP to any message, opted_out becomes true permanently and cannot be reset by the API.
  • urgency above 3 requires the clinic to have urgency overrides enabled, or the request returns 422.