Skip to main content
POST
/
v1
/
addresses
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rec_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rec_type": "<string>",
  "type": "<string>",
  "street": "<string>",
  "number": "<string>",
  "additional": "<string>",
  "postal_code": "<string>",
  "city": "<string>",
  "state": "<string>",
  "country": "<string>",
  "is_primary": true,
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

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 length: 255
​
postal_code
string
required
Required string length: 3 - 10
​
city
string
required
Maximum length: 100
​
country
string
required
Required string length: 2
​
number
string
Maximum length: 50
​
additional
string
Maximum length: 255
​
state
string
Maximum 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>