whatconverts_create_lead

WRITE: add a lead to WhatConverts, for example an offline phone call, a form submission from another system or a sale you want attributed. It appears in reports and counts toward lead totals; send_notification is always off, so no emails go out. Not idempotent: calling twice creates two leads. A Profile key adds to its own profile; an Agency key must pass profile_id. POST /leads.

Argument	Type	Description
message	string	Message body (text_message only).
lead_url	string	URL where the lead occurred.
quotable	string
form_name	string	Form name (web_form only).
lead_type*	string	Lead type.
profile_id	integer	Profile to add the lead to (required with an Agency key, not with a Profile key).
landing_url	string	URL where the visitor arrived.
lead_medium	string	Traffic medium, e.g. cpc.
lead_source	string	Traffic source, e.g. google.
quote_value	number
sales_value	number
date_created	string	When the lead happened (UTC); default now.
lead_content	string
lead_keyword	string
phone_number	string	Contact phone, E.164.
answer_status	string	phone_call only.
caller_number	string	Caller number, E.164 (phone_call / text_message).
custom_fields	object
email_address	string	Contact email address (stored on the lead; nothing is sent to it).
lead_campaign	string
tracking_number	string	Tracking number, E.164 (phone_call / text_message).
additional_fields	object
destination_number	string	Destination number, E.164 (phone_call).
call_duration_seconds	integer	Call length in seconds (phone_call only).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "lead_type"
  ],
  "properties": {
    "message": {
      "type": "string",
      "maxLength": 5000,
      "minLength": 1,
      "description": "Message body (text_message only)."
    },
    "lead_url": {
      "type": "string",
      "format": "uri",
      "maxLength": 2000,
      "description": "URL where the lead occurred."
    },
    "quotable": {
      "enum": [
        "yes",
        "no",
        "pending",
        "not_set"
      ],
      "type": "string"
    },
    "form_name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Form name (web_form only)."
    },
    "lead_type": {
      "enum": [
        "appointment",
        "chat",
        "email",
        "event",
        "other",
        "phone_call",
        "text_message",
        "transaction",
        "web_form"
      ],
      "type": "string",
      "description": "Lead type."
    },
    "profile_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Profile to add the lead to (required with an Agency key, not with a Profile key).",
      "exclusiveMinimum": 0
    },
    "landing_url": {
      "type": "string",
      "format": "uri",
      "maxLength": 2000,
      "description": "URL where the visitor arrived."
    },
    "lead_medium": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Traffic medium, e.g. cpc."
    },
    "lead_source": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Traffic source, e.g. google."
    },
    "quote_value": {
      "type": "number",
      "maximum": 1000000000,
      "minimum": 0
    },
    "sales_value": {
      "type": "number",
      "maximum": 1000000000,
      "minimum": 0
    },
    "date_created": {
      "type": "string",
      "description": "When the lead happened (UTC); default now."
    },
    "lead_content": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "lead_keyword": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "phone_number": {
      "type": "string",
      "pattern": "^\\+[1-9]\\d{6,14}$",
      "description": "Contact phone, E.164."
    },
    "answer_status": {
      "enum": [
        "Answered",
        "No Answer",
        "Busy"
      ],
      "type": "string",
      "description": "phone_call only."
    },
    "caller_number": {
      "type": "string",
      "pattern": "^\\+[1-9]\\d{6,14}$",
      "description": "Caller number, E.164 (phone_call / text_message)."
    },
    "custom_fields": {
      "type": "object",
      "propertyNames": {
        "type": "string",
        "pattern": "^[^\\[\\]&=#%\\x00-\\x1f]+$",
        "maxLength": 100,
        "minLength": 1
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 2000
      }
    },
    "email_address": {
      "type": "string",
      "maxLength": 254,
      "minLength": 3,
      "description": "Contact email address (stored on the lead; nothing is sent to it)."
    },
    "lead_campaign": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "tracking_number": {
      "type": "string",
      "pattern": "^\\+[1-9]\\d{6,14}$",
      "description": "Tracking number, E.164 (phone_call / text_message)."
    },
    "additional_fields": {
      "type": "object",
      "propertyNames": {
        "type": "string",
        "pattern": "^[^\\[\\]&=#%\\x00-\\x1f]+$",
        "maxLength": 100,
        "minLength": 1
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 2000
      }
    },
    "destination_number": {
      "type": "string",
      "pattern": "^\\+[1-9]\\d{6,14}$",
      "description": "Destination number, E.164 (phone_call)."
    },
    "call_duration_seconds": {
      "type": "integer",
      "maximum": 86400,
      "minimum": 0,
      "description": "Call length in seconds (phone_call only)."
    }
  }
}

whatconverts_get_account

Agency key only: one account by id with its profiles. GET /accounts/{account_id}.

read-only

Argument	Type	Description
account_id*	integer	WhatConverts account id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "account_id"
  ],
  "properties": {
    "account_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "WhatConverts account id.",
      "exclusiveMinimum": 0
    }
  }
}

whatconverts_get_call_recording_info

Recording and voicemail facts for a phone-call lead: the recording and voicemail links, call duration, answer status, tracking/caller numbers and the call/voicemail transcripts. Returns links and text only, never audio. Taken from GET /leads/{lead_id} (the audio endpoint GET /recording returns raw MP3 and is not used).

read-only

Argument	Type	Description
lead_id*	integer	WhatConverts lead id of a phone call.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "lead_id"
  ],
  "properties": {
    "lead_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "WhatConverts lead id of a phone call.",
      "exclusiveMinimum": 0
    }
  }
}

whatconverts_get_lead

One lead by id with every field: type, status, attribution (source, medium, campaign, keyword, landing page), contact details, location, device, quote/sales value, call details, transcripts, form/message content, and custom fields. GET /leads/{lead_id}.

read-only

Argument	Type	Description
lead_id*	integer	WhatConverts lead id (from whatconverts_list_leads).
customer_journey	boolean	Include the customer journey (Elite plans only).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "lead_id"
  ],
  "properties": {
    "lead_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "WhatConverts lead id (from whatconverts_list_leads).",
      "exclusiveMinimum": 0
    },
    "customer_journey": {
      "type": "boolean",
      "description": "Include the customer journey (Elite plans only)."
    }
  }
}

whatconverts_get_profile

Agency key only: one profile by id (name, date created). GET /accounts/{account_id}/profiles/{profile_id}.

read-only

Argument	Type	Description
account_id*	integer	WhatConverts account id.
profile_id*	integer	WhatConverts profile id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "account_id",
    "profile_id"
  ],
  "properties": {
    "account_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "WhatConverts account id.",
      "exclusiveMinimum": 0
    },
    "profile_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "WhatConverts profile id.",
      "exclusiveMinimum": 0
    }
  }
}

whatconverts_get_role

Agency key only: one role with its permission levels (none/view/edit) per area. GET /roles/{role_id}.

read-only

Argument	Type	Description
role_id*	integer	WhatConverts role id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "role_id"
  ],
  "properties": {
    "role_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "WhatConverts role id.",
      "exclusiveMinimum": 0
    }
  }
}

whatconverts_get_user

Agency key only: one user by id with role, notification settings and (for account users) the accounts they can access. GET /users/{user_id}.

read-only

Argument	Type	Description
user_id*	integer	WhatConverts user id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "user_id"
  ],
  "properties": {
    "user_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "WhatConverts user id.",
      "exclusiveMinimum": 0
    }
  }
}

whatconverts_list_accounts

Agency key only: list the accounts (clients) of the agency with their profiles (id, name, date created). Use the ids to filter leads. start_date/end_date filter by creation date (WhatConverts defaults start_date to today, so pass an early start_date to see all). GET /accounts.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
order	string	Sort by date created: asc or desc (default desc).
end_date	string	Accounts created up to this date (UTC).
per_page	integer	Results per page, 1-250 (default 25).
start_date	string	Accounts created from this date (UTC). Pass e.g. 2000-01-01 to list all.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "order": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort by date created: asc or desc (default desc)."
    },
    "end_date": {
      "type": "string",
      "description": "Accounts created up to this date (UTC)."
    },
    "per_page": {
      "type": "integer",
      "maximum": 250,
      "description": "Results per page, 1-250 (default 25).",
      "exclusiveMinimum": 0
    },
    "start_date": {
      "type": "string",
      "description": "Accounts created from this date (UTC). Pass e.g. 2000-01-01 to list all."
    }
  }
}

whatconverts_list_leads

List tracked leads (phone calls, web forms, chats, texts, emails, events, transactions) with source/medium/campaign/keyword attribution, contact details, quote and sales values, call duration and transcripts. start_date is REQUIRED because WhatConverts otherwise returns only today's leads; a range is at most 400 days. A Profile key sees its own profile; an Agency key can narrow by account_id/profile_id. GET /leads.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
spam	boolean	true = only spam leads.
order	string	Sort by date created: asc or desc (default desc).
user_id	string	Only leads handled by this WhatConverts user id.
end_date	string	Last day/time to include (UTC). Range from start_date at most 400 days.
per_page	integer	Results per page, 1-100 (default 25).
quotable	string	Only leads with this quotable state.
duplicate	boolean

whatconverts_list_phone_numbers

List the call-tracking numbers: tracking and destination number, call flow, trigger (source/medium), call recording and messaging flags, last used. A Profile key lists its own profile; an Agency key may filter by account_id/profile_id. GET /tracking/numbers.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
per_page	integer	Results per page, 1-250 (default 25).
account_id	integer	Agency key only: only this account.
profile_id	integer	Agency key only: only this profile.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "per_page": {
      "type": "integer",
      "maximum": 250,
      "description": "Results per page, 1-250 (default 25).",
      "exclusiveMinimum": 0
    },
    "account_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Agency key only: only this account.",
      "exclusiveMinimum": 0
    },
    "profile_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Agency key only: only this profile.",
      "exclusiveMinimum": 0
    }
  }
}

whatconverts_list_profiles

Agency key only: list the profiles (websites/campaign sets) of one account. start_date/end_date filter by creation date (WhatConverts defaults start_date to today, so pass an early start_date to see all). GET /accounts/{account_id}/profiles.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
order	string	Sort by date created: asc or desc (default desc).
end_date	string	Profiles created up to this date (UTC).
per_page	integer	Results per page, 1-250 (default 25).
account_id*	integer	WhatConverts account id.
start_date	string	Profiles created from this date (UTC). Pass e.g. 2000-01-01 to list all.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "account_id"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "order": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort by date created: asc or desc (default desc)."
    },
    "end_date": {
      "type": "string",
      "description": "Profiles created up to this date (UTC)."
    },
    "per_page": {
      "type": "integer",
      "maximum": 250,
      "description": "Results per page, 1-250 (default 25).",
      "exclusiveMinimum": 0
    },
    "account_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "WhatConverts account id.",
      "exclusiveMinimum": 0
    },
    "start_date": {
      "type": "string",
      "description": "Profiles created from this date (UTC). Pass e.g. 2000-01-01 to list all."
    }
  }
}

whatconverts_list_roles

Agency key only: list user roles (id, name, master-account or account type). GET /roles.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
order	string	Sort by role name (default asc).
per_page	integer	Results per page, 1-250 (default 25).
role_type	string	master_account (default) or account roles.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "order": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort by role name (default asc)."
    },
    "per_page": {
      "type": "integer",
      "maximum": 250,
      "description": "Results per page, 1-250 (default 25).",
      "exclusiveMinimum": 0
    },
    "role_type": {
      "enum": [
        "master_account",
        "account"
      ],
      "type": "string",
      "description": "master_account (default) or account roles."
    }
  }
}

whatconverts_list_users

Agency key only: list WhatConverts users (email, role, whether activation is pending) of the master account or of client accounts. start_date/end_date filter by creation date (WhatConverts defaults start_date to today, so pass an early start_date to see all). GET /users.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
order	string	Sort by date created: asc or desc (default desc).
end_date	string	Users created up to this date (UTC).
per_page	integer	Results per page, 1-250 (default 25).
user_type	string	master_account (default) or account users.
start_date	string	Users created from this date (UTC). Pass e.g. 2000-01-01 to list all.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "order": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort by date created: asc or desc (default desc)."
    },
    "end_date": {
      "type": "string",
      "description": "Users created up to this date (UTC)."
    },
    "per_page": {
      "type": "integer",
      "maximum": 250,
      "description": "Results per page, 1-250 (default 25).",
      "exclusiveMinimum": 0
    },
    "user_type": {
      "enum": [
        "master_account",
        "account"
      ],
      "type": "string",
      "description": "master_account (default) or account users."
    },
    "start_date": {
      "type": "string",
      "description": "Users created from this date (UTC). Pass e.g. 2000-01-01 to list all."
    }
  }
}

whatconverts_list_web_forms

List the web forms WhatConverts tracks (id, name, how the form and its submit are matched on the page). A Profile key lists its own profile; an Agency key may filter by account_id/profile_id. GET /tracking/forms.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
per_page	integer	Results per page, 1-250 (default 25).
account_id	integer	Agency key only: only this account.
profile_id	integer	Agency key only: only this profile.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "per_page": {
      "type": "integer",
      "maximum": 250,
      "description": "Results per page, 1-250 (default 25).",
      "exclusiveMinimum": 0
    },
    "account_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Agency key only: only this account.",
      "exclusiveMinimum": 0
    },
    "profile_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Agency key only: only this profile.",
      "exclusiveMinimum": 0
    }
  }
}

whatconverts_update_lead

WRITE: update a lead's sales data in WhatConverts: quotable state, quote value, sales value, the URL where the lead occurred, and/or custom/additional field values. Only the fields you pass change; it overwrites the previous values of those fields. Sends no notifications. At least one field is required. POST /leads/{lead_id}.

destructive

Argument	Type	Description
lead_id*	integer	WhatConverts lead id.
lead_url	string	URL where the lead occurred.
quotable	string	Quotable state.
quote_value	number	Quote value (number, account currency).
sales_value	number	Sales value (number, account currency).
custom_fields	object	Custom lead field values by field name.
additional_fields	object	Additional field values by field name, e.g. {"Reason": "pricing"}.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "lead_id"
  ],
  "properties": {
    "lead_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "WhatConverts lead id.",
      "exclusiveMinimum": 0
    },
    "lead_url": {
      "type": "string",
      "format": "uri",
      "maxLength": 2000,
      "description": "URL where the lead occurred."
    },
    "quotable": {
      "enum": [
        "yes",
        "no",
        "pending",
        "not_set"
      ],
      "type": "string",
      "description": "Quotable state."
    },
    "quote_value": {
      "type": "number",
      "maximum": 1000000000,
      "minimum": 0,
      "description": "Quote value (number, account currency)."
    },
    "sales_value": {
      "type": "number",
      "maximum": 1000000000,
      "minimum": 0,
      "description": "Sales value (number, account currency)."
    },
    "custom_fields": {
      "type": "object",
      "description": "Custom lead field values by field name.",
      "propertyNames": {
        "type": "string",
        "pattern": "^[^\\[\\]&=#%\\x00-\\x1f]+$",
        "maxLength": 100,
        "minLength": 1
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 2000
      }
    },
    "additional_fields": {
      "type": "object",
      "description": "Additional field values by field name, e.g. {\"Reason\": \"pricing\"}.",
      "propertyNames": {
        "type": "string",
        "pattern": "^[^\\[\\]&=#%\\x00-\\x1f]+$",
        "maxLength": 100,
        "minLength": 1
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 2000
      }
    }
  }
}

WhatConverts MCP by usefulapi

Try it

whatconverts_create_lead

WhatConverts MCP by usefulapi

Try it

whatconverts_create_lead

Tools (15)