Skip to main content
POST
Draft public compliance notes

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Body

application/json

Exactly one of assignedCheckIds or selection=all_answered

assignedCheckIds
string<uuid>[]
Required array length: 1 - 10 elements
selection
enum<string>

Select active-run checks whose private notes contain answer text

Available options:
all_answered
runId
string<uuid>

With selection only

selectionOffset
integer

Continue from a prior selectionCoverage.nextSelectionOffset

Required range: 0 <= x <= 100000
includeExistingPublicNotes
boolean

Also draft for checks that already have public notes (default true)

companyIds
string<uuid>[]
Required array length: 1 - 100 elements

Response

Drafts, per-check errors and selection coverage

data
object
required