Update an information request for an audit
Updates an existing information request for an audit, allowing modification of request details as audit requirements evolve. Supports partial updates where only specified fields are changed; omitted fields remain unchanged.
Common use cases:
- Updating due dates as audit timelines shift
- Refining descriptions to clarify requirements
- Adjusting request type
Note: The modificationDate is automatically updated to the current timestamp when any field is changed.
Rate limit: 50 requests / minute.
Path parameters
Request body
The framework codes this request addresses. An empty array if no framework codes are associated.
Detailed description of what evidence is needed.
Deadline for fulfilling this request. Null if no deadline. Format: ISO 8601 UTC timestamp.
Start date of the audit period. Evidence before this date may not be accepted. Null if not restricted. Format: ISO 8601 UTC timestamp.
Type of information request, defining what scope of evidence is needed.
- POINT_IN_TIME: Evidence for a specific moment (e.g., current state of a policy)
- POPULATION: Evidence covering all items in a category (e.g., all employees)
- SAMPLE: Evidence for a representative sample (e.g., 10 random customer records)
Short, descriptive title.
Frequency cadence for the information request, indicating how often it recurs.
Control IDs to link directly to this request, beyond those automatically mapped from framework codes. Replaces the existing set: pass the complete desired list, an empty array to clear all direct control links, or omit to leave them unchanged. Each must be the id of an existing control in the customer's organization (the identifier returned by the controls endpoints). The request is rejected if any ID does not match a control.
Response
Ok
The unique identifier for the information request within Vanta's system. This is the primary identifier used in all API endpoints. Format: ObjectId as a string (e.g., "6890e473dce1da5d8406f5e7")
External unique ID to prevent duplicates across different audit systems. Used for idempotency when syncing data between external audit management systems and Vanta. Unlike id, this value is provided by the external system.
Additional control IDs beyond those automatically mapped from framework codes. Allows manual association with specific controls when automatic mapping is insufficient. Each ID should reference a valid control in your audit framework.
Current approval status of the information request, tracking its lifecycle through the audit process.
The status progresses through the workflow: initial state → awaiting review → approved or flagged. Status can move between awaiting review and flagged states as evidence is reviewed and resubmitted.
Frequency cadence for the information request, indicating how often it recurs.
The framework codes this request addresses. Links the request to specific compliance requirements. Can be an empty array if no framework codes are associated. These codes correspond to standards like SOC 2, ISO 27001, etc.
Detailed description explaining what evidence is needed and why. Should provide clear instructions to help the customer understand what to submit.
The deadline by which the customer must fulfill this request. Null if no specific deadline is set. Format: ISO 8601 UTC timestamp.
The earliest date for which evidence should be captured. Evidence dated before this date may not be accepted. Null if not restricted. Format: ISO 8601 UTC timestamp.
Non-unique external reference ID for this request. Unlike uniqueId which must be unique, requestId is for display/reference purposes only (e.g., "REQ-123"). Null if not provided.
Type of information request, defining what scope of evidence is needed.
- POINT_IN_TIME: Evidence for a specific moment (e.g., current state of a policy)
- POPULATION: Evidence covering all items in a category (e.g., all employees)
- SAMPLE: Evidence for a representative sample (e.g., 10 random customer records)
Short, descriptive title summarizing what is being requested.
Timestamp when the request was created in the system. Format: ISO 8601 UTC timestamp.
Timestamp when the request was last modified. Format: ISO 8601 UTC timestamp.
Timestamp when the request was soft-deleted. Null if the request has not been deleted. Soft deletes allow retaining history while hiding the request from normal operations. Format: ISO 8601 UTC timestamp.