Skip to main content
PATCH
Revise filing check instructions

Authorizations

Authorization
string
header
required

Effective API key. Send Authorization: Bearer sk-eai-...

Path Parameters

checkId
string<uuid>
required

Body

application/json
expectedVersionId
string<uuid>
required

The current versionId returned by reading this check. The update succeeds only if this is still the published version; otherwise it returns 409 conflict.

markdown
string
required

Complete replacement Markdown, not an append or a text patch. Nonblank; maximum 64 KiB (65,536 UTF-8 bytes). A successful update immediately publishes a new immutable version.

Required string length: 1 - 65536

Response

Published revision.

id
string<uuid>
required
name
string
required

Human-readable check name, fixed when created.

scope
enum<string>
required

Global checks are shared by Effective; organization checks belong to your tenant.

Available options:
global,
organization
versionId
string<uuid>
required

Immutable instruction revision. Retain this ID with review results.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required

When the check was last published; historical reads retain this catalog timestamp.

markdown
string
required

Markdown instructions, applicability guidance, examples, and sources.