Cadastra bloco.

🔒

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)

Bloco é um conjunto de unidades de um empreendimento. Quando essa interface for consumida um novo bloco será cadastrado no CV, logo após irá verificar se o dado inserido no campo idbloco_int existe ou não no CVs, se já existir um bloco cadastrado com o mesmo idbloco_int essa API irá atualizar os dados solicitados na requisição, se não irá cadastrá-los.

Obs: Para que essas informações sejam inseridas no CV, os identificadores da etapa e do empreendimento devem existir no sistema.

Alterando o idbloco_int de um bloco já cadastrado: por padrão, o bloco é localizado pelo idbloco_int. Se você precisar alterar o idbloco_int de um bloco que já existe no CV (por exemplo, quando o empreendimento foi cadastrado no CV antes de existir no sistema legado), envie também o campo idbloco (o identificador interno do CV, retornado pela API que consulta empreendimento). Quando idbloco é informado, o bloco é localizado por esse identificador em vez do idbloco_int, permitindo atualizar o idbloco_int sem duplicar o bloco. Se o idbloco informado não existir ou não pertencer ao empreendimento/etapa informados na mesma requisição, a API retorna erro 400.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Requisição JSON para cadastro de um bloco.

JSON para cadastro de bloco.

string
required

Identificador do bloco no sistema legado (código interno).

integer

Identificador interno do bloco no CV (o mesmo retornado no campo idbloco da API que retorna empreendimento). Quando informado, é usado para localizar o bloco a ser atualizado em vez do idbloco_int, permitindo alterar o idbloco_int de um bloco já cadastrado sem risco de duplicá-lo. Deve pertencer ao mesmo idempreendimento_int/idetapa_int informados nesta requisição, senão a API retorna erro 400.

string
required

Identificador da etapa do bloco no sistema legado (código interno).

string
required

Identificador do empreendimento do bloco no sistema legado (código interno).

string
required

Nome do bloco.

string

Informa se está ativo no painel. (Ativo|Inativo)

string
required

Data de cadastro do bloco.

string

Identificador do bloco que deseja remover. Informar o código interno do bloco nesse campo.

Headers
string
required

E-mail de autenticação para cadastro de bloco.

string
required

Token de autenticação para cadastro de bloco.

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json