Welcome to the Flunter MCP
Connect Flunter once, then ask Claude about your contacts, campaigns, calls and tasks in plain language. Setup takes about a minute and needs no code.
Before you start, create an API key in Flunter under Settings → API. You paste it once, when your AI assistant asks you to sign in.
Setting up Claude by hand instead?
Claude (web, desktop and mobile)
- In Claude, go to Customize → Connectors, choose + Add, then Add custom connector.
-
Name the connector
Flunterand enter the server URLhttps://api.flunter.com/v1/mcp. Leave the OAuth client ID and secret empty: Claude registers itself with the Flunter server automatically. - When Claude asks you to sign in, it opens the Flunter authorization page: paste your API key and click Connect.
- In a chat, open the + menu at the lower left, choose Connectors, and switch on Flunter.
On Team and Enterprise plans, an Owner first adds the connector under Organization settings → Connectors; each member then connects it with their own API key.
Claude Code
Add the Flunter server as a remote HTTP server:
claude mcp add --transport http flunter https://api.flunter.com/v1/mcp
Then start Claude Code, run /mcp, select flunter and authenticate.
Your browser opens the Flunter authorization page: paste your API key and click Connect.
Claude Code stores the resulting access token and refreshes it on its own.
To share the server with everyone working in a repository, add it to .mcp.json at the project root.
Each person signs in through /mcp with their own API key, so no key goes in the file.
{
"mcpServers": {
"flunter": {
"type": "http",
"url": "https://api.flunter.com/v1/mcp"
}
}
}
Codex
Add the Flunter server to Codex, then sign in: your browser opens the Flunter authorization page, paste your API key and click Connect.
codex mcp add flunter --url https://api.flunter.com/v1/mcp
codex mcp login flunter
Or declare it in ~/.codex/config.toml:
[mcp_servers.flunter]
url = "https://api.flunter.com/v1/mcp"
Other MCP clients
The server works with any client supporting the Streamable HTTP transport. A client that supports MCP authorization only needs the server URL: it discovers the OAuth endpoints by itself and opens the Flunter sign-in page, where you paste your API key.
Server details
| Server URL | https://api.flunter.com/v1/mcp |
|---|---|
| Transport | Streamable HTTP |
| Authentication | OAuth 2.0 authorization code flow with PKCE (S256), or an x-api-key header |
| Authorization URL | https://api.flunter.com/v1/mcp/oauth/authorize |
| Token URL | https://api.flunter.com/v1/mcp/oauth/token |
| Client registration URL | https://api.flunter.com/v1/mcp/oauth/register (dynamic client registration, no client secret needed) |
| Discovery |
|
| Redirect URIs | Must use https, or http on localhost or 127.0.0.1 |
| Token lifetimes | Access token 30 days, refresh token 90 days. Each refresh returns a new pair. |
Configuration example
Most clients take a configuration like this one; check your client's documentation for the exact format.
{
"mcpServers": {
"flunter": {
"type": "http",
"url": "https://api.flunter.com/v1/mcp"
}
}
}
Header authentication
A client that cannot open a browser, such as a script or a hosted agent, can send the API key itself in an
x-api-key header on every request. Read it from an environment variable where the client supports
one, and keep the file out of version control.
{
"mcpServers": {
"flunter": {
"type": "http",
"url": "https://api.flunter.com/v1/mcp",
"headers": {
"x-api-key": "${FLUNTER_API_KEY}"
}
}
}
}
What is MCP?
Model Context Protocol (MCP) is an open standard that lets AI applications connect to external tools and data sources. Instead of copying data between Flunter and your AI assistant, MCP lets the assistant read and change your Flunter data itself.
What can you do with Flunter MCP?
Example prompts
Once connected, try prompts like these. Copy one and change the names to fit.
Find Jean Dupont and show me his call history and his open tasks.
Which of my calls last week were answered, and what outcomes did they get?
Create a follow-up task for next Monday at 10am on every contact I called today without reaching them.
Import my HubSpot list 12345 into a new campaign called Q2 Outbound.
Tools
Organization 3
Fetch the organization and its users read-only Fetch organization preferences read-only Update organization preferences writeContacts 5
Fetch a contact read-only Create a contact write Update a contact write Delete a contact destructive Search contacts read-onlyCampaigns 7
List campaigns read-only Fetch a campaign with all contacts read-only Create a campaign from a CRM list ID or from the contacts you provide write Update a campaign write Delete a campaign destructive Add a contact to a campaign write Remove a contact from a campaign destructiveOrganization
Fetch the organization and its users
get_organization read-only
Returns the organization's name and its users, with their UUIDs: use them as the owner of a campaign (create_campaign, update_campaign) or to filter campaigns and calls by user (list_campaigns, list_calls).
Admins and managers only.
No parameters.
Response
| Field | Type | Description |
|---|---|---|
uuid |
string | Organization UUID |
name |
string | Organization name |
users |
object[] | Users of the organization |
uuid |
string | User UUID |
email |
string | User email address |
name |
string | User full name |
Fetch organization preferences
get_organization_preferences read-only
Returns the organization's preferences: phone numbers visibility, call recording and transcription, goals edition, forced call outcome, contact fields configuration and call outcomes (use them to translate outcome IDs used by list_calls).
Admins and managers only.
No parameters.
Response
| Field | Type | Description |
|---|---|---|
hidePhoneNumbers |
boolean | Phone numbers of the contacts are masked for the users who are neither admin nor manager |
canUsersEditGoals |
boolean | The users can edit their own goals |
forceCallOutcome |
boolean | The users must set a call outcome after each call |
enableRecordings |
boolean | The call recordings are enabled |
enableTranscriptions |
boolean | The call transcripts are enabled |
contactFields |
object | Contact fields of the organization, keyed by field key |
{key} |
object | One entry per key |
label |
string | Translation key of the field label |
enabled |
boolean | The field is enabled for the organization |
visible |
boolean | The field is shown on the contact |
required |
boolean | The field is required when a contact is created |
custom |
boolean | The field is a custom one of the organization |
outcomes |
object | Call outcomes of the organization, keyed by outcome value |
{key} |
object | One entry per key |
label |
string | Translation key of the outcome label |
value |
integer | Call outcome ID, the callOutcome of the calls |
enabled |
boolean | The outcome is enabled for the organization |
editable |
boolean | The label of the outcome can be customized |
custom |
boolean | The outcome is a custom one of the organization |
contactStatuses |
object | Contact statuses of the organization, keyed by status key |
{key} |
object | One entry per key |
label |
string | Translation key of the status label, or the custom label |
enabled |
boolean | The status is enabled for the organization |
custom |
boolean | The status is a custom one of the organization |
Update organization preferences
update_organization_preferences write
Updates the organization's preferences.
Only the provided fields are updated.
contactFields and outcomes replace the whole configuration: fetch them with get_organization_preferences and send them back entirely with your changes: no field or outcome can be removed, default ones keep their label, required, custom and editable flags (only enabled/visible change), firstName/lastName/phone stay enabled, firstName/lastName stay visible, outcomes with editable false can not be enabled or disabled, and new contact fields must be custom ones.
Admins and managers only.
Writes data: only call it when the user explicitly asked to change the organization preferences.
| Parameter | Type | Required | Description |
|---|---|---|---|
hidePhoneNumbers |
boolean | optional | true to mask the phone numbers of the contacts for the users who are neither admin nor manager |
canUsersEditGoals |
boolean | optional | true when the users can edit their own goals |
forceCallOutcome |
boolean | optional | true when the users must set a call outcome after each call |
enableRecordings |
boolean | optional | false to stop recording the calls of the organization |
enableTranscriptions |
boolean | optional | false to stop transcribing and summarizing the calls of the organization |
contactFields |
object | optional | Whole contact fields configuration, keyed by field key |
{key} |
object | optional | One entry per key |
label |
string | optional | Translation key of the field label, or the custom label, e.g. contactField.firstName |
enabled |
boolean | optional | The field is enabled for the organization |
visible |
boolean | optional | The field is shown on the contact |
required |
boolean | optional | The field is required when a contact is created |
custom |
boolean | optional | The field is a custom one of the organization |
outcomes |
object | optional | Whole call outcomes configuration, keyed by outcome ID |
{key} |
object | optional | One entry per key |
label |
string | optional | Translation key of the outcome label, or the custom label, e.g. outcome.not_interested |
value |
integer | optional | Call outcome ID, the callOutcome of the calls |
enabled |
boolean | optional | The outcome is enabled for the organization |
editable |
boolean | optional | The label of the outcome can be customized |
custom |
boolean | optional | The outcome is a custom one of the organization |
Response
| Field | Type | Description |
|---|---|---|
hidePhoneNumbers |
boolean | Phone numbers of the contacts are masked for the users who are neither admin nor manager |
canUsersEditGoals |
boolean | The users can edit their own goals |
forceCallOutcome |
boolean | The users must set a call outcome after each call |
enableRecordings |
boolean | The call recordings are enabled |
enableTranscriptions |
boolean | The call transcripts are enabled |
contactFields |
object | Contact fields of the organization, keyed by field key |
{key} |
object | One entry per key |
label |
string | Translation key of the field label |
enabled |
boolean | The field is enabled for the organization |
visible |
boolean | The field is shown on the contact |
required |
boolean | The field is required when a contact is created |
custom |
boolean | The field is a custom one of the organization |
outcomes |
object | Call outcomes of the organization, keyed by outcome value |
{key} |
object | One entry per key |
label |
string | Translation key of the outcome label |
value |
integer | Call outcome ID, the callOutcome of the calls |
enabled |
boolean | The outcome is enabled for the organization |
editable |
boolean | The label of the outcome can be customized |
custom |
boolean | The outcome is a custom one of the organization |
contactStatuses |
object | Contact statuses of the organization, keyed by status key |
{key} |
object | One entry per key |
label |
string | Translation key of the status label, or the custom label |
enabled |
boolean | The status is enabled for the organization |
custom |
boolean | The status is a custom one of the organization |
Contacts
Fetch a contact
get_contact read-only
Returns one contact by UUID, with all its fields, its notes and its tasks.Contact UUIDs come from get_campaign, search_contacts or list_calls.
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid |
string | required | Contact UUID |
Response
| Field | Type | Description |
|---|---|---|
uuid |
string | Contact UUID |
name |
string | Full name, first name and last name |
firstName |
string | First name |
lastName |
string | Last name |
email |
string | Email address |
jobTitle |
string | Job title |
phone |
string | Phone number (E.164) |
phone2 |
string | Second phone number (E.164) |
phone3 |
string | Third phone number (E.164) |
company |
string | Company name |
cityName |
string | City of the contact |
countryCode |
string | Country code (ISO 3166-1 alpha-2) |
timezone |
string | Timezone (IANA name) |
companyCity |
string | City of the company |
companyWebsite |
string | Website of the company |
companyIndustry |
string | Industry of the company |
companyUrl |
string | URL of the company in the CRM |
linkedinUrl |
string | LinkedIn profile URL |
crmUrl |
string | URL of the contact in the CRM |
crmSource |
string | CRM the contact comes from: hubspot, salesforce, pipedrive, close, boond or odoo |
doNotCall |
boolean | The contact must not be called |
anonymous |
boolean | Contact created from a caller with a anonymous number |
origin |
string | How the contact was created |
customFields |
object | Custom field values, keyed by field key |
notes |
object[] | All the notes of the contact, most recent first |
uuid |
string | Note UUID |
content |
string | Note content |
createdAt |
string | Note creation date (ISO 8601 date-time, UTC) |
tasks |
object[] | All the tasks of the contact, most recent first |
uuid |
string | Task UUID |
status |
integer | Task status. Values: - 1: To do - 2: Overdue - 3: Completed |
scheduledAt |
string | Task due date (ISO 8601 date-time, UTC) |
title |
string | Task title |
description |
string | Task details |
processed |
boolean | The task is completed |
Create a contact
create_contact write
Creates a contact.
Writes data: only call it when the user explicitly asked to create a contact.
Which fields are required depends on the organization (see the contactFields of get_organization_preferences).
A contact of the organization with the same phone number is updated instead of duplicated.
Returns the contact, with its notes and tasks.
| Parameter | Type | Required | Description |
|---|---|---|---|
phone |
string | required | Phone number (E.164), e.g. +33612345678 |
phone2 |
string | optional | Second phone number (E.164), e.g. +33612345679 |
phone3 |
string | optional | Third phone number (E.164), e.g. +33612345670 |
firstName |
string | optional | First name, e.g. George |
lastName |
string | optional | Last name, e.g. Dupont |
name |
string | optional | Full name, used when first/last name are not split |
email |
string | optional | Email address, e.g. george.dupont@example.com |
jobTitle |
string | optional | Job title, e.g. Sales Manager |
company |
string | optional | Company name, e.g. ACME Corp |
cityName |
string | optional | City of the contact, e.g. Paris |
countryCode |
string | optional | Country code (ISO 3166-1 alpha-2), e.g. FR |
timezone |
string | optional | Timezone (IANA name), e.g. Europe/Paris |
companyCity |
string | optional | City of the company, e.g. Paris |
companyWebsite |
string | optional | Website of the company, e.g. https://www.acme.com |
companyIndustry |
string | optional | Industry of the company, e.g. Software |
companyUrl |
string | optional | URL of the company in the CRM, e.g. https://app.acme.com/company/acme |
linkedinUrl |
string | optional | LinkedIn profile URL, e.g. https://linkedin.com/in/georgedupont |
crmUrl |
string | optional | URL of the contact in the CRM, e.g. https://crm.example.com/contact/123 |
customFields |
object | optional | Custom field values, keyed by field key, e.g. {"custom1": "value1"} |
Response
| Field | Type | Description |
|---|---|---|
uuid |
string | Contact UUID |
name |
string | Full name, first name and last name |
firstName |
string | First name |
lastName |
string | Last name |
email |
string | Email address |
jobTitle |
string | Job title |
phone |
string | Phone number (E.164) |
phone2 |
string | Second phone number (E.164) |
phone3 |
string | Third phone number (E.164) |
company |
string | Company name |
cityName |
string | City of the contact |
countryCode |
string | Country code (ISO 3166-1 alpha-2) |
timezone |
string | Timezone (IANA name) |
companyCity |
string | City of the company |
companyWebsite |
string | Website of the company |
companyIndustry |
string | Industry of the company |
companyUrl |
string | URL of the company in the CRM |
linkedinUrl |
string | LinkedIn profile URL |
crmUrl |
string | URL of the contact in the CRM |
crmSource |
string | CRM the contact comes from: hubspot, salesforce, pipedrive, close, boond or odoo |
doNotCall |
boolean | The contact must not be called |
anonymous |
boolean | Contact created from a caller with a anonymous number |
origin |
string | How the contact was created |
customFields |
object | Custom field values, keyed by field key |
notes |
object[] | All the notes of the contact, most recent first |
uuid |
string | Note UUID |
content |
string | Note content |
createdAt |
string | Note creation date (ISO 8601 date-time, UTC) |
tasks |
object[] | All the tasks of the contact, most recent first |
uuid |
string | Task UUID |
status |
integer | Task status. Values: - 1: To do - 2: Overdue - 3: Completed |
scheduledAt |
string | Task due date (ISO 8601 date-time, UTC) |
title |
string | Task title |
description |
string | Task details |
processed |
boolean | The task is completed |
Update a contact
update_contact write
Updates a contact by UUID.
Only the provided fields are updated, but customFields replaces all the custom field values of the contact: fetch them with get_contact and send them back with your changes.
Writes data: only call it when the user explicitly asked to modify a contact.
Returns the updated contact, with its notes and tasks.
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid |
string | required | Contact UUID |
firstName |
string | optional | First name, e.g. George |
lastName |
string | optional | Last name, e.g. Dupont |
phone |
string | optional | Phone number (E.164), e.g. +33612345678 |
phone2 |
string | optional | Second phone number (E.164), e.g. +33612345679 |
phone3 |
string | optional | Third phone number (E.164), e.g. +33612345670 |
email |
string | optional | Email address, e.g. george.dupont@example.com |
jobTitle |
string | optional | Job title, e.g. Sales Manager |
company |
string | optional | Company name, e.g. ACME Corp |
cityName |
string | optional | City of the contact, e.g. Paris |
countryCode |
string | optional | Country code (ISO 3166-1 alpha-2), e.g. FR |
timezone |
string | optional | Timezone (IANA name), e.g. Europe/Paris |
companyCity |
string | optional | City of the company, e.g. Paris |
companyWebsite |
string | optional | Website of the company, e.g. https://www.acme.com |
companyIndustry |
string | optional | Industry of the company, e.g. Software |
companyUrl |
string | optional | URL of the company in the CRM, e.g. https://app.acme.com/company/acme |
linkedinUrl |
string | optional | LinkedIn profile URL, e.g. https://linkedin.com/in/georgedupont |
doNotCall |
boolean | optional | true when the contact must not be called |
customFields |
object | optional | All the custom field values of the contact, keyed by field key (see the contactFields of get_organization_preferences), e.g. {"custom1": "value1"} |
Response
| Field | Type | Description |
|---|---|---|
uuid |
string | Contact UUID |
name |
string | Full name, first name and last name |
firstName |
string | First name |
lastName |
string | Last name |
email |
string | Email address |
jobTitle |
string | Job title |
phone |
string | Phone number (E.164) |
phone2 |
string | Second phone number (E.164) |
phone3 |
string | Third phone number (E.164) |
company |
string | Company name |
cityName |
string | City of the contact |
countryCode |
string | Country code (ISO 3166-1 alpha-2) |
timezone |
string | Timezone (IANA name) |
companyCity |
string | City of the company |
companyWebsite |
string | Website of the company |
companyIndustry |
string | Industry of the company |
companyUrl |
string | URL of the company in the CRM |
linkedinUrl |
string | LinkedIn profile URL |
crmUrl |
string | URL of the contact in the CRM |
crmSource |
string | CRM the contact comes from: hubspot, salesforce, pipedrive, close, boond or odoo |
doNotCall |
boolean | The contact must not be called |
anonymous |
boolean | Contact created from a caller with a anonymous number |
origin |
string | How the contact was created |
customFields |
object | Custom field values, keyed by field key |
notes |
object[] | All the notes of the contact, most recent first |
uuid |
string | Note UUID |
content |
string | Note content |
createdAt |
string | Note creation date (ISO 8601 date-time, UTC) |
tasks |
object[] | All the tasks of the contact, most recent first |
uuid |
string | Task UUID |
status |
integer | Task status. Values: - 1: To do - 2: Overdue - 3: Completed |
scheduledAt |
string | Task due date (ISO 8601 date-time, UTC) |
title |
string | Task title |
description |
string | Task details |
processed |
boolean | The task is completed |
Delete a contact
delete_contact destructive
Deletes a contact by UUID.
Writes data: only call it when the user explicitly asked to delete a contact.
To only take a contact out of a campaign, use remove_contact_from_campaign instead.
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid |
string | required | Contact UUID |
Search contacts
search_contacts read-only
Finds contacts by name, phone number, company or email, most relevant first, paginated.
Set campaignUuid to only search inside one campaign.
| Parameter | Type | Required | Description |
|---|---|---|---|
query |
string | required | Name, phone number, company or email fragment |
campaignUuid |
string | optional | Only search inside this campaign |
page |
integer | optional | Page number (default 1) |
limit |
integer | optional | Page size (default 25, max 200) |
Response
| Field | Type | Description |
|---|---|---|
results |
object[] | Paginated list of results |
uuid |
string | Contact UUID |
name |
string | Full name, first name and last name |
firstName |
string | First name |
lastName |
string | Last name |
email |
string | Email address |
jobTitle |
string | Job title |
phone |
string | Phone number (E.164) |
phone2 |
string | Second phone number (E.164) |
phone3 |
string | Third phone number (E.164) |
company |
string | Company name |
cityName |
string | City of the contact |
countryCode |
string | Country code (ISO 3166-1 alpha-2) |
timezone |
string | Timezone (IANA name) |
companyCity |
string | City of the company |
companyWebsite |
string | Website of the company |
companyIndustry |
string | Industry of the company |
companyUrl |
string | URL of the company in the CRM |
linkedinUrl |
string | LinkedIn profile URL |
crmUrl |
string | URL of the contact in the CRM |
crmSource |
string | CRM the contact comes from: hubspot, salesforce, pipedrive, close, boond or odoo |
doNotCall |
boolean | The contact must not be called |
anonymous |
boolean | Contact created from a caller with a anonymous number |
origin |
string | How the contact was created |
customFields |
object | Custom field values, keyed by field key |
totalItems |
integer | Total number of items available |
limitPerPage |
integer | Number of items per page |
totalPages |
integer | Total number of pages available |
currentPage |
integer | Current page number |
Campaigns
List campaigns
list_campaigns read-only
Lists campaigns visible to the API key owner, paginated.
The `search` text also matches the first/last name or phone number of the contacts inside campaigns.
| Parameter | Type | Required | Description |
|---|---|---|---|
search |
string | optional | Campaign name, or contact first/last name / phone number |
campaignUuids |
string[] | optional | Only these campaigns |
userUuids |
string[] | optional | Only campaigns owned by or assigned to these users (managers only, user UUIDs come from get_organization) |
createdFrom |
string | optional | Campaigns created from this date (YYYY-MM-DD), inclusive |
createdTo |
string | optional | Campaigns created until this date (YYYY-MM-DD), inclusive |
sortBy |
createdAt | updatedAt | optional | Sort field (default: API order) |
sortDirection |
ASC | DESC | optional | Sort direction, used with sortBy (default DESC) |
page |
integer | optional | Page number (default 1) |
limit |
integer | optional | Page size (default 50, max 200) |
Response
| Field | Type | Description |
|---|---|---|
results |
object[] | Paginated list of results |
uuid |
string | Campaign UUID |
name |
string | Campaign name |
source |
string | Campaign source: csv for an import, api for the external API, or the CRM the contacts come from (hubspot, salesforce, pipedrive, close, boond, odoo) |
createdAt |
string | Campaign creation date (ISO 8601 date-time, UTC) |
updatedAt |
string | Campaign last update date (ISO 8601 date-time, UTC) |
owner |
object | Owner or user reference |
uuid |
string | User UUID |
email |
string | User email address |
name |
string | User full name |
user |
object | Owner or user reference |
uuid |
string | User UUID |
email |
string | User email address |
name |
string | User full name |
totalItems |
integer | Total number of items available |
limitPerPage |
integer | Number of items per page |
totalPages |
integer | Total number of pages available |
currentPage |
integer | Current page number |
Fetch a campaign with all contacts
get_campaign read-only
Returns one campaign by UUID, including all its contacts.
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid |
string | required | Campaign UUID |
Response
| Field | Type | Description |
|---|---|---|
uuid |
string | Campaign UUID |
name |
string | Campaign name |
source |
string | Campaign source: csv for an import, api for the external API, or the CRM the contacts come from (hubspot, salesforce, pipedrive, close, boond, odoo) |
createdAt |
string | Campaign creation date (ISO 8601 date-time, UTC) |
updatedAt |
string | Campaign last update date (ISO 8601 date-time, UTC) |
owner |
object | Owner or user reference |
uuid |
string | User UUID |
email |
string | User email address |
name |
string | User full name |
user |
object | Owner or user reference |
uuid |
string | User UUID |
email |
string | User email address |
name |
string | User full name |
contacts |
object[] | Contacts of the campaign |
uuid |
string | Contact UUID |
name |
string | Full name, first name and last name |
firstName |
string | First name |
lastName |
string | Last name |
email |
string | Email address |
jobTitle |
string | Job title |
phone |
string | Phone number (E.164) |
phone2 |
string | Second phone number (E.164) |
phone3 |
string | Third phone number (E.164) |
company |
string | Company name |
cityName |
string | City of the contact |
countryCode |
string | Country code (ISO 3166-1 alpha-2) |
timezone |
string | Timezone (IANA name) |
companyCity |
string | City of the company |
companyWebsite |
string | Website of the company |
companyIndustry |
string | Industry of the company |
companyUrl |
string | URL of the company in the CRM |
linkedinUrl |
string | LinkedIn profile URL |
crmUrl |
string | URL of the contact in the CRM |
crmSource |
string | CRM the contact comes from: hubspot, salesforce, pipedrive, close, boond or odoo |
doNotCall |
boolean | The contact must not be called |
anonymous |
boolean | Contact created from a caller with a anonymous number |
origin |
string | How the contact was created |
customFields |
object | Custom field values, keyed by field key |
Create a campaign from a CRM list ID or from the contacts you provide
create_campaign write
Creates a campaign and imports the given contacts into it.
Writes data: only call it when the user explicitly asked to import contacts.
Contacts failing validation are reported in importSummary.errors while the valid ones are still imported.
| Parameter | Type | Required | Description |
|---|---|---|---|
name |
string | required | Campaign name |
source |
string | optional | Campaign source, when the contacts come from a CRM: hubspot, salesforce, pipedrive, close, boond or odoo |
listId |
string | optional | CRM list ID, when the contacts come from a CRM (see source) |
contacts |
object[] | optional | Contacts to import |
firstName |
string | optional | First name, e.g. George |
lastName |
string | optional | Last name, e.g. Dupont |
name |
string | optional | Full name, used when first/last name are not split |
phone |
string | optional | Phone number (E.164), e.g. +33612345678 |
phone2 |
string | optional | Second phone number (E.164), e.g. +33612345679 |
phone3 |
string | optional | Third phone number (E.164), e.g. +33612345670 |
email |
string | optional | Email address, e.g. george.dupont@example.com |
jobTitle |
string | optional | Job title, e.g. Sales Manager |
company |
string | optional | Company name, e.g. ACME Corp |
cityName |
string | optional | City of the contact, e.g. Paris |
countryCode |
string | optional | Country code (ISO 3166-1 alpha-2), e.g. FR |
timezone |
string | optional | Timezone (IANA name), e.g. Europe/Paris |
companyCity |
string | optional | City of the company, e.g. Paris |
companyWebsite |
string | optional | Website of the company, e.g. https://www.acme.com |
companyIndustry |
string | optional | Industry of the company, e.g. Software |
companyUrl |
string | optional | URL of the company in the CRM, e.g. https://app.acme.com/company/acme |
linkedinUrl |
string | optional | LinkedIn profile URL, e.g. https://linkedin.com/in/georgedupont |
doNotCall |
boolean | optional | true when the contact must not be called |
crmUrl |
string | optional | URL of the contact in the CRM, e.g. https://crm.example.com/contact/123 |
crmSource |
string | optional | CRM the contact comes from: hubspot, salesforce, pipedrive, close, boond or odoo |
customFields |
object | optional | Custom field values, keyed by field key, e.g. {"custom1": "value1"} |
ownerUuid |
string | optional | Assign the campaign to this user (managers only, user UUIDs come from get_organization) |
Response
| Field | Type | Description |
|---|---|---|
campaign |
object | Campaign reference |
uuid |
string | Campaign UUID |
name |
string | Campaign name |
importSummary |
object | Summary of the import of the submitted contacts |
createdCount |
integer | Number of contacts successfully created and associated to the campaign |
totalCount |
integer | Total number of contacts in the import list |
errors |
object[] | Array of per-contact import errors |
index |
integer | Zero-based position of the contact in the submitted contacts array |
contact |
object | The submitted contact, as received |
errors |
object[] | Validation errors of the contact |
field |
string | Field in error |
message |
string | Error message key |
params |
object | Error parameters, such as the invalid value |
Update a campaign
update_campaign write
Updates a campaign by UUID: its name and/or its owner.
Only the provided fields are updated.
Writes data: only call it when the user explicitly asked to rename or reassign a campaign.
Returns the campaign, without its contacts.
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid |
string | required | Campaign UUID |
name |
string | optional | New campaign name |
ownerUuid |
string | optional | Assign the campaign to this user (managers only, user UUIDs come from get_organization) |
Response
| Field | Type | Description |
|---|---|---|
uuid |
string | Campaign UUID |
name |
string | Campaign name |
source |
string | Campaign source: csv for an import, api for the external API, or the CRM the contacts come from (hubspot, salesforce, pipedrive, close, boond, odoo) |
createdAt |
string | Campaign creation date (ISO 8601 date-time, UTC) |
updatedAt |
string | Campaign last update date (ISO 8601 date-time, UTC) |
owner |
object | Owner or user reference |
uuid |
string | User UUID |
email |
string | User email address |
name |
string | User full name |
user |
object | Owner or user reference |
uuid |
string | User UUID |
email |
string | User email address |
name |
string | User full name |
Delete a campaign
delete_campaign destructive
Deletes a campaign by UUID: its contacts are kept, with their notes, tasks and calls.
Writes data: only call it when the user explicitly asked to delete a campaign.
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid |
string | required | Campaign UUID |
Add a contact to a campaign
add_contact_to_campaign write
Adds an existing contact to a campaign, both by UUID.
Writes data: only call it when the user explicitly asked to add a contact to a campaign.
A contact already in the campaign is left as is.
Fails when the phone number of the contact is invalid.
Create the contact first with create_contact when it does not exist yet.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaignUuid |
string | required | Campaign UUID |
contactUuid |
string | required | Contact UUID |
Remove a contact from a campaign
remove_contact_from_campaign destructive
Removes a contact from a campaign, both by UUID: the contact itself is kept, with its notes and tasks.
Writes data: only call it when the user explicitly asked to remove a contact from a campaign.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaignUuid |
string | required | Campaign UUID |
contactUuid |
string | required | Contact UUID |
Calls
List calls
list_calls read-only
Lists calls, paginated.
Set contactUuid to get the call history of one contact.
callStatus IDs: 0 Created, 1 Initiated, 2 Ringing, 3 Connected, 4 No Answer, 5 Busy, 6 Canceled, 7 Completed, 8 Failed.
Outcome IDs: see the outcomes of get_organization_preferences.
| Parameter | Type | Required | Description |
|---|---|---|---|
contactUuid |
string | optional | Only calls made to this contact |
campaignUuid |
string | optional | Only calls of this campaign |
userUuids |
string[] | optional | Only calls made by these users (user UUIDs come from get_organization) |
search |
string | optional | Campaign name, or contact first/last name / phone number |
callStatus |
integer[] | optional | Call status IDs, listed in the tool description |
callOutcome |
integer[] | optional | Call outcome IDs (see the outcomes of get_organization_preferences) |
isIncoming |
boolean | optional | true for incoming calls only, false for outgoing calls only |
dateFrom |
string | optional | Calls from this date (YYYY-MM-DD), inclusive |
dateTo |
string | optional | Calls until this date (YYYY-MM-DD), inclusive |
minDurationSeconds |
integer | optional | Minimum call duration in seconds |
maxDurationSeconds |
integer | optional | Maximum call duration in seconds |
sortDirection |
ASC | DESC | optional | Sort direction by call date (default DESC) |
page |
integer | optional | Page number (default 1) |
limit |
integer | optional | Page size (default 50, max 1000) |
Response
| Field | Type | Description |
|---|---|---|
results |
object[] | Paginated list of results |
uuid |
string | Call UUID |
from |
string | Caller phone number (E.164) |
to |
string | Recipient phone number (E.164) |
redirectTo |
string | Redirect to phone number (E.164) |
isIncoming |
boolean | true for an incoming call, false for an outgoing one |
callStatus |
integer | Call status ID (see Call Status enum) |
callOutcome |
integer | Call outcome ID (see Call Outcome enum and `get call outcomes endpoint`) |
callDuration |
integer | Call duration in seconds |
transcript |
string | Full transcript text when available |
transcriptResume |
string | Transcript summary when available |
recordingUrl |
string | Recording URL when available |
voiceMailMessageUrl |
string | Voicemail message URL when available |
createdAt |
string | Call date (ISO 8601 date-time, UTC) |
contact |
object | Contact reference |
uuid |
string | Contact UUID |
email |
string | Contact email address |
name |
string | Contact full name |
campaign |
object | Campaign associated with the call, or null if the call is not linked to a campaign. |
uuid |
string | Campaign UUID |
name |
string | Campaign name |
user |
object | Owner or user reference |
uuid |
string | User UUID |
email |
string | User email address |
name |
string | User full name |
totalItems |
integer | Total number of items available |
limitPerPage |
integer | Number of items per page |
totalPages |
integer | Total number of pages available |
currentPage |
integer | Current page number |
Fetch a call
get_call read-only
Returns one call by UUID.
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid |
string | required | Call UUID |
Response
| Field | Type | Description |
|---|---|---|
uuid |
string | Call UUID |
from |
string | Caller phone number (E.164) |
to |
string | Recipient phone number (E.164) |
redirectTo |
string | Redirect to phone number (E.164) |
isIncoming |
boolean | true for an incoming call, false for an outgoing one |
callStatus |
integer | Call status ID (see Call Status enum) |
callOutcome |
integer | Call outcome ID (see Call Outcome enum and `get call outcomes endpoint`) |
callDuration |
integer | Call duration in seconds |
transcript |
string | Full transcript text when available |
transcriptResume |
string | Transcript summary when available |
recordingUrl |
string | Recording URL when available |
voiceMailMessageUrl |
string | Voicemail message URL when available |
createdAt |
string | Call date (ISO 8601 date-time, UTC) |
contact |
object | Contact reference |
uuid |
string | Contact UUID |
email |
string | Contact email address |
name |
string | Contact full name |
campaign |
object | Campaign associated with the call, or null if the call is not linked to a campaign. |
uuid |
string | Campaign UUID |
name |
string | Campaign name |
user |
object | Owner or user reference |
uuid |
string | User UUID |
email |
string | User email address |
name |
string | User full name |
Change the outcome of a call
update_call_outcome write
Sets the outcome of a call by UUID.
Pick an enabled outcome from the outcomes of get_organization_preferences.
When the call is the last one of the contact in its campaign, the outcome of the contact in the campaign changes too.
Writes data: only call it when the user explicitly asked to change the outcome of a call.
Returns the updated call.
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid |
string | required | Call UUID |
callOutcome |
integer | required | Call outcome ID (see the outcomes of get_organization_preferences) |
Response
| Field | Type | Description |
|---|---|---|
uuid |
string | Call UUID |
from |
string | Caller phone number (E.164) |
to |
string | Recipient phone number (E.164) |
redirectTo |
string | Redirect to phone number (E.164) |
isIncoming |
boolean | true for an incoming call, false for an outgoing one |
callStatus |
integer | Call status ID (see Call Status enum) |
callOutcome |
integer | Call outcome ID (see Call Outcome enum and `get call outcomes endpoint`) |
callDuration |
integer | Call duration in seconds |
transcript |
string | Full transcript text when available |
transcriptResume |
string | Transcript summary when available |
recordingUrl |
string | Recording URL when available |
voiceMailMessageUrl |
string | Voicemail message URL when available |
createdAt |
string | Call date (ISO 8601 date-time, UTC) |
contact |
object | Contact reference |
uuid |
string | Contact UUID |
email |
string | Contact email address |
name |
string | Contact full name |
campaign |
object | Campaign associated with the call, or null if the call is not linked to a campaign. |
uuid |
string | Campaign UUID |
name |
string | Campaign name |
user |
object | Owner or user reference |
uuid |
string | User UUID |
email |
string | User email address |
name |
string | User full name |
Tasks
List tasks
list_tasks read-only
Lists tasks visible to the API key owner, paginated.
status IDs: 1 To do, 2 Overdue, 3 Completed.
| Parameter | Type | Required | Description |
|---|---|---|---|
status |
integer[] | optional | Task status IDs: 1 To do, 2 Overdue, 3 Completed |
page |
integer | optional | Page number (default 1) |
limit |
integer | optional | Page size (default 50, max 200) |
Response
| Field | Type | Description |
|---|---|---|
results |
object[] | Paginated list of results |
uuid |
string | Task UUID |
status |
integer | Task status. Values: - 1: To do - 2: Overdue - 3: Completed |
scheduledAt |
string | Task due date (ISO 8601 date-time, UTC) |
title |
string | Task title |
description |
string | Task details |
processed |
boolean | The task is completed |
contact |
object | Contact reference |
uuid |
string | Contact UUID |
email |
string | Contact email address |
name |
string | Contact full name |
totalItems |
integer | Total number of items available |
limitPerPage |
integer | Number of items per page |
totalPages |
integer | Total number of pages available |
currentPage |
integer | Current page number |
Fetch a task
get_task read-only
Returns one task by UUID.
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid |
string | required | Task UUID |
Response
| Field | Type | Description |
|---|---|---|
uuid |
string | Task UUID |
status |
integer | Task status. Values: - 1: To do - 2: Overdue - 3: Completed |
scheduledAt |
string | Task due date (ISO 8601 date-time, UTC) |
title |
string | Task title |
description |
string | Task details |
processed |
boolean | The task is completed |
contact |
object | Contact reference |
uuid |
string | Contact UUID |
email |
string | Contact email address |
name |
string | Contact full name |
Create a task
create_task write
Creates a task linked to a contact.
Writes data: only call it when the user explicitly asked for a task/reminder.
| Parameter | Type | Required | Description |
|---|---|---|---|
contactUuid |
string | required | Contact this task is linked to |
type |
integer | optional | Task type: 1 Call reminder, 2 Generic reminder, 3 Email reminder, 99 Other |
title |
string | optional | Task title, e.g. Follow up call |
description |
string | optional | Task details, e.g. Call back about the proposal |
scheduledAt |
string | optional | Task due date (ISO 8601 date-time), e.g. 2026-12-01T10:00:00+00:00 |
processed |
boolean | optional | true when the task is completed |
Response
| Field | Type | Description |
|---|---|---|
uuid |
string | Task UUID |
status |
integer | Task status. Values: - 1: To do - 2: Overdue - 3: Completed |
scheduledAt |
string | Task due date (ISO 8601 date-time, UTC) |
title |
string | Task title |
description |
string | Task details |
processed |
boolean | The task is completed |
contact |
object | Contact reference |
uuid |
string | Contact UUID |
email |
string | Contact email address |
name |
string | Contact full name |
Update a task
update_task write
Updates a task by UUID.
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid |
string | required | Task UUID |
type |
integer | optional | Task type: 1 Call reminder, 2 Generic reminder, 3 Email reminder, 99 Other |
title |
string | optional | Task title, e.g. Follow up call |
description |
string | optional | Task details, e.g. Call back about the proposal |
scheduledAt |
string | optional | Task due date (ISO 8601 date-time), e.g. 2026-12-01T10:00:00+00:00 |
processed |
boolean | optional | true when the task is completed |
contactUuid |
string | optional | Reassign this task to another contact |
Response
| Field | Type | Description |
|---|---|---|
uuid |
string | Task UUID |
status |
integer | Task status. Values: - 1: To do - 2: Overdue - 3: Completed |
scheduledAt |
string | Task due date (ISO 8601 date-time, UTC) |
title |
string | Task title |
description |
string | Task details |
processed |
boolean | The task is completed |
contact |
object | Contact reference |
uuid |
string | Contact UUID |
email |
string | Contact email address |
name |
string | Contact full name |
Delete a task
delete_task destructive
Deletes a task by UUID.
Writes data: only call it when the user explicitly asked to delete a task.
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid |
string | required | Task UUID |
Notes
Fetch a note
get_note read-only
Returns one note by UUID, with the contact it belongs to.
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid |
string | required | Note UUID |
Response
| Field | Type | Description |
|---|---|---|
uuid |
string | Note UUID |
content |
string | Note content |
createdAt |
string | Note creation date (ISO 8601 date-time, UTC) |
contact |
object | Contact reference |
uuid |
string | Contact UUID |
email |
string | Contact email address |
name |
string | Contact full name |
Create a note
create_note write
Add a note to a contact.
Writes data: only call it when the user explicitly asked to add a note.
| Parameter | Type | Required | Description |
|---|---|---|---|
contactUuid |
string | required | Contact this note is added to |
content |
string | required | Note content, e.g. Prospect interested, call back next Tuesday. |
Response
| Field | Type | Description |
|---|---|---|
uuid |
string | Note UUID |
content |
string | Note content |
createdAt |
string | Note creation date (ISO 8601 date-time, UTC) |
contact |
object | Contact reference |
uuid |
string | Contact UUID |
email |
string | Contact email address |
name |
string | Contact full name |
Update a note
update_note write
Updates the content of a note by UUID.
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid |
string | required | Note UUID |
content |
string | optional | Note content |
contactUuid |
string | optional | Move this note to another contact |
Response
| Field | Type | Description |
|---|---|---|
uuid |
string | Note UUID |
content |
string | Note content |
createdAt |
string | Note creation date (ISO 8601 date-time, UTC) |
contact |
object | Contact reference |
uuid |
string | Contact UUID |
email |
string | Contact email address |
name |
string | Contact full name |
Delete a note
delete_note destructive
Deletes a note by UUID.
Writes data: only call it when the user explicitly asked to delete a note.
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid |
string | required | Note UUID |
SMS
List SMS
list_sms read-only
Lists the SMS sent and received, paginated, newest first.
Set contactUuid to get the SMS conversation with one contact, dateFrom and dateTo to cover a period.
| Parameter | Type | Required | Description |
|---|---|---|---|
contactUuid |
string | optional | Only the SMS exchanged with this contact |
userUuids |
string[] | optional | Only the SMS of these users (user UUIDs come from get_organization) |
direction |
incoming | outgoing | optional | Only incoming (received) SMS or only outgoing (sent) SMS |
dateFrom |
string | optional | SMS from this date (YYYY-MM-DD), inclusive |
dateTo |
string | optional | SMS until this date (YYYY-MM-DD), inclusive |
sortDirection |
ASC | DESC | optional | Sort direction by SMS date (default DESC) |
page |
integer | optional | Page number (default 1) |
limit |
integer | optional | Page size (default 50, max 1000) |
Response
| Field | Type | Description |
|---|---|---|
results |
object[] | Paginated list of results |
uuid |
string | SMS UUID |
from |
string | Sender phone number (E.164) |
to |
string | Recipient phone number (E.164) |
content |
string | SMS content |
isIncoming |
boolean | true for an SMS received from the contact, false for an SMS sent to the contact |
readAt |
string | Date the SMS was marked as read (ISO 8601 date-time, UTC), null while unread |
createdAt |
string | SMS date (ISO 8601 date-time, UTC) |
user |
object | Owner or user reference |
uuid |
string | User UUID |
email |
string | User email address |
name |
string | User full name |
contact |
object | Contact reference |
uuid |
string | Contact UUID |
email |
string | Contact email address |
name |
string | Contact full name |
totalItems |
integer | Total number of items available |
limitPerPage |
integer | Number of items per page |
totalPages |
integer | Total number of pages available |
currentPage |
integer | Current page number |
Send an SMS
send_sms write
Sends an SMS to a contact from one of the phone numbers of the API key owner, and uses one SMS credit.
A manager may also send from the phone number of a user they manage: the SMS then belongs to this user.
The content may use {{firstName}}, {{lastName}}, {{email}} and {{phone}} as placeholders for the contact fields.
Writes data and costs a credit: only call it when the user explicitly asked to send an SMS.
Returns the SMS sent.
| Parameter | Type | Required | Description |
|---|---|---|---|
contactUuid |
string | required | Contact the SMS is sent to, on its selected phone number |
from |
string | required | Sender phone number (E.164), one of the SMS-enabled phone numbers of the API key owner, or of a user they manage for a manager |
content |
string | required | SMS content, e.g. Hello {{firstName}}, following our call, here is the link to book a meeting. |
Response
| Field | Type | Description |
|---|---|---|
uuid |
string | SMS UUID |
from |
string | Sender phone number (E.164) |
to |
string | Recipient phone number (E.164) |
content |
string | SMS content |
isIncoming |
boolean | true for an SMS received from the contact, false for an SMS sent to the contact |
readAt |
string | Date the SMS was marked as read (ISO 8601 date-time, UTC), null while unread |
createdAt |
string | SMS date (ISO 8601 date-time, UTC) |
user |
object | Owner or user reference |
uuid |
string | User UUID |
email |
string | User email address |
name |
string | User full name |
contact |
object | Contact reference |
uuid |
string | Contact UUID |
email |
string | Contact email address |
name |
string | Contact full name |
Delete an SMS
delete_sms destructive
Deletes an SMS by UUID.
Writes data: only call it when the user explicitly asked to delete an SMS.
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid |
string | required | SMS UUID |