Skip to main content
POST
Create new address

Body

application/json
rec_id
string<uuid>
required
rec_type
enum<string>
required
Available options:
customer,
user,
company
type
enum<string>
required
Available options:
registration,
actual,
operational,
correspondence,
billing
street
string
required
Maximum string length: 255
postal_code
string
required
Required string length: 3 - 10
city
string
required
Maximum string length: 100
country
string
required
Required string length: 2
number
string
Maximum string length: 50
additional
string
Maximum string length: 255
state
string
Maximum string length: 100
is_primary
boolean
default:false
metadata
object

Response

201 - application/json

Address created successfully

id
string<uuid>
rec_id
string<uuid>
rec_type
string
type
string
street
string
number
string
additional
string
postal_code
string
city
string
state
string
country
string
is_primary
boolean
metadata
object
created_at
string<date-time>
updated_at
string<date-time>