canonical: https://jentic.com/apis/falaiatendimento.com/falai

# Falaiatendimento FALAI Funnels API

The FALAI Funnels API manages sales pipelines inside the FALAI customer-engagement platform, organising funnels, their stages, and the items that move through them. It creates and duplicates funnels, builds and reorders stages, adds items and moves them between stages, and acts on items in bulk including transfers and messaging. Funnel membership is managed per funnel so the right team sees each pipeline. Calls authenticate with an API key sent in the api_access_token header.

## For AI agents

Build sales funnels, manage their stages, and move deal items through the pipeline inside the FALAI platform, with bulk transfer, messaging, and per-funnel membership. Authenticated with an API key in the api_access_token header.

## Scope

Does not handle live chat inboxes, conversation history, or billing. Use for sales funnel, stage, and item management only.

## Capabilities

- Create, duplicate, and update sales funnels for an account
- Build funnel stages and reorder them within a funnel
- Add funnel items and move them between stages as deals progress
- Filter funnel items to find the ones that match given criteria
- Act on items in bulk: create, transfer, delete, and send messages to many at once
- Manage funnel membership so the right team can see each pipeline

## Use cases

### Agent-Driven Pipeline Progression

An AI agent connected through Jentic can advance deals through a sales funnel without a developer wiring FALAI's nested account and funnel paths. The agent lists items in a stage, decides which qualify, and moves each one to the next stage, keeping the pipeline current. Jentic injects the API key at call time so the credential never reaches the agent.

Example prompt: List the items in a funnel stage, then move the qualified items to the next stage and confirm each move

### Bulk Lead Import and Routing

Teams loading leads from a campaign can create many funnel items at once and route them to the right funnel. The agent bulk-creates items in a stage and can transfer a batch to another funnel when ownership changes. This replaces one-by-one data entry for large lead lists.

Example prompt: Bulk-create a batch of items in the first stage of a funnel, then transfer part of the batch to another funnel

### Pipeline Membership Management

As teams change, the people who can see a funnel need updating. The agent reads the current members of a funnel, adds new ones, and removes those who no longer need access. This keeps each pipeline visible only to its owning team.

Example prompt: Fetch the members of a funnel, add a new member, and remove one who has left the team

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/accounts/{account_id}/funnels` | Create a new funnel |
| GET | `/accounts/{account_id}/funnels` | List all funnels |
| POST | `/accounts/{account_id}/funnels/{funnel_id}/funnel_steps` | Create a funnel step |
| POST | `/accounts/{account_id}/funnels/{funnel_id}/funnel_steps/{funnel_step_id}/funnel_items` | Create a funnel item |
| PUT | `/accounts/{account_id}/funnels/{funnel_id}/funnel_steps/{funnel_step_id}/funnel_items/{funnel_item_id}/update_step` | Move an item to another stage |
| POST | `/accounts/{account_id}/funnels/{funnel_id}/funnel_items/bulk_transfer` | Transfer multiple items |
| POST | `/accounts/{account_id}/funnel_members/{funnel_id}` | Add funnel members |

## Key resources

- **Funnels** — List, create, update, delete, and duplicate sales funnels
- **Funnel Steps** — Create, update, delete, and reorder the stages within a funnel
- **Funnel Items** — Create, move, filter, and bulk create, transfer, delete, and message items
- **Funnel Members** — Read, add, update, and remove the members of a funnel

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 63 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 79 / 100
  - Developer Experience & Jentic Compatibility: 62 / 100
  - AI-Readiness & Agent Experience: 51 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 61 / 100
- **View full report:** https://jentic.com/apis/falaiatendimento.com/falai/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring FALAI by hand means sending your API key in the api_access_token header on every call and threading the account, funnel, step, and item ids through nested URL paths yourself. Through Jentic you install once, import FALAI from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** FALAI puts the account and funnel ids in the URL path, for example `/accounts/{account_id}/funnels/{funnel_id}`, so a rule can pin your agent to one funnel: it can list and move items within that funnel and nothing else. You choose which operations it may call, so destructive ones like deleting a funnel or bulk-deleting items are not included unless you add them.
- **Credential handling:** Your FALAI API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'move a deal to the next stage' or 'bulk import leads', and Jentic returns the matching FALAI operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Pipedrive** — Sales CRM built around visual deal pipelines and stages
- **Close** — Sales CRM with pipelines plus built-in calling and email
- **Agendor** — Brazilian sales CRM with deal funnels and activity tracking
- **Gupshup** — Conversational messaging across WhatsApp and other channels

## FAQ

### What authentication does the FALAI Funnels API use?

Per its OpenAPI spec, the FALAI Funnels API uses an API key sent in the api_access_token header. Through Jentic the key is stored encrypted by your own instance and injected at call time, so it never reaches the agent.

### Is there a FALAI MCP server?

You don't need an MCP server to give your agent FALAI. Jentic connects it directly from the API Directory: import it, store your credential once, and your agent calls operations like creating a funnel or moving an item between stages on demand, without loading another server's tool definitions into its context.

### Can I limit what my agent is allowed to do with FALAI?

Yes. Write a rule that allows only the item list, create, and move operations under one funnel id, so the agent can advance deals through stages but cannot delete the funnel or bulk-delete items unless you add those operations, and every call it makes is logged. This matches a pipeline bot that should keep deals current without destructive power.

### Can I move deals between stages with the FALAI Funnels API?

Yes. List the items in a stage, then call the move operation to send an item to another stage of the same funnel. You can also transfer items in bulk between funnels when ownership changes.

### What are the rate limits for the FALAI Funnels API?

The OpenAPI spec does not specify rate limits. Check the FALAI documentation on SwaggerHub at https://app.swaggerhub.com/apis/falaiatendimento/Falai-Funil-api for current limits before running bulk item jobs.

### How do I advance a deal through a funnel with the FALAI Funnels API through Jentic?

Search Jentic for 'move a deal to the next stage', which returns the item list and move operations with their input schemas. The agent lists a stage's items, moves the qualified ones forward, and confirms each move, with your stored key injected at call time. To run it on your own infrastructure, install Jentic One from its GitHub repo.