MagicDoorAPI
SupportOpen MagicDoor
External insurance

Update an external insurance record

Corrects the details on a record of a policy bought outside MagicDoor. Only records awaiting review or already rejected can be changed; an approved record cannot. Omitted fields keep their current value. Requires the leasing_insurance:write permission.

PUT
https://services.magicdoor.com/tenantinsurance/company-portal/insurance/externals/{externalId}

Authorization

Authorizationstringrequired
Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

externalIdstringrequired

The external insurance record to act on.

example: 1851002938471120896

Body

application/json

Every field is optional. There is no way to clear a value: sending nothing leaves the stored value alone.

carrierNamestring

The insurance company that issued the policy. Up to 250 characters.

policyNumberstring

The policy number from the document. Up to 250 characters.

coverageAmountnumber

Coverage in dollars. Must be 0 or more.

policyStartDatestring · date-time

When the policy takes effect.

policyEndDatestring · date-time

When the policy expires.

resubmitIfRejectedboolean

When the record was rejected, leaving this true puts it back in front of a reviewer and clears the rejection reason. Set it to false to correct a rejected record without resubmitting it.

default: true

Response

200 · The updated record.

idstring

The external insurance record's id.

leaseIdstring

The lease this policy covers.

companyIdstring

The company that owns the lease.

carrierNamestring

The insurance company that issued the policy. An empty string when none was recorded.

policyNumberstring

The policy number taken from the document. Absent when none was recorded.

coverageAmountnumber

Coverage in dollars. Absent when none was recorded.

policyStartDatestring · date-time

When the policy takes effect.

policyEndDatestring · date-time

When the policy expires.

stateenum<string>

Where the record stands with the reviewer. A new record starts at pending; only an approved record counts as coverage for the lease.

pendingapprovedrejected
rejectionReasonstring

Why the record was rejected. Absent unless state is rejected and a reason was given.

insurancePolicyFileobject

The uploaded proof of insurance. Absent when the record has no document attached.

deletedstring · date-time

When the record was deleted. Absent while the record is live.

createdstring · date-time

When the record was created.

updatedstring · date-time

When the record last changed.

401 · The access token is missing, expired, or not a company portal token.

403 · The token is valid but the caller does not hold the `leasing_insurance:write` permission.

404 · No record with that id, or the record belongs to another company.

422 · The record has already been approved and cannot be modified. Delete it and create a new one instead.