Update questionnaire response content

PATCH

customer-trust

questionnaires

{questionnaireId}

responses

{responseId}

Update questionnaire response content

curl --request PATCH \
  --url https://api.vanta.com/v1/customer-trust/questionnaires/{questionnaireId}/responses/{responseId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "answerPartsValues": {}
}
'

import requests

url = "https://api.vanta.com/v1/customer-trust/questionnaires/{questionnaireId}/responses/{responseId}"

payload = { "answerPartsValues": {} }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({answerPartsValues: {}})
};

fetch('https://api.vanta.com/v1/customer-trust/questionnaires/{questionnaireId}/responses/{responseId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vanta.com/v1/customer-trust/questionnaires/{questionnaireId}/responses/{responseId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'answerPartsValues' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.vanta.com/v1/customer-trust/questionnaires/{questionnaireId}/responses/{responseId}"

	payload := strings.NewReader("{\n  \"answerPartsValues\": {}\n}")

	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(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.vanta.com/v1/customer-trust/questionnaires/{questionnaireId}/responses/{responseId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"answerPartsValues\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vanta.com/v1/customer-trust/questionnaires/{questionnaireId}/responses/{responseId}")

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 = "{\n  \"answerPartsValues\": {}\n}"

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

{
  "id": "000000000000000000000001",
  "question": "Do you encrypt customer data at rest?",
  "isPendingAnswerGeneration": false,
  "answer": {
    "explanation": "Yes, we encrypt all customer data at rest with AES-256."
  },
  "ownerAssignment": {
    "type": "User",
    "id": "000000000000000000000002",
    "displayName": "Jane Doe"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

questionnaireId

string

required

responseId

string

required

Body

application/json

Request body for updating a questionnaire response's answer content.

answerPartsValues

object

required

Map of answer part id -> value, matching the shape of the answerPartsValues read field. Values must be string, number, boolean, null, or string[]. A null value clears that part's value; ids omitted from the map are left unchanged.

Show child attributes

Response

200 - application/json

A questionnaire response without the fields that describe what the requesting user may do with it. Surfaces that authenticate a client rather than a user return this, since there is no user those fields could describe.

string

required

The unique identifier for the questionnaire response

question

string

required

The actual question text

isPendingAnswerGeneration

boolean

required

Indicates whether the answer is currently being worked on by AI.

ownerAssignment

object | null

required

The response's owner, or null when no owner is assigned. Resolved from the object-role grant rather than the response document's legacy ownerUserId, which the object-role registry leaves unset for Team owners.

Show child attributes

sectionId

string | null

The questionnaire section this response belongs to, if any. Null for standalone questions or legacy responses without a section.

sequenceLabel

string

Sequence label for ordering responses within a questionnaire

answer

object

deprecated

The current answer for the question.

Show child attributes

editedBy

object | null

The user who last edited the question/answer

Show child attributes

approvedBy

object | null

The user who approved the current answer

Show child attributes

originType

enum<string>

Where the current answer has came from

AI: generated by Vanta AI
Manual: written in by a user
Original questionnaire: included in the original import
Answer library: the answer was found in a matching question in the knowledge center
Resource: the answer was found in a matching excerpt from a document in the knowledge center

Available options:

AI,

ANSWER_LIBRARY,

MANUAL,

ORIGINAL_QUESTIONNAIRE,

RESOURCE

answerSchema

string

JSON Schema describing the expected answer format for this question. Prefer answerPartsSchema + answerPartsValues — those mirror the apps/web GraphQL surface and let clients render against the canonical composite schema.

answerPartsSchema

object

Composite JSONSchema7 built from the response's stored answer parts (via toCompositeSchema). Mirrors the GraphQL answerPartsSchema field. Absent when the response has no stored parts — clients fall back to the legacy answerSchema field.

Show child attributes

answerPartsValues

object

Flat map of part-id → current value (via toAnswerPartsValues). Same key set as answerPartsSchema.properties. Absent when the response has no stored parts.

Show child attributes

attachedEvidence

object[]

Evidence documents attached to support this questionnaire response

Show child attributes

generatedAnswerLogId

string

Id of the QAutoGeneratedAnswerLog that produced the current generated answer on this response, if any. The browser extension API exposes the log body and citations at GET /questionnaires/{questionnaireId}/responses/{responseId}/generated-answer-log.

⌘I

Update questionnaire response content

curl --request PATCH \
  --url https://api.vanta.com/v1/customer-trust/questionnaires/{questionnaireId}/responses/{responseId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "answerPartsValues": {}
}
'

import requests

url = "https://api.vanta.com/v1/customer-trust/questionnaires/{questionnaireId}/responses/{responseId}"

payload = { "answerPartsValues": {} }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({answerPartsValues: {}})
};

fetch('https://api.vanta.com/v1/customer-trust/questionnaires/{questionnaireId}/responses/{responseId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vanta.com/v1/customer-trust/questionnaires/{questionnaireId}/responses/{responseId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'answerPartsValues' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.vanta.com/v1/customer-trust/questionnaires/{questionnaireId}/responses/{responseId}"

	payload := strings.NewReader("{\n  \"answerPartsValues\": {}\n}")

	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(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.vanta.com/v1/customer-trust/questionnaires/{questionnaireId}/responses/{responseId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"answerPartsValues\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vanta.com/v1/customer-trust/questionnaires/{questionnaireId}/responses/{responseId}")

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 = "{\n  \"answerPartsValues\": {}\n}"

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

{
  "id": "000000000000000000000001",
  "question": "Do you encrypt customer data at rest?",
  "isPendingAnswerGeneration": false,
  "answer": {
    "explanation": "Yes, we encrypt all customer data at rest with AES-256."
  },
  "ownerAssignment": {
    "type": "User",
    "id": "000000000000000000000002",
    "displayName": "Jane Doe"
  }
}

API Basics

Manage API

Integrations API

Audit API

Webhooks

Update questionnaire response content

Authorizations

Path Parameters

Body

Response