ImobyFlowParcerias Imobiliárias
Navegar na documentação
English

Listas de valores

Os valores aceitos em cada campo de código: tipos de imóvel, finalidades, status, etapas, permissões e eventos. São os MESMOS valores do banco — não existe tradução no meio.

Os valores

Os códigos aceitos hoje. O rótulo de cada um, na língua do pedido, vem das rotas abaixo. Valor novo pode chegar: o seu sistema deve tolerar o que não conhece.

Tipo de imóvel (type)
APARTAMENTOCASA_RUACASA_CONDOMINIOCASA_VILASTUDIOFLATCOBERTURASALA_COMERCIALLOJA_PONTOGALPAOPREDIOTERRENO_RUATERRENO_CONDOMINIOCHACARA_SITIOFAZENDA
Categoria
RESIDENCIALCOMERCIALTERRENORURAL
Finalidade (purposes)
VENDALOCACAO
Status do imóvel
ACTIVEINACTIVESOLDRENTED
Etapa do cliente
NEWATTENDINGPROPOSALWONLOST
Etapa da parceria
PENDINGACCEPTEDDECLINEDCANCELLEDLEAD_REGISTEREDCONTACTEDNEGOTIATINGPROPOSALWONLOST
Estágio da obra
LAUNCHOFF_PLANNEWREADY
Permissões da chave
properties:readproperties:writeleads:readleads:writeradar:readradar:writepartnerships:readpartnerships:writeteam:readlaunches:readlaunches:writecaptacao:readcaptacao:acceptevents:readwebhooks:manage
O que falta para o imóvel entrar nas recomendações
CITY_MISSINGCITY_NOT_IN_CATALOGNEIGHBORHOOD_MISSINGNEIGHBORHOOD_NOT_IN_CATALOGTYPE_MISSINGPURPOSE_MISSINGSALE_PRICE_MISSINGRENT_PRICE_MISSINGCOVER_PHOTO_MISSINGOTHER
O que falta para o cliente receber recomendações
PURPOSE_MISSINGPROPERTY_TYPES_MISSINGCITY_MISSINGCITY_NOT_IN_CATALOGBUDGET_MISSINGSALE_BUDGET_MISSINGRENT_BUDGET_MISSINGOTHER
Motivo de recusa na análise
LANCAMENTOSEM_VALORQUALIDADE_BAIXANAO_ANGARIACAOMARCA_DAGUAFOTOS_INSUFICIENTESDADOS_INCOERENTESOUTRO

As rotas

GET/v1/reference/property-types

Tipos de imóvel

As categorias e os subtipos. É o subtipo que vai no campo type.

Permissão: qualquer chave válida

Resposta200OK

datalista de PropertyTypeGroupobrigatório
A lista.

Exemplo

curl -X GET 'https://api.imobyflow.com.br/v1/reference/property-types' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR'

Erros desta rota

    E os erros comuns a toda rota

    GET/v1/reference/purposes

    Finalidades

    Venda e locação.

    Permissão: qualquer chave válida

    Resposta200OK

    datalista de ValueLabelobrigatório
    A lista.

    Exemplo

    curl -X GET 'https://api.imobyflow.com.br/v1/reference/purposes' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR'

    Erros desta rota

      E os erros comuns a toda rota

      GET/v1/reference/property-statuses

      Status do imóvel

      Os status que o imóvel pode ter.

      Permissão: qualquer chave válida

      Resposta200OK

      datalista de ValueLabelobrigatório
      A lista.

      Exemplo

      curl -X GET 'https://api.imobyflow.com.br/v1/reference/property-statuses' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR'

      Erros desta rota

        E os erros comuns a toda rota

        GET/v1/reference/lead-statuses

        Etapas do cliente

        As etapas do atendimento.

        Permissão: qualquer chave válida

        Resposta200OK

        datalista de ValueLabelobrigatório
        A lista.

        Exemplo

        curl -X GET 'https://api.imobyflow.com.br/v1/reference/lead-statuses' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR'

        Erros desta rota

          E os erros comuns a toda rota

          GET/v1/reference/partnership-statuses

          Etapas da parceria

          As etapas da parceria.

          Permissão: qualquer chave válida

          Resposta200OK

          datalista de ValueLabelobrigatório
          A lista.

          Exemplo

          curl -X GET 'https://api.imobyflow.com.br/v1/reference/partnership-statuses' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR'

          Erros desta rota

            E os erros comuns a toda rota

            GET/v1/reference/construction-stages

            Estágios da obra

            Os estágios de um lançamento.

            Permissão: qualquer chave válida

            Resposta200OK

            datalista de ValueLabelobrigatório
            A lista.

            Exemplo

            curl -X GET 'https://api.imobyflow.com.br/v1/reference/construction-stages' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR'

            Erros desta rota

              E os erros comuns a toda rota

              GET/v1/reference/scopes

              Permissões

              As permissões que uma chave pode ter.

              Permissão: qualquer chave válida

              Resposta200OK

              datalista de ScopeInfoobrigatório
              A lista.

              Exemplo

              curl -X GET 'https://api.imobyflow.com.br/v1/reference/scopes' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR'

              Erros desta rota

                E os erros comuns a toda rota

                GET/v1/reference/event-types

                Tipos de evento

                Os eventos, com a permissão de leitura que dá acesso a cada um.

                Permissão: qualquer chave válida

                Resposta200OK

                datalista de EventTypeInfoobrigatório
                A lista.

                Exemplo

                curl -X GET 'https://api.imobyflow.com.br/v1/reference/event-types' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR'

                Erros desta rota

                  E os erros comuns a toda rota

                  Os objetos

                  ValueLabel

                  Um valor aceito e o seu rótulo.

                  valuestringobrigatório
                  O valor que vai no campo.
                  labelstringobrigatório
                  O rótulo, na língua do Accept-Language.

                  PropertyTypeGroup

                  Uma categoria de imóvel e os seus subtipos.

                  categorystringobrigatório
                  A categoria.um de RESIDENCIAL COMERCIAL TERRENO RURAL
                  labelstringobrigatório
                  Rótulo da categoria.
                  typeslista de ValueLabelobrigatório
                  Os subtipos da categoria — é o subtipo que vai em type.

                  ScopeInfo

                  Uma permissão que uma chave pode ter.

                  idstringobrigatório
                  A permissão.um de properties:read properties:write leads:read leads:write radar:read radar:write partnerships:read partnerships:write team:read launches:read launches:write captacao:read captacao:accept events:read webhooks:manage
                  groupstringobrigatório
                  O grupo, para exibir.
                  labelstringobrigatório
                  O nome, para exibir.
                  descriptionstringobrigatório
                  O que ela permite.

                  EventTypeInfo

                  Um tipo de evento.

                  typestringobrigatório
                  O tipo do evento.um de property.created property.updated property.deleted property.restored property.purged lead.created lead.updated lead.deleted lead.restored lead.purged radar.client_summary partnership.created partnership.updated captacao.offer_received captacao.offer_accepted captacao.offer_withdrawn
                  scopestringobrigatório
                  A permissão de leitura que dá acesso a ele.um de properties:read properties:write leads:read leads:write radar:read radar:write partnerships:read partnerships:write team:read launches:read launches:write captacao:read captacao:accept events:read webhooks:manage
                  descriptionstringobrigatório
                  O que ele avisa.