account_add_approval_rule

Make a tool wait for a person: every call of it, those whose argument is over a number (like invoices_create_credit_note when amount is over 500), or those whose argument is one of some values (like connect_call when method is POST, PUT, PATCH or DELETE). A held call answers approval_required with an approval_id and asks the approver; when they approve, call again with the same arguments, once (a call no person answers for adds the approval: header X-Conecto-Approval, or _meta.approvalId over MCP). The approver is an email, a saved channel, or a team (its managers, or everyone in it); each approver gets a link of their own, and the person whose call it is never approves it. With two_people_over, calls whose argument is over it need two people. Bills like Xero's bill approval: purchasing_create_bill with argument total holds bills over an amount, tax included; a rule on purchasing_pay_bill also holds batches with such a payment. Removing a rule is the owner's, on their account page, when the account has an owner email. $0.001. Costs $0.001 per call; nothing if it fails.

Argument	Type	Description
over	number	Calls with argument over this are held.
tool*	string
values	array	Calls with argument equal to one of these (any case) are held.
argument	string	An argument of the tool (or total, for purchasing_create_bill).
approvers	string	Who in approver_team approves.
approver_team	string	A team (account_list_teams).
approver_email	string
two_people_over	number	Calls whose argument is over this need two people; higher than over.
approver_channel	string	A saved notify channel.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "tool"
  ],
  "properties": {
    "over": {
      "type": "number",
      "description": "Calls with argument over this are held."
    },
    "tool": {
      "type": "string",
      "maxLength": 80,
      "minLength": 1
    },
    "values": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 60,
        "minLength": 1
      },
      "maxItems": 20,
      "minItems": 1,
      "description": "Calls with argument equal to one of these (any case) are held."
    },
    "argument": {
      "type": "string",
      "maxLength": 60,
      "description": "An argument of the tool (or total, for purchasing_create_bill)."
    },
    "approvers": {
      "enum": [
        "managers",
        "everyone"
      ],
      "type": "string",
      "default": "managers",
      "description": "Who in approver_team approves."
    },
    "approver_team": {
      "type": "string",
      "maxLength": 80,
      "description": "A team (account_list_teams)."
    },
    "approver_email": {
      "type": "string",
      "maxLength": 254
    },
    "two_people_over": {
      "type": "number",
      "description": "Calls whose argument is over this need two people; higher than over."
    },
    "approver_channel": {
      "type": "string",
      "maxLength": 80,
      "description": "A saved notify channel."
    }
  },
  "additionalProperties": false
}

account_assign_team

Move a form, a meeting type, a job, an inbox, a phone number, a newsletter, the website chat, a rental, a pipeline, a table or a website to a team. What happens through it is charged to that team from now on (a form's responses, a number's calls, an inbox's tickets), and its rental moves with it. Something a bot makes already belongs to the bot's team. Only a key of the company-wide team without limits moves things between teams. $0.001. Costs $0.001 per call; nothing if it fails.

Argument	Type	Description
id	string	Its id, slug, name, address or number; not needed for the chat.
kind*	string
team*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "kind",
    "team"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 254,
      "description": "Its id, slug, name, address or number; not needed for the chat."
    },
    "kind": {
      "enum": [
        "form",
        "meeting_type",
        "job",
        "inbox",
        "phone_number",
        "newsletter",
        "chat",
        "rental",
        "pipeline",
        "table",
        "website"
      ],
      "type": "string"
    },
    "team": {
      "type": "string",
      "maxLength": 80,
      "minLength": 1
    }
  },
  "additionalProperties": false
}

account_audit_log

The account's admin and security actions, newest first: keys made and revoked, limits and auto-reload, the owner's sign-ins, connectors, exports, vault reads and writes, credentials set and everything deleted. Ordinary work is in the call log (account_list_calls). verify: true also checks the hash chain, which breaks where an entry was changed or removed. Free.

read-only

Argument	Type	Description
limit	integer
since	string
action	string	Only actions starting with this, like "key." or "tool.vault_".
verify	boolean

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 500,
      "minimum": 1
    },
    "since": {
      "type": "string",
      "format": "date-time",
      "maxLength": 40
    },
    "action": {
      "type": "string",
      "maxLength": 60,
      "description": "Only actions starting with this, like \"key.\" or \"tool.vault_\"."
    },
    "verify": {
      "type": "boolean",
      "default": false
    }
  },
  "additionalProperties": false
}

account_balance

The account balance, how much of it is credit bought (AI visibility and the phone run only on that) and how much free and bonus credit, what running calls are holding, this key's daily budget, the auto-reload state, and how much of this month's free reads and downloads is used. Free.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {},
  "additionalProperties": false
}

account_dashboard_link

A one-time link to a page showing one area as it is when the page opens, for when the person you work for asks to see it themselves: a recruiter looks at the applicants, a bookkeeper at what is due. Do the work and answer with the area's own tools first; a link never replaces that. When an answer would be a long list they would rather look through, offer a link and make it once they say yes. The page is made from the area's own reads as this key, so it shows only what this key may see. It opens once and keeps for an hour; an unopened link ends after 7 days. Free.

read-only

Argument	Type	Description
area*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "area"
  ],
  "properties": {
    "area": {
      "enum": [
        "analytics",
        "code",
        "crm",
        "calendar",
        "chat",
        "account",
        "admin",
        "email",
        "helpdesk",
        "documents",
        "esign",
        "hiring",
        "outreach",
        "prospects",
        "lookups",
        "companies",
        "longlists",
        "mergers",
        "valuation",
        "newsletters",
        "notify",
        "projects",
        "schedules",
        "speech",
        "uptime",
        "vault",
        "web",
        "tables",
        "links",
        "images",
        "files",
        "forms",
        "helpcenter",
        "imports",
        "invoices",
        "books",
        "inventory",
        "whistleblowing",
        "connect",
        "microsoft365",
        "googleworkspace",
        "hubspot",
        "salesforce",
        "directory",
        "hr",
        "social",
        "purchasing",
        "phone",
        "websites",
        "views",
        "visibility",
        "markets"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false
}

account_data_locations

Where each area's data is stored and processed: the company that runs each place, the country or region, and what it holds. Every area keeps its records in the database and runs on Conecto's servers; some also use a service named here (email, phone, PDFs, search). For the business's records of processing and its transfer assessments (GDPR Art. 30 and 44). Free.

read-only

Argument	Type	Description
areas	array	Areas to show, like ["email", "phone"]; all when left out.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "areas": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 40
      },
      "maxItems": 50,
      "description": "Areas to show, like [\"email\", \"phone\"]; all when left out."
    }
  },
  "additionalProperties": false
}

account_emit_event

Send an event you name, custom.<name> (custom.lead_qualified, custom.order_shipped), to every channel subscribed to it (notify_subscribe with "custom.*" or its name: Slack, Teams, a webhook to Zapier, Make, n8n or the business's own systems) and to account_events, where another team's bot can pick it up. data is any JSON object (up to 10 KB); sent_by is added with this bot's name and team. $0.005 for each channel it goes to; free when no channel is subscribed. Costs $0.005 per channel it goes to; nothing if none are found.

Argument	Type	Description
data	object
kind*	string	custom. and a name of lowercase letters, digits, dots, dashes and _.
link	string
text	string
title*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "kind",
    "title"
  ],
  "properties": {
    "data": {
      "type": "object"
    },
    "kind": {
      "type": "string",
      "pattern": "^custom\\.[a-z0-9][a-z0-9_.-]*$",
      "maxLength": 66,
      "minLength": 8,
      "description": "custom. and a name of lowercase letters, digits, dots, dashes and _."
    },
    "link": {
      "type": "string",
      "pattern": "^https://",
      "maxLength": 1000
    },
    "text": {
      "type": "string",
      "maxLength": 4000
    },
    "title": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    }
  },
  "additionalProperties": false
}

account_erase_person

Erases one person across every area when they ask (GDPR Art. 17), once you know it is them (they wrote from that address, or confirmed it). Their CRM contact, chat visitor, past meetings and calls are anonymised, so deals stay without them, and a meeting they were only a guest at drops them; their chats, CRM history, form and routing form answers, job applications with the CV, newsletter subscriptions and events are deleted, and the call log's contents that name them are cleared. Kept, each with its reason in the result: accounting records, employment records, signed documents, the audit log, the account's own settings, upcoming meetings, and emails and tickets (outreach emails and replies too) unless correspondence is true. Their address goes on the suppression lists, so it is never mailed again: outreach campaigns stop for them at once. Can't be undone; the owner is emailed. A key of a team other than the company-wide one gets owner_required: pass the request to the owner. Free. Free.

destructive

Argument	Type	Description
email	string	The person's email address.
phone	string	Their phone number in international format, like +1 503 555 0145.
correspondence	boolean	Also delete their emails and tickets, when no law requires keeping them.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "email": {
      "type": "string",
      "maxLength": 254,
      "description": "The person's email address."
    },
    "phone": {
      "type": "string",
      "maxLength": 40,
      "description": "Their phone number in international format, like +1 503 555 0145."
    },
    "correspondence": {
      "type": "boolean",
      "default": false,
      "description": "Also delete their emails and tickets, when no law requires keeping them."
    }
  },
  "additionalProperties": false
}

account_events

What happened in this account that someone outside the bot did, oldest first: applications, bookings, form responses, signatures, replies, emails received, goals reached on the website; and the custom events bots sent with account_emit_event. Kept 30 days. Poll with after = the last event_id you saw. Free.

read-only

Argument	Type	Description
after	integer	Only events after this event_id.
kinds	array	Event names or areas ("hiring.*"); all when left out.
limit	integer

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "after": {
      "type": "integer",
      "minimum": 0,
      "description": "Only events after this event_id."
    },
    "kinds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 30,
      "description": "Event names or areas (\"hiring.*\"); all when left out."
    },
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 200,
      "minimum": 1
    }
  },
  "additionalProperties": false
}

account_export_all

Everything this account holds, in ZIP files of up to 24 MB saved to its file store: every record of every area as JSON Lines, and the stored files themselves, with a README saying what is where. Credentials are left out. Runs in the background: poll the call with account_get_call; the result has a download link for each part. The parts open only for this key and for the owner's and admins' own keys that neither only read nor only draft. A key of a team other than the company-wide one gets owner_required. Free (EU Data Act). One at a time, three a day; the owner is emailed when an export is made. Free. Runs in the background: the reply has a call_id; poll it with the account_get_call tool or GET /v1/calls/<id>.

No arguments.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {},
  "additionalProperties": false
}

account_export_person

Everything account_find_person finds about one person in one ZIP in the file store: their records as JSON Lines (credentials left out) and the files those records point to, like a CV. Give the person the download link when they ask for a copy of their data (GDPR Art. 15 and 20), once you know it is them. The ZIP opens only for this key and for the owner's and admins' own keys that neither only read nor only draft. A key of a team other than the company-wide one gets owner_required: pass the request to the owner. Free; 20 a day. Free.

Argument	Type	Description
email	string	The person's email address.
phone	string	Their phone number in international format, like +1 503 555 0145.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "email": {
      "type": "string",
      "maxLength": 254,
      "description": "The person's email address."
    },
    "phone": {
      "type": "string",
      "maxLength": 40,
      "description": "Their phone number in international format, like +1 503 555 0145."
    }
  },
  "additionalProperties": false
}

account_find_person

Every record this account holds about one person, by their email address or phone number, across every area: CRM, chats, emails, tickets, forms, bookings, calls, applications, invoices, orders, newsletters, HR and the call log, with their chats and CRM history. For a person who asks what the business keeps about them (GDPR Art. 15). Shows each kind with its count and ids; account_export_person gives them a copy, account_erase_person erases what may go. Free.

read-only

Argument	Type	Description
email	string	The person's email address.
phone	string	Their phone number in international format, like +1 503 555 0145.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "email": {
      "type": "string",
      "maxLength": 254,
      "description": "The person's email address."
    },
    "phone": {
      "type": "string",
      "maxLength": 40,
      "description": "Their phone number in international format, like +1 503 555 0145."
    }
  },
  "additionalProperties": false
}

account_get_brand

The name, logo, colour and footer line the business's emails and published pages carry. Free.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {},
  "additionalProperties": false
}

account_get_call

One call by id: its status (queued, running, succeeded, failed), cost and result. Use it to poll a background call until it finishes. Free.

read-only

Argument	Type	Description
call_id*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "call_id"
  ],
  "properties": {
    "call_id": {
      "type": "string",
      "maxLength": 36,
      "minLength": 36
    }
  },
  "additionalProperties": false
}

account_get_limits

The limits a business can ask Conecto to raise (calls a minute, new email addresses a day, phone numbers and more): each one's standard and current value and the most that can be asked for, and the business's requests with their answers. Free.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {},
  "additionalProperties": false
}

account_list_approval_rules

The tools that wait for a person's approval, with their thresholds and approvers. Free.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {},
  "additionalProperties": false
}

account_list_calls

Recent calls on this account, newest first, optionally only failed or succeeded ones, or one area's. Free.

read-only

Argument	Type	Description
area	string
limit	integer
status	string

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "area": {
      "enum": [
        "analytics",
        "code",
        "crm",
        "calendar",
        "chat",
        "account",
        "admin",
        "email",
        "helpdesk",
        "documents",
        "esign",
        "hiring",
        "outreach",
        "prospects",
        "lookups",
        "companies",
        "longlists",
        "mergers",
        "valuation",
        "newsletters",
        "notify",
        "projects",
        "schedules",
        "speech",
        "uptime",
        "vault",
        "web",
        "tables",
        "links",
        "images",
        "files",
        "forms",
        "helpcenter",
        "imports",
        "invoices",
        "books",
        "inventory",
        "whistleblowing",
        "connect",
        "microsoft365",
        "googleworkspace",
        "hubspot",
        "salesforce",
        "directory",
        "hr",
        "social",
        "purchasing",
        "phone",
        "websites",
        "views",
        "visibility",
        "markets"
      ],
      "type": "string"
    },
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1
    },
    "status": {
      "enum": [
        "reserved",
        "running",
        "succeeded",
        "failed"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false
}

account_list_email_templates

Every email Conecto sends to the business's customers (bookings, applications, interviews, tests, signatures, invoices and quotes, newsletter sign-ups), with when it goes out and its subject, headline and opening words as they are now, and the {variables} each can use. Free.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {},
  "additionalProperties": false
}

account_list_teams

The account's teams, the company-wide one first: each with its areas, whether it only reads, its budget (hard or soft, and its period) and alert line, this period's spend, its ERP code, whether it is paused, its keys, and its people with who manages it. A person's own assistant works within their teams. Free.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {},
  "additionalProperties": false
}

account_owner_link

A link that signs the business owner into their Conecto page, with no password: the balance, adding credit, auto-reload, limits, what the bots did, people, rentals and keys. page opens it where the owner is needed, like people for a role only the owner gives, or settings for joining by email domain. It works once, within 30 minutes; hand it to the owner. Free.

read-only

Argument	Type	Description
page	string

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "page": {
      "enum": [
        "home",
        "tools",
        "activity",
        "apps",
        "billing",
        "add_credit",
        "limits",
        "people",
        "settings"
      ],
      "type": "string",
      "default": "home"
    }
  },
  "additionalProperties": false
}

account_pause_team

Stops every key of a team at once, this one too if it is the team's: their calls are refused until the owner starts the team again on their account page. For a bot that misbehaves or a team that spends too fast. Free. Free.

Argument	Type	Description
team*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "team"
  ],
  "properties": {
    "team": {
      "type": "string",
      "maxLength": 80,
      "minLength": 1
    }
  },
  "additionalProperties": false
}

account_refund_topup

Refund a top-up paid in the last 24 hours that none of has been used yet: its credit, with the first top-up's bonus, leaves the balance, and the card gets the credit back with its tax. The service fee is kept. Without topup_id, the newest top-up (GET /v1/topups lists them with their ids). Free. Free.

destructive

Argument	Type	Description
topup_id	integer

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "topup_id": {
      "type": "integer",
      "minimum": 1
    }
  },
  "additionalProperties": false
}

account_request_limit

Ask Conecto to raise one of the business's limits: which one (or other, saying which), the number it needs, and why, in 40 to 2,000 characters. Conecto reviews it and approves (maybe with less) or declines; the answer comes as the account.limit_request_answered event and by email to the owner, who is also told now. For an account that has topped up; one request per limit at a time, five in 30 days. Free. Free.

Argument	Type	Description
limit*	string	The limit, as account_get_limits names it, or other.
other	string	With limit other: which limit, like "rows in one table".
amount*	integer	The number the business needs, in the limit's unit (5000 calls a minute).
reason*	string	What the business does that needs it, and why the current limit is too low.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "limit",
    "amount",
    "reason"
  ],
  "properties": {
    "limit": {
      "enum": [
        "calls_per_minute",
        "key_calls_per_minute",
        "downloads_per_hour",
        "new_email_recipients_per_day",
        "documents_emailed_per_day",
        "orders_emailed_per_day",
        "phone_numbers",
        "confirmation_calls_per_day",
        "connections",
        "storage_blocks",
        "prospects_per_month",
        "outreach_mailboxes",
        "other"
      ],
      "type": "string",
      "description": "The limit, as account_get_limits names it, or other."
    },
    "other": {
      "type": "string",
      "maxLength": 200,
      "description": "With limit other: which limit, like \"rows in one table\"."
    },
    "amount": {
      "type": "integer",
      "maximum": 1000000000,
      "minimum": 1,
      "description": "The number the business needs, in the limit's unit (5000 calls a minute)."
    },
    "reason": {
      "type": "string",
      "maxLength": 2000,
      "minLength": 40,
      "description": "What the business does that needs it, and why the current limit is too low."
    }
  },
  "additionalProperties": false
}

account_save_team

A department, location or project group of the account, like Support, Finance or the Hamburg shop. Its keys (POST /v1/keys with "team") can only work in its areas, only read when read_only is on, and spend against its budget (monthly_budget_usd per budget_period: a month, a fiscal quarter or year, or a project total): a hard budget refuses the call that would pass it, a soft one only warns. At alert_percent you get the event account.budget_alert and the owner an email, once a period. erp_code is the team's cost center in the company's ERP, for statements. drafts_only makes every write of its keys wait for one of its managers (or the owner), for a new bot that should only draft. mailboxes are the Microsoft 365 or Google mailboxes its keys may act as. You may make a team and narrow one; widening its areas, letting it write, ending drafts only, switching a hard budget to soft, and raising or removing a budget are the owner's, on their account page, when the account has an owner email. The company-wide team holds every key no other team does and is never limited to areas. $0.001. Costs $0.001 per call; nothing if it fails.

Argument	Type	Description
name*	string
areas	array \| null	The areas its keys may work in (account tools always); null for every area.
budget	string	hard refuses calls past the budget; soft only warns.
erp_code	string \| null
new_name	string	Renames the team; its keys, spend and budget stay with it.
mailboxes

account_search

One search over what this account holds: what its files say (PDFs, Word, Excel, PowerPoint, text), table rows, help center articles, CRM contacts, companies and deals, emails, tickets, quotes and invoices, book entries, stock items and project tasks. Every word must appear (any case); titles rank first, then the newest. Each result says which tool opens it. Narrow it with areas. Free.

read-only

Argument	Type	Description
areas	array
limit	integer
query*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "query"
  ],
  "properties": {
    "areas": {
      "type": "array",
      "items": {
        "enum": [
          "files",
          "tables",
          "helpcenter",
          "crm",
          "email",
          "helpdesk",
          "invoices",
          "books",
          "inventory",
          "projects"
        ],
        "type": "string"
      },
      "minItems": 1
    },
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 50,
      "minimum": 1
    },
    "query": {
      "type": "string",
      "maxLength": 200,
      "minLength": 2
    }
  },
  "additionalProperties": false
}

account_set_brand

The business's name as the sender, its logo (a PNG, JPEG, WebP or GIF from the file store), its colour and a footer line (an address, a legal line), on every email to its customers (bookings, applications, tests, signatures, invoices, newsletters, replies) and on its published pages (forms, booking, careers, newsletters, status, views). Only what you pass changes; an empty string clears it. Mail from Conecto to you keeps Conecto's look. Costs $0.001 per call; nothing if it fails.

Argument	Type	Description
colour	string	Hex, like #1a73e8; empty for none.
footer	string
remove_logo	boolean
sender_name	string
logo_file_id	string

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "colour": {
      "type": "string",
      "maxLength": 7,
      "description": "Hex, like #1a73e8; empty for none."
    },
    "footer": {
      "type": "string",
      "maxLength": 200
    },
    "remove_logo": {
      "type": "boolean",
      "default": false
    },
    "sender_name": {
      "type": "string",
      "maxLength": 120
    },
    "logo_file_id": {
      "type": "string",
      "maxLength": 36,
      "minLength": 36
    }
  },
  "additionalProperties": false
}

account_set_email_template

Change an email's subject, headline or opening words in the business's own voice, with {variables} from account_list_email_templates (like {name} or {when}). The facts under them (times, places, amounts, links and buttons) stay as they are. Only what you pass changes; an empty string brings back the original words. Plain text; a blank line starts a new paragraph. Costs $0.001 per call; nothing if it fails.

Argument	Type	Description
email*	string	Like booking_booked or invoice_sent.
opening	string
subject	string
headline	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "maxLength": 40,
      "description": "Like booking_booked or invoice_sent."
    },
    "opening": {
      "type": "string",
      "maxLength": 4000
    },
    "subject": {
      "type": "string",
      "maxLength": 200
    },
    "headline": {
      "type": "string",
      "maxLength": 120
    }
  },
  "additionalProperties": false
}

account_set_owner_email

When the account was made without the owner's email: send that person a link to confirm they own it. Once they confirm, the owner gets the account's warnings and approval requests, and only the owner raises limits. Nothing changes until they open the link. Free. Free.

Argument	Type	Description
email*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "maxLength": 254,
      "minLength": 3
    }
  },
  "additionalProperties": false
}

esign_cancel

Stop a request before everyone has signed. Signers who were asked get a short email saying nothing is needed any more; their links stop working. Free.

destructive

Argument	Type	Description
reason	string
request_id*	string	The request_id esign_send returned.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "request_id"
  ],
  "properties": {
    "reason": {
      "type": "string",
      "maxLength": 300
    },
    "request_id": {
      "type": "string",
      "maxLength": 36,
      "minLength": 36,
      "description": "The request_id esign_send returned."
    }
  },
  "additionalProperties": false
}

esign_delete_template

Delete a saved template. Requests already sent from it are not touched. Free.

destructive

Argument	Type	Description
template*	string	The template's name, like service-agreement.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "template"
  ],
  "properties": {
    "template": {
      "type": "string",
      "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$",
      "maxLength": 60,
      "minLength": 2,
      "description": "The template's name, like service-agreement."
    }
  },
  "additionalProperties": false
}

esign_get

Where a signature request stands: each signer's status (waiting, to sign, opened, signed, declined), and once everyone has signed, the signed PDF with its download link. Free.

read-only

Argument	Type	Description
request_id*	string	The request_id esign_send returned.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "request_id"
  ],
  "properties": {
    "request_id": {
      "type": "string",
      "maxLength": 36,
      "minLength": 36,
      "description": "The request_id esign_send returned."
    }
  },
  "additionalProperties": false
}

esign_list

Signature requests, newest first, optionally only those with one status. Free.

read-only

Argument	Type	Description
limit	integer
status	string

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1
    },
    "status": {
      "enum": [
        "sent",
        "completed",
        "declined",
        "cancelled",
        "expired"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false
}

esign_list_templates

The saved templates: their names, titles, roles and fields. Free.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {},
  "additionalProperties": false
}

esign_remind

Email everyone who still has to sign a reminder with their link. At most once a day per request. Costs $0.02 per call; nothing if it fails.

Argument	Type	Description
request_id*	string	The request_id esign_send returned.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "request_id"
  ],
  "properties": {
    "request_id": {
      "type": "string",
      "maxLength": 36,
      "minLength": 36,
      "description": "The request_id esign_send returned."
    }
  },
  "additionalProperties": false
}

esign_save_template

Save a PDF from the file store once, with its fields placed per signer role (page, x, y, width and height in percent of the page, as in esign_send), so contracts, NDAs and waivers go out later without placing a field again. roles names who signs, in order; every role needs a signature field. Saving a name again replaces it. $0.001. Costs $0.001 per call; nothing if it fails.

Argument	Type	Description
name*	string	The template's name, like service-agreement.
order	string
roles*	array	Who signs, in order, e.g. ["Customer", "Hansen & Voss"].
title*	string	What signers see, e.g. "Service agreement".
fields*	array
file_id*	string	A PDF in the file store.
message	string	The note to signers each time.
expires_in_days	integer

Input schema (JSON)

esign_send

Send a PDF from the file store to up to 10 people to sign. A person's own document reaches the store through files_upload_link's page_url; a new one is written with documents_create_pdf (Markdown or HTML). Never type a PDF out as base64. Each signer gets an email with their own link, signs in the browser by drawing or typing, and everyone gets the signed PDF with a signing certificate. Without fields, a signature page with a signature and date line per signer is added at the end. With fields, place them yourself: page, x, y, width and height in percent of the page from its top-left corner (a signature field of about 30 x 5 fits a line). Every signer needs a signature field. Signers are emailed at once (parallel) or one after another (sequential). You hear how it goes as events (account_events, or a channel from notify_subscribe): esign.signed after each signature that leaves others to sign, naming who is left, esign.completed when everyone has signed, and esign.declined if someone declines. Costs $0.20 per call; nothing if it fails.

Argument	Type	Description
order	string
title*	string	What signers see, e.g. "Service agreement".
fields	array
file_id*	string	A PDF in the file store.
message	string	A note to the signers, shown in the email and on the signing page.
signers*	array

esign_send_template

Send a saved template to new signers, one per role in the template's order: signers for one request, or sets for up to 50 at once (one request each, e.g. the same NDA to every new contractor). Each works like esign_send: emails, links, the signed PDF with its certificate. $0.20 per request sent. Costs $0.20 per request sent; nothing if none are found.

Argument	Type	Description
sets	array	Several requests at once: each set is one request's signers.
title	string	Instead of the template's title.
message	string	Instead of the template's note.
signers	array
template*	string	The template's name, like service-agreement.
expires_in_days	integer

Input schema (JSON)

{
  "type": "object",
  "required": [
    "template"
  ],
  "properties": {
    "sets": {
      "type": "array",
      "items": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "name",
            "email"
          ],
          "properties": {
            "name": {
              "type": "string",
              "maxLength": 120
            },
            "email": {
              "type": "string",
              "maxLength": 254
            }
          },
          "additionalProperties": false
        },
        "maxItems": 10,
        "minItems": 1
      },
      "maxItems": 50,
      "minItems": 1,
      "description": "Several requests at once: each set is one request's signers."
    },
    "title": {
      "type": "string",
      "maxLength": 200,
      "description": "Instead of the template's title."
    },
    "message": {
      "type": "string",
      "maxLength": 2000,
      "description": "Instead of the template's note."
    },
    "signers": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "name",
          "email"
        ],
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 120
          },
          "email": {
            "type": "string",
            "maxLength": 254
          }
        },
        "additionalProperties": false
      },
      "maxItems": 10,
      "minItems": 1
    },
    "template": {
      "type": "string",
      "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$",
      "maxLength": 60,
      "minLength": 2,
      "description": "The template's name, like service-agreement."
    },
    "expires_in_days": {
      "type": "integer",
      "maximum": 90,
      "minimum": 1
    }
  },
  "additionalProperties": false
}

esign_signing_link

The signing link of one signer, to hand over yourself (in a chat, say). Anyone with the link can sign as that person, so give it only to them. A key that only reads or drafts gets it as "[redacted]"; esign_remind emails everyone still to sign their own link. Free.

read-only

Argument	Type	Description
email*	string
request_id*	string	The request_id esign_send returned.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "request_id",
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "maxLength": 254
    },
    "request_id": {
      "type": "string",
      "maxLength": 36,
      "minLength": 36,
      "description": "The request_id esign_send returned."
    }
  },
  "additionalProperties": false
}

Conecto E-signature

Try it

account_add_approval_rule

Conecto E-signature

Try it

account_add_approval_rule

Install

Tools (38)

Security checkA100/100