Skip to content
Fleet Fleet Platform API

Update a company address

PATCH
/addresses/{address_id}

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
address_id
required

Address id

string
/^[1-9]\d*$/
Example
42

Request Body

Section titled “Request Body ”
object
first_name
string
>= 1 characters
last_name
string
>= 1 characters
phone
string
>= 1 characters
phone_country
string
>= 1 characters
address1
string
>= 1 characters <= 70 characters
address2
string
<= 70 characters
zip
string
>= 1 characters
city
string
>= 1 characters
country

ISO 3166-1 alpha-2 country code

string
Example
FR
type
string
label
string
>= 1 characters
comment
string
is_default
boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Updated address

object
data
required
object
id
required
integer
first_name
required
string
nullable
last_name
required
string
nullable
phone
required
string
nullable
phone_country
required
string
nullable
address1
required
string
nullable
address2
required
string
nullable
type
required
string
nullable
zip
required
string
nullable
city
required
string
nullable
country
required

ISO 3166-1 alpha-2 country code

string
nullable
Example
FR
label
required
string
nullable
comment
required
string
nullable
is_default
required
boolean
is_hq
required
boolean

400

Section titled “400 ”

Validation error

object
error
required
string

403

Section titled “403 ”

Forbidden

object
error
required
string
Allowed values: INSUFFICIENT_SCOPE

404

Section titled “404 ”

Resource not found

object
error
required
string
Allowed values: COMPANY_NOT_FOUND ADDRESS_NOT_FOUND DELIVERY_COUNTRY_NOT_FOUND

500

Section titled “500 ”

Internal server error

object
error
required
string
Allowed values: INTERNAL_ERROR