Cadastrar agenciamento

Cadastra UM agenciamento (a captação de um imóvel de um proprietário). Reexecutável: reenviar o mesmo partner_code devolve result: "skipped" com o agenciamento que já existe, sem atualizar nada; duas chamadas simultâneas com o mesmo código resultam em uma created e uma skipped.

Obrigatórios: partner_code, o proprietário (owner_partner_code ou owner_id — ele precisa existir antes; cadastre-o em POST /partner/v1/owner), realstate_agent_id (corretor ativo da imobiliária), property_type, property_contract, total_area, expected_value, visit_availability, property_description e address. O imóvel (property_partner_code ou property_id) é opcional e, se informado, já deve existir; ele é só uma referência gravada no agenciamento e volta no campo property.

O agenciamento nasce sempre na etapa "Solicitado" do fluxo (veja GET /partner/v1/property-agency/workflow); a condução nas etapas seguintes é feita no painel. O cadastro também cria, como no painel, um imóvel em situação "Em agenciamento" vinculado ao proprietário e ao corretor informado.

Se o proprietário já está vinculado a outro corretor da imobiliária, o cadastro é recusado com 409 — o parceiro não toma o proprietário de outro corretor.

Não há atualização, mudança de etapa nem exclusão por esta API. O token de corretor se comporta como nas demais rotas: o recorte é a imobiliária, e o corretor do token não restringe a lista.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "partner_code": "AGE-3310",
    "owner_partner_code": "PRO-1020",
    "owner_id": "507f1f77bcf86cd799439011",
    "property_type": "Andar Corporativo",
    "property_contract": "Compra",
    "property_partner_code": "IMO-5521",
    "realstate_agent_id": 42,
    "total_area": 120.5,
    "expected_value": 650000,
    "visit_availability": "Seg a sex, das 9h às 17h",
    "property_description": "Apartamento de 3 quartos, sol da manhã.",
    "address": {
        "zipcode": "88010-000",
        "street": "das Flores",
        "street_type": "Rua",
        "number": "100",
        "neighborhood": "Centro",
        "city": "Florianópolis",
        "state": "SC",
        "complement": "Apto 12"
    },
    "property_id": 1234,
    "owner_observations": "Prefere contato à tarde."
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

Agenciamento criado (created) ou já existente (skipped).

Bodyapplication/json

Example

{
    "result": "created",
    "partner_code": "AGE-3310",
    "property_agency_id": 55
}

Request

Request Code Samples

Responses