Skip to main content
PATCH
Update document relevance setting

Authorizations

X-API-Key
string
header
required

API key for authentication

Headers

X-Organization-Id
string

Organization ID (required for session auth, optional for API key auth)

Path Parameters

formType
enum<string>
required

Slug of the evidence form. Call GET /v1/evidence-forms to see every form with its title.

Available options:
board-meeting,
it-leadership-meeting,
risk-committee-meeting,
meeting,
access-request,
whistleblower-report,
penetration-test,
rbac-matrix,
infrastructure-inventory,
employee-performance-evaluation,
network-diagram,
tabletop-exercise,
account-types

Body

application/json
isNotRelevant
boolean
required

True marks the form as not applicable to this organization, so it stops counting as missing evidence.

Example:

true

notRelevantReason
string

Why the form does not apply. Auditors expect a reason for every exclusion; a not-relevant form without one gets a review issue. Ignored when isNotRelevant is false.

Maximum string length: 1000
Example:

"A vendor does this for us, so this does not apply to us."

Response

200