Skip to main content
POST
Import an address

Authorizations

Authorization
string
header
required

Body

application/json

Address object to import

clientId
string<uuid>
required
company
string
required
Maximum string length: 80
line1
string
required
Maximum string length: 80
city
string
required
Maximum string length: 80
postalCode
string
required
Maximum string length: 80
country
string
required
Maximum string length: 80
name
string | null
Maximum string length: 80
line2
string | null
Maximum string length: 80
line3
string | null
Maximum string length: 80
externalId
string | null
Maximum string length: 80
main
boolean

Response

Returns the imported address

id
string<uuid>
tenantId
string<uuid>
clientId
string<uuid>
name
string | null
company
string
line1
string
line2
string | null
line3
string | null
city
string
postalCode
string
country
string
externalId
string | null
main
boolean
createdAt
string<date-time>
updatedAt
string<date-time>