Create Client Address

Create a new address for a client.

POST /client-address
Request Body Fields
Field Type Required Description
client string Yes Client ID
address object Yes Address object (see below)
address_types array No Array of address type IDs (billing, shipping)
default_address boolean No Set as default address for client
Address Object Fields
Field Type Required Description
country string Yes Two-letter country code (e.g., US, UK)
administrative_area string No State/Province code
locality string No City
postal_code string No Postal/ZIP code
thoroughfare string No Street address
premise string No Apartment/Suite number
first_name string No First name
last_name string No Last name
organisation_name string No Company/Organization name
Example Request
POST /api/v1.0/client-address
{
  "client": "123",
  "address": {
    "country": "US",
    "administrative_area": "NY",
    "locality": "New York",
    "postal_code": "10001",
    "thoroughfare": "123 Main St",
    "premise": "Apt 4B",
    "first_name": "John",
    "last_name": "Doe"
  },
  "address_types": ["billing", "shipping"],
  "default_address": true
}
Response
{
  "data": [{
    "id": "502",
    "client": "123",
    "address": {
      "country": "US",
      "administrative_area": "NY",
      "locality": "New York",
      "postal_code": "10001",
      "thoroughfare": "123 Main St",
      "premise": "Apt 4B",
      "first_name": "John",
      "last_name": "Doe",
      "name_line": "John Doe"
    },
    "address_types": [
      {
        "id": "billing",
        "label": "Billing"
      },
      {
        "id": "shipping",
        "label": "Shipping"
      }
    ],
    "default_address": true,
    "created": "2025-10-30T10:00:00Z"
  }]
}
Back to Addresses List