Update a questionnaire

PATCH

/api/v1/questionnaires/{id}

aasm_state accepts only needs_input and approved; any other value is dropped silently and the rest of the update still applies. Setting approved also approves every item that can be approved.

Authorizations

bearerAuth

Path Parameters

NameType

required

string

The record’s prefixed ID

Request Body^required

application/json

object

questionnaire

required

object

title

string

Defaults to the filename on create

description

string

deadline

string format: date

file

string format: binary

.xlsx or .docx; multipart create only

aasm_state

string

Allowed values: needs_input approved

Other values are dropped silently

portal_url

string format: uri

Responses

200

The updated questionnaire

Response body

application/json

object

string

web_link

string format: uri

The questionnaire’s page in the web app

title

string

description

string | null

deadline

string | null format: date

state

string

Allowed values: new qa_complete mapping_complete items_generated processing_items needs_input approved

Processing and review state

filetype

string | null

Allowed values: pdf xlsx docx

framework

string | null

Allowed values: nist-csf-2.0 hecvat-3.06 hecvat-4.1 rh-1.0 cjis-5 cjis-6

portal_url

string | null format: uri

Set for questionnaires answered in a third-party portal

created_at

string format: date-time

updated_at

string format: date-time

owner

One of:

object
null

The member who owns or answered a record. id is the numeric database ID.

object

integer

name

string

email

string format: email

stats

Item counts. Discarded items are excluded.

object

total_items

integer

needs_input_items

integer

Items the AI could not answer confidently

auto_answered_items

integer

approved_items

integer

overall_completion_percentage

integer

<= 100

Approved items as a percentage of total

403

Insufficient scope, role, or credits

Response body

application/json

object

error

object

code

string

A stable machine-readable code

message

string

details

Array<string>

Present on validation errors; one entry per failed validation

404

No such record in this account

Response body

application/json

object

error

object

code

string

A stable machine-readable code

message

string

details

Array<string>

Present on validation errors; one entry per failed validation

422

The record could not be saved

Response body

application/json

object

error

object

code

string

A stable machine-readable code

message

string

details

Array<string>

Present on validation errors; one entry per failed validation

Request

curl --request PATCH \
  --url https://app.responsehub.io/api/v1/questionnaires/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "questionnaire": { "title": "example", "description": "example", "deadline": "2026-04-15", "file": "binary", "aasm_state": "needs_input", "portal_url": "https://example.com" } }'

require 'uri'
require 'net/http'

url = URI("https://app.responsehub.io/api/v1/questionnaires/example")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{ \"questionnaire\": { \"title\": \"example\", \"description\": \"example\", \"deadline\": \"2026-04-15\", \"file\": \"binary\", \"aasm_state\": \"needs_input\", \"portal_url\": \"https://example.com\" } }"

response = http.request(request)
puts response.read_body

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://app.responsehub.io/api/v1/questionnaires/example', [
  'body' => '{ "questionnaire": { "title": "example", "description": "example", "deadline": "2026-04-15", "file": "binary", "aasm_state": "needs_input", "portal_url": "https://example.com" } }',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

const url = 'https://app.responsehub.io/api/v1/questionnaires/example';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"questionnaire":{"title":"example","description":"example","deadline":"2026-04-15","file":"binary","aasm_state":"needs_input","portal_url":"https://example.com"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://app.responsehub.io/api/v1/questionnaires/example"

  payload := strings.NewReader("{ \"questionnaire\": { \"title\": \"example\", \"description\": \"example\", \"deadline\": \"2026-04-15\", \"file\": \"binary\", \"aasm_state\": \"needs_input\", \"portal_url\": \"https://example.com\" } }")

  req, _ := http.NewRequest("PATCH", url, payload)

  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

Request body example

Example^generated

{
  "questionnaire": {
    "title": "example",
    "description": "example",
    "deadline": "2026-04-15",
    "file": "binary",
    "aasm_state": "needs_input",
    "portal_url": "https://example.com"
  }
}

200example

Example^generated

{
  "id": "qu_1a2b",
  "web_link": "https://example.com",
  "title": "example",
  "description": "example",
  "deadline": "2026-04-15",
  "state": "new",
  "filetype": "pdf",
  "framework": "nist-csf-2.0",
  "portal_url": "https://example.com",
  "created_at": "2026-04-15T12:00:00Z",
  "updated_at": "2026-04-15T12:00:00Z",
  "owner": {
    "id": 1,
    "name": "example",
    "email": "hello@example.com"
  },
  "stats": {
    "total_items": 1,
    "needs_input_items": 1,
    "auto_answered_items": 1,
    "approved_items": 1,
    "overall_completion_percentage": 1
  }
}

403example

Example^generated

{
  "error": {
    "code": "not_found",
    "message": "example",
    "details": [
      "example"
    ]
  }
}

404example

Example^generated

{
  "error": {
    "code": "not_found",
    "message": "example",
    "details": [
      "example"
    ]
  }
}

422example

Example^generated

{
  "error": {
    "code": "not_found",
    "message": "example",
    "details": [
      "example"
    ]
  }
}

Update a questionnaire

Authorizations

Path Parameters

Request Bodyrequired

Responses

200

403

404

422

Request Body^required