Neighborhoods

Update A Neighborhood

post/v1/neighborhoods/{neighborhood_id}

Request

  • Base URL: https://api.imobzi.app
  • URL: https://api.imobzi.app/v1/neighborhoods/{neighborhood_id}
  • Auth: API key in header X-Imobzi-Secret

Path parameters

neighborhood_idstring required

Request body

Example request

{
  "neighborhood": {
    "name": "Vila Olímpia",
    "zone": "Zona Sul",
    "mercado_livre_id": "ML123",
    "mercado_livre_city_id": "ML_CITY_123"
  }
}

Response

Successful Response

namestring required

Name of the neighborhood

zonestring nullable

Zone of the neighborhood

city_idstring required

ID of the city the neighborhood belongs to

mercado_livre_idstring nullable

Mercado Livre ID of the neighborhood

mercado_livre_city_idstring nullable

Mercado Livre city ID of the neighborhood

Example response

{
  "name": "Vila Olímpia",
  "zone": "Zona Sul",
  "city_id": "123",
  "mercado_livre_id": "ML123",
  "mercado_livre_city_id": "ML_CITY_123"
}

Changes

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