PUT v1/PersonalCustomers/{customerID}/AdditionalContacts

Upsert an additional/business contact for a customer. Set EntityID to 0 to insert a new contact, or to the existing ID to update.

Request Information

URI Parameters

Name	Description	Type	Additional information
customerID	ID of the customer	integer	Required

Body Parameters

Contact fields to save

AdditionalBusinessContactDTO

Name	Description	Type	Additional information
EntityID	The contact's entity ID. Required when updating (EntityRelationEntityID > 0).	integer	None.
RelationID	ID of the relation type (e.g. Spouse, Child).	integer	None.
EmergencyContact	Whether this contact is an emergency contact for the parent entity.	boolean	None.
PrimaryContact	Whether this is the primary contact for the business. Not applicable for additional contacts.	boolean	None.
FirstName	First name of the contact.	string	None.
MiddleName	Middle name of the contact.	string	None.
LastName	Last name of the contact.	string	None.
Salutation	Salutation (e.g. Mr., Mrs., Dr.).	string	None.
Nickname	Nickname of the contact.	string	None.
Gender	Gender of the contact.	string	None.
DOB	Date of birth in MM/DD/YYYY format.	string	None.
MaritalStatusID	ID of the marital status.	byte	None.
OccupationID	ID of the occupation.	integer	None.
isBusinessOwner	Whether the contact is a business owner.	boolean	None.
ResidenceTypeID	ID of the residence type.	byte	None.
LicenseStateCode	Driver's license state code. The license number is excluded for privacy.	string	None.
LicenseCountry	Driver's license country. The license number is excluded for privacy.	string	None.
WebPage	Web page URL for the contact.	string	None.
PreferredLanguageCode	Preferred language code.	string	None.
Notes	Notes about the contact.	string	None.
Address	Addresses for the contact. AddressTypeID valid values: G (Garage), L (Location/Property), M (Mailing), B (Billing).	AdditionalBusinessAddressDTO	None.
PhoneNumbers	Phone numbers for the contact.	Collection of AdditionalContactPhoneDTO	None.
EmailAddresses	Email addresses for the contact.	Collection of AdditionalContactEmailDTO	None.

Request Formats

application/json, text/json

Sample:

{
  "EntityID": 1,
  "RelationID": 1,
  "EmergencyContact": true,
  "PrimaryContact": true,
  "FirstName": "sample string 4",
  "MiddleName": "sample string 5",
  "LastName": "sample string 6",
  "Salutation": "sample string 7",
  "Nickname": "sample string 8",
  "Gender": "sample string 9",
  "DOB": "sample string 10",
  "MaritalStatusID": 64,
  "OccupationID": 1,
  "isBusinessOwner": true,
  "ResidenceTypeID": 64,
  "LicenseStateCode": "sample string 11",
  "LicenseCountry": "sample string 12",
  "WebPage": "sample string 13",
  "PreferredLanguageCode": "sample string 14",
  "Notes": "sample string 15",
  "Address": {
    "Street": "sample string 1",
    "AptSuiteOther": "sample string 2",
    "City": "sample string 3",
    "State": "sample string 4",
    "County": "sample string 5",
    "Zip": "sample string 6",
    "CountryCode": "sample string 7"
  },
  "PhoneNumbers": [
    {
      "PhoneNumber": "sample string 1",
      "ContactInfoTypeID": 2,
      "IsPrimary": true,
      "OptOut": true
    },
    {
      "PhoneNumber": "sample string 1",
      "ContactInfoTypeID": 2,
      "IsPrimary": true,
      "OptOut": true
    }
  ],
  "EmailAddresses": [
    {
      "EmailAddress": "sample string 1",
      "ContactInfoTypeID": 2,
      "IsPrimary": true
    },
    {
      "EmailAddress": "sample string 1",
      "ContactInfoTypeID": 2,
      "IsPrimary": true
    }
  ]
}

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

application/xml, text/xml

Sample:

<AdditionalBusinessContactDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts">
  <Address>
    <AptSuiteOther>sample string 2</AptSuiteOther>
    <City>sample string 3</City>
    <CountryCode>sample string 7</CountryCode>
    <County>sample string 5</County>
    <State>sample string 4</State>
    <Street>sample string 1</Street>
    <Zip>sample string 6</Zip>
  </Address>
  <DOB>sample string 10</DOB>
  <EmailAddresses>
    <AdditionalContactEmailDTO>
      <ContactInfoTypeID>2</ContactInfoTypeID>
      <EmailAddress>sample string 1</EmailAddress>
      <IsPrimary>true</IsPrimary>
    </AdditionalContactEmailDTO>
    <AdditionalContactEmailDTO>
      <ContactInfoTypeID>2</ContactInfoTypeID>
      <EmailAddress>sample string 1</EmailAddress>
      <IsPrimary>true</IsPrimary>
    </AdditionalContactEmailDTO>
  </EmailAddresses>
  <EmergencyContact>true</EmergencyContact>
  <EntityID>1</EntityID>
  <FirstName>sample string 4</FirstName>
  <Gender>sample string 9</Gender>
  <LastName>sample string 6</LastName>
  <LicenseCountry>sample string 12</LicenseCountry>
  <LicenseStateCode>sample string 11</LicenseStateCode>
  <MaritalStatusID>64</MaritalStatusID>
  <MiddleName>sample string 5</MiddleName>
  <Nickname>sample string 8</Nickname>
  <Notes>sample string 15</Notes>
  <OccupationID>1</OccupationID>
  <PhoneNumbers>
    <AdditionalContactPhoneDTO>
      <ContactInfoTypeID>2</ContactInfoTypeID>
      <IsPrimary>true</IsPrimary>
      <OptOut>true</OptOut>
      <PhoneNumber>sample string 1</PhoneNumber>
    </AdditionalContactPhoneDTO>
    <AdditionalContactPhoneDTO>
      <ContactInfoTypeID>2</ContactInfoTypeID>
      <IsPrimary>true</IsPrimary>
      <OptOut>true</OptOut>
      <PhoneNumber>sample string 1</PhoneNumber>
    </AdditionalContactPhoneDTO>
  </PhoneNumbers>
  <PreferredLanguageCode>sample string 14</PreferredLanguageCode>
  <PrimaryContact>true</PrimaryContact>
  <RelationID>1</RelationID>
  <ResidenceTypeID>64</ResidenceTypeID>
  <Salutation>sample string 7</Salutation>
  <WebPage>sample string 13</WebPage>
  <isBusinessOwner>true</isBusinessOwner>
</AdditionalBusinessContactDTO>

Response Information

Resource Description

ActionResultDTO

Name	Description	Type	Additional 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>