Sign in

v1

latestOpenAPI 3.0.02026-07-264636241.7 MB
Etapa

Cadastra etapa.

🔒 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)

Etapa é um conjunto de blocos pertencentes a um empreendimento. Quando essa interface for consumida uma nova etapa será criada dentro de um empreendimento no Construtor de Vendas, ela irá verificar se o dado inserido no campo idetapa_int existe ou não no Construtor de Vendas, se já existir uma etapa cadastrada com o mesmo idetapa_int, essa API irá atualizar os dados solicitados na requisição, se não irá cadastrá-los.

Obs: Para que a etapa seja inserida no Contrutor de Vendas, o identificador do empreendimento deve existir no sistema. Somente será aceito um cadastro por nome

post/v1/cadastros/empreendimentos/etapas

Headers

emailstring required
Example:email@email.com

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

tokenstring required
Example:79d965e5027b7423423f2471824e799949c75f9ce

Token de autenticação para cadastro de etapa.

Request body

idetapa_intstring required

Identificador da etapa no sistema legado (Código interno).

idempreendimento_intstring required

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

nomestring required

Nome da etapa.

disponivelstring required

Disponibilidade da etapa (Ativo ou Finalizado).

data_cadstring required

Data de cadastro da etapa.

removerstring

Identificador (código interno - etapa_int) da etapa que deseja remover.

Example request

{
  "idetapa_int": "2320",
  "idempreendimento_int": "12345678",
  "nome": "Etapa Única",
  "disponivel": "Ativo",
  "data_cad": "2018-11-21 16:16:35",
  "remover": "0"
}

Response

Mensagem de sucesso ao cadastrar etapa.

idinteger

Id criado

sucessoboolean

Example response

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