Skip to main content
PATCH
cURL
Updates an existing policy. Every field is optional and only supplied fields change. The policy must belong to the authenticated upstream entity.

Path Parameters

Association Fields Are Set-or-Clear

productId and downstreamEntityAssociationId follow this rule. Omitting a field leaves the existing association untouched.

Response Shape

All successful responses are wrapped in the standard response envelope. See Request/Response Conventions.
The response is the full policy object, identical in shape to Create Policy.

Error Scenarios

Bad Request (400)

Returned when policyId is malformed or the body fails validation.

Not Found (404)

Returned when the policy, or a supplied productId or downstreamEntityAssociationId, does not exist for your upstream entity.

Unauthorized (401)

Missing or invalid authentication token. See Authentication.

Path Parameters

policyId
string
required

Unique identifier of the policy

Example:

"6650a1b2c3d4e5f6a7b8c9d0"

Body

application/json
currentStatus
enum<string>

Lifecycle status override

Available options:
bound,
active,
expired,
cancelled,
non renewed
Example:

"active"

insuredEntityName
string

Name of the insured party

Example:

"Example Corp"

agencyName
string

Agency name

Example:

"Premier Insurance Agency"

carrierName
string

Insurance carrier name

Example:

"National Insurance Co"

effectiveDate
string

Policy effective date (ISO 8601)

Example:

"2025-01-15T00:00:00.000Z"

expiryDate
string

Policy expiration date (ISO 8601)

Example:

"2026-01-15T00:00:00.000Z"

premiumAmountInUSD
number

Premium amount in USD

Example:

5000

aggregateCoverageInUSD
number

Aggregate coverage limit in USD

Example:

1000000

coveragePerClaimInUSD
number

Per-claim coverage limit in USD

Example:

500000

lineOfBusiness
string

Line of business

Example:

"Commercial Lines"

licenseNumber
string

License number

Example:

"LIC-001"

npn
string

National Producer Number

Example:

"11223344"

producerName
string

Producing agent name

Example:

"Jon Doe"

producerCode
string

Producer identifier code

Example:

"PROD-001"

productName
string

Product name

Example:

"General Liability"

productCode
string

Product code

Example:

"GL-100"

filingNumber
string

Filing number

Example:

"FIL-2025-001"

slaNumber
string

SLA number

Example:

"SLA-2025-001"

externalBillingId
string

External billing identifier

Example:

"BILL-2025-001"

agencyNpn
string

Agency National Producer Number

Example:

"12345678"

agencyFein
string

Agency Federal Employer Identification Number

Example:

"12-3456789"

agencyLicenseNumber
string

Agency state license number

Example:

"ABC-123456"

agencyLicensedStateCode
string

State where the agency license was issued

Example:

"CA"

agentName
string

Individual agent name

Example:

"John Smith"

agentNpn
string

Agent National Producer Number

Example:

"87654321"

agentLicenseNumber
string

Agent state license number

Example:

"LIC-789012"

agentLicensedState
string

State where the agent license was issued

Example:

"TX"

productId
string | null

Product association. Pass an id to (re)link, or null to clear the product match.

Example:

"6650a1b2c3d4e5f6a7b8c9d0"

downstreamEntityAssociationId
string | null

Agency association (downstreamEntityAssociationId from GET /downstream-entity-associations). Pass an id to (re)link, or null to clear the agency match.

Example:

"6650a1b2c3d4e5f6a7b8c9d0"

Response

Updated policy

data
object
required
requestId
string
required

Unique request identifier

Example:

"dev-2c5e7cf2-9acf-4c8c-ab2f-b81f39d775a8"

timestamp
string
required

Response timestamp

Example:

"2025-11-12T20:49:03.293Z"