Skip to main content
POST
Close Event

Authorizations

Authorization
string
header
required

API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey, and do not use an X-API-Key header; those are not accepted.

Path Parameters

companyId
string<uuid>
required

Company identifier

eventId
string<uuid>
required

Event (claim or incident) identifier

Body

application/json
effectiveOnDate
object
required

Field Model V1 Date value: a calendar day pinned to an IANA time zone — the day a person wrote on the policy, not an instant.

date is the day as YYYY-MM-DD and must name a real calendar day (2026-02-30 is rejected with 400). timezone is an IANA tz database identifier (e.g. America/New_York, UTC); an unknown zone is rejected with 400. On a write timezone may be omitted, in which case it defaults to America/New_York. Every value the API returns carries both members.

This is the one Date shape the API accepts, stores and returns, for every field typed Date — entity fields, policy term dates, custom-object sub-fields, embedded exposure items and the event lifecycle dates alike. The retired { day, month, year, timezone } spelling is refused with 400 (see the API changelog, 2026-09-08). The policy endorsement deltas channel additionally requires both members stated, because it stores each value exactly as sent (2026-09-04).

Response

The event was closed.

eventId
string<uuid>
required

The event that was closed.

eventStatus
enum<string>
required

The event's status after the call.

Available options:
closed