Profile

Update a home

Only the fields given change.

patch/api/homes/{id}

Request

  • Base URL: https://trvlrr.app
  • URL: https://trvlrr.app/api/homes/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The id.

Request body

citystring

City.

countrystring nullable

Country (name or ISO code).

hometownstring nullable

Hometown.

gatewaystring nullable

The city they usually fly from.

from_datestring nullable

YYYY or YYYY-MM-DD.

to_datestring nullable

YYYY or YYYY-MM-DD; leave out for the current home.

Response

The home after the change.

idstring required
citystring required
countrystring nullable required

ISO alpha-2.

hometownstring nullable required
gatewaystring nullable required

The city they usually fly from.

from_datestring nullable required

YYYY or YYYY-MM-DD.

to_datestring nullable required

YYYY or YYYY-MM-DD; null for the current home.

created_atstring required

Changes

No recorded changes to this operation across all 1 revision of this API.