Update Submission

Updates an existing submission. Only send fields you want to change (PATCH semantics).

Optional update fields:

• name - Update submission name (send null to clear)
• status - Update submission status
• type - Update submission type
• renewingPolicyId - Update renewing policy (send null to clear)
• declineReason - Update decline reason (send null to clear)

Note: The renewingPolicyId must reference an existing, non-deleted policy.

Required permission: company.submission:update

PATCH /api/external/companies/{companyId}/submissions/{submissionId}

cURL

updateName

curl --request PATCH \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/submissions/{submissionId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme Corp - Updated Submission"
}
'

200

success

{
  "id": "550e8400-e29b-41d4-a716-446655440001",
  "companyId": "660e8400-e29b-41d4-a716-446655440000",
  "number": "SUB-2024-001",
  "name": "Acme Corp - Updated Submission",
  "status": "quoted",
  "type": "new_business",
  "primaryInsuredName": "Acme Corporation",
  "applicationId": "550e8400-e29b-41d4-a716-446655440010",
  "renewingPolicyId": null,
  "renewingPolicyNumber": null,
  "declineReason": null,
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-20T09:00:00.000Z",
  "closedAt": null,
  "boundAt": null
}

Authorizations

Authorization · string · header · required

API key authentication. Include your API key in the Authorization header.

Path Parameters

companyId · string<uuid> · required

Company identifier

submissionId · string<uuid> · required

Submission identifier

Body

application/json

Request to update a submission. All fields are optional (PATCH semantics).

name · string | null

Update submission name (send null to clear)

status · enum<string>

Available options: in_progress, submitted, quote_in_progress, quoted, bound, declined, expired, cancelled

type · enum<string>

Internal submission type

Available options: new_business, renewal, endorsement, cancellation, reinstatement

renewingPolicyId · string<uuid> | null

Policy ID being renewed (send null to clear)

declineReason · string | null

Reason for declining (send null to clear, typically set when status is 'declined')

Response

200

application/json

Submission updated successfully

The updated submission (without quoteIds)

id · string<uuid>

companyId · string<uuid>

number · string

name · string | null

status · enum<string>

Available options: in_progress, submitted, quote_in_progress, quoted, bound, declined, expired, cancelled

type · enum<string>

Internal submission type

Available options: new_business, renewal, endorsement, cancellation, reinstatement

primaryInsuredName · string | null

applicationId · string<uuid> | null

renewingPolicyId · string<uuid> | null

renewingPolicyNumber · string | null

declineReason · string | null

createdAt · string<date-time>

updatedAt · string<date-time> | null

closedAt · string<date-time> | null

boundAt · string<date-time> | null