1. Proprietários
Veploy API
  • Visão geral
  • Autenticação
  • Limites de requisição
  • Imóveis
    • Listar imóveis
    • Consultar imóvel
    • Cadastrar imóvel
    • Alterar imóvel
    • Excluir imóvel
    • Restaurar imóvel
    • Enviar foto do imóvel (Beta)
    • Remover foto do imóvel (Beta)
    • Listar tipos de imóvel
  • Proprietários
    • Listar proprietários
      GET
    • Consultar proprietário
      GET
    • Cadastrar proprietário
      POST
    • Alterar proprietário
      PATCH
    • Excluir proprietário
      DELETE
  • Leads
    • Listar leads
    • Consultar lead
    • Criar lead
    • Alterar responsável
    • Atualizar lead
    • Consultar linha do tempo do lead
  • Visitas
    • Listar visitas
    • Consultar visita
    • Agendar visita
    • Alterar visita
  • Propostas
    • Listar propostas
    • Consultar proposta
    • Registrar proposta
    • Alterar proposta
  • Portais
    • Listar portais
    • Consultar portal
    • Listar imóveis do XML
  • Usuários
    • Listar usuários
    • Consultar usuário
    • Consultar permissões do usuário
    • Convidar usuário
    • Alterar ficha do usuário
    • Desativar usuário
    • Reativar usuário
    • Remover usuário
  • Perfis de acesso
    • Listar perfis de acesso
  • Artigos
    • Listar artigos
    • Criar artigo
    • Consultar artigo
    • Alterar artigo
    • Enviar capa do artigo (Beta)
  • Temas
    • Tema do site
  1. Proprietários

Alterar proprietário

PATCH
/v1/owners/{id}
Altera um proprietário: só os campos enviados mudam; null limpa onde o campo admite. documents, address e social são mesclados chave a chave; phones substitui a lista inteira. type e name nunca ficam vazios, e trocar type exige que os documentos fiquem coerentes com o novo tipo. Pedir o estado que já vale responde 200 sem alterar nada.
Respostas
200: proprietário atualizado. A resposta entra na trilha de acesso a dados pessoais da conta.
400: corpo vazio, campo só de leitura, valor fora do contrato, documento incoerente com type ou estado final sem contato.
404 OWNER_NOT_FOUND: inexistente, de outra conta ou fora do recorte da chave.

Requisição

Authorization
Bearer Token
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
or
Parâmetros de Caminho

Parâmetros de Consulta

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200
application/json
Default Response
Bodyapplication/json

🟠400
🟠401
🟠403
🟠404
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://api.veploy.com/v1/owners/?expand=created_by' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "individual",
    "name": "string",
    "representative_name": "string",
    "phones": [
        {
            "number": "string",
            "label": "string"
        }
    ],
    "email": "user@example.com",
    "documents": {
        "cpf": "string",
        "cnpj": "string",
        "representative_cpf": "string"
    },
    "address": {
        "state": "AC",
        "city": "string",
        "neighborhood": "string",
        "street": "string",
        "number": "string",
        "complement": "string",
        "zipcode": "string"
    },
    "social": {
        "facebook": "http://example.com",
        "instagram": "http://example.com",
        "x": "http://example.com",
        "tiktok": "http://example.com",
        "youtube": "http://example.com",
        "linkedin": "http://example.com"
    }
}'
Response Response Example
200 - Exemplo 1
{
    "data": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "type": "individual",
        "name": null,
        "representative_name": null,
        "phones": [
            {
                "number": "string",
                "label": null
            }
        ],
        "email": null,
        "documents": {
            "cpf": null,
            "cnpj": null,
            "representative_cpf": null
        },
        "address": {
            "state": null,
            "city": null,
            "neighborhood": null,
            "street": null,
            "number": null,
            "complement": null,
            "zipcode": null
        },
        "social": {
            "facebook": null,
            "instagram": null,
            "x": null,
            "tiktok": null,
            "youtube": null,
            "linkedin": null
        },
        "properties": [
            {
                "ref": "string"
            }
        ],
        "created_by_id": "9377d689-01fb-4abf-8450-3368d2c1924f",
        "created_by": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "email": "string",
            "phone": "string",
            "cpf": "string",
            "creci": "string",
            "birth_date": "string",
            "avatar_url": "string",
            "role": "string",
            "status": "active",
            "lead_distribution_enabled": true,
            "username": "string",
            "invited_at": "2019-08-24T14:15:22.123Z",
            "email_confirmed_at": "2019-08-24T14:15:22.123Z",
            "created_at": "2019-08-24T14:15:22.123Z"
        },
        "created_at": "2019-08-24T14:15:22.123Z",
        "updated_at": "2019-08-24T14:15:22.123Z"
    }
}
Modificado em 2026-11-12 20:12:25
Página anterior
Cadastrar proprietário
Próxima página
Excluir proprietário
Built with