Cadastrar proprietário

POST

/partner/v1/property-owner

Cadastra um proprietário. Reexecutável: reenviar o mesmo partner_code devolve o proprietário já existente em skipped, sem criar outro — e sem atualizar nada: o corpo reenviado é descartado. Para alterar quem já existe, use PUT /partner/v1/property-owner.

Só partner_code, name e whatsapp são obrigatórios. O WhatsApp é a identidade da pessoa e é único por imobiliária; e-mail e documento, quando informados, também são. Se a chave já pertencer a um proprietário que NÃO veio da sua integração (cadastrado no painel ou trazido por migração), não há como assumi-lo pela API — o item volta em errors sem conflict_partner_code.

A resposta 201 pode conter falha: confira errors antes de dar o cadastro por concluído. Item que aparece em errors NÃO foi cadastrado.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "document_type": "cpf",
    "birth_date": "1985-03-14",
    "partner_code": "PROP-4471",
    "name": "João da Silva",
    "whatsapp": "(48) 99999-1234",
    "email": "joao@exemplo.com",
    "phone": "(48) 3333-2222",
    "document": "123.456.789-00",
    "notes": "Prefere contato pela manhã.",
    "address_state": "SC",
    "address_city": "Florianópolis",
    "address_zipcode": "88015-600",
    "address_street": "Rua Bocaiúva",
    "address_number": "120",
    "address_complement": "Apto 302",
    "address_neighborhood": "Centro",
    "profession": "Engenheiro",
    "marital_status": "Casado",
    "marriage_regime": "Comunhão parcial de bens",
    "nationality": "Brasileira",
    "rg": "12.345.678-9",
    "rg_issuer": "SSP/SC",
    "origin": "Indicação",
    "spouse": {
        "birth_date": "1985-03-14",
        "name": "Maria Souza",
        "document": "123.456.789-00",
        "rg": "12.345.678-9",
        "email": "maria@exemplo.com",
        "profession": "Advogada",
        "nationality": "Brasileira"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/partner/v1/property-owner' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "document_type": "cpf",
    "birth_date": "1985-03-14",
    "partner_code": "PROP-4471",
    "name": "João da Silva",
    "whatsapp": "(48) 99999-1234",
    "email": "joao@exemplo.com",
    "phone": "(48) 3333-2222",
    "document": "123.456.789-00",
    "notes": "Prefere contato pela manhã.",
    "address_state": "SC",
    "address_city": "Florianópolis",
    "address_zipcode": "88015-600",
    "address_street": "Rua Bocaiúva",
    "address_number": "120",
    "address_complement": "Apto 302",
    "address_neighborhood": "Centro",
    "profession": "Engenheiro",
    "marital_status": "Casado",
    "marriage_regime": "Comunhão parcial de bens",
    "nationality": "Brasileira",
    "rg": "12.345.678-9",
    "rg_issuer": "SSP/SC",
    "origin": "Indicação",
    "spouse": {
        "birth_date": "1985-03-14",
        "name": "Maria Souza",
        "document": "123.456.789-00",
        "rg": "12.345.678-9",
        "email": "maria@exemplo.com",
        "profession": "Advogada",
        "nationality": "Brasileira"
    }
}'

Responses

🟢201

application/json

Proprietário criado, ou já existente em skipped.

Bodyapplication/json

Example

{
    "created": [
        {
            "partner_code": "AP-1024",
            "property_owner_id": "66c1f3a2e4b0a1d2c3e4f5a6"
        }
    ],
    "skipped": [
        {
            "partner_code": "AP-1024",
            "property_owner_id": "66c1f3a2e4b0a1d2c3e4f5a6"
        }
    ],
    "errors": [
        {
            "partner_code": "AP-1024",
            "errorCode": "PARTNER_PROPERTY_NOT_FOUND",
            "errorMessage": "string",
            "conflict_partner_code": "string"
        }
    ]
}

🟠400

🟠401

🟠403

🟠429

🔴500

Modified at 2026-08-20 16:06:11

Buscar imóveis

Atualizar proprietário