Add a business address

Beta

POST

/v2/businesses/:businessReference/addresses

POST

/api/v2/businesses/:businessReference/addresses

curl -X POST https://api-sandbox.payabli.com/api/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55/addresses \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "type": "mailing",
  "addressLine1": "202 Warehouse Ln",
  "cityLocality": "Austin",
  "stateProvince": "TX",
  "postalCode": "73302",
  "country": "US",
  "location": "warehouse"
}'

{
  "success": true,
  "message": "Address added successfully",
  "traceId": "0HNOF89NNTM7O:00000092",
  "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": "mailing",
    "location": "warehouse",
    "addressLine1": "202 Warehouse Ln",
    "addressLine2": null,
    "cityLocality": "Austin",
    "stateProvince": "TX",
    "postalCode": "73302",
    "country": "US",
    "floor": null,
    "suiteApartNumber": null
  }
}

Adds an address to a business. Returns the new address and its businessAddressReference.

Authentication

AuthorizationBearer

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

Path parameters

businessReferencestringRequired

The business reference (businessUuid).

Request

This endpoint expects an object.

typeenumRequired

The address role.

addressLine1stringRequired

The first line of the street address.

cityLocalitystringRequired

The city or locality.

stateProvincestringRequired

The state or province.

postalCodestringRequired

The postal or ZIP code.

countrystringRequired

The two-character ISO country code.

locationenumOptional

The physical use of the address.

Allowed values:

addressLine2stringOptional

The second line of the street address.

floorstringOptional

The floor, if applicable.

suiteApartNumberstringOptional

The suite or apartment number, if applicable.

Response

Address added.

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