Dar baixa em um cliente
DELETE /property-v1/customers
Quando você deixa de trabalhar com um cliente, isto o tira de circulação. É reversível: o
POST o reativa com o mesmo customerId.
curl -X DELETE https://property-api.mapaprop.com/property-v1/customers \
-H "Authorization: Bearer $TOKEN" \
-H "x-client-ref: cliente-42"
Não leva body. Resposta 200:
{
"deleted": true,
"alreadyDeleted": false,
"customer": {
"customerId": "MAPAPROP-PA-000002",
"clientRef": "cliente-42",
"deletedAt": "2026-10-01T18:22:04.117Z",
"name": "Inmobiliaria Modelo"
}
}
O customerId vem na resposta porque é o código com que esse cliente está publicado nos portais: é
útil para o seu próprio registro.
Requer o scope property-api-delete, que é diferente dos outros três: você pode estar habilitado
para criar, ler e atualizar clientes e não para dar baixa neles.
O que deixa de funcionar
A partir da baixa, esse cliente não opera:
| Operação | Depois da baixa |
|---|---|
POST /properties | 400 com rule: account_required |
PUT .../publication/{portal} | 409 com customer_not_active |
POST /connect-links | 409 |
GET e PUT da ficha dele | 404 com customer_deleted |
O que NÃO é afetado
Os anúncios que o seu cliente tenha publicados nos portais continuam publicados. A baixa não os retira: eles estão na conta DELE no portal, publicados com as credenciais dele, e não é uma decisão nossa. Se tiverem que sair, saem pelo painel do próprio portal.
Também não são apagados os imóveis dele, nem as fotos, nem as conexões com portais. A baixa é uma marca, não uma limpeza — e é por isso que pode ser desfeita.
Dar baixa duas vezes não é um erro
A segunda chamada devolve 200 com alreadyDeleted: true e a data da primeira. Se uma chamada
falhou e você não sabe se chegou, chame de novo.
Desfazer
O mesmo POST o reativa, com revived: true e o customerId de
sempre:
curl -X POST https://property-api.mapaprop.com/property-v1/customers \
-H "Authorization: Bearer $TOKEN" \
-H "x-client-ref: cliente-42" \
-H "Content-Type: application/json" \
-d '{ "name": "Inmobiliaria Modelo", "phone1": "2234567890" }'
Os dados que você enviar nesse POST são os que ficam.
Códigos de resposta
| Código | O que aconteceu | O que fazer |
|---|---|---|
200 | Baixa dada, ou já estava (alreadyDeleted: true) | — |
400 | Falta o header x-client-ref | — |
401 | Token ausente ou inválido | — |
403 | O seu token não tem o scope property-api-delete | Escreva para nós para habilitá-lo |
404 | Esse clientRef nunca declarou uma ficha | Nada para dar baixa |
Relacionado
- Clientes — o que é a ficha e os quatro métodos
POST·GET·PUT- Publicar em um portal — o
409 customer_not_active