UPupguard
vendors

Send a security questionnaire to a vendor

Request a vendor questionnaire to be sent to one or more nominated email addresses. Vendor must be already monitored in UpGuard.

Required API key permissions: VendorRisk (select when creating API key in Account Settings)

The following merge tags are supported for email_title and email_subject text:

  • Vendor name {{VendorName}}
  • Account name {{AccountName}}
  • Questionnaire type {{QuestionnaireType}}
  • Due date {{DueDate}}

The following merge tags are supported for email_message text:

  • Vendor name {{VendorName}}
post/vendor/questionnaire

Request

Request body

due_datestring required

The date the questionnaire is due to be completed by.

Must be a future ISO 8601 formatted date string (YYYY-MM-DD).

email_messagestring

Optional message sent to the questionnaire recipient. If not provided, the organization's default message will be used.

email_titlestring

Optional email title sent to the questionnaire recipient. If not provided, the organization's default email title will be used.

questionnaire_type_idinteger required

Numeric ID of the questionnaire type to be sent.

reminder_datestring

The date to send a questionnaire reminder to the recipients.

Must be a future ISO 8601 formatted date string (YYYY-MM-DD).

risk_information_visiblity'ShowAllRiskInformation' | 'HideSeverity' | 'HideAllRiskInformation' required

The visibility level of risk information in the questionnaire.

sender_emailstring required

The email address of the questionnaire sender (must be an UpGuard user with full access to Vendor Risk or the portfolio containing the vendor).

vendor_idinteger

ID of the vendor the questionnaire is being sent to.

This, or vendor_primary_hostname must be provided.

vendor_primary_hostnamestring

Primary hostname of the vendor the questionnaire is being sent to.

This, or vendor_id must be provided.

Example request

{
  "due_date": "2024-11-20",
  "email_message": "Please complete the following questionnaire",
  "email_title": "Questionnaire",
  "questionnaire_type_id": 123,
  "recipients": [
    {
      "recipient_email": "security@upguard.com"
    }
  ],
  "reminder_date": "2024-11-16",
  "risk_information_visiblity": "ShowAllRiskInformation",
  "sender_email": "vendor.user@upguard.com",
  "vendor_id": 123456789,
  "vendor_primary_hostname": "example.com"
}

Response

The questionnaire was successfully sent

questionnaire_idinteger

The id of the questionnaire that was sent

Changes

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