Postal Address PUT
URI
https://{DATACENTER}.brightpearlconnect.com/public-api/{ACCOUNT}/contact-service/postal-address/{ID} Refer to our documentation on URI syntax for more information on how to construct URIs.
Description
This resource allows you to update a postal address specified by ID.
Things to note:
- addressLine1 is required.
- You can either specify a country using the Brightpearl countryId or the country's 3 character ISO code using countryIsoCode.
Field Listing:
| Field Name | Field Description | Required |
|---|---|---|
| addressLine1 | First line of the address. Maps to Street. | Yes |
| addressLine2 | Second line of the address. Maps to Suburb. | No |
| addressLine3 | Third line of the address. Maps to City. | No |
| addressLine4 | Fourth line of the address. Maps to State. | No |
| postalCode | Zip or postal code. | No |
| countryIsoCode | ISO code of the country for this address. Use either this field, or countryId. | No |
| countryId | Brightpearl country ID for the address. Use either this, or countryIsoCode. | No |
Example 1
Update postal address with ID 100 using country ISO code.
Request URI
/postal-address/100 Request body
{
"addressLine1": "123 Example Street",
"addressLine2": "Suburbia",
"addressLine3": "Cityville",
"addressLine4": "Countyshire",
"postalCode": "BP1 2AZ",
"countryIsoCode": "GBR"
}Response
{
}Example 2
Update postal address with ID 100 using country ID.
Request URI
/postal-address/100 Request body
{
"addressLine1": "123 Example Street",
"addressLine2": "Suburbia",
"addressLine3": "Cityville",
"addressLine4": "Countyshire",
"postalCode": "BP1 2AZ",
"countryId": 222
}Response
{
}