Update Contact Address

Updates the address information for the specified contact.

Resource Information

Scopecontacts

Deprecated scope name:   update_contacts_addresses

App TypeAll
Authorization TypeAccess token
URI /v4/contacts/{contactId}/addresses/{id}?lang={lang}
HTTP MethodPUT
Automation Version(s)7.3.3.4

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
addressLine1stringNo The first line of the address. 7.3.3.4
addressLine2stringNo The second line of the address.7.3.3.4
addressLine3stringNo The third line of the address.7.3.3.4
citystringNo The name of the city.7.3.3.4
countrycountry{}No Get All Address Countries The name of the country.7.3.3.4
country.textstringNo The localized display text.7.3.3.4
country.valuestringNo The value for the specified parameter.7.3.3.4
directiondirection{}No Get All Address Street Directions The street direction of the primary address associated with the application.7.3.3.4
direction.textstringNo The localized display text.7.3.3.4
direction.valuestringNo The value for the specified parameter.7.3.3.4
effectiveDatedateTimeNo The date when the address takes effect.7.3.3.4
expirationDatedateTimeNo The date when the address expires.7.3.3.4
faxstringNo The fax number for the contact.7.3.3.4
faxCountryCodestringNo Fax Number Country Code7.3.3.4
houseAlphaEndstringNo The ending street number that makes up the address.7.3.3.4
houseAlphaStartstringNo The beginning street number that makes up the address.7.3.3.4
idlongNo The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.4
isPrimarystringNoY | NIndicates whether or not to designate the address as the primary address. Only one address can be primary at any given time.7.3.3.4
levelEndstringNo The ending level number (floor number) that makes up the address within a complex.7.3.3.4
levelPrefixstringNo The prefix for the level numbers (floor numbers) that make up the address.7.3.3.4
levelStartstringNo The beginning level number (floor number) that makes up the address within a complex.7.3.3.4
phonestringNo The telephone number of the user. 7.3.3.4
phoneCountryCodestringNo The country code for the assoicated phone number.7.3.3.4
postalCodestringNo The postal ZIP code for the address.7.3.3.4
recipientstringNo The contact person for the contact address.7.3.3.4
statestate{}No Get All Address States The state corresponding to the address on record.7.3.3.4
state.textstringNo The localized display text.7.3.3.4
state.valuestringNo The value for the specified parameter.7.3.3.4
statusstatus{}NoA | IThe address status indicating whether the address is active or inactive.7.3.3.4
status.textstringNo The localized display text.7.3.3.4
status.valuestringNo The value for the specified parameter.7.3.3.4
streetAddressstringNo The street address. 7.3.3.4
streetEndlongNo The end of a range of street numbers.7.3.3.4
streetNamestringNo The street name for the address.7.3.3.4
streetPrefixstringNo Any part of an address that appears before a street name or number. For example, if the address is 123 West Main, "West" is the street prefix.7.3.3.4
streetStartlongNo The start of a range of street numbers.7.3.3.4
streetSuffixstreetSuffix{}No Get All Address Street Suffixes The type of street such as "Lane" or "Boulevard".7.3.3.4
streetSuffix.textstringNo The localized display text.7.3.3.4
streetSuffix.valuestringNo The value for the specified parameter.7.3.3.4
streetSuffixDirectionstreetSuffixDirection{}No Get All Address Street Directions The direction appended to the street suffix. For example, if the address is 500 56th Avenue NW, "NW" is the street suffix direction.7.3.3.4
streetSuffixDirection.textstringNo The localized display text.7.3.3.4
streetSuffixDirection.valuestringNo The value for the specified parameter.7.3.3.4
typetype{}No Get All Address Unit Types The address type.7.3.3.4
type.textstringNo The localized display text.7.3.3.4
type.valuestringNo The value for the specified parameter.7.3.3.4
unitEndstringNo The end parameter of a range of unit numbers.7.3.3.4
unitStartstringNo The starting parameter of a range of unit numbers.7.3.3.4
unitTypeunitType{}No Get All Address Unit Types The unit type designation of the address.7.3.3.4
unitType.textstringNo The localized display text.7.3.3.4
unitType.valuestringNo The value for the specified parameter.7.3.3.4
contactIdlongYes Get All Contacts The unique ID associated with the contact.7.3.3.4
idstringYes The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.4
langStringNo Indicates the language applied.7.3.3.4

Response Information

FieldTypeDescriptionAutomation Version
resultresult{} 7.3.3.4
result.addressLine1stringThe first line of the address. 7.3.3.4
result.addressLine2stringThe second line of the address.7.3.3.4
result.addressLine3stringThe third line of the address.7.3.3.4
result.citystringThe name of the city.7.3.3.4
result.countryresult.country{}The name of the country.7.3.3.4
result.country.textstringThe localized display text.7.3.3.4
result.country.valuestringThe value for the specified parameter.7.3.3.4
result.directionresult.direction{}The street direction of the primary address associated with the application.7.3.3.4
result.direction.textstringThe localized display text.7.3.3.4
result.direction.valuestringThe value for the specified parameter.7.3.3.4
result.effectiveDatedateTimeThe date when the address takes effect.7.3.3.4
result.expirationDatedateTimeThe date when the address expires.7.3.3.4
result.faxstringThe fax number for the contact.7.3.3.4
result.faxCountryCodestringFax Number Country Code7.3.3.4
result.houseAlphaEndstringThe ending street number that makes up the address.7.3.3.4
result.houseAlphaStartstringThe beginning street number that makes up the address.7.3.3.4
result.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.4
result.isPrimarystringIndicates whether or not to designate the address as the primary address. Only one address can be primary at any given time.7.3.3.4
result.levelEndstringThe ending level number (floor number) that makes up the address within a complex.7.3.3.4
result.levelPrefixstringThe prefix for the level numbers (floor numbers) that make up the address.7.3.3.4
result.levelStartstringThe beginning level number (floor number) that makes up the address within a complex.7.3.3.4
result.phonestringThe telephone number of the contact.7.3.3.4
result.phoneCountryCodestringThe country code for the assoicated phone number.7.3.3.4
result.postalCodestringThe postal ZIP code for the address.7.3.3.4
result.recipientstringThe contact person for the contact address.7.3.3.4
result.stateresult.state{}The state corresponding to the address on record.7.3.3.4
result.state.textstringThe localized display text.7.3.3.4
result.state.valuestringThe value for the specified parameter.7.3.3.4
result.statusresult.status{}The address status indicating whether the address is active or inactive.7.3.3.4
result.status.textstringThe localized display text.7.3.3.4
result.status.valuestringThe value for the specified parameter.7.3.3.4
result.streetAddressstringThe street address. 7.3.3.4
result.streetEndlongThe end of a range of street numbers.7.3.3.4
result.streetNamestringThe street name for the address.7.3.3.4
result.streetPrefixstringAny part of an address that appears before a street name or number. For example, if the address is 123 West Main, "West" is the street prefix.7.3.3.4
result.streetStartlongThe start of a range of street numbers.7.3.3.4
result.streetSuffixresult.streetSuffix{}The type of street such as "Lane" or "Boulevard".7.3.3.4
result.streetSuffix.textstringThe localized display text.7.3.3.4
result.streetSuffix.valuestringThe value for the specified parameter.7.3.3.4
result.streetSuffixDirectionresult.streetSuffixDirection{}The direction appended to the street suffix. For example, if the address is 500 56th Avenue NW, "NW" is the street suffix direction.7.3.3.4
result.streetSuffixDirection.textstringThe localized display text.7.3.3.4
result.streetSuffixDirection.valuestringThe value for the specified parameter.7.3.3.4
result.typeresult.type{}The address type.7.3.3.4
result.type.textstringThe localized display text.7.3.3.4
result.type.valuestringThe value for the specified parameter.7.3.3.4
result.unitEndstringThe end parameter of a range of unit numbers.7.3.3.4
result.unitStartstringThe starting parameter of a range of unit numbers.7.3.3.4
result.unitTyperesult.unitType{}The unit type designation of the address.7.3.3.4
result.unitType.textstringThe localized display text.7.3.3.4
result.unitType.valuestringThe value for the specified parameter.7.3.3.4
statusintegerThe record status.7.3.3.4