Update a business address

patch

https://sandbox-api.prioritycommerce.com/v1/businesses/{businessId}/addresses/{addressId}

Updates an address of a business. Send only the fields you want to change.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

businessId

string

required

ID of the business, for example bus_3f8a2c71-9d4e-4b6a-8f15-6c2e9a7b4d10.

addressId

string

required

ID of the address, for example addr_2e9b5c47-8d1a-4f36-b7e2-6a4c9f1d3b85.

Body Params

Address fields to update. Send only the fields you want to change.

type

string

enum

What the address is used for.

Allowed:

externalId

string

length ≤ 255

Your own reference for this record, up to 255 characters. Use it to find the record later with the externalId filter.

line1

string

Street address, such as the building number and street name.

line2

string

Additional address details, such as a suite, unit or floor.

city

string

City or town.

stateProvince

string

State or province, as a two-letter code where one exists, for example TX.

postalCode

string

ZIP or postal code.

countryCode

string

^[A-Z]{2}$

Country, as a two-letter ISO 3166-1 code, for example US.

isPrimary

boolean

Set to true for the main record of this kind.

Headers

idempotency-key

string

Optional. A unique value, such as a UUID, that identifies this request. If you retry with the same key, the change is not applied twice.

Responses

200Updated. The response contains the updated record.

401The API key is missing or invalid.

404No record exists with the ID in the path.

422The request failed validation. errors lists each field to fix.