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

Alterando o idetapa_int de uma etapa já cadastrada: por padrão, a etapa é localizada pelo idetapa_int. Se você precisar alterar o idetapa_int de uma etapa 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 idetapa (o identificador interno do CV, retornado pela API que consulta empreendimento). Quando idetapa é informado, a etapa é localizada por esse identificador em vez do idetapa_int, permitindo atualizar o idetapa_int sem duplicar a etapa. Se o idetapa informado não existir ou não pertencer ao empreendimento informado 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 uma etapa.

JSON para cadastro de empreendimento.

string
required

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

integer

Identificador interno da etapa no CV (o mesmo retornado no campo idetapa da API que retorna empreendimento). Quando informado, é usado para localizar a etapa a ser atualizada em vez do idetapa_int, permitindo alterar o idetapa_int de uma etapa já cadastrada sem risco de duplicá-la. Deve pertencer ao mesmo idempreendimento_int informado nesta requisição, senão a API retorna erro 400.

string
required

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

string
required

Nome da etapa.

string
required

Disponibilidade da etapa (Ativo ou Finalizado).

string
required

Data de cadastro da etapa.

string

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

Headers
string
required

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

string
required

Token de autenticação para cadastro de etapa.

Responses

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