v1

latestOpenAPI 3.0.02026-07-247150151.6 KB

Business address

Create a business address

Creates an address associated with a business

post/businesses/{business_id}/addresses

Path parameters

business_idstring required

Request body

address_type'MAILING' | 'PHYSICAL' | 'REGISTERED' required

Address type is one of the following : MAILING, PHYSICAL, REGISTERED

streetstring required

Has a 1 to 40-character limit. May only contain alphanumerics and the special characters . , _ - #

street2string

Has a 40-character limit. May only contain alphanumerics and the special characters . , _ - #

citystring required

Has a 2 to 40-character limit. May contain only alphanumerics, -, _,., and spaces

statestring required

Has a 2-character limit for US address.<br />Has a 20-character limit for non US address.

zip_codestring required

zip code in 5-digit (12345) or 9-digit (12345-1234) format for US address.<br />Has a 2 to 20-character limit for non US address.

countrystring required

ISO 3166-1 alpha-2 country code.<br />Has a 2-character limit.

is_primaryboolean required

Is Primary Address?

Example request

{
  "street": "345 California Ave.",
  "street2": "Suit 600",
  "city": "San Francisco",
  "state": "CA",
  "zip_code": "12345-1234",
  "country": "US",
  "is_primary": true
}

Response

Example response

address_typestring required