Skip to navigation

Mover oportunidade de etapa

Move a oportunidade para outra etapa do funil.

Autenticação: Bearer Token da API WBudget. O acesso aos dados respeita as permissões do usuário.

Consulte GET /status/{id}/form para conhecer os campos e atividades da etapa antes da movimentação. A movimentação respeita a sequência permitida, a aprovação e as atividades obrigatórias da etapa. A consulta do formulário não substitui o preenchimento dessas exigências.

Parâmetros de caminho

CampoTipoObrigatórioDescrição
idintegerSimID da oportunidade.

Corpo da requisição

CampoTipoObrigatórioDescrição
statusintegerSimID da etapa de destino.
optionsobjectNãoOpções da movimentação. create_activities=1 cria as atividades previstas para a etapa; padrão 0.
options.create_activitiesintegerNão1 cria as atividades configuradas para a etapa; 0 não cria automaticamente (padrão).

Exemplo de JSON enviado

{
"status": 20,
"options": {
"create_activities": 0
}
}

Resposta

HTTP 200. Os exemplos usam dados fictícios e mostram os campos principais; outros campos podem acompanhar a resposta. Campos sem valor podem ser nulos.

Campos principais de data:

CampoTipoDescrição
idintegerID do recurso.
statusintegerID da etapa.
{
"data": {
"id": 1001,
"status": 20
}
}

Erros específicos

HTTPCódigoSituação
422VALIDATION_FAILEDThe status field is required.

Consulte a introdução da collection para o formato de erros e a configuração das variáveis.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
ID da oportunidade.

Request

This endpoint expects an object.
optionsobjectOptional
statusdoubleOptional

Response

200 — Sucesso — exemplo ilustrativo

dataobjectOptional

Errors

422
Unprocessable Entity Error