Skip to main content
POST
/
api
/
management
/
project-funnel
Criar ou atualizar um funil de projeto
curl --request POST \
  --url https://api.olie.ai/api/management/project-funnel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": null,
  "name": "Nome do funil",
  "prefix": "PREFIX",
  "steps": [
    {
      "name": "Backlog",
      "step_forward": null,
      "step_backward": null,
      "show_contact_form": false,
      "hide_contact_form_when_linked": false,
      "show_customer_form": false,
      "hide_customer_form_when_linked": false,
      "sensation_amount": 50,
      "checklists": [
        {
          "name": "Checklist 1",
          "info": "Texto informativo da checklist",
          "required": true,
          "order": 0
        },
        {
          "name": "Checklist 2",
          "info": "",
          "required": true,
          "order": 1
        },
        {
          "name": "Checklist 3",
          "info": "",
          "required": false,
          "order": 2
        }
      ],
      "attachments": [
        {
          "id": 1
        },
        {
          "id": 2
        }
      ],
      "restrictions": [],
      "sort_config": null,
      "allow_execution": true,
      "form": {
        "id": 7,
        "title": "Formulário para funil"
      },
      "help_text": "Texto de ajuda da etapa"
    },
    {
      "name": "Em andamento",
      "step_forward": null,
      "step_backward": null,
      "show_contact_form": true,
      "hide_contact_form_when_linked": false,
      "show_customer_form": true,
      "hide_customer_form_when_linked": false,
      "sensation_amount": 0,
      "checklists": [],
      "attachments": [],
      "restrictions": [],
      "sort_config": null,
      "allow_execution": true
    },
    {
      "name": "Concluído",
      "step_forward": null,
      "step_backward": null,
      "show_contact_form": false,
      "hide_contact_form_when_linked": false,
      "show_customer_form": false,
      "hide_customer_form_when_linked": false,
      "sensation_amount": 0,
      "checklists": [],
      "attachments": [],
      "restrictions": [],
      "sort_config": null,
      "allow_execution": true
    }
  ],
  "tags": [
    {
      "name": "Nova etiqueta 1",
      "color": "#5e4ff8",
      "funnel_step_blockings": []
    },
    {
      "name": "Nova etiqueta 2",
      "color": "#7fd87d",
      "funnel_step_blockings": []
    },
    {
      "name": "Nova etiqueta 3",
      "color": "#5e4ff8",
      "funnel_step_blockings": []
    }
  ],
  "project_term": {
    "key": "called",
    "en": {
      "project_term": {
        "singular": "called",
        "plural": "calls"
      }
    },
    "pt_br": {
      "project_term": {
        "singular": "chamado",
        "plural": "chamados"
      }
    }
  },
  "dynamic_form": null,
  "business_area": {
    "id": 19,
    "name": "Área de negócio",
    "frame_id": "019c75de-532c-7047-9563-daf1448ca963"
  },
  "allow_multi_step": true,
  "show_cost_info": true,
  "form": {
    "id": 7,
    "title": "Formulário para funil"
  },
  "attachments": [
    {
      "id": 3
    }
  ],
  "access": [
    {
      "id": "019c75de-509e-711a-8933-175cb2514cc5",
      "name": "Test User",
      "avatar_url": "https://via.placeholder.com/124x124.png/00aa99?text=quas",
      "index_all": false,
      "index_assigned": true,
      "index_created": false
    },
    {
      "id": "019c75de-50f0-7366-a948-b8cbdd1841be",
      "name": "Cotestr User",
      "avatar_url": null,
      "index_all": true,
      "index_assigned": false,
      "index_created": false
    }
  ],
  "funnel_status": [
    {
      "name": "Novo status 1",
      "color": "#b59ef6",
      "is_conclusive": false,
      "funnel_step_blockings": []
    },
    {
      "name": "Novo status 2",
      "color": "#7fd87d",
      "is_conclusive": false,
      "funnel_step_blockings": []
    },
    {
      "name": "Novo status 3",
      "color": "#b59ef6",
      "is_conclusive": false,
      "funnel_step_blockings": []
    }
  ],
  "condition": "active",
  "allow_execution": true,
  "template_projects": [
    {
      "id": "019c75de-7fcf-70af-b840-1340626e2764"
    }
  ]
}
'
{
  "response": true,
  "project_funnel": {
    "order": 11,
    "name": "Nome do funil",
    "condition": "active",
    "allow_multi_step": true,
    "show_cost_info": true,
    "frame_id": "019c75de-532c-7047-9563-daf1448ca963",
    "allow_execution": true,
    "prefix": "PREFIX2",
    "form_id": 7,
    "updated_at": "2026-03-16T16:34:43.000000Z",
    "created_at": "2026-03-16T16:34:43.000000Z",
    "id": 54,
    "business_area_id": 19,
    "business_area": {
      "id": 19,
      "name": "Área de negócio",
      "order": 0,
      "frame_id": "019c75de-532c-7047-9563-daf1448ca963",
      "deleted_at": null
    },
    "steps": [
      {
        "id": 240,
        "name": "Backlog",
        "project_funnel_id": 54,
        "sensation_amount": 50,
        "step_forward_id": null,
        "step_backward_id": null,
        "show_contact_form": false,
        "hide_contact_form_when_linked": false,
        "show_customer_form": false,
        "hide_customer_form_when_linked": false,
        "order": 1,
        "help_text": "Texto de ajuda da etapa",
        "form_id": 7,
        "sort_config": null,
        "allow_execution": true,
        "created_at": "2026-03-16T16:34:43.000000Z",
        "updated_at": "2026-03-16T16:34:43.000000Z",
        "deleted_at": null,
        "checklists": [
          {
            "id": 4,
            "name": "Checklist 1",
            "info": "Texto informativo da checklist",
            "funnel_step_id": 240,
            "required": true,
            "order": 0
          },
          {
            "id": 5,
            "name": "Checklist 2",
            "info": null,
            "funnel_step_id": 240,
            "required": true,
            "order": 1
          },
          {
            "id": 6,
            "name": "Checklist 3",
            "info": null,
            "funnel_step_id": 240,
            "required": false,
            "order": 2
          }
        ],
        "attachments": [
          {
            "id": 1,
            "name": "Captura de tela de 2026-02-12 09-34-45.png",
            "technical_name": "",
            "extension": "png",
            "file_url": "https://olie-main-dev.s3.amazonaws.com/app/frames/019c75de-532c-7047-9563-daf1448ca963/funnel_attachments/EUCnLFRPVhJkpyq6GKDcmXNgI2S1j9HWs0AZ-captura-de-tela-de-2026-02-12-09-34-45.png",
            "popup_video": 0,
            "watch": false,
            "user_id": "019c75de-509e-711a-8933-175cb2514cc5",
            "frame_id": "019c75de-532c-7047-9563-daf1448ca963",
            "created_at": "2026-03-16T13:23:06.000000Z",
            "updated_at": "2026-03-16T13:23:06.000000Z",
            "deleted_at": null,
            "pivot": {
              "funnel_step_id": 240,
              "step_attachment_id": 1
            }
          },
          {
            "id": 2,
            "name": "Link Vídeo",
            "technical_name": "link_technical_name",
            "extension": "link",
            "file_url": "https://youtu.be/JOopR4MKbhI?si=HNIGI1bcPNXUuTVy",
            "popup_video": 1,
            "watch": true,
            "user_id": "019c75de-509e-711a-8933-175cb2514cc5",
            "frame_id": "019c75de-532c-7047-9563-daf1448ca963",
            "created_at": "2026-03-16T13:24:05.000000Z",
            "updated_at": "2026-03-16T13:25:13.000000Z",
            "deleted_at": null,
            "pivot": {
              "funnel_step_id": 240,
              "step_attachment_id": 2
            }
          }
        ],
        "form": {
          "id": 7,
          "title": "Formulário para funil",
          "frame_id": "019c75de-532c-7047-9563-daf1448ca963",
          "created_at": "2026-03-16T13:12:12.000000Z",
          "updated_at": "2026-03-16T13:12:12.000000Z",
          "deleted_at": null
        },
        "restrictions": []
      },
      {
        "id": 241,
        "name": "Em andamento",
        "project_funnel_id": 54,
        "sensation_amount": 0,
        "step_forward_id": null,
        "step_backward_id": null,
        "show_contact_form": false,
        "hide_contact_form_when_linked": false,
        "show_customer_form": false,
        "hide_customer_form_when_linked": false,
        "order": 2,
        "help_text": null,
        "form_id": null,
        "sort_config": null,
        "allow_execution": true,
        "created_at": "2026-03-16T16:34:43.000000Z",
        "updated_at": "2026-03-16T16:34:43.000000Z",
        "deleted_at": null,
        "checklists": [],
        "attachments": [],
        "form": null,
        "restrictions": []
      },
      {
        "id": 242,
        "name": "Concluído",
        "project_funnel_id": 54,
        "sensation_amount": 0,
        "step_forward_id": null,
        "step_backward_id": null,
        "show_contact_form": false,
        "hide_contact_form_when_linked": false,
        "show_customer_form": false,
        "hide_customer_form_when_linked": false,
        "order": 3,
        "help_text": null,
        "form_id": null,
        "sort_config": null,
        "allow_execution": true,
        "created_at": "2026-03-16T16:34:43.000000Z",
        "updated_at": "2026-03-16T16:34:43.000000Z",
        "deleted_at": null,
        "checklists": [],
        "attachments": [],
        "form": null,
        "restrictions": []
      }
    ],
    "tags": [
      {
        "id": 6,
        "name": "Nova etiqueta 1",
        "color": "#5e4ff8",
        "project_funnel_id": 54,
        "deleted_at": null
      },
      {
        "id": 7,
        "name": "Nova etiqueta 2",
        "color": "#7fd87d",
        "project_funnel_id": 54,
        "deleted_at": null
      },
      {
        "id": 8,
        "name": "Nova etiqueta 3",
        "color": "#5e4ff8",
        "project_funnel_id": 54,
        "deleted_at": null
      }
    ],
    "attachments": [],
    "funnel_status": [
      {
        "id": 6,
        "name": "Novo status 1",
        "color": "#b59ef6",
        "project_funnel_id": 54,
        "is_conclusive": false,
        "created_at": "2026-03-16T16:34:43.000000Z",
        "updated_at": "2026-03-16T16:34:43.000000Z",
        "deleted_at": null
      },
      {
        "id": 7,
        "name": "Novo status 2",
        "color": "#7fd87d",
        "project_funnel_id": 54,
        "is_conclusive": false,
        "created_at": "2026-03-16T16:34:43.000000Z",
        "updated_at": "2026-03-16T16:34:43.000000Z",
        "deleted_at": null
      },
      {
        "id": 8,
        "name": "Novo status 3",
        "color": "#b59ef6",
        "project_funnel_id": 54,
        "is_conclusive": false,
        "created_at": "2026-03-16T16:34:43.000000Z",
        "updated_at": "2026-03-16T16:34:43.000000Z",
        "deleted_at": null
      }
    ]
  },
  "objects_above_limit": []
}

Documentation Index

Fetch the complete documentation index at: https://docs.olie.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

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

Body

application/json

Payload utilizado para criação ou atualização de um funil com etapas, etiquetas, status, acessos e templates.

name
string
required

Nome do funil. Campo obrigatório na criação.

Example:

"Nome do funil"

steps
object[]
required

Lista de etapas que do funil.

id
integer

ID do funil. Deve ser null na criação e preenchido em operações de atualização.

Example:

null

prefix
string

Prefixo utilizado para geração automática de códigos dos projetos criados dentro do funil.

Maximum string length: 20
Example:

"PREFIX"

tags
object[]

Lista de etiquetas disponíveis no funil.

dynamic_form
object

Formulário dinâmico associado ao funil.

business_area
object

Área de negócio vinculada ao funil.

allow_multi_step
boolean

Permite que um projeto esteja em múltiplas etapas simultaneamente.

Example:

true

project_term
object

Configuração dos termos de projeto por idioma.

show_cost_info
boolean

Define se informações de custo devem ser exibidas no funil.

Example:

true

form
object

Formulário principal associado ao funil.

attachments
object[]

Lista de anexos vinculados ao funil.

access
object[]

Lista de usuários com acesso ao funil.

funnel_status
object[]

Lista de status possíveis dentro do funil.

condition
string

Condição do funil. Exemplo: active, inactive.

Example:

"active"

allow_execution
boolean

Define se o funil permite execução de projetos.

Example:

true

template_projects
object[]

Lista de projetos modelo vinculados ao funil.

Response

Funil criado com sucesso

response
boolean
project_funnel
object
objects_above_limit
any[]