UPupguard
vendors

Send a relationship questionnaire about a vendor

Request a vendor relationship questionnaire to be sent to a nominated email address. Vendor must be already monitored in UpGuard

A relationship questionnaire must be set up (in UpGuard) prior to the request.

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

post/vendor/relationship_questionnaire

Request

Request body

idinteger

ID of the vendor the relationship questionnaire is about.

messagestring

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

recipient_emailstring

The email address of the questionnaire recipient (will be invited to your organization if not already a member).

sender_emailstring

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

Example vendor.user@upguard.com

subjectstring

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

Example request

{
  "id": 123456789,
  "message": "Please complete the following questionnaire",
  "recipient_email": "security@upguard.com",
  "subject": "Onboarding request for {{VendorName}}."
}

Response

The relationship 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.