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.

Changes

Changed in 1 of the 4 revisions of this API.696

Mar 11, 2026ff825f6602c8696See the full diff
- ▲
  added the new required request property
  new-required-request-property
- ▲
  added the new required request property
  new-required-request-property
- ▲
  the request property became required
  request-property-became-required
- ▲
  the request property became required
  request-property-became-required
- ▲
  the request property became required
  request-property-became-required
- ▲
  the request property became required
  request-property-became-required
- ●
  the request property's maxLength was set to 255
  request-property-max-length-set
- ●
  the request property's maxLength was set to 2
  request-property-max-length-set
- ●
  the request property's maxLength was set to 255
  request-property-max-length-set
- ●
  the request property's maxLength was set to 255
  request-property-max-length-set
- ●
  the request property's maxLength was set to 255
  request-property-max-length-set
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added

Full history