Skip to main content
PATCH
https://api.voxmind.ai
/
organisations
/
{orgId}
/
settings
curl -X PATCH https://api.voxmind.ai/organisations/42/settings \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "org_id": 42,
    "settings": {
      "alert_on_failure": true
    }
  }'
{
  "id": 1,
  "org_id": 42,
  "settings": {
    "alert_on_failure": true
  },
  "created_at": "2025-01-15T09:00:00Z",
  "updated_at": "2025-03-15T11:30:00Z"
}

Path Parameters

orgId
string
required
Your organisation’s unique identifier.

Request Body

org_id
integer
The associated organisation’s ID. Must match the orgId path parameter.
settings
object
A JSON object containing the settings fields to update. Currently supported settings:
  • alert_on_failure (boolean) — When true, Voxmind sends a notification to your organisation’s contact email when a verification failure rate exceeds normal thresholds. Useful for detecting coordinated attack patterns or integration issues in production.
curl -X PATCH https://api.voxmind.ai/organisations/42/settings \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "org_id": 42,
    "settings": {
      "alert_on_failure": true
    }
  }'
{
  "id": 1,
  "org_id": 42,
  "settings": {
    "alert_on_failure": true
  },
  "created_at": "2025-01-15T09:00:00Z",
  "updated_at": "2025-03-15T11:30:00Z"
}