Sign in

v1

latestOpenAPI 3.0.02026-07-264636241.7 MB
bloquear_unidade

Bloqueia ou disponibiliza unidade.

🔒 Autenticação necessária

Esta API utiliza autenticação via e-mail e token nos headers da requisição. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v1 — E-mail e Token)

Unidade é um imóvel do empreendimento. Quando essa interface for consumida irá mudar a situação da unidade, seja para bloqueada temporariamente ou para disponivel.

Obs: Para que essas informações sejam inseridas no CV, os identificadores da etapa, bloco e empreendimento precisam existir no sistema quando forem utilizados para localizar a unidade.

post/v1/cadastros/empreendimentos/unidades/bloquear

Headers

emailstring required
Example:email@email.com

E-mail de autenticação para bloqueio de unidade.

tokenstring required
Example:79d965e5027b7423423f2471824e799949c75f9ce

Token de autenticação para bloqueio de unidade.

Request body

idunidade_intstring required

Obrigatório quando idunidade não for informado. Código interno da unidade.

idunidadestring

Obrigatório quando idunidade_int não for informado. ID da unidade no CV.

idempreendimento_intstring

Opcional. Código interno do empreendimento. Usado em conjunto com idetapa_int e idbloco_int para localizar a unidade.

idbloco_intstring

Opcional. Código interno do bloco. Usado para localizar a unidade quando idunidade não for informado.

idetapa_intstring

Opcional. Código interno da etapa. Usado para localizar a unidade quando idunidade não for informado.

idblocostring

Opcional. ID do bloco no CV. Usado para localizar a unidade quando idunidade não for informado.

idetapastring

Opcional. ID da etapa no CV. Usado para localizar a unidade quando idunidade não for informado.

situacao'Bloqueada' | 'Disponivel' required

Obrigatório. Situação desejada da unidade.

motivo_bloqueiostring required

Motivo do bloqueio. Obrigatório quando situacao for Bloqueada.

descricao_motivo_bloqueiostring required

Opcional. Descrição complementar do motivo do bloqueio.

documento_bloqueiostring required

Obrigatório quando data_desbloqueio for informada. Documento relacionado ao bloqueio temporário.

data_desbloqueiostring required

Data em que a unidade ficará disponível automaticamente.

hora_desbloqueiostring required

Opcional. Hora em que a unidade ficará disponível automaticamente.

Example request

{
  "idunidade_int": "12345678",
  "idempreendimento_int": "1234",
  "idetapa_int": "123",
  "idbloco_int": "12345",
  "idetapa": "678",
  "idbloco": "901",
  "situacao": "Bloqueada",
  "motivo_bloqueio": "Unidade bloqueada",
  "descricao_motivo_bloqueio": "bloqueio de unidade a pedido do cliente",
  "documento_bloqueio": "58796512466",
  "data_desbloqueio": "01/01/2022",
  "hora_desbloqueio": "13:00:00"
}

Response

Mensagem de sucesso ao bloquear ou disponibilizar unidade.

idinteger

Id criado

sucessoboolean

Example response

{
  "id": 90,
  "sucesso": true
}