Skip to main content
PATCH
Update a chronology event

Authorizations

Authorization
string
header
required

Workspace credential issued from the automation console at /automation. Send it as Authorization: Bearer vq_ws_.... This is NOT a Data API key: a vq_key_ credential is refused here and names the other product in the error.

Path Parameters

matterId
string
required

mat_ identifier of the matter to work inside. Everything in this API hangs off a matter, and the matter in the path is what the authorization boundary is checked against. Take it from GET /v1/matters.

eventId
string
required

evt_ identifier of one chronology event. Take it from the matter's chronology.

Body

application/json

Fields to change. Omitted fields are left alone.

An explicit null clears description or eventDateEnd. Every other field here is backed by a NOT NULL column, so a null for one is refused by name rather than passed to the database.

documentId is deliberately not patchable: which document an event came from is provenance, and re-pointing it would make an extracted event claim a source it was never read from.

eventDate
string<date> | null

When it happened.

Example:

"2026-08-19"

eventDateEnd
string<date> | null

The end of a date range. Send null to clear it.

Example:

"2026-08-19"

eventDateApproximate
boolean | null

True when the date is an estimate rather than a record.

Example:

false

eventType
enum<string> | null

What happened.

Available options:
signed,
executed,
filed,
served,
effective,
expired,
terminated,
notice_sent,
notice_received,
payment,
hearing,
meeting,
judgment,
order,
correspondence,
amended,
enacted,
published,
decided,
incident,
referenced,
founded,
incorporated,
appointed,
resigned,
acquired,
launched,
awarded,
approved,
registered,
commenced,
completed,
transferred,
invested,
dissolved,
announced,
renewed,
other
Example:

"signed"

category
enum<string> | null

Which swim lane it joins.

Available options:
contract_event,
court_filing,
correspondence,
payment_financial,
deadline_notice,
meeting_hearing,
legislative,
case_law,
historical,
corporate,
regulatory,
employment,
milestone,
other
Example:

"contract_event"

title
string | null

A one-line description.

Required string length: 1 - 500
Example:

"Master Services Agreement"

description
string | null

The longer account. Send null to clear it.

Maximum string length: 5000
Example:

"Master services agreement with Acme for the 2026 platform rollout."

parties
string[] | null

Who was involved. Replaces the whole list.

Maximum array length: 50
Example:
tags
string[] | null

Free-form labels. Replaces the whole list.

Maximum array length: 30
Example:
significance
enum<string> | null

high, medium or low.

Available options:
high,
medium,
low
Example:

"high"

Response

Successful Response

One dated event on the matter's timeline.

id
string
required

evt_ identifier.

Example:

"evt_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"

matterId
string
required

The mat_ matter this event belongs to.

Example:

"mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"

eventDate
string<date>
required

When it happened.

Example:

"2026-08-19"

eventDateApproximate
boolean
required

True when the source dated this loosely ('early 2024').

Example:

false

eventType
string
required

What happened, for example signed, filed or hearing. Read it as an open string: the column carries no constraint, so production can hold a value this API would refuse on a write.

Example:

"signed"

category
string
required

The swim lane it groups into. Open, as eventType is.

Example:

"commercial"

significance
string
required

high, medium or low. Open, as above.

Example:

"high"

title
string
required

A one-line description of the event.

Example:

"Master Services Agreement"

isAiExtracted
boolean
required

False for an event created through this API or typed into the product.

Example:

false

isPrimaryInGroup
boolean
required

False when this event duplicates another and was not chosen as the representative. Pass primaryOnly=true to drop the non-primary copies.

Example:

false

createdAt
string<date-time>
required

When the row was written.

Example:

"2026-08-19T14:32:10Z"

updatedAt
string<date-time>
required

When it last changed.

Example:

"2026-08-19T14:32:10Z"

documentId
string | null

The doc_ document this event was extracted from, or null for an event somebody entered by hand.

Example:

"doc_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"

documentName
string | null

That document's filename, resolved at read time.

Example:

"msa-acme-v3.docx"

eventDateEnd
string<date> | null

The end of the range, for an event that spans days.

Example:

"2026-08-19"

description
string | null

The longer account, when there is one.

Example:

"Master services agreement with Acme for the 2026 platform rollout."

parties
string[]

Who was involved.

Example:
tags
string[]

Free-form labels.

Example:
sourceText
string | null

The passage the event was extracted from. Locate this string in the document's text to find it; there is no offset to trust.

Example:

"This Master Services Agreement is entered into as of 19 August 2026 between Acme Corporation, a Delaware corporation, and the Supplier identified on the signature page."

sourcePageNumber
integer | null

The page the passage was found on, when it could be resolved.

Example:

1

confidenceScore
number | null

0 to 1 for an extracted event, null for a manual one.

Example:

1

Last modified on August 23, 2026