POST v1/Contacts/InactivateContacts

Inactivates a list of given Contacts

Request Information

URI Parameters

None.

Body Parameters

list of contact IDs to be updated

Name	Type	Additional information
CustomerIDs	Collection of integer	None.
ProspectIDs	Collection of integer	None.
CarrierIDs	Collection of integer	None.
MgaIDs	Collection of integer	None.
EmployeeIDs	Collection of integer	None.
CertHolderIDs	Collection of integer	None.
LienholderIDs	Collection of integer	None.
FinanceCompanyIDs	Collection of integer	None.
VendorIDs	Collection of integer	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerIDs": [
    1,
    2
  ],
  "ProspectIDs": [
    1,
    2
  ],
  "CarrierIDs": [
    1,
    2
  ],
  "MgaIDs": [
    1,
    2
  ],
  "EmployeeIDs": [
    1,
    2
  ],
  "CertHolderIDs": [
    1,
    2
  ],
  "LienholderIDs": [
    1,
    2
  ],
  "FinanceCompanyIDs": [
    1,
    2
  ],
  "VendorIDs": [
    1,
    2
  ]
}

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 'InactivateContactsDTO'.

application/xml, text/xml

Sample:

<InactivateContactsDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts">
  <CarrierIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CarrierIDs>
  <CertHolderIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CertHolderIDs>
  <CustomerIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CustomerIDs>
  <EmployeeIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </EmployeeIDs>
  <FinanceCompanyIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </FinanceCompanyIDs>
  <LienholderIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </LienholderIDs>
  <MgaIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </MgaIDs>
  <ProspectIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ProspectIDs>
  <VendorIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </VendorIDs>
</InactivateContactsDTO>

Response Information

Resource Description

Action result

InactivateContactsResultDTO

Name	Type	Additional information
IsSuccess	boolean	None.
CustomerIDs	Collection of ContactResult	None.
ProspectIDs	Collection of ContactResult	None.
CarrierIDs	Collection of ContactResult	None.
MgaIDs	Collection of ContactResult	None.
EmployeeIDs	Collection of ContactResult	None.
CertHolderIDs	Collection of ContactResult	None.
LienholderIDs	Collection of ContactResult	None.
FinanceCompanyIDs	Collection of ContactResult	None.
VendorIDs	Collection of ContactResult	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccess": true,
  "CustomerIDs": null,
  "ProspectIDs": null,
  "CarrierIDs": null,
  "MgaIDs": null,
  "EmployeeIDs": null,
  "CertHolderIDs": null,
  "LienholderIDs": null,
  "FinanceCompanyIDs": null,
  "VendorIDs": null
}

application/xml, text/xml

Sample:

<InactivateContactsResultDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts">
  <CarrierIDs i:nil="true" />
  <CertHolderIDs i:nil="true" />
  <CustomerIDs i:nil="true" />
  <EmployeeIDs i:nil="true" />
  <FinanceCompanyIDs i:nil="true" />
  <IsSuccess>true</IsSuccess>
  <LienholderIDs i:nil="true" />
  <MgaIDs i:nil="true" />
  <ProspectIDs i:nil="true" />
  <VendorIDs i:nil="true" />
</InactivateContactsResultDTO>