1. Empreendimento
Homfy Public API
  • Bem vindo
  • Autenticação
    • Emitir token
      POST
    • Renovar token
      POST
  • Empreendimento
    • Cadastrar empreendimento
      POST
    • Atualizar empreendimento
      PUT
    • Cadastrar empreendimentos em lote
      POST
    • Consultar empreendimento
      POST
    • Vincular imóveis ao empreendimento
      POST
  • Imóvel
    • Cadastrar imóvel
      POST
    • Atualizar imóvel
      PUT
    • Cadastrar imóveis em lote
      POST
    • Consultar detalhes do imóvel
      POST
    • Enviar fotos — passo 1: obter URLs
      POST
    • Enviar fotos — passo 2: concluir
      POST
    • Andamento do processamento das fotos
      POST
    • Enviar documento — passo 1: obter URL
      POST
    • Enviar documento — passo 2: concluir
      POST
    • Buscar imóveis
      POST
  • Proprietário
    • Cadastrar proprietário
      POST
    • Atualizar proprietário
      PUT
    • Cadastrar proprietários em lote
      POST
    • Consultar detalhes do proprietário
      POST
    • Buscar proprietários
      POST
    • Vincular proprietário a imóvel
      POST
  • Cliente
    • Cadastrar cliente
      POST
    • Atualizar cliente
      PUT
    • Cadastrar clientes em lote
      POST
    • Consultar detalhes do cliente
      POST
    • Buscar clientes
      POST
    • Atribuir cliente a corretor
      POST
  • Corretor
    • Consultar corretores
  • Schemas
    • ApiPartnerAuthTokenDTO
    • ApiPartnerAuthTokenResponseDTO
    • ApiPartnerErrorResponseDTO
    • ApiPartnerAuthRefreshTokenDTO
    • ApiPartnerAddressDTO
    • ApiPartnerPropertyDetailDTO
    • ApiPartnerPropertyPriceDTO
    • ApiPartnerPropertyListingDTO
    • ApiPartnerPropertyRegisterDTO
    • ApiPartnerPropertyCreatedDTO
    • ApiPartnerPropertySkippedDTO
    • ApiPartnerPropertyErrorItemDTO
    • ApiPartnerPropertyRegisterResponseDTO
    • ApiPartnerPropertyItemDTO
    • ApiPartnerPropertyBatchRegisterDTO
    • ApiPartnerPropertyUpdateDTO
    • ApiPartnerPropertyUpdateResponseDTO
    • ApiPartnerPropertyFindDTO
    • ApiPartnerListingPriceDTO
    • ApiPartnerListingImageDTO
    • ApiPartnerListingVideoDTO
    • ApiPartnerListingResponseDTO
    • ApiPartnerPropertyDetailResponseDTO
    • ApiPartnerPhotoFileDTO
    • ApiPartnerPhotosInitDTO
    • ApiPartnerPresignedPartDTO
    • ApiPartnerPhotoUploadTargetDTO
    • ApiPartnerPhotosInitResponseDTO
    • ApiPartnerUploadPartDTO
    • ApiPartnerPhotoUploadDTO
    • ApiPartnerPhotosCompleteDTO
    • ApiPartnerPhotoCompleteItemDTO
    • ApiPartnerPhotosCompleteResponseDTO
    • ApiPartnerPhotosStatusDTO
    • ApiPartnerPhotoVariantDTO
    • ApiPartnerPhotoStatusItemDTO
    • ApiPartnerPhotosStatusResponseDTO
    • ApiPartnerDocumentInitDTO
    • ApiPartnerDocumentInitResponseDTO
    • ApiPartnerDocumentCompleteDTO
    • ApiPartnerDocumentCompleteResponseDTO
    • ApiPartnerPropertyFiltroDTO
    • ApiPartnerPropertySearchFiltersDTO
    • ApiPartnerSearchSortDTO
    • ApiPartnerPropertySearchDTO
    • ApiPartnerPropertySummaryDTO
    • ApiPartnerPropertySearchResponseDTO
    • ApiPartnerOwnerSpouseDTO
    • ApiPartnerOwnerRegisterDTO
    • ApiPartnerOwnerCreatedDTO
    • ApiPartnerOwnerSkippedDTO
    • ApiPartnerOwnerErrorItemDTO
    • ApiPartnerOwnerRegisterResponseDTO
    • ApiPartnerOwnerItemDTO
    • ApiPartnerOwnerBatchRegisterDTO
    • ApiPartnerOwnerUpdateDTO
    • ApiPartnerOwnerUpdateResponseDTO
    • ApiPartnerOwnerFindDTO
    • ApiPartnerOwnerSpouseResponseDTO
    • ApiPartnerOwnerDetailResponseDTO
    • ApiPartnerOwnerSearchSortDTO
    • ApiPartnerOwnerSearchFiltersDTO
    • ApiPartnerOwnerSearchDTO
    • ApiPartnerOwnerSummaryDTO
    • ApiPartnerOwnerSearchResponseDTO
    • ApiPartnerOwnerLinkPropertyDTO
    • ApiPartnerOwnerLinkResponseDTO
    • ApiPartnerLeadRegisterDTO
    • ApiPartnerLeadCreatedDTO
    • ApiPartnerLeadSkippedDTO
    • ApiPartnerLeadErrorItemDTO
    • ApiPartnerLeadRegisterResponseDTO
    • ApiPartnerLeadItemDTO
    • ApiPartnerLeadBatchRegisterDTO
    • ApiPartnerLeadUpdateDTO
    • ApiPartnerLeadUpdateResponseDTO
    • ApiPartnerLeadFindDTO
    • ApiPartnerLeadDetailResponseDTO
    • ApiPartnerLeadSearchSortDTO
    • ApiPartnerLeadSearchFiltersDTO
    • ApiPartnerLeadSearchDTO
    • ApiPartnerLeadSummaryDTO
    • ApiPartnerLeadSearchResponseDTO
    • ApiPartnerLeadAssignAgentDTO
    • ApiPartnerLeadAssignAgentResponseDTO
    • ApiPartnerAgentSearchFiltersDTO
    • ApiPartnerAgentSearchDTO
    • ApiPartnerAgentSummaryDTO
    • ApiPartnerAgentSearchResponseDTO
    • ApiPartnerRealtyClusterRegisterDTO
    • ApiPartnerRealtyClusterCreatedDTO
    • ApiPartnerRealtyClusterSkippedDTO
    • ApiPartnerRealtyClusterErrorItemDTO
    • ApiPartnerRealtyClusterRegisterResponseDTO
    • ApiPartnerRealtyClusterItemDTO
    • ApiPartnerRealtyClusterBatchRegisterDTO
    • ApiPartnerRealtyClusterUpdateDTO
    • ApiPartnerRealtyClusterAddressResponseDTO
    • ApiPartnerRealtyClusterDetailResponseDTO
    • ApiPartnerRealtyClusterFindDTO
    • ApiPartnerRealtyClusterLinkPropertiesDTO
    • ApiPartnerRealtyClusterLinkedDTO
    • ApiPartnerRealtyClusterLinkErrorDTO
    • ApiPartnerRealtyClusterLinkResponseDTO
  1. Empreendimento

Cadastrar empreendimentos em lote

POST
/partner/v1/realty-cluster/batch
Até 50 empreendimentos por chamada — um quarto do teto de 200 das outras entidades, porque cada empreendimento são DUAS gravações do lado da Homfy (o cadastro e a complementação com endereço). A resposta separa created de skipped, então a carga inteira pode ser reenviada após uma falha sem duplicar nada — lembrando que skipped NÃO atualiza o que já existe.
partner_code repetido DENTRO da mesma carga é recusado com 400 e nada é gravado. Já um código que existe de uma carga anterior não é erro: volta em skipped.
A resposta 201 pode conter falha: um item pode falhar sozinho e os demais serem criados. Cada entrada de errors identifica o empreendimento pelo partner_code.

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Body Params application/jsonRequired

Example
{
    "realty_clusters": [
        {
            "type": "Empreendimento",
            "partner_code": "EMP-1024",
            "name": "Residencial Bela Vista",
            "is_active": true,
            "description": "Condomínio fechado com 4 torres, entregue em 2019.",
            "email": "contato@belavista.com.br",
            "phone": "(48) 3333-4444",
            "whatsapp": "48999998888",
            "address": {
                "state": "SC",
                "zipcode": "88015-600",
                "city": "Florianópolis",
                "district": "Centro",
                "street": "Bocaiúva",
                "street_number": "120",
                "street_type": "Rua",
                "reference": "Próximo ao mercado",
                "complement": "Apto 302",
                "block": "Torre B",
                "latitude": "-27.593500",
                "longitude": "-48.548500"
            }
        }
    ]
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/partner/v1/realty-cluster/batch' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "realty_clusters": [
        {
            "type": "Empreendimento",
            "partner_code": "EMP-1024",
            "name": "Residencial Bela Vista",
            "is_active": true,
            "description": "Condomínio fechado com 4 torres, entregue em 2019.",
            "email": "contato@belavista.com.br",
            "phone": "(48) 3333-4444",
            "whatsapp": "48999998888",
            "address": {
                "state": "SC",
                "zipcode": "88015-600",
                "city": "Florianópolis",
                "district": "Centro",
                "street": "Bocaiúva",
                "street_number": "120",
                "street_type": "Rua",
                "reference": "Próximo ao mercado",
                "complement": "Apto 302",
                "block": "Torre B",
                "latitude": "-27.593500",
                "longitude": "-48.548500"
            }
        }
    ]
}'

Responses

🟢201
application/json
Resultado item a item: created, skipped e errors. Os errorCode de errors[] são os mesmos do cadastro individual: PARTNER_REALTY_CLUSTER_INCOMPLETE, PARTNER_REALTY_CLUSTER_ALREADY_EXISTS e PARTNER_REALTY_CLUSTER_REGISTER_FAILED.
Bodyapplication/json

Example
{
    "created": [
        {
            "partner_code": "AP-1024",
            "realty_cluster_id": 42,
            "code": "SC1547"
        }
    ],
    "skipped": [
        {
            "partner_code": "AP-1024",
            "realty_cluster_id": 42
        }
    ],
    "errors": [
        {
            "partner_code": "AP-1024",
            "errorCode": "PARTNER_PROPERTY_NOT_FOUND",
            "errorMessage": "string"
        }
    ]
}
🟠400
🟠401
🟠403
🟠429
🔴500
Modified at 2026-08-20 16:06:11
Previous
Atualizar empreendimento
Next
Consultar empreendimento
Built with