Sign in

v1

latestOpenAPI 3.0.1Vanta Terms of Service2026-07-26327517821.8 KB
Audits

Update a comment for a control within an audit

Updates an existing comment on a control. Only the original author of the comment can update it. The author is identified by their email address, which must match the email of the user who created the comment.

Rate limit: 10 requests / minute.

patch/audits/{auditId}/controls/{controlId}/comments/{commentId}

Path parameters

auditIdstring required
controlIdstring required
commentIdstring required

Request body

textstring required

The text content of the comment. Must be at least 1 character. Can include questions, clarifications, or explanations related to the control.

emailstring required

Email address of the comment author. Must match an existing Vanta user who belongs to the audit firm making the API request. This email uniquely identifies the author across systems.

Response

Ok

idstring required

The unique identifier for the comment within Vanta's system. Format: ObjectId as a string (e.g., "6890e473dce1da5d8406f5e7").

textstring required

The comment message content. Can include explanations, questions, or clarifications about the control.

creationDatestring date-time required

Timestamp when the comment was created. Format: ISO 8601 UTC timestamp.

modificationDatestring date-time nullable required

Timestamp when the comment was last edited. Null if the comment has never been modified. Format: ISO 8601 UTC timestamp.

deletionDatestring date-time nullable required

Timestamp when the comment was soft-deleted. Null if the comment has not been deleted. Soft deletes retain the comment for audit history while hiding it from normal operations. Format: ISO 8601 UTC timestamp.

emailstring nullable required

Email address of the comment author. This email uniquely identifies users between Vanta and external audit systems. Null when the comment author can't be matched to a Vanta user.

authorNamestring nullable required

Human-readable display name of the comment author. Null if the author's name is not available (e.g., user was deleted). This enables correct author attribution in integrations where users cannot be reliably matched across systems by email alone.