VEverdun
sites

Update Site Disarm Trusted

put/sites/{site_id}/disarm-trusted

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/sites/{site_id}/disarm-trusted
  • Auth
    HTTP bearer

Path parameters

site_idstring required

Request body

enabledboolean required

True to let this site's trusted numbers skip the passcode by text and by phone; false to switch that off (the list is kept, inert).

acknowledged_riskboolean

Must be true when enabled is true, or the request is refused with a 422. Caller ID on a phone call can be faked, so enabling is a warned act: the console shows the warning and sends this flag, and the server enforces it so the warning cannot be skipped by calling the API directly. Ignored when switching OFF.

Example request

{
  "enabled": true,
  "acknowledged_risk": true
}

Response

Successful Response

enabledboolean required

Whether a caller-ID match at this site stands in for the passcode. Default false.

enabled_atstring date-time nullable

When it was switched on; null while off.

enabled_by_namestring nullable

Who switched it on; null while off or once that operator is deleted.

can_manageboolean required

Whether THIS caller may switch it and edit the list (owner, monitoring manager, support, Parent Manager or account manager). Everyone else who can see the site sees the state read-only.

Example response

{
  "enabled_by_name": "Dana Reyes",
  "numbers": [
    {
      "phone_number": "+18015550142",
      "label": "Jerry - GM",
      "created_by_name": "Sonny Tai"
    }
  ]
}

Changes

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