Adicionar etapa de funil

post/stages

Request

Base URL
https://api.pipe.run/v1
Auth
API key in header token
TypeScript
https://skmtc.dev/pipe/apis/application-json/docs/stages/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

pipeline_idinteger required

ID do funil de vendas.

namestring required

Nome da etapa.

origin_idinteger

ID da origem.

descriptionstring

Descrição da etapa.

colorstring

Cor da etapa.

orderinteger

Ordem da etapa dentro do funil.

allow_win_dealboolean

Habilita ou desabilita a opção de ganhar oportunidade dentro da etapa: false: desabilita a opção, true: habilita a opção.

allow_create_dealboolean

Habilita ou desabilita a opção de gerar oportunidade na etapa: false: desabilita a opção, true: habilita a opção.

Response

201

successboolean

messagestring

Example response

{
  "success": true,
  "message": "Created",
  "data": {
    "id": 123,
    "account_id": 123,
    "pipeline_id": 123,
    "name": "Teste Documentação",
    "description": "Etapa referente à recuperação de clientes",
    "order": 1,
    "color": "#ffffff",
    "hash": "c027a9d1-c2dc-5c6d-96ca-7dff65428715",
    "allow_win_deal": true,
    "allow_create_deal": true
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.