Editar Proposta
Atualiza parcialmente os dados de uma proposta. Apenas os campos presentes no corpo da requisição serão modificados.
Requisição
Endpoint
- Metodo: PATCH
- Endpoint:
/v2/proposals/{proposal_id}
Parâmetros (Path)
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| proposal_id | string (uuid) | ✅ | Identificador da proposta |
Parâmetros (Body)
Todos os campos são opcionais. Envie apenas os campos que deseja alterar.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| name | string | Nome do tomador |
| date_of_birth | string (date) | Data de nascimento do tomador |
| gender | string | Gênero do tomador |
| cpf | string | CPF do tomador |
| marital_status | EstadoCivil | Estado Civil do tomador |
| phone | string | Telefone do tomador |
string | Email do tomador | |
| credit_contract_id | string | Identificador do contrato de crédito |
| address | Address | Endereço do tomador |
Exemplo de corpo
{
"phone": "+5551999887766",
"email": "novo@mail.com",
"address": {
"street": "Av. Ipiranga",
"number": "6681",
"zip": "90619-900",
"neighborhood": "Partenon",
"city": "Porto Alegre",
"state": "RS"
}
}
Resposta
Campos da resposta (200)
Retorna a proposta atualizada. Veja o schema completo em Consultar Proposta.
Exemplo (200)
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa4",
"client_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "PENDING_SIGNATURE",
"expires_at": "2025-08-11T02:07:49.030Z",
"credit_contract_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"quote_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"premium": "100.0",
"lucky_number": null,
"coverage_from": "2025-08-11T00:00:00.000Z",
"coverage_until": "2035-08-11T00:00:00.000Z",
"loan": {
"amount": "1000.0",
"period_in_months": 120
},
"person": {
"name": "Fulano de Tal",
"date_of_birth": "2000-01-01",
"gender": "M",
"cpf": "01234567890",
"marital_status": "SINGLE",
"phone": "+5551999887766",
"email": "novo@mail.com"
},
"address": {
"street": "Av. Ipiranga",
"number": "6681",
"complement": null,
"zip": "90619-900",
"neighborhood": "Partenon",
"city": "Porto Alegre",
"state": "RS"
},
"signature": {
"signature_id": null,
"signed_at": null,
"signature_provider": null
},
"created_at": "2025-08-10T02:07:49.030Z",
"updated_at": "2025-08-10T02:07:49.030Z",
"cancelled_at": null
}
Erros
| Código | HTTP | Descrição |
|---|---|---|
NOT_FOUND | 404 | Proposta não encontrada. |