UPupguard
vendors

Add collaborators to a questionnaire

Changed on

Adds one or more collaborators to a questionnaire or onboarding request. Collaborators are organization-side users who can review (but not answer) the questionnaire. If a collaborator is already on the questionnaire, they are skipped (idempotent).

To add vendor-side recipients who answer the questionnaire, use POST /vendor/questionnaire/recipients/add instead.

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

post/vendor/questionnaire/collaborators/add

Request

Request body

messagestring

A custom message to include in the invitation email sent to collaborators. If not provided, the organization's default questionnaire collaborator message will be used. Supports the placeholder {{VendorName}} which will be substituted with the vendor's name.

questionnaire_idinteger required

The ID of the questionnaire to add collaborators 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.

titlestring

A custom subject line for the invitation email sent to collaborators. If not provided, the organization's default questionnaire collaborator title will be used. Supports the placeholders {{VendorName}} and {{QuestionnaireType}}.

Example request

{
  "collaborators": [
    {
      "email_address": "colleague@example.com"
    }
  ],
  "message": "Please review this questionnaire for our vendor assessment.",
  "questionnaire_id": 12345,
  "title": "Review request for vendor questionnaire"
}

Response

Collaborators added successfully

resultsobject

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

Example response

{
  "results": {
    "colleague@example.com": "success",
    "inactive@example.com": "inactive"
  }
}

Changes