1. Imóveis
Veploy API
  • Visão geral
  • Autenticação
  • Limites de requisição
  • Imóveis
    • Listar imóveis
      GET
    • Consultar imóvel
      GET
    • Cadastrar imóvel
      POST
    • Alterar imóvel
      PATCH
    • Excluir imóvel
      DELETE
    • Restaurar imóvel
      POST
    • Enviar foto do imóvel (Beta)
      POST
    • Remover foto do imóvel (Beta)
      DELETE
    • Listar tipos de imóvel
      GET
  • Proprietários
    • Listar proprietários
    • Consultar proprietário
    • Cadastrar proprietário
    • Alterar proprietário
    • Excluir proprietário
  • Leads
    • Listar leads
    • Consultar lead
    • Criar lead
    • Alterar responsável
    • Atualizar lead
    • Consultar linha do tempo do lead
  • Visitas
    • Listar visitas
    • Consultar visita
    • Agendar visita
    • Alterar visita
  • Propostas
    • Listar propostas
    • Consultar proposta
    • Registrar proposta
    • Alterar proposta
  • Portais
    • Listar portais
    • Consultar portal
    • Listar imóveis do XML
  • Usuários
    • Listar usuários
    • Consultar usuário
    • Consultar permissões do usuário
    • Convidar usuário
    • Alterar ficha do usuário
    • Desativar usuário
    • Reativar usuário
    • Remover usuário
  • Perfis de acesso
    • Listar perfis de acesso
  • Artigos
    • Listar artigos
    • Criar artigo
    • Consultar artigo
    • Alterar artigo
    • Enviar capa do artigo (Beta)
  • Temas
    • Tema do site
  1. Imóveis

Alterar imóvel

PATCH
/v1/properties/{ref}
Altera um imóvel: só os campos enviados mudam; null limpa onde o campo admite. Blocos (pricing, location, features) são mesclados campo a campo; listas (media.images, media.floor_plans, amenities.*, agents, owners, purpose, hidden_fields) substituem a lista inteira. Uma foto que o imóvel já tem pode ser mantida ou reordenada pelo id da leitura; a que sai da lista volta a ter prazo para ser usada em outro imóvel. As regras de publicação valem para o estado final: um imóvel no ar não pode perder o que o mantém no ar. status: active publica (sem fila de aprovação), inactive tira do ar, draft só para imóvel nunca publicado.
Respostas
200: imóvel atualizado.
404 PROPERTY_NOT_FOUND: inexistente, na lixeira, de outra conta ou fora do recorte da chave.
422 INVALID_STATUS_TRANSITION: draft em imóvel já publicado.
400 VALIDATION_ERROR: corpo fora do contrato, ou vínculo que não existe na conta: type desconhecido, comodidade fora do catálogo, foto que não é desta conta, não foi enviada com purpose=property ou venceu, agente que não é membro, proprietário inexistente. details[].field aponta o campo.
403 INSUFFICIENT_PERMISSIONS: agents sem properties.acquisition.update, ou owners sem owners.read.
422 PUBLISH_REQUIREMENTS_NOT_MET: pediu active sem tipo, finalidade, modalidade, valor (salvo on_request/negotiable), cidade e UF ou foto; details.fields lista o que falta.
422 PLAN_LIMIT_EXCEEDED: teto de imóveis cadastrados ou publicados do plano; details traz resource, limit e current.
422 PLAN_FEATURE_REQUIRED: agents[].transaction_types separa pessoas por operação e o plano não tem o recurso.
422 ACQUISITION_AGENT_REQUIRED: chave com properties.read em "só os meus" gravando agents sem o próprio criador como captador.
503 PLAN_CHECK_UNAVAILABLE: não foi possível conferir o plano; repita a chamada.

Requisição

Authorization
Bearer Token
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
or
Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200
application/json
Default Response
Bodyapplication/json

🟠400
🟠401
🟠403
🟠404
🟠409
🟠422
🔴500
🔴503
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://api.veploy.com/v1/properties/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "status": "draft",
    "title": "string",
    "description": "string",
    "type": "string",
    "purpose": [
        "residential"
    ],
    "is_brand_new": true,
    "exclusive": true,
    "accepts_exchange": true,
    "mcmv": true,
    "portals_enabled": true,
    "site_enabled": true,
    "hidden_fields": [
        "string"
    ],
    "year_built": 1800,
    "pricing": {
        "currency": "str",
        "sale": {
            "enabled": true,
            "price": {
                "min": "string",
                "max": "string"
            },
            "display": "price"
        },
        "rent": {
            "enabled": true,
            "price": {
                "min": "string",
                "max": "string"
            },
            "display": "price"
        },
        "short_term": {
            "enabled": true,
            "price": {
                "min": "string",
                "max": "string"
            },
            "display": "price"
        }
    },
    "condominium_fee": {
        "amount": "string",
        "display": "amount"
    },
    "property_tax": {
        "amount": "string",
        "display": "amount"
    },
    "location": {
        "country": "st",
        "state": "string",
        "city": "string",
        "neighborhood": "string",
        "street": "string",
        "number": "string",
        "complement": "string",
        "zipcode": "string",
        "in_condominium": true,
        "condominium": "string",
        "unit": {
            "tower": "string",
            "floor": "string",
            "number": "string"
        },
        "lot": {
            "sector": "string",
            "block": "string",
            "number": "string"
        },
        "latitude": -90,
        "longitude": -180,
        "map_display": "exact"
    },
    "features": {
        "bedrooms": {
            "min": 0,
            "max": 0
        },
        "bathrooms": {
            "min": 0,
            "max": 0
        },
        "suites": {
            "min": 0,
            "max": 0
        },
        "rooms": {
            "min": 0,
            "max": 0
        },
        "parkings": {
            "min": 0,
            "max": 0
        },
        "usable_area": {
            "min": 0,
            "max": 0
        },
        "total_area": {
            "min": 0,
            "max": 0
        }
    },
    "amenities": {
        "unit": [
            "string"
        ],
        "condominium": [
            "string"
        ]
    },
    "media": {
        "images": [
            {
                "id": "string",
                "alt": "string"
            }
        ],
        "floor_plans": [
            {
                "id": "string",
                "title": "string"
            }
        ],
        "video": "http://example.com",
        "virtual_tour": "http://example.com"
    },
    "agents": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "role": "acquisition",
            "transaction_types": [
                "sale"
            ]
        }
    ],
    "owners": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        }
    ]
}'
Response Response Example
200 - Exemplo 1
{
    "data": {
        "id": "7d8f1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b",
        "ref": "AP0042",
        "status": "active",
        "source": null,
        "slug": "apartamento-3-quartos-moema-sao-paulo-ap0042",
        "title": "Apartamento com 3 quartos à venda em Moema",
        "auto_title": true,
        "description": "Apartamento reformado em andar alto, com vista livre e varanda gourmet.",
        "type": {
            "slug": "apartamento",
            "name": "Apartamento"
        },
        "purpose": [
            "residential"
        ],
        "kind": "unit",
        "is_brand_new": false,
        "exclusive": true,
        "accepts_exchange": false,
        "is_network_listing": false,
        "portals_enabled": true,
        "site_enabled": true,
        "mcmv": false,
        "hidden_fields": [],
        "pricing": {
            "currency": "BRL",
            "sale": {
                "enabled": true,
                "price": {
                    "min": "980000",
                    "max": "980000"
                },
                "display": "price"
            },
            "rent": {
                "enabled": false,
                "price": {
                    "min": null,
                    "max": null
                },
                "display": "price"
            },
            "short_term": {
                "enabled": false,
                "price": {
                    "min": null,
                    "max": null
                },
                "display": "price"
            }
        },
        "condominium_fee": {
            "amount": "1450",
            "currency": "BRL",
            "frequency": "monthly",
            "display": "amount"
        },
        "property_tax": {
            "amount": "4200",
            "currency": "BRL",
            "frequency": "yearly",
            "display": "amount"
        },
        "location": {
            "country": "BR",
            "state": "SP",
            "city": "São Paulo",
            "neighborhood": "Moema",
            "value_zone": null,
            "street": "Alameda dos Arapanés",
            "number": "1000",
            "complement": null,
            "zipcode": "04524001",
            "in_condominium": true,
            "condominium": "Edifício Arapanés",
            "unit": {
                "tower": null,
                "floor": "12",
                "number": "121"
            },
            "lot": null,
            "latitude": -23.6045,
            "longitude": -46.6653,
            "map_display": "approx"
        },
        "year_built": 2012,
        "features": {
            "bedrooms": {
                "min": 3,
                "max": 3
            },
            "bathrooms": {
                "min": 2,
                "max": 2
            },
            "suites": {
                "min": 1,
                "max": 1
            },
            "rooms": {
                "min": null,
                "max": null
            },
            "parkings": {
                "min": 2,
                "max": 2
            },
            "usable_area": {
                "min": 96,
                "max": 96
            },
            "total_area": {
                "min": 128,
                "max": 128
            }
        },
        "amenities": {
            "unit": [
                "varanda_gourmet",
                "ar_condicionado"
            ],
            "condominium": [
                "piscina",
                "academia",
                "portaria_24h"
            ]
        },
        "media": {
            "images": [
                {
                    "id": "48213",
                    "url": "https://cdn.veploy.com/properties/ap0042/fachada.jpg",
                    "featured": true,
                    "alt": "Fachada do edifício",
                    "position": 0
                },
                {
                    "id": "48214",
                    "url": "https://cdn.veploy.com/properties/ap0042/sala.jpg",
                    "featured": false,
                    "alt": null,
                    "position": 1
                }
            ],
            "floor_plans": [
                {
                    "id": "48215",
                    "url": "https://cdn.veploy.com/properties/ap0042/planta.jpg",
                    "title": "Planta de 128 m²"
                }
            ],
            "video": null,
            "virtual_tour": null
        },
        "agents": [
            {
                "id": "3f8a2b1c-5d6e-4f7a-9b8c-1d2e3f4a5b6c",
                "role": "acquisition",
                "transaction_types": [
                    "sale"
                ]
            }
        ],
        "owners": [],
        "published_at": "2026-05-12T14:30:00-03:00",
        "last_published_at": "2026-08-30T09:12:00-03:00",
        "created_at": "2026-05-10T11:03:00-03:00",
        "updated_at": "2026-09-01T16:45:00-03:00"
    }
}
Modificado em 2026-11-12 20:11:50
Página anterior
Cadastrar imóvel
Próxima página
Excluir imóvel
Built with