UPupguard
vendors

Create a comment on a questionnaire

Comments can be added to a questionnaire at the top-level (for general questionnaire commentary), or attached to specific questions. Top-level comments can be replied to. Comment authors can be any user in your organization.

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

post/vendor/questionnaire/comments/add

Request

Request body

author_email_addressstring required

The email address of the user creating the comment. Must be associated with a user in your organization.

privateboolean

If true, the new comment will be private, visible only to your organization.

question_idstring

If populated, the new comment will be associated with a specific question in the questionnaire. Mutually exclusive with reply_to_comment_id, a comment cannot be both a question-specific comment and a reply.

questionnaire_idinteger required

The ID of the questionnaire to add a comment to.

reply_to_comment_idinteger

If populated, the new comment will be a reply to an existing comment. Must be a top-level comment ID. Mutually exclusive with question_id, a comment cannot be both a reply and a question-specific comment.

textstring required

The comment text (max 4000 characters).

Example request

{
  "author_email_address": "user@yourcompany.com",
  "question_id": "q_security_policy",
  "questionnaire_id": 12345,
  "reply_to_comment_id": 67890,
  "text": "This is a comment on the security policy question."
}

Response

OK

Changes

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