Update a report

patch

https://api.kalepa.com/external/reports/{report_id}

Update mutable fields of a report — for example its name, assigned underwriter, status, key dates, brokerage/broker, identifiers, org group or the first named insured's requested name and address. Target the report by its Kalepa report ID or by your own external_id (auto-detected by shape; use id_type to force it, and org_group / sub_org_group to select a scope when targeting by external_id). Returns the report's ID and name.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

report_id

string

required

length ≥ 1

Identifies the report: either its Kalepa report ID (the id returned when the report is created) or the external_id you set on the report (on create, or later via PATCH). The value is auto-detected by shape — a UUID-shaped value (for example a dashed UUID or 32 hexadecimal characters; brace-wrapped and urn:uuid: forms count too) is treated as the Kalepa report ID, anything else as your external_id. Use the id_type query parameter to force the interpretation, and org_group / sub_org_group to narrow an external_id that is reused across groups. Deleted reports are never matched. When the same external_id is on several reports, archived reports are ignored if at least one non-archived report matches; if more than one report still matches, the request fails with 400 and error code AMBIGUOUS_IDENTIFIER (in the response body at detail.code). An external_id lookup searches only the reports available to your API client; anything else answers 404. URL-encode reserved characters (e.g. a space as %20). Two values cannot be used in this path segment: an external_id containing a forward slash (/), and the exact value extract when calling GET /external/reports/{report_id} (that path is a different endpoint). For those, look up the Kalepa report ID with GET /external/report_id and use that instead.

Query Params

id_type

string

enum

Overrides how the report_id path value is interpreted: uuid (the Kalepa report ID) or external_id (your own identifier). Omit for auto-detect (a UUID-shaped value is treated as uuid, otherwise as external_id). Set external_id when your identifier is itself UUID-shaped (for example a dashed UUID or 32 hexadecimal characters) and would otherwise be read as a Kalepa report ID. With id_type=uuid, a path value that is not a valid UUID returns 400; any id_type value other than uuid or external_id also returns 400.

Allowed:

org_group

string

Used only when the report is targeted by external_id: exact match on the report's org_group. Pass an empty value (?org_group=) to match reports that have no org_group. Omit the parameter to skip the filter.

sub_org_group

string

Used only when the report is targeted by external_id: exact match on the report's sub_org_group. Pass an empty value (?sub_org_group=) to match reports that have no sub_org_group. Omit the parameter to skip the filter.

Body Params

name

string | null

the name of the report.

assigned_user_email

string | null

the email address of the assigned underwriter (the underwriter must have a Kalepa account)

assigned_user_code

string | null

code identifying the underwriter in your system, resolved to the assigned underwriter in Kalepa (the underwriter must have a Kalepa account). If assigned_user_email is sent as well, both must identify the same underwriter.

external_id

string | null

id of the submission in the insurer's system

requested_name

string | null

The requested name of the first named insured, as your system has it. Updates the first named insured's requested name only; the business Kalepa resolved it to is left unchanged. When the report has no first named insured yet but exactly one business, that business is updated. Returns 400 when the report has no business to update. A null or empty value is ignored.

requested_address

string | null

The requested address of the first named insured, as your system has it. Updates the first named insured's requested address only; the business Kalepa resolved it to is left unchanged. When the report has no first named insured yet but exactly one business, that business is updated. Returns 400 when the report has no business to update. A null or empty value is ignored.

is_renewal

boolean | null

flag indicating whether submission is a renewal

status

string | null

enum

status of the report

status_details

object | null

additional details of the status e.g. decline reason

proposed_effective_date

date-time | null

proposed effective date of the insurance policy

policy_expiration_date

date-time | null

expiration date of the insurance policy

received_date

date-time | null

received date of the inquiry

coverages

array of objects | null

list of coverages and related premiums

coverages

email_body

string | null

the body content of the related email

email_subject

string | null

the subject of the related email

email_message_id

string | null

the message ID of the related email

email_references

string | null

the references header of the related email

brokerage

string | null

brokerage/agency who provided the submission

brokerage_office

string | null

brokerage/agency location

broker

string | null

broker/agent who provided the submission

broker_email

string | null

email of the broker/agent who provided the submission

broker_code

string | null

code identifying the broker/agent who provided the submission

correspondence_contact_name

string | null

point of contact for the submission

correspondence_contact_email

string | null

email for the point of contact for the submission

sub_producer_name

string | null

name of the sub producer of the submission

sub_producer_email

string | null

email of the sub producer of the submission

retail_brokerage

string | null

the retail brokerage/agency associated with the submission

retail_broker

string | null

name of the retail broker/agent associated with the submission

retail_broker_email

string | null

email of the retail broker/agent associated with the submission

additional_identifiers

array of objects | null

additional_identifiers

org_group

string | null

the group associated with the submission

sub_org_group

string | null

the sub-group associated with the submission

primary_naics_code

string | null

NAICS code of the business

iso_gl_code

string | null

ISO General Liability code of the business

sic_code

string | null

SIC code of the business

client_clearing_status

string | null

client-specific clearing status of the submission

additional_data

object | null

additional data related to the report

created_at

date-time | null

the timestamp when the report was created

client_status

string | null

client-specific status of the report. Must match one of your organization's configured statuses exactly (case-sensitive; surrounding whitespace is ignored). An unknown value returns 400 with the list of allowed statuses, and nothing in the request is applied. A null or blank value is ignored.

Responses

400

The request is invalid, or the supplied external_id matches more than one report (error code AMBIGUOUS_IDENTIFIER, in the response body at detail.code). Narrow with org_group / sub_org_group, or target the report by its Kalepa report ID. Also returned when requested_name or requested_address is sent for a report that has no business to update, and when client_status matches none of your organization's configured statuses.

401

The bearer token is missing or invalid.

403

The authenticated client is not permitted to access this resource (e.g. insufficient permissions or org-group scope).

404

The Report was not found.

409

The external_id in the body is already assigned to another non-deleted report in your organization. Sending the report's current external_id does not conflict.

429

The report is currently locked by another update; retry after a short delay.

500

An unexpected error occurred.

200The Report was successfully updated.