Updates the address information for the specified contact.
| Scope | contacts Deprecated scope name: update_contacts_addresses |
| App Type | All |
| Authorization Type | Access token |
| URI | /v4/contacts/{contactId}/addresses/{id}?lang={lang} |
| HTTP Method | PUT |
| Automation Version(s) | 7.3.3.4 |
| Field or Parameter | Type | Required | Values | Description | Automation Version |
|---|---|---|---|---|---|
| addressLine1 | string | No | � | The first line of the address. | 7.3.3.4 |
| addressLine2 | string | No | � | The second line of the address. | 7.3.3.4 |
| addressLine3 | string | No | � | The third line of the address. | 7.3.3.4 |
| city | string | No | � | The name of the city. | 7.3.3.4 |
| country | country{} | No | Get All Address Countries | The name of the country. | 7.3.3.4 |
| country.text | string | No | � | The localized display text. | 7.3.3.4 |
| country.value | string | No | � | The value for the specified parameter. | 7.3.3.4 |
| direction | direction{} | No | Get All Address Street Directions | The street direction of the primary address associated with the application. | 7.3.3.4 |
| direction.text | string | No | � | The localized display text. | 7.3.3.4 |
| direction.value | string | No | � | The value for the specified parameter. | 7.3.3.4 |
| effectiveDate | dateTime | No | � | The date when the address takes effect. | 7.3.3.4 |
| expirationDate | dateTime | No | � | The date when the address expires. | 7.3.3.4 |
| fax | string | No | � | The fax number for the contact. | 7.3.3.4 |
| faxCountryCode | string | No | � | Fax Number Country Code | 7.3.3.4 |
| houseAlphaEnd | string | No | � | The ending street number that makes up the address. | 7.3.3.4 |
| houseAlphaStart | string | No | � | The beginning street number that makes up the address. | 7.3.3.4 |
| id | long | No | � | The unique identifier for the object, assigned by the Civic Platform server and provided in a response. | 7.3.3.4 |
| 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.3.4 |
| levelEnd | string | No | � | The ending level number (floor number) that makes up the address within a complex. | 7.3.3.4 |
| levelPrefix | string | No | � | The prefix for the level numbers (floor numbers) that make up the address. | 7.3.3.4 |
| levelStart | string | No | � | The beginning level number (floor number) that makes up the address within a complex. | 7.3.3.4 |
| phone | string | No | � | The telephone number of the user. | 7.3.3.4 |
| phoneCountryCode | string | No | � | The country code for the assoicated phone number. | 7.3.3.4 |
| postalCode | string | No | � | The postal ZIP code for the address. | 7.3.3.4 |
| recipient | string | No | � | The contact person for the contact address. | 7.3.3.4 |
| state | state{} | No | Get All Address States | The state corresponding to the address on record. | 7.3.3.4 |
| state.text | string | No | � | The localized display text. | 7.3.3.4 |
| state.value | string | No | � | The value for the specified parameter. | 7.3.3.4 |
| status | status{} | No | A | I | The address status indicating whether the address is active or inactive. | 7.3.3.4 |
| status.text | string | No | � | The localized display text. | 7.3.3.4 |
| status.value | string | No | � | The value for the specified parameter. | 7.3.3.4 |
| streetAddress | string | No | � | The street address. | 7.3.3.4 |
| streetEnd | long | No | � | The end of a range of street numbers. | 7.3.3.4 |
| streetName | string | No | � | The street name for the address. | 7.3.3.4 |
| 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.3.4 |
| streetStart | long | No | � | The start of a range of street numbers. | 7.3.3.4 |
| streetSuffix | streetSuffix{} | No | Get All Address Street Suffixes | The type of street such as "Lane" or "Boulevard". | 7.3.3.4 |
| streetSuffix.text | string | No | � | The localized display text. | 7.3.3.4 |
| streetSuffix.value | string | No | � | The value for the specified parameter. | 7.3.3.4 |
| 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.3.4 |
| streetSuffixDirection.text | string | No | � | The localized display text. | 7.3.3.4 |
| streetSuffixDirection.value | string | No | � | The value for the specified parameter. | 7.3.3.4 |
| type | type{} | No | Get All Address Unit Types | The address type. | 7.3.3.4 |
| type.text | string | No | � | The localized display text. | 7.3.3.4 |
| type.value | string | No | � | The value for the specified parameter. | 7.3.3.4 |
| unitEnd | string | No | � | The end parameter of a range of unit numbers. | 7.3.3.4 |
| unitStart | string | No | � | The starting parameter of a range of unit numbers. | 7.3.3.4 |
| unitType | unitType{} | No | Get All Address Unit Types | The unit type designation of the address. | 7.3.3.4 |
| unitType.text | string | No | � | The localized display text. | 7.3.3.4 |
| unitType.value | string | No | � | The value for the specified parameter. | 7.3.3.4 |
| contactId | long | Yes | Get All Contacts | The unique ID associated with the contact. | 7.3.3.4 |
| id | string | Yes | � | The unique identifier for the object, assigned by the Civic Platform server and provided in a response. | 7.3.3.4 |
| lang | String | No | � | Indicates the language applied. | 7.3.3.4 |
| Field | Type | Description | Automation Version |
|---|---|---|---|
| result | result{} | � | 7.3.3.4 |
| result.addressLine1 | string | The first line of the address. | 7.3.3.4 |
| result.addressLine2 | string | The second line of the address. | 7.3.3.4 |
| result.addressLine3 | string | The third line of the address. | 7.3.3.4 |
| result.city | string | The name of the city. | 7.3.3.4 |
| result.country | result.country{} | The name of the country. | 7.3.3.4 |
| result.country.text | string | The localized display text. | 7.3.3.4 |
| result.country.value | string | The value for the specified parameter. | 7.3.3.4 |
| result.direction | result.direction{} | The street direction of the primary address associated with the application. | 7.3.3.4 |
| result.direction.text | string | The localized display text. | 7.3.3.4 |
| result.direction.value | string | The value for the specified parameter. | 7.3.3.4 |
| result.effectiveDate | dateTime | The date when the address takes effect. | 7.3.3.4 |
| result.expirationDate | dateTime | The date when the address expires. | 7.3.3.4 |
| result.fax | string | The fax number for the contact. | 7.3.3.4 |
| result.faxCountryCode | string | Fax Number Country Code | 7.3.3.4 |
| result.houseAlphaEnd | string | The ending street number that makes up the address. | 7.3.3.4 |
| result.houseAlphaStart | string | The beginning street number that makes up the address. | 7.3.3.4 |
| result.id | long | The unique identifier for the object, assigned by the Civic Platform server and provided in a response. | 7.3.3.4 |
| result.isPrimary | string | Indicates 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.levelEnd | string | The ending level number (floor number) that makes up the address within a complex. | 7.3.3.4 |
| result.levelPrefix | string | The prefix for the level numbers (floor numbers) that make up the address. | 7.3.3.4 |
| result.levelStart | string | The beginning level number (floor number) that makes up the address within a complex. | 7.3.3.4 |
| result.phone | string | The telephone number of the contact. | 7.3.3.4 |
| result.phoneCountryCode | string | The country code for the assoicated phone number. | 7.3.3.4 |
| result.postalCode | string | The postal ZIP code for the address. | 7.3.3.4 |
| result.recipient | string | The contact person for the contact address. | 7.3.3.4 |
| result.state | result.state{} | The state corresponding to the address on record. | 7.3.3.4 |
| result.state.text | string | The localized display text. | 7.3.3.4 |
| result.state.value | string | The value for the specified parameter. | 7.3.3.4 |
| result.status | result.status{} | The address status indicating whether the address is active or inactive. | 7.3.3.4 |
| result.status.text | string | The localized display text. | 7.3.3.4 |
| result.status.value | string | The value for the specified parameter. | 7.3.3.4 |
| result.streetAddress | string | The street address. | 7.3.3.4 |
| result.streetEnd | long | The end of a range of street numbers. | 7.3.3.4 |
| result.streetName | string | The street name for the address. | 7.3.3.4 |
| result.streetPrefix | string | 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 |
| result.streetStart | long | The start of a range of street numbers. | 7.3.3.4 |
| result.streetSuffix | result.streetSuffix{} | The type of street such as "Lane" or "Boulevard". | 7.3.3.4 |
| result.streetSuffix.text | string | The localized display text. | 7.3.3.4 |
| result.streetSuffix.value | string | The value for the specified parameter. | 7.3.3.4 |
| result.streetSuffixDirection | result.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.text | string | The localized display text. | 7.3.3.4 |
| result.streetSuffixDirection.value | string | The value for the specified parameter. | 7.3.3.4 |
| result.type | result.type{} | The address type. | 7.3.3.4 |
| result.type.text | string | The localized display text. | 7.3.3.4 |
| result.type.value | string | The value for the specified parameter. | 7.3.3.4 |
| result.unitEnd | string | The end parameter of a range of unit numbers. | 7.3.3.4 |
| result.unitStart | string | The starting parameter of a range of unit numbers. | 7.3.3.4 |
| result.unitType | result.unitType{} | The unit type designation of the address. | 7.3.3.4 |
| result.unitType.text | string | The localized display text. | 7.3.3.4 |
| result.unitType.value | string | The value for the specified parameter. | 7.3.3.4 |
| status | integer | The record status. | 7.3.3.4 |