API Referenceaddresses

Update

Authentication

AuthorizationBearer

Your API key, sent as Authorization: Bearer usgmk_live_....

Path parameters

idstringRequired

Request

This endpoint expects an object.
typeenumOptional

shipping = a shipment destination; deposit = where check deposits are sent.

namestringOptional1-255 characters
line1stringOptional1-255 characters
line2stringOptional<=255 characters
line3stringOptional<=255 characters
citystringOptional1-255 characters
statestringOptional1-255 characters
postal_codestringOptional1-32 characters
countrystringOptional1-255 characters
phone_numberstringOptional1-32 characters
tax_idstringOptional<=64 characters

Response

idstring

Address id (UUID).

typeenum

shipping = a shipment destination; deposit = where check deposits are sent.

is_defaultboolean

The default address of its type — one per type.

namestring or null
Recipient name on the address.
line1string or null
line2string or null
citystring or null
statestring or null
postal_codestring or null
countrystring or null
line3string or null
phone_numberstring or null
tax_idstring or null

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error