---
title: "Update DigitQuery"
method: PUT
path: "/digitqueries/{id}"
tags: ["DigitQueries", "digitqueries"]
---

# Update DigitQuery

`PUT /digitqueries/{id}`

## Request

- Base URL: `https://api.fonestorm.com/v2`
- URL: `https://api.fonestorm.com/v2/digitqueries/{id}`
- Auth: API key in header `token`

Update a DigitQuery.

## Path parameters

- `id` string, required

## Request body

- object
  - `label` string: Name/Label for DigitQuery.
  - `soundfile` string: DigitQuery soundfile or text to speech string
  - `maxdigits` integer: Maximum digits allowed. Default is 1
  - `mindigits` integer: Minimum digits allowed. Default is 24
  - `retries` integer: Number of allowed retries. Default is 3
  - `timeout` integer: Number of seconds before timeout. Default is 5 seconds
  - `invalid_prompt` boolean: Play invalid prompt or not
  - `callback_settings` object
    - `url` string: Callback URL
    - `url_method` 'GET' | 'POST' | 'JSON': Callback URL method
    - `url_username` string: HTTP authentication username
    - `url_password` string: HTTP authentication password
  - `match_pattern` string: Match pattern a regular expression
  - `match_destination` object
    - `destination_type` 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'FoneNumber' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector': Match destination type
    - `destination` string: Match destination value
  - `nomatch_destination` object
    - `destination_type` 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'FoneNumber' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector': No Match destination type
    - `destination` string: No Match destination value
  - `default_destination` object
    - `destination_type` 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'FoneNumber' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector': Default destination type
    - `destination` string: Default destination value
  - `email_options` object
    - `email` string: Email address
    - `subject` string: Email subject
    - `body` string: Email body

## Response `200`

Success

- object
  - `digitquery` DigitQuery
    - `id` string: DigitQuery ID.
    - `label` string: Name/Label for DigitQuery.
    - `soundfile` string: DigitQuery soundfile or text to speech string
    - `maxdigits` integer: Maximum digits allowed
    - `mindigits` integer: Minimum digits allowed
    - `retries` integer: Number of allowed retries
    - `timeout` integer: Number of seconds before timeout
    - `invalid_prompt` boolean: Play invalid prompt or not
    - `callback_settings` object
      - `url` string: Callback URL
      - `url_method` string: Callback URL method GET, POST or JSON
      - `url_username` string: HTTP authentication username
      - `url_password` string: HTTP authentication password
    - `match_pattern` string: Match pattern a regular expression
    - `match_destination` object
      - `destination_type` string: Match destination type
      - `destination` string: Match destination value
    - `nomatch_destination` object
      - `destination_type` string: No Match destination type
      - `destination` string: No Match destination value
    - `default_destination` object
      - `destination_type` string: Default destination type
      - `destination` string: Default destination value
    - `email_options` object
      - `email` string: Email address
      - `subject` string: Email subject
      - `body` string: Email body
    - `active` boolean: DigitQuery active or not

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `404`: Not Found
- `default`: Error

---

[API](https://skmtc.dev/fonestorm/apis/fractel-api-2-12-87c-hail.md) · [All operations](https://skmtc.dev/fonestorm/apis/fractel-api-2-12-87c-hail/llms.txt) · [OpenAPI document](https://skmtc.dev/fonestorm/apis/fractel-api-2-12-87c-hail/revisions/9738d9b806d4?raw)