Update a business address

Beta

PATCH

/v2/businesses/:businessReference/addresses/:businessAddressReference

PATCH

/api/v2/businesses/:businessReference/addresses/:businessAddressReference

curl -X PATCH https://api-sandbox.payabli.com/api/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55/addresses/019fed1a-67d6-768a-b4cc-29d4299e21d9 \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "type": "billing"
}'

{
  "success": true,
  "message": "Address updated successfully",
  "traceId": "0HNOF89NNTM7O:000000C9",
  "data": {
    "_links": {
      "self": "/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55/addresses/019fed1a-67d6-768a-b4cc-29d4299e21d9",
      "business": "/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55"
    },
    "businessAddressReference": "019fed1a-67d6-768a-b4cc-29d4299e21d9",
    "type": "billing",
    "location": "warehouse",
    "addressLine1": "202 Warehouse Ln",
    "addressLine2": null,
    "cityLocality": "Austin",
    "stateProvince": "TX",
    "postalCode": "73302",
    "country": "US",
    "floor": null,
    "suiteApartNumber": null
  }
}

Applies a partial update to a business address. Send only the fields you want to change; omitted fields are kept.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

businessReferencestringRequired

The business reference (businessUuid).

businessAddressReferencestringRequired

The business address reference.

Request

This endpoint expects an object.

typeenumOptional

The address role.

locationenumOptional

The physical use of the address.

Allowed values:

addressLine1stringOptional

The first line of the street address.

addressLine2stringOptional

The second line of the street address.

cityLocalitystringOptional

The city or locality.

stateProvincestringOptional

The state or province.

postalCodestringOptional

The postal or ZIP code.

countrystringOptional

The two-character ISO country code.

floorstringOptional

The floor, if applicable.

suiteApartNumberstringOptional

The suite or apartment number, if applicable.

Response

Address updated.

successboolean

Whether the request succeeded.

messagestring or null

A human-readable result message.

traceIdstring or null

The trace identifier for the request, useful for support.

dataobject or null

The business address.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error