Adicionar funil

post/pipelines

Request

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

Request body

namestring required

Nome do funil.

funnel_typeinteger required

Tipo de funil: 0: vendas, 1: pré vendas, 2: pós vendas, 3: customer sucess, 4: marketing, 5: contratos, 6: projetos, 7: administrativo.

user_idstring required

ID do usuário responsável pelo funil.

is_mainboolean

Define se o funil em questão é o principal da conta: false: funil não é o principal, true: funil é o principal.

limit_timeinteger

Alerta de estagnação: quantidade de dias até exibir o alerta nos cards do funil.

orderinteger

Ordem (posição) do funil na listagem.

descriptionstring

Descrição do funil.

visibilityinteger

Visibilidade: 0: público (padrão), 1: privado, 2: usuário (relacionar ID do usuário).

Response

201

successboolean

messagestring

Example response

{
  "success": true,
  "message": "Created",
  "data": {
    "id": 748,
    "account_id": 748,
    "user_id": 2,
    "name": "Entradas 4",
    "description": "Entradas de vendas",
    "funnel_type_name": "Vendas"
  }
}

Changes

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