Skip to main content
POST
/
customers
/
{customer_id}
/
addresses
curl --request POST \
  --url https://api.zenskar.com/customers/{customer_id}/addresses \
  --header 'Content-Type: application/json' \
  --header 'organisation: <api-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "line1": "123 Business Ave",
  "line2": "Suite 100",
  "city": "San Francisco",
  "state": "CA",
  "zipCode": "94102",
  "country": "United States",
  "country_code": "US",
  "is_default_billing": true,
  "is_default_shipping": false
}
'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "customer_id": "223e4567-e89b-12d3-a456-426614174001",
  "line1": "123 Business Ave",
  "line2": "Suite 100",
  "city": "San Francisco",
  "state": "CA",
  "zip_code": "94102",
  "country": "United States",
  "country_code": "US",
  "is_default_billing": true,
  "is_default_shipping": false,
  "validation_status": "pending",
  "created_at": "2023-01-01T00:00:00",
  "updated_at": "2023-01-01T00:00:00"
}

Documentation Index

Fetch the complete documentation index at: https://docs2.zenskar.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-api-key
string
header
default:<your-api-key>
required
organisation
string
header
default:<your-organisation-id>
required

Path Parameters

customer_id
string<uuid>
required

Body

application/json

Request schema for creating/updating customer addresses. Extends the existing Address schema with default billing/shipping flags. customer_id comes from URL params, not request body.

line1
string | null

Street address line 1 (e.g., building number and street name)

line2
string | null

Street address line 2 (e.g., apartment, suite, unit number)

line3
string | null

Street address line 3 (additional address information)

city
string | null

City or locality name

state
string | null

State, province, or region

zipCode
string | null

Postal code or ZIP code

country
string | null

Country name (e.g., 'United States')

country_code
string | null

Two-letter ISO country code (e.g., 'US', 'GB')

validation_status
string | null

Address validation status

connector_validation
Connector Validation · object

Validation data from external connector

is_default_billing
boolean

Set as default billing address

is_default_shipping
boolean

Set as default shipping address

Response

Successfully created customer address

Customer Address Response Schema

id
string<uuid>
required

Address ID

customer_id
string<uuid>
required

Customer ID

is_default_billing
boolean
required

Whether this is the default billing address

is_default_shipping
boolean
required

Whether this is the default shipping address

line1
string | null

Street address line 1 (e.g., building number and street name)

line2
string | null

Street address line 2 (e.g., apartment, suite, unit number)

line3
string | null

Street address line 3 (additional address information)

city
string | null

City or locality name

state
string | null

State, province, or region

zip_code
string | null

Postal/ZIP code

country
string | null

Country name (e.g., 'United States')

country_code
string | null

Two-letter ISO country code (e.g., 'US', 'GB')

validation_status
string | null

Address validation status

connector_validation
Connector Validation · object

Validation data from external connector