Cadastrar imóvel urbano de um cliente

POST

/assets/{clientId}/properties/urban/create

Cadastra um imóvel urbano no patrimônio do cliente informado em clientId. São obrigatórios type (residential_building, commercial_building, hangar, apartment, house, terrain, room_or_conjunct, store, others ou consolidated), description, value e state (sigla da UF, ou vazio). totalArea (área total do imóvel), county (município), year (ano de referência) e situationAt (histórico de valores, com data e valor) são opcionais. description e county são gravados em letras maiúsculas. Devolve o imóvel cadastrado, sem situationAt. Corpo fora do formato devolve 422; tipo ou UF fora da lista devolvem 400. Requer autenticação via Bearer JWT ou header x-api-key. O cliente precisa pertencer à empresa do usuário: cliente inexistente devolve 404 (Cliente não encontrado), cliente de outra empresa devolve 401 (Acesso negado) e usuário inativo devolve 404 (Usuário não encontrado).

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201

application/json

Imóvel urbano cadastrado

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Tipo ou UF inválidos

🟠422Dados do imóvel inválidos

Request Example

Shell

JavaScript

Java

Swift

curl --location '/assets/7c9e6679-7425-40de-944b-e07fc1f90ae7/properties/urban/create' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "type": "house",
    "description": "Casa sede na área urbana",
    "totalArea": 250,
    "value": 850000,
    "state": "MT",
    "county": "Sorriso",
    "year": "2026",
    "situationAt": [
        {
            "data": "2025-12-31",
            "value": 800000
        }
    ]
}'

Response Example

201 - Sucesso

{
    "id": "f1a2b3c4-0000-4000-8000-000000000201",
    "type": "house",
    "description": "CASA SEDE NA ÁREA URBANA",
    "totalArea": 250,
    "value": 850000,
    "state": "MT",
    "county": "SORRISO",
    "year": "2026"
}

Modificado em 2026-10-13 09:47:06

Página anterior

Baixar KML de um imóvel rural

Próxima página

Atualizar imóvel urbano