Update questionnaire

Update an existing questionnaire.

Updates one or more fields of a questionnaire. This endpoint cannot be used to set a questionnaire’s status to APPROVED or COMPLETED. To perform those specific transitions, please use the approveQuestionnaire and completeQuestionnaire endpoints, respectively.

PATCH /customer-trust/questionnaires/{questionnaireId}

Update questionnaire

cURL

curl --request PATCH \
  --url https://api.vanta.com/v1/customer-trust/questionnaires/{questionnaireId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "dueDate": "<string>",
  "status": "IN_PROGRESS",
  "metadata": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "tagAndCategoryIds": [
    {
      "categoryId": "<string>",
      "tagId": "<string>"
    }
  ]
}
'

200

{
  "id": "507f1f77bcf86cd799439011",
  "displayName": "SOC 2 Security Questionnaire",
  "type": "SPREADSHEET",
  "status": "IN_PROGRESS",
  "statusLog": [],
  "dueDate": "2024-12-31T00:00:00.000Z",
  "metadata": [
    {
      "key": "priority",
      "value": "high"
    }
  ],
  "tagAndCategoryIds": [],
  "createdDate": "2024-12-01T00:00:00.000Z",
  "updatedDate": "2024-12-14T00:00:00.000Z"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

questionnaireId · string · required

Body

application/json

displayName · string

Display name of the questionnaire

dueDate · string | null

Due date for questionnaire completion (ISO 8601 string, null to clear)

status · enum<string>

Status transition (limited to settable statuses)

Available options: IN_PROGRESS, IN_REVIEW, READY_FOR_REVIEW, WAITING_ON_ANSWERS, ON_HOLD, NO_LONGER_NEEDED

ownerAssignment · object

Owner assignment as Actor (null to unassign)

Show child attributes

approverAssignment · object

Approver assignment as Actor (null to unassign, requires QuestionnaireAutomationAdvanced)

Show child attributes

metadata · object[]

Metadata key-value pairs

Show child attributes

tagAndCategoryIds · object[]

Tags to assign to the questionnaire. Each entry must include a categoryId and tagId. Replaces all existing tags.

Show child attributes

Response

200 - application/json

Ok

id · string · required

displayName · string · required

type · enum<string> · required

Available options: SPREADSHEET, WEBSITE, DOCUMENT

status · enum<string> · required

Available options: APPROVED, IN_PROGRESS, IN_REVIEW, READY_FOR_REVIEW, WAITING_ON_ANSWERS, ON_HOLD, NO_LONGER_NEEDED, COMPLETE, ERROR, EXTRACTING_QUESTIONS, QUEUED_FOR_EXTRACTION, PROCESSING, QUEUED_FOR_PROCESSING, WAITING_ON_COLUMN_SELECTION, WAITING_ON_COLUMN_APPROVAL, QUEUED_FOR_COLUMN_DETECTION, DETECTING_COLUMNS

statusLog · object[] · required

The status change history log for the questionnaire. Entries are ordered by the most recent status change first.

Show child attributes

tagAndCategoryIds · object[] · required

Tags assigned to this questionnaire. Each entry contains a categoryId and tagId.

Show child attributes

createdDate · string<date-time> · required

updatedDate · string<date-time> · required

url · string

ownerAssignment · object

The owner assignment in actor form (User or Team).

Show child attributes

approverAssignment · object

The approver assignment in actor form (User or Team).

Show child attributes

customerTrustAccountId · string

dueDate · string<date-time>

metadata · object[]

Show child attributes

completedDate · string<date-time>