Sign in

v4

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-04-277127123.7 KB
Customers

Add address to customer

post/customers/{uuid}/addresses

Path parameters

uuidstring required

Customer UUID.

Request body

namestring required

Address label or recipient name.

line1string required

Address line 1 (street and number).

line2string

Address line 2 (apartment, suite, etc.).

citystring required
statestring required
zip_codestring required

ZIP or postal code.

countrystring required

ISO 3166-1 alpha-2 country code.

emailstring email
prefixstring

Phone country prefix (e.g. +34). Required with phone.

phonestring

Phone number. Required with prefix.

tagstring
metadataobject

Example request

{
  "name": "my_address",
  "line1": "Main street 123",
  "city": "Barcelona",
  "state": "Catalonia",
  "zip_code": "08001",
  "country": "ES"
}

Response

Address created

idinteger
selfstring nullable
uuidstring
namestring nullable
emailstring nullable
prefixstring nullable
phonestring nullable
line1string nullable
line2string nullable
citystring nullable
statestring nullable
countrystring nullable
zip_codestring nullable
tagstring nullable
metadataobject nullable
created_atstring date-time nullable
connectionsConnections

Hypermedia links to related resources.