View all methods

snapshots.settings.drivers.update

Update a custom driver. Omitted fields keep their values.

Facts
Method POST https://api.getdx.com/snapshots.settings.drivers.update
Required scope snapshots:admin

Arguments

Name Type Description
token Token Auth token passed as an HTTP header.
driver_id Text Required. Custom driver ID from snapshots.settings.library.
name Text Optional. Driver name.
prompt Text Optional. Survey question.
ranking_item Text or null Optional. Priority-ranking label; may be null on update.
target_role Text Optional. dev, nondev, or all.
translations Object Optional locale-to-fields map, e.g. {"fr": {"name": "Exemple"}}. Uses enabled translation locales.

Translations support name, prompt, and ranking_item. Rewording clears existing translations unless replacements are supplied; an empty string clears a translation.

Example request

curl -X POST https://api.getdx.com/snapshots.settings.drivers.update \
  -H 'Authorization: Bearer xxxx-xxxxxxxxx-xxxx' \
  -H 'Content-Type: application/json' \
  --data '{
  "driver_id": "NTIxNDc",
  "prompt": "My tools help me work efficiently."
}'

Example response

{
  "ok": true,
  "driver": {
    "id": "NTIxNDc",
    "name": "Toolchain efficiency",
    "prompt": "My tools help me work efficiently.",
    "ranking_item": "Improve tools",
    "target_role": "all",
    "custom": true,
    "scale_points": 5,
    "translations": {}
  }
}

Errors

not_authed or not_authorized for missing authentication or access. not_found for unavailable item IDs. 422 validation_error for invalid input (error_details explains why); 409 snapshot_live while a snapshot is live.