Customer Trust

Create file questionnaire

Create a new file-based questionnaire from an uploaded file (.xlsx, .docx, .pdf). File type is inferred as SPREADSHEET or DOCUMENT based on the uploaded file.

post/customer-trust/questionnaires/file

Request

Request body multipart/form-data

filestring binary required
displayNamestring required

Display name for the questionnaire.

ownerAssignmentstring

Owner to assign, as a JSON string: {"type": "User" | "Team", "id": "<id>"}.

approverAssignmentstring

Approver to assign, as a JSON string: {"type": "User" | "Team", "id": "<id>"}.

descriptionstring

Description of the questionnaire.

companyUrlstring

URL of the company associated with this questionnaire.

dueDatestring

Due date for questionnaire completion.

customerTrustAccountIdstring

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

includeUntaggedEntitiesForCategoryIdsstring

Comma-separated category IDs for which to include untagged entities.

metadatastring

Custom key-value pairs, as a JSON string array: [{"key": "<key>", "value": "<value>"}]. Keys and values may contain alphanumeric characters, hyphens, underscores, and periods.

tagAndCategoryIdsstring

Tags to assign, as a JSON string array: [{"categoryId": "<id>", "tagId": "<id>"}]. Replaces all existing tags.

Response

File questionnaire created

idstring required
displayNamestring required
urlstring
type'SPREADSHEET' | 'WEBSITE' | 'DOCUMENT' required
status'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' required
customerTrustAccountIdstring
dueDatestring date-time
createdDatestring date-time required
updatedDatestring date-time required
completedDatestring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.