Create website questionnaire

Create a new website-based questionnaire from a portal URL.

The portal URL is used to fetch questionnaire content from the target website.

POST /customer-trust/questionnaires/website

Create website questionnaire

cURL

curl --request POST \
  --url https://api.vanta.com/v1/customer-trust/questionnaires/website \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "url": "<string>",
  "companyUrl": "<string>",
  "customerTrustAccountId": "<string>",
  "description": "<string>",
  "dueDate": "2023-11-07T05:31:56Z",
  "metadata": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "includeUntaggedEntitiesForCategoryIds": [
    "<string>"
  ],
  "tagAndCategoryIds": [
    {
      "categoryId": "<string>",
      "tagId": "<string>"
    }
  ]
}
'

201

{
  "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.

Body

application/json

Request body for creating a website-based questionnaire from a portal URL.

displayName · string · required

Display name for the questionnaire.

url · string · required

The portal URL to create the questionnaire from.

ownerAssignment · object

Actor to assign as the owner (user or team).

Show child attributes

approverAssignment · object

Actor to assign as the approver (user or team).

Show child attributes

companyUrl · string

URL of the company associated with this questionnaire.

customerTrustAccountId · string

ID of the customer trust account to associate with this questionnaire.

description · string

Description of the questionnaire.

dueDate · string<date-time>

Due date for questionnaire completion (ISO 8601).

metadata · object[]

Custom key-value pairs. Keys and values may contain alphanumeric characters, hyphens, underscores, and periods. Maximum 30 entries.

Show child attributes

includeUntaggedEntitiesForCategoryIds · string[]

Category IDs for which to include untagged entities.

tagAndCategoryIds · object[]

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

Show child attributes

Response

201 - application/json

Website questionnaire created

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>