Create Contact Addresses

Creates detailed address information for the specified contact.

Resource Information

Scopecontacts

Deprecated scope name:   create_contact_addresses

App TypeAgency
Authorization TypeAccess token
URI /v4/contacts/{id}/addresses?lang={lang}
HTTP MethodPOST
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
addressLine1stringNoThe first line of the address. 7.3.2
addressLine2stringNoThe second line of the address.7.3.2
addressLine3stringNoThe third line of the address.7.3.2
citystringNoThe name of the city.7.3.2
countrycountry{}No Get All Address Countries The name of the country.7.3.2
country.textstringNoThe localized display text.7.3.2
country.valuestringNoThe value for the specified parameter.7.3.2
directiondirection{}No Get All Address Street Directions The street direction of the primary address associated with the application.7.3.2
direction.textstringNoThe localized display text.7.3.2
direction.valuestringNoThe value for the specified parameter.7.3.2
effectiveDatedateTimeNoThe date when you want the condition to become effective.7.3.2
expirationDatedateTimeNoThe date when the condition expires.7.3.2
faxstringNoThe fax number for the contact.7.3.2
faxCountryCodestringNoFax Number Country Code7.3.2
houseAlphaEndstringNoThe ending street number that makes up the address.7.3.2
houseAlphaStartstringNoThe beginning street number that makes up the address.7.3.2
idlongNoThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
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.2
levelEndstringNoThe ending level number (floor number) that makes up the address within a complex.7.3.2
levelPrefixstringNoThe prefix for the level numbers (floor numbers) that make up the address.7.3.2
levelStartstringNoThe beginning level number (floor number) that makes up the address within a complex.7.3.2
phonestringNoThe telephone number of the contact.7.3.2
phoneCountryCodestringNoThe country code for the assoicated phone number.7.3.2
postalCodestringNoThe postal ZIP code for the address.7.3.2
recipientstringNoThe entity on the receiving end of an operation, for example a notification of an event.7.3.2
statestate{}No Get All Address States The state corresponding to the address on record.7.3.2
state.textstringNoThe localized display text.7.3.2
state.valuestringNoThe value for the specified parameter.7.3.2
statusstatus{}NoThe contact address status.7.3.2
status.textstringNoThe localized display text.7.3.2
status.valuestringNoThe value for the specified parameter.7.3.2
streetAddressstringNoThe street address. 7.3.2
streetEndlongNoThe end of a range of street numbers.7.3.2
streetNamestringNoThe street name for the address.7.3.2
streetPrefixstringNoAny 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.2
streetStartlongNoThe start of a range of street numbers.7.3.2
streetSuffixstreetSuffix{}No Get All Address Street Suffixes The type of street such as "Lane" or "Boulevard".7.3.2
streetSuffix.textstringNoThe localized display text.7.3.2
streetSuffix.valuestringNoThe value for the specified parameter.7.3.2
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.2
streetSuffixDirection.textstringNoThe localized display text.7.3.2
streetSuffixDirection.valuestringNoThe value for the specified parameter.7.3.2
typetype{}NoThe address type.7.3.2
type.textstringNoThe localized display text.7.3.2
type.valuestringNoThe value for the specified parameter.7.3.2
unitEndstringNoThe end parameter of a range of unit numbers.7.3.2
unitStartstringNoThe starting parameter of a range of unit numbers.7.3.2
unitTypeunitType{}No Get All Address Unit Types The unit type designation of the address.7.3.2
unitType.textstringNoThe localized display text.7.3.2
unitType.valuestringNoThe value for the specified parameter.7.3.2
idstringYesThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
langStringNoIndicates the language applied.7.3.2

Response Information

FieldTypeDescriptionAutomation Version
result[]result{}7.3.2
result.codestringA code identifying an associated item7.3.2
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.isSuccessbooleanIndicates whether or not the operation on the item is successful. 7.3.2
result.messagestringA text message related to the operation.7.3.2
statusintegerThe record status.7.3.3