Public API
Build integrations on the Chatfuel GraphQL API: tokens and virtual users, requests and errors, and a reference for every operation.
Last updated on
Build integrations on the Chatfuel GraphQL API: tokens and virtual users, requests and errors, and a reference for every operation.
Articles in this section
API operation index
Every query, mutation and subscription of the Chatfuel Public API, with the role it needs and a link to its reference.
Docs API for AI agents
One link your AI assistant or coding agent can use to search the help center and the Public API reference. No sign-in.
Chatfuel Public API Overview
The Chatfuel Public API is a GraphQL API for managing bots, contacts, messages and flows from your server, authenticated with virtual user tokens.
Chatfuel Public API Quickstart
Create a personal API token, find your bot ID, create a virtual user and make your first Chatfuel Public API query and mutation in about ten minutes.
Public API Authentication and Tokens
Send a personal API token (CLI token) or a virtual user token as a Bearer token. Use virtual users for daily calls and the personal token for account tasks.
Virtual Users in the Chatfuel Public API
A virtual user is an API-only Editor or Agent in one bot with its own token. Create, rotate, re-role and remove virtual users with your personal API token.
Making Public API Requests
Send GraphQL POST requests to panel.chatfuel.com/graphql, paginate with cursors, subscribe over WebSocket, upload files and stay within the rate limits.
Public API Errors and Error Codes
Public API errors arrive in the GraphQL errors array. Read extensions.code for the reason, such as Unauthorized or NotEnoughPermissions, and keep traceId.
Public API Versioning and Deprecation
The Public API has one unversioned endpoint. Published fields never break: changes are additive, and removals are deprecated with a date first.
Bots and Account API Reference
Read a bot and the current account with bot(id:) and currentUser. Renaming, deleting and creating bots and workspaces needs the personal API token.
Team and Roles API Reference
List bot members and invites, and create, rotate, re-role or remove virtual users. Changing the team always needs a bot Admin's personal API token.
Contacts API Reference
Search, read and update Chatfuel contacts: attributes, names, notes, assignees and sales stages, segments, CSV import and export, and contact events.
Messaging API Reference
Read conversations and send text, attachments and WhatsApp templates on WhatsApp, Instagram, Facebook, TikTok and the website widget through the Public API.
Flows API Reference
Read and build Chatfuel flows through the Public API: flows and groups, blocks and connections, message and action components, keyword rules and test chats.
Fuely AI and Automations API Reference
Configure Fuely AI through the Public API: Automations and their settings, company knowledge, booking rules and WhatsApp broadcasts.
Bookings and Catalog API Reference
Manage bookings, specialists, products and services through the Public API: read the calendar, create and update appointments, and sync Google Calendar.
Channels API Reference
Read a bot's connected channels and manage WhatsApp, Instagram, Facebook, TikTok and website widget settings. Connecting channels needs the personal token.
Files and Tasks API Reference
Upload files and read file URLs, and follow long-running jobs such as contact exports and Google Calendar syncs with getTask and taskUpdated.