Set or change the contact mailing address Post

The API provides the feature to manage the mailing address for a contact, the API can set or update the existing mailing address for a contact, in order to set the mailing address for a contact pass the mailing address followed by the contact Id(RelatedToId).

Request Information

Body Parameters

Body parameters need to be integrated as json key value collection followed by valid object notations, below if the list of parameters can be sent as request body by an integrator.

Mailing Address. Pass contact-id in 'RelatedToId' while posting the information. If this is do perform a Change in existing address, then pass the current mailing address in 'Id' field

MailingAddress

Name	Description	Type	Additional information
VerificationDetails	Details for the Verified Address. DO NOT Explicitly set values. The verification details for the verified addresses are retrieved while fetching MailingAddress details or Contact Details. For unverified address this field would remain null or empty. If the address is existing, API Callers are requested to make call to GetXXXAddress(..) before SetXXXAddress(...) in order to ensure proper updation	AddressVerification	None.
AddressType		string	None.
AddressLine1	Address Line 1	string	None.
AddressLine2	Address Line 2	string	None.
AddressLine3	Address Line 3	string	None.
AddressLine4	Address Line 4	string	None.
PostalCode	Postal (ZIP) code	string	None.
City	City	string	None.
County	County	string	None.
Country	Country	string	None.
StateRegionProvince	Represnts the 2 digit State Code/Abbrevation.	string	String length: inclusive between 0 and 50
Plus4Code		string	None.
SetAsMailing		boolean	None.
SameAsMailing		boolean	None.
AddressCategory		string	None.
FormattedAddress		string	None.
Id		integer	None.
RelatedToId		integer	None.
MergedWith_Or_Secondary_Id		integer	None.
MergeType		string	None.
SortOrder		integer	None.

Request Format

Below is the typical object of the request, in order to use the API for various requirement, refer the documentation.

{
  "VerificationDetails": {
    "Latitude": 1.1,
    "Longitude": 1.1,
    "CarrierRoute": "String Parameter 1",
    "DeliveryPointBarcode": "String Parameter 2",
    "AddressCensusStatistics": "String Parameter 4",
    "AddressJurisdictions": "String Parameter 5"
  },
  "AddressType": "Mailing",
  "AddressLine1": "String Parameter 2",
  "AddressLine2": "String Parameter 3",
  "AddressLine3": "String Parameter 4",
  "AddressLine4": "String Parameter 5",
  "PostalCode": "String Parameter 6",
  "City": "String Parameter 7",
  "County": "String Parameter 8",
  "Country": "String Parameter 9",
  "StateRegionProvince": "String Parameter 10",
  "Plus4Code": "String Parameter 11",
  "SetAsMailing": true,
  "SameAsMailing": true,
  "AddressCategory": "String Parameter 14",
  "FormattedAddress": "String Parameter 15",
  "Id": 16,
  "RelatedToId": 1,
  "MergedWith_Or_Secondary_Id": 1,
  "MergeType": "String Parameter 17",
  "SortOrder": 1
}

Setting the mailing address

In order to set the mailing address for a contact pass the address parameters with the contact id(RelatedToId) associated with:

{
  "AddressLine1": "206",
  "AddressLine2": "Sarthik 2",
  "AddressLine3": "Opp rajapath Club",
  "PostalCode": "380001",
  "City": "Ahmedabad",
  "Country": "India",
  "StateRegionProvince": "Gujarat",
  "RelatedToId": 9831292
}

Updating the mailing address

In order to update the mailing address, pass the RelatedToId and address Id combination in request body, below is the sample

{
  "AddressLine1": "206/2nd floor",
  "AddressLine2": "Sarthik 2",
  "AddressLine3": "Opp rajapath Club",
  "PostalCode": "380001",
  "City": "Ahmedabad",
  "Country": "India",
  "Id":55590513,
  "StateRegionProvince": "Gujarat",
  "RelatedToId": 9831292
}

Response Information

Resource Description

Address-ID

ITypedResponseOfNullableOfInt32

Name	Description	Type	Additional information
Result		integer	None.
Category		string	None.

Response Formats

Sample not available.