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
addressLine1stringNo The first line of the address. 7.3.2
addressLine2stringNo The second line of the address.7.3.2
addressLine3stringNo The third line of the address.7.3.2
citystringNo The name of the city.7.3.2
countrycountry{}No Get All Address Countries The name of the country.7.3.2
country.textstringNo The localized display text.7.3.2
country.valuestringNo The 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.textstringNo The localized display text.7.3.2
direction.valuestringNo The value for the specified parameter.7.3.2
effectiveDatedateTimeNo The date when you want the condition to become effective.7.3.2
expirationDatedateTimeNo The date when the condition expires.7.3.2
faxstringNo The fax number for the contact.7.3.2
faxCountryCodestringNo Fax Number Country Code7.3.2
houseAlphaEndstringNo The ending street number that makes up the address.7.3.2
houseAlphaStartstringNo The beginning street number that makes up the address.7.3.2
idlongNo The 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
levelEndstringNo The ending level number (floor number) that makes up the address within a complex.7.3.2
levelPrefixstringNo The prefix for the level numbers (floor numbers) that make up the address.7.3.2
levelStartstringNo The beginning level number (floor number) that makes up the address within a complex.7.3.2
phonestringNo The telephone number of the contact.7.3.2
phoneCountryCodestringNo The country code for the assoicated phone number.7.3.2
postalCodestringNo The postal ZIP code for the address.7.3.2
recipientstringNo The 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.textstringNo The localized display text.7.3.2
state.valuestringNo The value for the specified parameter.7.3.2
statusstatus{}No The contact address status.7.3.2
status.textstringNo The localized display text.7.3.2
status.valuestringNo The value for the specified parameter.7.3.2
streetAddressstringNo The street address. 7.3.2
streetEndlongNo The end of a range of street numbers.7.3.2
streetNamestringNo The street name for the address.7.3.2
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.2
streetStartlongNo The 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.textstringNo The localized display text.7.3.2
streetSuffix.valuestringNo The 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.textstringNo The localized display text.7.3.2
streetSuffixDirection.valuestringNo The value for the specified parameter.7.3.2
typetype{}No The address type.7.3.2
type.textstringNo The localized display text.7.3.2
type.valuestringNo The value for the specified parameter.7.3.2
unitEndstringNo The end parameter of a range of unit numbers.7.3.2
unitStartstringNo The 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.textstringNo The localized display text.7.3.2
unitType.valuestringNo The value for the specified parameter.7.3.2
idstringYes The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
langStringNo Indicates 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