Imóveis

Criar

<aside>🔒 Para acessar essa rota é necessária a permissão de cadastro de Imóveis</aside>
post/buildings

Request

  • Base URL: https://api.apresenta.me
  • URL: https://api.apresenta.me/buildings
  • Auth: HTTP bearer

Request body

id2integer

ID visível do imóvel.

condominium_idinteger

ID do condomínio.

referencestring

Referência.

statusstring

Status.

lockstring

Bloqueio do imóvel.

type_idinteger required

ID do Tipo do imóvel.

stage_idinteger

ID do estágio.

country_idinteger

ID do País.

state_idinteger

ID do estado.

city_idinteger

ID da cidade.

district_idinteger

ID do bairro.

tagsinteger[]

Tags do imóvel.

responsibleinteger[]

IDs dos responsáveis.

constructor_idinteger

ID da construtora.

accessstring

Tipo de Acesso.

pickupinteger

ID do usuário que captou o imóvel.

slugstring

Link permanente para site.

expirationboolean

Expiração do imóvel ativa.

expiration_datestring

Data da expiração do imóvel.

activeboolean

Imóvel Ativo.

import_idstring

Referência do sistema externo.

principal_mediastring

Mídia principal.

purpose_featuredstring

Finalidade em destaque.

positioninteger

Ordem do imóvel.

occupancystring

Ocupação do imóvel.

garageinteger

Quantidade mínima de garagens.

garage_numberinteger

Número da Vaga.

suiteinteger

Quantidade mínima de Suítes.

roominteger

Quantidade mínima de Salas.

bathroominteger

Quantidade mínima de Banheiros.

bedroominteger

Quantidade mínima de Quartos.

conservationstring

Conservação do imóvel.

built_yearinteger

Ano de construção.

floorinteger

Andar do imóvel.

total_floorsinteger

Quantidade de Andares.

total_by_floorsinteger

Apartamentos por Andar.

blocksinteger

Quantidade de Blocos do condomínio.

accommodatesinteger

Quantidade de Pessoas que acomoda.

furnishingstring

Status da mobília.

titlestring required

Titulo do imóvel.

platestring

Status da placa.

contentstring

HTML de Descrição do imóvel.

lock_descriptionstring

Observações do bloqueio.

area_totalstring

Área total mínima.

area_privatestring

Área privada mínima.

area_usefulstring

Área útil mínima.

area_groundstring

Área do terreno.

area_frontstring

Frente do imóvel.

area_lengthstring

Comprimento do imóvel.

area_backstring

Fundos do imóvel.

streetstring

Rua do imóvel.

numberinteger

número do imóvel.

complementstring

Complemento do imóvel.

reference_pointstring

Ponto de referência.

building_namestring

Nome do empreendimento.

zip_codeinteger

CEP do imóvel.

amount_updated_atstring

Data de Atualização dos valores.

delivery_datestring

Data de entrega.

show_addressboolean

Divulga Endereço.

show_numberboolean

Divulga Número.

show_complementboolean

Divulga Complemento.

mapboolean

Divulga Mapa.

map_streetboolean

Divulga Mapa da Rua.

map_infostring[]

Infos do mapa.

map_aroundboolean

Ofuscar ponto exato no mapa.

iptu_referencestring

Inscrição de IPTU.

energy_referencestring

Matrícula de inscrição de Energia.

water_referencestring

Matrícula de inscrição de Água.

gas_referencestring

Matrícula de inscrição de gás.

incorporation_referencestring

Inscrição de Incorporação.

notesstring

Observações.

virtual_tourstring

Link do Tour Virtual.

html_titlestring

Título da página (HTML title).

html_keywordstring

Palavras Chave (HTML Keyword). Example:

html_descriptionstring

descrição SEO.

system_featuredboolean

Destaque no Site.

thirdparty_featuredstring

Destaque nos Portais.

uses_calendarstring

Uso do calendário.

watermarkboolean

Usa Marca d'água.

exclusivityboolean

Exclusividade.

head_codestring

Códigos para Plugins Específicos dentro da tag Head.

status_barboolean

Barra de Status ativa.

status_bar_contentstring

Conteúdo da Barra de Status.

status_bar_colorstring

Cor da Barra de Status.

owner_reportboolean

Notificação para o Proprietário.

Example request

{
  "id2": 11,
  "condominium_id": 13,
  "reference": "CA001",
  "status": "active",
  "lock": "free",
  "type_id": 1,
  "stage_id": 2,
  "country_id": 1,
  "state_id": 24,
  "city_id": 8650,
  "district_id": 1,
  "tags": [
    1,
    2
  ],
  "responsible": [
    1
  ],
  "constructor_id": 1,
  "access": "all",
  "pickup": 123,
  "slug": "exemplo-perma-link",
  "expiration_date": "2024-03-20",
  "active": true,
  "import_id": "CA001",
  "principal_media": "https://...",
  "purpose_featured": "rent",
  "position": 1,
  "occupancy": "vacant",
  "garage": 1,
  "garage_number": 123,
  "suite": 1,
  "room": 1,
  "bathroom": 1,
  "bedroom": 3,
  "conservation": "Bem conservado",
  "built_year": 2000,
  "floor": 2,
  "total_floors": 4,
  "total_by_floors": 2,
  "blocks": 2,
  "accommodates": 5,
  "furnishing": "furnished",
  "title": "Título Exemplar",
  "plate": "without",
  "content": "<p>Imóvel de Exemplo!</p>",
  "lock_description": "Fim da Locação",
  "area_total": "123",
  "area_private": "123",
  "area_useful": "123",
  "area_ground": "12",
  "area_front": "21",
  "area_length": "132",
  "area_back": "123",
  "street": "Rua Guanabara",
  "number": 1,
  "complement": "Apartamento",
  "reference_point": "Bar do Seu Zé",
  "building_name": "Guanabara Prime",
  "zip_code": 89160000,
  "amount_updated_at": "2024-01-01",
  "delivery_date": "2024-05-01",
  "show_address": true,
  "show_number": true,
  "show_complement": true,
  "map_info": [],
  "iptu_reference": "12321321",
  "energy_reference": "12321313",
  "water_reference": "213213",
  "gas_reference": "23213213-12",
  "incorporation_reference": "213213123.223",
  "notes": "Observações do imóvel",
  "virtual_tour": "https://...",
  "html_title": "SEO Título",
  "html_keyword": "optio",
  "html_description": "SEO,chave",
  "system_featured": true,
  "thirdparty_featured": "disabled",
  "uses_calendar": "disabled",
  "watermark": true,
  "head_code": "function example(foo,bar){...}",
  "status_bar_content": "Sem conteúdo",
  "status_bar_color": "ff00fa",
  "owner_report": true
}

Changes

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