Skip to main content
POST
Set Default Address

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

addressId
string<uuid>
required

Customer address identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

Customer address

customerAddressId
string<uuid>
required

Customer address identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

customerId
string<uuid>
required

Customer identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

city
string
required

City

Example:

"Sao Paulo"

country
any
required

Country

Example:

"BR"

label
string
required

Address label

Example:

"Casa"

lat
number
required

Latitude

Required range: -90 <= x <= 90
Example:

-23.55052

lng
number
required

Longitude

Required range: -180 <= x <= 180
Example:

-46.633308

neighborhood
string
required

Neighborhood

Example:

"Bela Vista"

number
string
required

Number

Example:

"1000"

state
any
required

State

Example:

"SP"

street
string
required

Street

Example:

"Av. Paulista"

zipCode
any
required

Zip code

Example:

"01310-100"

isDefault
boolean
required

Default address

Example:

true

createdAt
string<date-time>
required

Created at

Example:

"2026-01-01T00:00:00.000Z"

updatedAt
string<date-time>
required

Updated at

Example:

"2026-01-01T00:00:00.000Z"

complement
string | null

Complement

Example:

"Apto 42"

createdBy
string<uuid> | null

Created by

Example:

null

updatedBy
string<uuid> | null

Updated by

Example:

null

deletedBy
string<uuid> | null

Deleted by

Example:

null

deletedAt
string<date-time> | null

Deleted at

Example:

null