1. Propostas
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
    • Consultar proprietário
    • Cadastrar proprietário
    • Alterar proprietário
    • Excluir proprietário
  • 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
      GET
    • Consultar proposta
      GET
    • Registrar proposta
      POST
    • Alterar proposta
      PATCH
  • 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. Propostas

Alterar proposta

PATCH
/v1/proposals/{id}
Altera uma proposta: só os campos enviados mudam; null limpa onde o campo admite. status registra o desfecho; accepted aplica o gatilho de proposta aceita do funil, quando a conta o configurou. validity_days recalcula expires_at a partir da alteração. Lead, imóvel, responsável e proposta de origem não mudam por aqui.
Respostas
200: proposta atualizada.
400: corpo vazio, campo imutável ou valor fora do contrato.
404 PROPOSAL_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
🟠409
🟠422
🔴500
🔴503
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://api.veploy.com/v1/proposals/?expand=responsible&expand=created_by' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "status": "pending",
    "amount": "string",
    "down_payment": "string",
    "payment_method": "cash",
    "validity_days": 1,
    "notes": "string"
}'
Response Response Example
200 - Exemplo 1
{
    "data": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "status": "pending",
        "property": {
            "ref": "string"
        },
        "lead_id": "9bddab70-98e6-43a9-8f32-c9788b9de0c0",
        "amount": "string",
        "down_payment": "string",
        "currency": "str",
        "payment_method": "cash",
        "validity_days": 0,
        "expires_at": "2019-08-24T14:15:22.123Z",
        "notes": null,
        "parent_proposal_id": "096a9c18-f010-4074-96b9-ef96f145488b",
        "responsible_id": "58c9585a-8dec-43d5-adfc-6e46bfe76ff5",
        "created_by_id": "9377d689-01fb-4abf-8450-3368d2c1924f",
        "responsible": {
            "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_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:15:35
Página anterior
Registrar proposta
Próxima página
Listar portais
Built with