Create Contact Addresses

Creates detailed address information for the specified contact.

Resource Information

Scope	contacts Deprecated scope name: create_contact_addresses
App Type	Agency
Authorization Type	Access token
URI	/v4/contacts/{id}/addresses?lang={lang}
HTTP Method	POST
Automation Version(s)	7.3.2

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
addressLine1	string	No	�	The first line of the address.	7.3.2
addressLine2	string	No	�	The second line of the address.	7.3.2
addressLine3	string	No	�	The third line of the address.	7.3.2
city	string	No	�	The name of the city.	7.3.2
country	country{}	No	Get All Address Countries	The name of the country.	7.3.2
country.text	string	No	�	The localized display text.	7.3.2
country.value	string	No	�	The value for the specified parameter.	7.3.2
direction	direction{}	No	Get All Address Street Directions	The street direction of the primary address associated with the application.	7.3.2
direction.text	string	No	�	The localized display text.	7.3.2
direction.value	string	No	�	The value for the specified parameter.	7.3.2
effectiveDate	dateTime	No	�	The date when you want the condition to become effective.	7.3.2
expirationDate	dateTime	No	�	The date when the condition expires.	7.3.2
fax	string	No	�	The fax number for the contact.	7.3.2
faxCountryCode	string	No	�	Fax Number Country Code	7.3.2
houseAlphaEnd	string	No	�	The ending street number that makes up the address.	7.3.2
houseAlphaStart	string	No	�	The beginning street number that makes up the address.	7.3.2
id	long	No	�	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
isPrimary	string	No	Y \| N	Indicates whether or not to designate the address as the primary address. Only one address can be primary at any given time.	7.3.2
levelEnd	string	No	�	The ending level number (floor number) that makes up the address within a complex.	7.3.2
levelPrefix	string	No	�	The prefix for the level numbers (floor numbers) that make up the address.	7.3.2
levelStart	string	No	�	The beginning level number (floor number) that makes up the address within a complex.	7.3.2
phone	string	No	�	The telephone number of the contact.	7.3.2
phoneCountryCode	string	No	�	The country code for the assoicated phone number.	7.3.2
postalCode	string	No	�	The postal ZIP code for the address.	7.3.2
recipient	string	No	�	The entity on the receiving end of an operation, for example a notification of an event.	7.3.2
state	state{}	No	Get All Address States	The state corresponding to the address on record.	7.3.2
state.text	string	No	�	The localized display text.	7.3.2
state.value	string	No	�	The value for the specified parameter.	7.3.2
status	status{}	No	�	The contact address status.	7.3.2
status.text	string	No	�	The localized display text.	7.3.2
status.value	string	No	�	The value for the specified parameter.	7.3.2
streetAddress	string	No	�	The street address.	7.3.2
streetEnd	long	No	�	The end of a range of street numbers.	7.3.2
streetName	string	No	�	The street name for the address.	7.3.2
streetPrefix	string	No	�	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
streetStart	long	No	�	The start of a range of street numbers.	7.3.2
streetSuffix	streetSuffix{}	No	Get All Address Street Suffixes	The type of street such as "Lane" or "Boulevard".	7.3.2
streetSuffix.text	string	No	�	The localized display text.	7.3.2
streetSuffix.value	string	No	�	The value for the specified parameter.	7.3.2
streetSuffixDirection	streetSuffixDirection{}	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.text	string	No	�	The localized display text.	7.3.2
streetSuffixDirection.value	string	No	�	The value for the specified parameter.	7.3.2
type	type{}	No	�	The address type.	7.3.2
type.text	string	No	�	The localized display text.	7.3.2
type.value	string	No	�	The value for the specified parameter.	7.3.2
unitEnd	string	No	�	The end parameter of a range of unit numbers.	7.3.2
unitStart	string	No	�	The starting parameter of a range of unit numbers.	7.3.2
unitType	unitType{}	No	Get All Address Unit Types	The unit type designation of the address.	7.3.2
unitType.text	string	No	�	The localized display text.	7.3.2
unitType.value	string	No	�	The value for the specified parameter.	7.3.2
id	string	Yes	�	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
lang	String	No	�	Indicates the language applied.	7.3.2

Response Information

Field	Type	Description	Automation Version
result[]	result{}	�	7.3.2
result.code	string	A code identifying an associated item	7.3.2
result.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.isSuccess	boolean	Indicates whether or not the operation on the item is successful.	7.3.2
result.message	string	A text message related to the operation.	7.3.2
status	integer	The record status.	7.3.3