UPupguard
vendors

Add recipients to a questionnaire

Changed on

Adds one or more recipients to a questionnaire or onboarding request. Recipients are vendor-side users who will receive an invitation to answer the questionnaire. If a recipient is already on the questionnaire, they are skipped (idempotent).

To add organization-side collaborators who review (but do not answer) the questionnaire, use POST /vendor/questionnaire/collaborators/add instead.

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

post/vendor/questionnaire/recipients/add

Request

Request body

messagestring

A custom message to include in the invitation email sent to recipients. If not provided, the organization's default questionnaire invitation message will be used.

questionnaire_idinteger required

The ID of the questionnaire to add recipients to. This is the same ID returned when creating a questionnaire or onboarding request. Use GET /vendor/questionnaires/v2 to list questionnaires for a vendor, or GET /onboarding_request/list to list onboarding requests.

Example request

{
  "message": "Please complete this questionnaire at your earliest convenience.",
  "questionnaire_id": 12345,
  "recipients": [
    {
      "email_address": "vendor-contact@example.com",
      "first_name": "Jane"
    }
  ]
}

Response

Recipients added successfully

resultsobject

A map of recipient email addresses to their result status. Possible values: "success": the recipient was successfully added to the questionnaire. "already_exists": the recipient is already on the questionnaire (no action taken). "inactive": the email address has been marked as inactive due to previous delivery failures. "failed": the recipient could not be added due to an error sending the invitation.

Example response

{
  "results": {
    "inactive@example.com": "inactive",
    "vendor-contact@example.com": "success"
  }
}

Changes