PATCH v1/Policies/{policyID}/UpdatePolicy

Updates a policy. Top-level policy fields are updated individually when provided. They will not be changed when not included in the request object or passed in as null. Nested collections (such as Quotes, Named Insureds, and Binder Information) replace existing data and require all fields to be specified.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
policyID

The policy to update

integer

Required

Body Parameters

The policy DTO

PolicyUpdateDTO
NameDescriptionTypeAdditional information
PolicyNo

Policy number

string

None.

Status

Status of the policy

string

None.

CarrierID

Id of the carrier

integer

None.

AgentID

Id of the agent

integer

None.

CsrID

Id of the CSR

integer

None.

EffectiveDate

Effective date of the policy

string

None.

ExpirationDate

Expiration date of the policy

string

None.

BusinessType

Business type of the policy

string

None.

Description

Description of policy

string

None.

Nonrenewal

Nonrenewal

boolean

None.

Reinstated

Reinstated

boolean

None.

ProducerIDs

List of Producer IDs

Collection of integer

None.

BinderNumber

Binder number

string

None.

BinderDate

Binder date

string

None.

BinderInfo

Binder info

PolicyBinderInfoDTO

None.

Quotes

List of Quotes

Collection of QuoteDTO

None.

NamedInsured

List of Named Insureds

Collection of PolicyNamedInsuredDTO

None.

Request Formats

application/json, text/json

Sample:
{
  "PolicyNo": "sample string 1",
  "Status": "sample string 2",
  "CarrierID": 1,
  "AgentID": 1,
  "CsrID": 1,
  "EffectiveDate": "sample string 3",
  "ExpirationDate": "sample string 4",
  "BusinessType": "sample string 5",
  "Description": "sample string 6",
  "Nonrenewal": true,
  "Reinstated": true,
  "ProducerIDs": [
    1,
    2
  ],
  "BinderNumber": "sample string 7",
  "BinderDate": "sample string 8",
  "BinderInfo": {
    "BinderInfoID": 1,
    "BinderPurposeID": 1,
    "NewBinder": true,
    "NonStandardConditions": true,
    "BinderDocument": "sample string 2",
    "BinderEffectiveTime": "00:00:00.1234567",
    "NumberOfDays": 1,
    "BinderExpirationDate": "2026-08-14T17:26:30.381968+00:00",
    "BinderExpirationTime": "00:00:00.1234567"
  },
  "Quotes": [
    {
      "QuoteID": 1,
      "PolicyID": 2,
      "QuoteNumber": "sample string 3",
      "QuoteStatus": "sample string 4",
      "QuoteSubStatus": "sample string 5",
      "QuoteType": "sample string 6",
      "CarrierID": 1,
      "MGAID": 1,
      "QuoteDate": "2026-08-14T17:26:30.381968+00:00",
      "QuoteExpirationDate": "2026-08-14T17:26:30.381968+00:00",
      "QuotedByID": 7,
      "Conditions": "sample string 8",
      "BasePremium": 1.0,
      "IsDeleted": true,
      "Preferred": true,
      "QuoteCarrierFees": [
        {
          "QuoteID": 1,
          "CarrierFeeID": 2,
          "AmountIsPercent": true,
          "Amount": 4.0
        },
        {
          "QuoteID": 1,
          "CarrierFeeID": 2,
          "AmountIsPercent": true,
          "Amount": 4.0
        }
      ]
    },
    {
      "QuoteID": 1,
      "PolicyID": 2,
      "QuoteNumber": "sample string 3",
      "QuoteStatus": "sample string 4",
      "QuoteSubStatus": "sample string 5",
      "QuoteType": "sample string 6",
      "CarrierID": 1,
      "MGAID": 1,
      "QuoteDate": "2026-08-14T17:26:30.381968+00:00",
      "QuoteExpirationDate": "2026-08-14T17:26:30.381968+00:00",
      "QuotedByID": 7,
      "Conditions": "sample string 8",
      "BasePremium": 1.0,
      "IsDeleted": true,
      "Preferred": true,
      "QuoteCarrierFees": [
        {
          "QuoteID": 1,
          "CarrierFeeID": 2,
          "AmountIsPercent": true,
          "Amount": 4.0
        },
        {
          "QuoteID": 1,
          "CarrierFeeID": 2,
          "AmountIsPercent": true,
          "Amount": 4.0
        }
      ]
    }
  ],
  "NamedInsured": [
    {
      "PolicyNamedInsuredID": 1,
      "PolicyQuoteID": 2,
      "NamedInsured": "sample string 3",
      "ListOrder": 64,
      "CompanyId": "sample string 5",
      "AgencyId": "sample string 6",
      "LegalEntityCode": "sample string 7",
      "NoOfMemberAndManagers": 1,
      "TaxCode": "sample string 8",
      "EducationLevelId": 1,
      "CountryId": "sample string 9"
    },
    {
      "PolicyNamedInsuredID": 1,
      "PolicyQuoteID": 2,
      "NamedInsured": "sample string 3",
      "ListOrder": 64,
      "CompanyId": "sample string 5",
      "AgencyId": "sample string 6",
      "LegalEntityCode": "sample string 7",
      "NoOfMemberAndManagers": 1,
      "TaxCode": "sample string 8",
      "EducationLevelId": 1,
      "CountryId": "sample string 9"
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PolicyUpdateDTO'.

application/xml, text/xml

Sample:
<PolicyUpdateDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Policies">
  <AgentID>1</AgentID>
  <BinderDate>sample string 8</BinderDate>
  <BinderInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Policies.MultipleIssuePolicies">
    <d2p1:BinderDocument>sample string 2</d2p1:BinderDocument>
    <d2p1:BinderEffectiveTime>PT0.1234567S</d2p1:BinderEffectiveTime>
    <d2p1:BinderExpirationDate>2026-08-14T17:26:30.381968+00:00</d2p1:BinderExpirationDate>
    <d2p1:BinderExpirationTime>PT0.1234567S</d2p1:BinderExpirationTime>
    <d2p1:BinderInfoID>1</d2p1:BinderInfoID>
    <d2p1:BinderPurposeID>1</d2p1:BinderPurposeID>
    <d2p1:NewBinder>true</d2p1:NewBinder>
    <d2p1:NonStandardConditions>true</d2p1:NonStandardConditions>
    <d2p1:NumberOfDays>1</d2p1:NumberOfDays>
  </BinderInfo>
  <BinderNumber>sample string 7</BinderNumber>
  <BusinessType>sample string 5</BusinessType>
  <CarrierID>1</CarrierID>
  <CsrID>1</CsrID>
  <Description>sample string 6</Description>
  <EffectiveDate>sample string 3</EffectiveDate>
  <ExpirationDate>sample string 4</ExpirationDate>
  <NamedInsured>
    <PolicyNamedInsuredDTO>
      <AgencyId>sample string 6</AgencyId>
      <CompanyId>sample string 5</CompanyId>
      <CountryId>sample string 9</CountryId>
      <EducationLevelId>1</EducationLevelId>
      <LegalEntityCode>sample string 7</LegalEntityCode>
      <ListOrder>64</ListOrder>
      <NamedInsured>sample string 3</NamedInsured>
      <NoOfMemberAndManagers>1</NoOfMemberAndManagers>
      <PolicyNamedInsuredID>1</PolicyNamedInsuredID>
      <PolicyQuoteID>2</PolicyQuoteID>
      <TaxCode>sample string 8</TaxCode>
    </PolicyNamedInsuredDTO>
    <PolicyNamedInsuredDTO>
      <AgencyId>sample string 6</AgencyId>
      <CompanyId>sample string 5</CompanyId>
      <CountryId>sample string 9</CountryId>
      <EducationLevelId>1</EducationLevelId>
      <LegalEntityCode>sample string 7</LegalEntityCode>
      <ListOrder>64</ListOrder>
      <NamedInsured>sample string 3</NamedInsured>
      <NoOfMemberAndManagers>1</NoOfMemberAndManagers>
      <PolicyNamedInsuredID>1</PolicyNamedInsuredID>
      <PolicyQuoteID>2</PolicyQuoteID>
      <TaxCode>sample string 8</TaxCode>
    </PolicyNamedInsuredDTO>
  </NamedInsured>
  <Nonrenewal>true</Nonrenewal>
  <PolicyNo>sample string 1</PolicyNo>
  <ProducerIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ProducerIDs>
  <Quotes>
    <QuoteDTO>
      <BasePremium>1</BasePremium>
      <CarrierID>1</CarrierID>
      <Conditions>sample string 8</Conditions>
      <IsDeleted>true</IsDeleted>
      <MGAID>1</MGAID>
      <PolicyID>2</PolicyID>
      <Preferred>true</Preferred>
      <QuoteCarrierFees>
        <QuoteCarrierFeeDTO>
          <Amount>4</Amount>
          <AmountIsPercent>true</AmountIsPercent>
          <CarrierFeeID>2</CarrierFeeID>
          <QuoteID>1</QuoteID>
        </QuoteCarrierFeeDTO>
        <QuoteCarrierFeeDTO>
          <Amount>4</Amount>
          <AmountIsPercent>true</AmountIsPercent>
          <CarrierFeeID>2</CarrierFeeID>
          <QuoteID>1</QuoteID>
        </QuoteCarrierFeeDTO>
      </QuoteCarrierFees>
      <QuoteDate>2026-08-14T17:26:30.381968+00:00</QuoteDate>
      <QuoteExpirationDate>2026-08-14T17:26:30.381968+00:00</QuoteExpirationDate>
      <QuoteID>1</QuoteID>
      <QuoteNumber>sample string 3</QuoteNumber>
      <QuoteStatus>sample string 4</QuoteStatus>
      <QuoteSubStatus>sample string 5</QuoteSubStatus>
      <QuoteType>sample string 6</QuoteType>
      <QuotedByID>7</QuotedByID>
    </QuoteDTO>
    <QuoteDTO>
      <BasePremium>1</BasePremium>
      <CarrierID>1</CarrierID>
      <Conditions>sample string 8</Conditions>
      <IsDeleted>true</IsDeleted>
      <MGAID>1</MGAID>
      <PolicyID>2</PolicyID>
      <Preferred>true</Preferred>
      <QuoteCarrierFees>
        <QuoteCarrierFeeDTO>
          <Amount>4</Amount>
          <AmountIsPercent>true</AmountIsPercent>
          <CarrierFeeID>2</CarrierFeeID>
          <QuoteID>1</QuoteID>
        </QuoteCarrierFeeDTO>
        <QuoteCarrierFeeDTO>
          <Amount>4</Amount>
          <AmountIsPercent>true</AmountIsPercent>
          <CarrierFeeID>2</CarrierFeeID>
          <QuoteID>1</QuoteID>
        </QuoteCarrierFeeDTO>
      </QuoteCarrierFees>
      <QuoteDate>2026-08-14T17:26:30.381968+00:00</QuoteDate>
      <QuoteExpirationDate>2026-08-14T17:26:30.381968+00:00</QuoteExpirationDate>
      <QuoteID>1</QuoteID>
      <QuoteNumber>sample string 3</QuoteNumber>
      <QuoteStatus>sample string 4</QuoteStatus>
      <QuoteSubStatus>sample string 5</QuoteSubStatus>
      <QuoteType>sample string 6</QuoteType>
      <QuotedByID>7</QuotedByID>
    </QuoteDTO>
  </Quotes>
  <Reinstated>true</Reinstated>
  <Status>sample string 2</Status>
</PolicyUpdateDTO>

Response Information

Resource Description

ActionResultDTO
NameDescriptionTypeAdditional information
IsSuccess

Signifies whether action is successful

boolean

None.

ErrorCode

Error code

string

None.

ErrorMessage

Error message

string

None.

InfoMessage

Information message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccess": true,
  "ErrorCode": "sample string 2",
  "ErrorMessage": "sample string 3",
  "InfoMessage": "sample string 4"
}

application/xml, text/xml

Sample:
<ActionResultDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
  <ErrorCode>sample string 2</ErrorCode>
  <ErrorMessage>sample string 3</ErrorMessage>
  <InfoMessage>sample string 4</InfoMessage>
  <IsSuccess>true</IsSuccess>
</ActionResultDTO>