Skip to main content
POST
Create a bulk shipping address

Authorizations

Authorization
string
header
required

Bearer JWT issued to your business account during onboarding

Body

application/json
line1
string
required
Example:

"123 Main Street"

city
string
required
Example:

"Springfield"

region
string
required
Example:

"Arizona"

postalCode
string
required
Example:

"85001"

countryCode
string
required

Two-letter ISO country code

Example:

"US"

recipientFirstName
string
required
Example:

"Jane"

recipientLastName
string
required
Example:

"Doe"

recipientPhoneCountryCode
string
required

Dial code digits only, no plus

Example:

"1"

recipientPhoneNumber
string
required
Example:

"5555555555"

line2
string
Example:

"Suite 4"

isDefault
boolean

When true, this address becomes the tenant default. The first address is default automatically.

Example:

true

Response

201 - application/json
id
string
required

Bulk shipping address id. Pass this as bulkShippingGroupId when issuing physical cards.

Example:

"507f1f77bcf86cd799439011"

line1
string
required
Example:

"123 Main Street"

city
string
required
Example:

"Springfield"

region
string
required
Example:

"Arizona"

postalCode
string
required
Example:

"85001"

countryCode
string
required
Example:

"US"

recipientFirstName
string
required
Example:

"Jane"

recipientLastName
string
required
Example:

"Doe"

recipientPhoneCountryCode
string
required
Example:

"1"

recipientPhoneNumber
string
required
Example:

"5555555555"

isDefault
boolean
required
Example:

true

line2
string
Example:

"Suite 4"