Skip to content
VesttaDocs
VesttaDocs
API Reference Vestta

Loading…

Update a property

Update a property without exposing its private CRM record.

PATCH/v1/properties/{property_id}

Requires the properties:write scope

On this page

Only supplied top-level fields change. pricing and characteristics merge supplied fields; location and area are complete replacement objects. features replaces the list. Only owner_id and subtype can be cleared with null.

This endpoint cannot replace image URLs or set publication directly. Use upload sessions and the publication endpoint. Updating a public property's gallery queues marked-image processing before it is made visible again.

Example request

curl -X PATCH "https://api.vestta.app/v1/properties/1" \
  -H "X-Api-Key: $VESTTA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Updated apartment title",
  "pricing": {
    "sale": 340000
  }
}'

Authorization

  • X-Api-Keystringheaderrequired

    Your API key, AC_LIVE_<key_id>.<secret>. Authorization: ApiKey <key> is also accepted.

Path parameters

  • property_idintegerrequired≥ 1

Request body

application/json · required

  • operationsarray of strings
  • typePropertyType
  • subtypestring≤ 100 chars
  • titlestring1–300 chars
  • descriptionstring≤ 50000 chars
  • pricingPropertyPricing
  • locationPropertyLocation
  • areaPropertyArea
  • bedroomsinteger≥ 0≤ 1000
  • bathroomsinteger≥ 0≤ 1000
  • characteristicsPropertyCharacteristics
  • featuresarray of objects
  • owner_idinteger≥ 1
  • is_featuredboolean
  • statusstring

    One ofdisponiblereservadaretiradovendidaalquilada

Response

200 Successful response.

Example response
{
  "status": "ok",
  "id": 1355
}

Response fields

  • statusstring default: ok always ok
  • idintegerrequired

Errors

StatusWhen
401 UnauthorizedThe API key is missing, malformed, unknown, revoked or expired.
403 ForbiddenThe API key lacks the required scope.
404 Not FoundThe resource does not exist in this business.
409 ConflictDuplicate contact or idempotency key reused with a different payload.
422 Unprocessable ContentA path parameter, query parameter or body field is invalid.
500 Internal Server ErrorUnexpected server error while processing the request.

Error bodies and how to handle each case: Errors.