VEverdun
speakers

Set Speaker Onboarding Checklist

Merge the owner's device-setup attestations. PARTIAL — send only what changed.

ITS OWN ROUTE, NEVER PUT /speakers/{id}: that body is a full replace that re-defaults every omitted field, so checklist state living there would be one forgotten key away from an unrelated edit wiping the record of a device someone drove to a site to configure.

put/speakers/{speaker_id}/onboarding-checklist

Request

  • Base URL
    https://api.verdun.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.verdun.ai/speakers/{speaker_id}/onboarding-checklist
  • Auth
    HTTP bearer

Path parameters

speaker_idstring required

Request body

itemsobject required

The checklist items to set, keyed by item id. Omitted items are left exactly as they are.

Example request

{
  "items": {
    "audio_direction": true,
    "firewall": false
  }
}

Response

Successful Response

speaker_idstring uuid required

The speaker this checklist belongs to.

speaker_labelstring required

The speaker's display name.

onboarding_checklistobject required

The whole stored envelope: {"version": 1, "items": {...}}.

confirmed_countinteger required

How many of the attestable items the owner has confirmed.

total_countinteger required

How many attestable items there are. Excludes the items the device answers for itself.

Example response

{
  "speaker_label": "North horn — gate",
  "confirmed_count": 5,
  "total_count": 6
}

Changes

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