Update business address

put

https://api.infinant.com/interlace/business-api/v1/business/{businessId}/addresses/{addressId}

Updates the specific information of an existing business address given passed parameters. If a parameter is not provided in the request then no change will be made.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

businessId

string

required

length ≤ 256

Business identifier

addressId

string

required

length ≤ 256

Business address identifier

Body Params

The data of the business address to be updated

A delivery address and its location type

line1

string

length ≤ 64

Address line 1

line2

string

length ≤ 64

Address line 2

line3

string

length ≤ 64

Address line 3

city

string

length ≤ 64

City

state

string

length ≤ 64

A state name or state code. For example, NC or North Carolina are allowed

postalCode

string

length ≤ 16

Postal code. For U.S. postal addresses, zip code should be either 5-digit or 9-digit (with or without hyphen separation) value. For example, 10001, 10001-1234, and 100001234 are valid postal codes

country

string

length between 2 and 2

Country 2-digit code for the Address

type

string

enum

The location type of an address

Allowed:

addressCategory

string

enum

Defaults to Master

The categorization info for the address

Allowed:

sequence

string

Sequence number to identify multiple addresses

string

Unique identifier for the address

Headers

x-rquid

uuid

required

Unique request identifier - UUID

x-userid

string

It's an optional header that identifies the end-user of client application. In some cases, client application is expected to send BusinessId associated with the authenticated user.

x-tecd-alias

string

TECD alias that overrides default user's tecd

Responses

404

Business address Not Found.

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ok

400Bad request