Build on Plodder

POST/api/external/tools/add_task_comment

Scopes: tasks:write

Add a comment to a task thread. It shows as written through your AI client, not as you typing it.

POST/api/external/tools/agenda_snapshots

Scopes: tasks:read, tasks:write

Daily snapshots of every task with its status (/api/agendas). Owner only: snapshots are one table by date. Actions: - list: Dates that have a snapshot. - get: The snapshot for a date (YYYY-MM-DD). - save: Save today's snapshot from your workspaces' tasks (replaces today's).

POST/api/external/tools/auto_schedule

Scopes: tasks:read, tasks:write

The owner's auto-scheduler: work-hours schedules (blocks = [{day 0-6, start "09:00", end "17:00"}]), flexible hours for one date, rescheduling now, and the task timer (start/stop). Actions: - list_schedules: Every work-hours schedule. - create_schedule: A new schedule (name, blocks, color, is_default). - update_schedule: Change a schedule (schedule_id, name, blocks, color, is_default). - delete_schedule: Delete a schedule. (waits for approval: delete) - get_flexible_hours: The flexible hours set for one date (YYYY-MM-DD). - set_flexible_hours: Different hours for one date (date, blocks). - clear_flexible_hours: Back to the normal schedule for that date. (waits for approval: delete) - reschedule: Run the auto-scheduler now (repacks auto-scheduled tasks around the calendar). - toggle_task_timer: Start the timer on a task (status in progress), or stop it when it is running.

POST/api/external/tools/complete_task

Scopes: tasks:write

Mark a task done. Pass a short result note (20+ characters) when the task was created by an AI agent; it is required there and saved to the task thread.

POST/api/external/tools/create_task

Scopes: tasks:write

Create a task inside a project. Every task needs a project: call list_projects first if you do not know the id. Assignee defaults to the project default, else you.

POST/api/external/tools/delete_task

Scopes: tasks:write

Delete a task. Needs your approval in Plodder before it happens (unless you changed that in Settings > AI agents).

POST/api/external/tools/get_task

Scopes: tasks:read

Full detail for one task: description, subtasks and recent comments/activity.

POST/api/external/tools/list_tasks

Scopes: tasks:read

List tasks you can see, newest first. Filter by workspace, project, status, assignee, due dates or text. Open tasks only unless include_done is true.

POST/api/external/tools/saved_views

Scopes: tasks:read, tasks:write

Your saved list views on Home, Drive and Search (filters, sort, grouping saved under a name). Only you see them. config is the list settings object the app saves. Home: { status: all|unread|read, types: [tasks|email|chat|notifications|files|projects|agents], group?: date|type|none, sort?: latest|oldest|unread|name }. Search: { q, scope, group?: type|date|none, sort?: relevance|updated|oldest|name }. Actions: - list: Your saved views on a surface. - create: Save a view (surface, name, config). - update: Rename it, replace its config, or make it the default (is_default). - delete: Delete one of your saved views. (waits for approval: delete)

POST/api/external/tools/status_updates

Scopes: tasks:read, tasks:write

Status updates posted on a task or a project (/api/status-updates). Give task_id or project_id. Actions: - list: Updates on a task or project, newest first. - create: Post an update (content) on a task or project. - delete: Delete an update (update_id). (waits for approval: delete)

POST/api/external/tools/task_actions

Scopes: tasks:read, tasks:write

More task actions, as you: bulk changes over many tasks, copy a task, recurring series (edit or delete one occurrence or the whole series), scheduled work blocks (chunks), possible duplicates, and GitHub pull requests on a task. For one task's fields use update_task. Actions: - bulk: Change many tasks at once (task_ids, bulk, value). (may wait for approval) - copy: Copy a task (task_id): same project, stage, assignee, priority and description, status todo. - recurrence: A recurring task's series (task_id, series, changes): detach and change one occurrence, edit_all, delete_one, delete_all. (may wait for approval) - complete_chunk: Mark one scheduled work block done or not done (task_id, chunk_start, completed). - lock_chunk: Move and pin a scheduled work block (task_id, old_chunk_start, new_chunk_start, new_chunk_end); the rest reschedules around it. - duplicates: Possible duplicates of a task (task_id). - dismiss_duplicate: Say two tasks are not duplicates (task_id, other_task_id). - pulls: GitHub pull requests linked to a task, ones that look related, and your open ones to pick from (task_id). - link_pull: Link a GitHub pull request to a task (task_id, url, title). - unlink_pull: Unlink a pull request from a task (task_id, url).

POST/api/external/tools/task_views

Scopes: tasks:read, tasks:write

The named views on the task board (list, kanban, gantt, dashboard, workload) with their saved settings. Everyone on the board shares them, the same as in the app. Actions: - list: Every task view. - create: A new view (name, view_type, config). - update: Change name, view_type, config or sort_order. - delete: Delete a view. (waits for approval: delete)

POST/api/external/tools/time_tracking

Scopes: tasks:read, tasks:write

Plodder time tracking from the Mac collector, as you (/api/ctrl-flow/*): classify sessions and apps to businesses and projects (the review queue), log a session's time to a task, privacy rules, retention, and maintenance backfills. Pairing a new Mac happens in the app. Actions: - classify: One review / attribution change (op + fields). merge_sessions and merge_entities wait for approval. (may wait for approval) - log_time: Log a session's business time to a task (session_id, business_id, task_id or new_task_title, project_id?, note?). reverse=true takes it back off. - backfill: Re-derive tracked data (backfill: default | localAiSessionIds | fleetFlags | fleetDispatch | reviewSweep | businessSeconds | reconcile; limit?, max_seconds?, days?). - delete_range: Delete tracked activity in a range (start + end ISO, or the last `days`). (waits for approval: delete) - retention: Keep `days` of tracked activity and delete what is older now. (waits for approval: delete) - privacy_rules: Privacy rules (what the collector never records). - add_privacy_rule: A privacy rule (kind, value, rule_action block|allow, default block). - remove_privacy_rule: Remove a privacy rule (rule_id). (waits for approval: delete) - devices: Paired Mac collectors. - revoke_device: Revoke a Mac collector (device_id); its token stops working. (waits for approval: delete)

POST/api/external/tools/update_task

Scopes: tasks:write

Change a task: title, description, status, priority, assignee, dates, duration, or move it to another project. Only the fields you pass change.

POST/api/external/tools/create_project

Scopes: projects:write

Create a project with the standard Todo, In Progress and Done stages.

POST/api/external/tools/get_project

Scopes: projects:read

One project with its stages, task counts and open tasks.

POST/api/external/tools/list_projects

Scopes: projects:read

List projects in your workspaces (or one workspace). Archived ones are left out unless include_archived is true.

POST/api/external/tools/project_actions

Scopes: projects:read, projects:write

Project settings, copies, stages and the project's comment box, as you. For tasks in a project use create_task / list_tasks. Actions: - update: Change a project (project_id, set). archived 1 archives it, 0 brings it back. - delete: Delete a project (it goes to Trash with its stages and tasks). (waits for approval: delete) - copy: Copy a project with its stages, tasks and docs (project_id, name). - comments: The project's comment box. - comment: Post in the project's comment box (project_id, body). - delete_comment: Delete your own project comment (comment_id). (waits for approval: delete) - stages: The project's stages in order. - add_stage: Add a stage (project_id, name, color). - update_stage: Change a stage (stage_id, set: {name, color, is_active, ...}). - reorder_stages: Put the stages in this order (project_id, stage_ids). - delete_stage: Delete a stage (stage_id); its tasks move to reassign_to, or lose their stage. (waits for approval: delete) - apply_template: Add a project template's stages and tasks to a project (project_id, template_id).

POST/api/external/tools/templates

Scopes: projects:read, projects:write

Project templates, task templates and doc templates, as you: list, create, change, delete, and use them. Actions: - list_project: Project templates. - create_project: A project template (name, description, set {stages, default_tasks, roles, text_variables} as JSON strings), or from_project_id. - update_project: Change a project template (template_id, set). - delete_project: Delete a project template (template_id). (waits for approval: delete) - list_task: Task templates (workspace_id optional). - create_task: A task template (name, set {default_title, default_priority, default_duration_minutes, default_status, description, subtasks}). - use_task: Create the task(s) from a task template (template_id, project_id, stage_id, workspace_id). - delete_task: Delete a task template (template_id). (waits for approval: delete) - list_doc: Doc templates you can use (built-in and your workspaces'). - get_doc: One doc template with its blocks. - save_doc: Save a doc as a doc template (doc_id, name, description, set {category}). - update_doc: Change a doc template (template_id, set {name, description, category, icon}, or set {duplicate: true}). - delete_doc: Delete a doc template (template_id). (waits for approval: delete) - use_doc: A new doc from a doc template (template_id, title, workspace_id or project_id).

POST/api/external/tools/add_database_row

Scopes: docs:write

Add a row to a database. values maps column names (from list_database_rows) to values.

POST/api/external/tools/append_to_doc

Scopes: docs:write

Add markdown to the end of a doc without touching what is there.

POST/api/external/tools/code_files

Scopes: docs:read, docs:write

Read and write code files in Drive, as you: files made in the code editor (id) and code-type uploads (.js .ts .py .json .css .html .md ..., drive_file). Edit with a find and replace (edit) or write the whole text (write). Actions: - list: Code files you can open, newest first. - get: A code file: title, type, revision, content, where it sits in Drive. - create: A new code file: title (with extension sets the language), file_type, content, workspace_id or folder_id. - write: Replace the whole content (base_rev from get; force=true overwrites a newer change). - edit: Replace old_text with new_text (exactly once unless all=true). - rename: Change the title (an extension also sets the language). - set_type: Change the language (file_type, an extension like "py"). - move: Move in Drive: workspace_id and/or folder_id. - trash: Move to Drive Trash. (waits for approval: delete) - drive_get: A code-type Drive upload (drive_file): content and its sha256. - drive_write: Save a Drive upload's text: content (base_sha from drive_get; force=true overwrites), or old_text/new_text.

POST/api/external/tools/create_doc

Scopes: docs:write

Create a doc from markdown (headings, lists, checklists, code, bold/italic/links; $$ LaTeX $$ or a ```math fence for a math block;  or  for a video block; a ```poll fence with the question line and "- option" lines, flags multi / anonymous / closed, for a poll people vote on).

POST/api/external/tools/database_admin

Scopes: docs:read, docs:write

Change a database's structure, as you: the same operations as the database grid (op = create_sheet {name, workspace_id}, rename_sheet {name}, add_column {name, type}, rename_column {column_name, new_name}, delete_column {column_name}, and the grid's other ops; pass their fields in fields), plus sharing with an email. Rows: add_database_row / update_database_row / delete_database_row. Actions: - change: Run one grid operation (op, database_id, fields): create_sheet, rename_sheet, add_column, rename_column, delete_column, reorder_columns, update_sheet, update_sheet_labels, update_settings, set_column_required {column_name, required} (a required column must hold a value in every row), import_csv, set_link_access, delete_sheet. Deletes and opening link access wait for approval. (may wait for approval) - shares: Who the database is shared with by email. - share: Share with an email (role, notify). (waits for approval: external) - unshare: Remove an email's access.

POST/api/external/tools/delete_database_row

Scopes: docs:write

Delete one row of a database. Needs the user's approval unless they allowed deletes.

POST/api/external/tools/design

Scopes: docs:read, docs:write

Read and edit design files, as you. Items: pages {t:"page", name, bg, modes: {<collection id>: <mode id>}}, color/text styles {t:"style", kind}, variable collections {t:"vars", name, modes: [{id, name}]}, variables {t:"var", coll, name, type: color|number|string|boolean, values: {<mode id>: value}}, and nodes {t: frame|group|rect|ellipse|polygon|star|path|text|instance|boolean, parent: page or container id, name, x, y, w, h, fills: [{type:"solid", color:"#hex"}], strokes, strokeWidth, effects: [], text nodes {text, style}}. Bind a node property to a variable with bind: {fill|stroke|opacity|radius|strokeWidth|w|h|gap|padding|text|visible|fontSize: <variable id>} (the value is written on save). Frames take layout grids: grids: [{type: columns|rows|grid, count, size, gutter, margin, align: stretch|start|center|end, color, opacity}] and modes like pages. Get a design first to see its pages and node shapes, then add nodes with the same fields. Actions: - list: Designs you can open, newest first. - get: The design: title, your access, and every item as JSON. - create: A new design (title, workspace_id or folder_id), filed in Drive. - rename: Change the title. - add: Add items: a list of objects (an id is made when missing). - update: Change items by id: a list of {id, ...fields to change}. - remove: Remove items by id (ids). Undo is in the editor's history. - replace: Replace the whole design content (content = {items: [...]}). - trash: Move the design to Trash. (waits for approval: delete)

POST/api/external/tools/design_library

Scopes: docs:read, docs:write

Team libraries for design files, as you: publish a design file's components, colour and text styles and variables; use another file's library in a design file (its items are copied in on a hidden page); take newer versions; stop using one (anything still used stays as the file's own). Actions: - list: Libraries you can use: src (the publishing file), name, version, counts, mine. - get: One library's current version (src) with its items. - publish: Publish (or publish the next version of) the design file id; description optional. - unpublish: Unpublish the design file id's library (files using it keep their copies). - use: Make the design file id use the library src (copies its items in). - update: Take the newest version of every library the design file id uses (or only lib, a lib item id). - stop_using: Stop using a library in the design file id (lib = the lib item id from get on the design).

POST/api/external/tools/discussion_actions

Scopes: docs:write

Change comments in an item's discussion, as you: edit your message, resolve or reopen a thread, react with an emoji, delete a message. item = <type>:<id>. Read and post with read_discussion / post_discussion. Actions: - edit: Edit your message (message_id, content). - resolve: Resolve (resolved true) or reopen a thread (thread_root_id). - react: Toggle an emoji reaction (message_id, emoji). - delete: Delete a message (message_id). (waits for approval: delete)

POST/api/external/tools/doc_actions

Scopes: docs:read, docs:write

More doc actions, as you: delete, who wrote each block (blame), polls (results, vote, close), block comments (add, resolve, delete), publish to the web, share with someone by email, and synced blocks. Read and write a doc's text with get_doc / update_doc. Actions: - delete: Delete a doc (to Trash). (waits for approval: delete) - polls: The doc's polls with results: question, options, votes per option, who voted (unless anonymous), your vote, closed. - vote: Vote in a doc poll as you (poll_id from get_doc's ```poll id=..., vote: option numbers from 0; [] withdraws). - close_poll: Close (closed: true) or reopen (closed: false) a doc poll. - blame: Who last changed each block of the doc and when ({blocks: {block_id: {name, user_id, source, at}}}), from its version history. - comments: A doc's block comments, threaded. - comment: Comment on a doc block (doc_id, content, block_id, parent_comment_id to reply). @Claude or an agent handle runs that agent. - resolve_comment: Resolve a block comment (comment_id). - delete_comment: Delete a block comment (comment_id). (waits for approval: delete) - publish: Publish the doc on a public web page (returns its slug). (waits for approval: external) - unpublish: Take the public page down. - shares: Who the doc is shared with by email. - share: Share the doc with an email (role viewer|editor; notify emails them, default true). (waits for approval: external) - unshare: Remove an email's access. - create_synced_block: A synced block (content shown live in several docs): blocks, workspace_id. Insert it in a doc with the returned id. - update_synced_block: Change a synced block everywhere it is shown (block, blocks, rev from its last read).

POST/api/external/tools/get_database_row

Scopes: docs:read

One database row with every column (formulas computed, relations as titles), its notes, and its database. Rows are items too: sheet_row:<id> works with get_properties, set_tags, read_discussion, post_discussion and read_activity.

POST/api/external/tools/get_doc

Scopes: docs:read

Read a doc as markdown-style text, with its word_count, characters and reading_minutes. checklists lists each checklist (2+ items in a row) with its done/total progress and the filter that shows items (all, open, done).

POST/api/external/tools/illustration

Scopes: docs:read, docs:write

Read and edit illustrations (vector artwork on artboards), as you. Same document as design files: artboards are top-level frames on a page; draw with path nodes {t:"path", paths: [{pts: [{x, y, i?: [dx, dy], o?: [dx, dy]}], closed}], fills, strokes, strokeWidth}, shapes and text. Items: pages {t:"page", name, bg, modes: {<collection id>: <mode id>}}, color/text styles {t:"style", kind}, variable collections {t:"vars", name, modes: [{id, name}]}, variables {t:"var", coll, name, type: color|number|string|boolean, values: {<mode id>: value}}, and nodes {t: frame|group|rect|ellipse|polygon|star|path|text|instance|boolean, parent: page or container id, name, x, y, w, h, fills: [{type:"solid", color:"#hex"}], strokes, strokeWidth, effects: [], text nodes {text, style}}. Bind a node property to a variable with bind: {fill|stroke|opacity|radius|strokeWidth|w|h|gap|padding|text|visible|fontSize: <variable id>} (the value is written on save). Frames take layout grids: grids: [{type: columns|rows|grid, count, size, gutter, margin, align: stretch|start|center|end, color, opacity}] and modes like pages. Actions: - list: Illustrations you can open, newest first. - get: The illustration: title, your access, and every item as JSON. - create: A new illustration (title, workspace_id or folder_id), filed in Drive. - rename: Change the title. - add: Add items: a list of objects (an id is made when missing). - update: Change items by id: a list of {id, ...fields to change}. - remove: Remove items by id (ids). Undo is in the editor's history. - replace: Replace the whole illustration content (content = {items: [...]}). - trash: Move the illustration to Trash. (waits for approval: delete)

POST/api/external/tools/images

Scopes: docs:read, docs:write

Layered image projects (the image editor), as you: list, create, open a Drive image for editing, read and change layers (name, visibility, opacity, position, order, text of text layers, remove), versions, and Remove background. Painting, filters and selections are in the editor in the browser. Actions: - list: Image projects you can open, newest first. - get: Size, access, where it sits, the Drive image it came from, and its layers. - create: A blank image: title, width, height, background (default white), workspace_id or folder_id. - open_drive_image: Open a Drive image (drive_file) as a layered project (reuses the one made before). - update_layers: Change layers: layers [{id, name?, visible?, opacity?, x?, y?, w?, h?, blend?, text?, locked?}]. - move_layer: Move a layer (layer_id) to index (0 = bottom) within its group. - remove_layer: Remove a layer (layer_id). (waits for approval: delete) - remove_background: Remove the background of a pixel layer (layer_id): with the user's OpenAI key the result is added as a new layer above (the original is hidden, not lost); without one, the answer explains the in-browser path. (may wait for approval) - rename: Change the title. - move: Move in Drive: workspace_id and/or folder_id. - versions: Earlier saves of the project, and of the Drive image it came from. - restore_version: Make an earlier project save current (version_id), or of the Drive original (original=true). - trash: Move to Drive Trash. (waits for approval: delete)

POST/api/external/tools/list_database_rows

Scopes: docs:read

The columns and rows of a database (sheet). Find databases with list_items types ["sheet"]. Optionally filter rows by text.

POST/api/external/tools/list_docs

Scopes: docs:read

List docs in your workspaces, optionally by project or a text search on title and content.

POST/api/external/tools/list_tags

Scopes: docs:read

Tags, in two separate sets: scope "crm" (people, businesses, deals, conversations, bookings, forms, workflow tag steps) and scope "work" (tasks, projects, docs, files, everything else). The same name can exist in both. No scope = both, each with its scope.

POST/api/external/tools/presentations

Scopes: docs:read, docs:write

Read and build slide decks, as you. Layouts: title, title-content, section, two-content, title-only, blank. A slide from fields: {layout, title, subtitle, body (one line per paragraph, "- " for bullets, indent two spaces per level), notes}. get_slide returns the raw elements (text, image, table) for fine edits with set_elements. Actions: - list: Presentations you can open, newest first. - get: Title, access, theme name and every slide's title, text and notes. - get_slide: One slide (slide_id or slide number) as raw JSON. - create: A new deck: title, slides [{layout, title, subtitle, body, notes}], theme (name), workspace_id or folder_id. - add_slide: Add a slide from fields (fields) at position (1-based; default the end). - update_slide: Change a slide's layout, title, subtitle, body or notes (fields), or hide it (hidden). - set_elements: Replace a slide's elements with raw JSON (elements), for layouts the fields cannot express. - move_slide: Move a slide to position (1-based). - delete_slide: Remove a slide. (waits for approval: delete) - rename: Change the title. - move: Move in Drive: workspace_id and/or folder_id. - versions: Saved .pptx versions (exports, imports). - trash: Move to Drive Trash. (waits for approval: delete) - list_items: A slide's items like the Selection pane: id, kind, name, hidden, locked, group, box (front first). - update_items: Selection pane changes on a slide: items [{id, name, hidden, locked, x, y, w, h}], order (ids front first) to restack. - group: Group items (ids) so they select and move together. - ungroup: Ungroup: every group touching ids comes apart. - set_animations: Replace a slide's animations, in play order: animations [{element (item id), class entrance|emphasis|exit, effect, trigger click|with|after, duration_ms, delay_ms, direction left|right|up|down (fly, float, wipe), repeat}]. Effects: entrance:appear, entrance:fade, entrance:fly, entrance:float, entrance:split, entrance:wipe, entrance:zoom, entrance:growTurn, entrance:bounce, entrance:swivel, emphasis:pulse, emphasis:teeter, emphasis:spin, emphasis:growShrink, emphasis:transparency, exit:disappear, exit:fade, exit:fly, exit:float, exit:split, exit:wipe, exit:zoom, exit:shrinkTurn. Empty list removes them. - set_transition: Set a slide's transition (or every slide's with all_slides): transition {type none|fade|push|wipe|cover|uncover|split|zoom|cut|dissolve, duration_ms, direction (push, wipe, cover, uncover), after_ms (move on by itself), no_click}; null removes it. - add_chart: Add a native chart: chart {type bar|stacked|line|area|stacked-area|pie|doughnut|scatter|radar, title, legend, categories [labels], series [{name, values}]}, optional x/y/w/h (points, slide 960x540). update with element_id to change an existing chart. - add_equation: Add an equation from LaTeX (latex, size), optional x/y; element_id changes an existing one. - add_diagram: Add a SmartArt-style diagram: diagram {type list|process|cycle|hierarchy, text (one line per shape; indent two spaces for a child in a hierarchy)}, optional x/y/w/h; element_id (any shape of it) redraws an existing diagram. - get_master: The slide master: graphics, background, title/body text styles, and per layout its graphics, background, placeholder boxes and hide flag. - set_master: Replace the slide master (same JSON as get_master: {els, bg, title {font,size,color,bold,italic}, body, layouts {<layout>: {els, bg, boxes, hideMaster}}}); null removes it. Slides whose placeholders follow the master move and restyle with it. - set_slide_options: Slide flags: hide_background_graphics (hide the master graphics on this slide). - find: Find text like the editor's find bar: query, match_case, whole_word, include_notes (default true), optional slide / slide_id to look on one slide. Returns each match (slide, item id or notes, table cell, context). - replace_text: Find and replace across the deck (text boxes, shapes, table cells and, unless include_notes is false, speaker notes): query, replacement, match_case, whole_word, optional slide / slide_id. The new text keeps the formatting where each match starts. Returns how many changed.

POST/api/external/tools/query_database

Scopes: docs:read

Answer a question from a database's rows: filter, group, aggregate, sort and limit, computed by the app over the rows the user can see (formula and rollup columns are filled in, relation cells are titles). Returns the result table and the equivalent SQL. Leave out group_by and metrics to list rows; give metrics without group_by for one number; give group_by (plus bucket for a date column) for a breakdown. chart is a display hint for the app (bar for categories, line for time, pie for parts of a whole, table for lists); it does not change the result. Column names must match the database (see list_database_rows).

POST/api/external/tools/spreadsheets

Scopes: docs:read, docs:write

Read and write spreadsheets (the grid editor, not databases), as you. Ranges are A1 notation ("B2", "A1:D20"); sheet is the tab name (default the first). Values are written like typing: numbers, "12%", "$1,200", dates, TRUE/FALSE, and "=SUM(A1:A5)" formulas. read returns computed values, the formulas behind them and the formatted text. Actions: - list: Spreadsheets you can open, newest first. - get: Title, access, sheets with their used ranges, named ranges. - read: Cells in range (default the used range) on sheet: values, formulas, text. - write: Write values (rows: a 2D list) starting at cell (default A1) on sheet. Empty string clears a cell; null leaves it. - format: Style a range: style {b, i, u, fc, bg, fs, ha: left|center|right, nf: number format like "#,##0.00" or "0%", wrap}. - evaluate: Compute a formula against the workbook without saving it (formula, sheet). - create: A new spreadsheet (title, workspace_id or folder_id); rows fills the first sheet. - add_sheet: Add a sheet tab (name). - rename_sheet: Rename a sheet tab (sheet, name). - delete_sheet: Remove a sheet tab and its cells (sheet). (waits for approval: delete) - rename: Change the spreadsheet title. - trash: Move the spreadsheet to Trash. (waits for approval: delete) - conditional_formats: The sheet's conditional formatting rules in priority order (earlier wins), each {id, range, kind, v1, v2, style | scale}. - add_conditional_format: Add a conditional formatting rule on sheet: rule {range (A1), kind: gt|gte|lt|lte|eq|ne|between|notbetween|contains|notcontains|begins|ends|blank|notblank|error|top|bottom|above_avg|below_avg|dup|unique|scale, v1, v2 (between), style {bg, fc (#RRGGBB), b, i, st} or for kind scale: scale {min, mid?, max} colours}. top / bottom take v1 = a count or "10%". - charts: The sheet's charts, each {id, kind, range, title, one_axis, cell (top-left anchor), w, h}. - add_chart: Add a chart on sheet from range (first column = categories, first row = series names): chart {range, kind: bar|stacked|percent-stacked|percent-bar|line|area|stacked-area|percent-area|combo|pie|doughnut|scatter|radar|stock, title?, cell? (anchor, default right of the data), w?, h?, one_axis? (combo: the line shares the left axis)}. combo = columns for every series but the last, which is a line on its own right axis; percent-* = 100% stacks. - set_charts: Replace the sheet's charts with charts (same shape as add_chart plus id; keep ids to keep charts; [] removes them). Use it to change a chart type, range or title, or delete one. - dropdowns: The sheet's in-cell dropdowns (data validation lists): each {id, range, list | source, allow_other, choices}, plus invalid: cells whose entry is not a choice. - set_dropdown: Put an in-cell dropdown on range: list (choices, a list or "a, b, c") or source (a range of cells like F2:F9 or 'Lists'!A2:A20); allow_other true keeps other entries and flags them (default: refused in the editor). remove true takes dropdowns off range. A cell has one dropdown: a new one replaces what was there. - goal_seek: Goal seek on sheet: find the number for changing_cell (a value cell) that makes set_cell (a formula) equal to_value, then write it (one save). dry_run true only reports it. - set_conditional_formats: Replace the sheet's rules with rules (same shape as add; keep ids to keep rules; [] removes them all). Use it to edit, reorder or delete rules.

POST/api/external/tools/update_database_row

Scopes: docs:write

Change cells of one row. Only the columns you pass change.

POST/api/external/tools/update_doc

Scopes: docs:write

Rename a doc, replace its whole content with new markdown, move it into a project (project_id, or null to take it out), and/or turn checklist items into tasks (checklist_to_tasks). The old version is kept in version history.

POST/api/external/tools/whiteboard

Scopes: docs:read, docs:write

Read and draw on whiteboards, as you. Element kinds: rect, ellipse, diamond {stroke, fill, strokeWidth, text}, sticky {fill: yellow|orange|pink|purple|blue|teal|green|gray, text}, text {text, fontSize, color}, pen {points: [[x,y,pressure]]}, arrow / line {start: {x,y,bind?: {id, anchor: center|n|e|s|w}}, end, text}, image {src: a Drive raw path}, card {ref: {type, id}} (a live CTRL item). Every element has x, y, w, h. Colors: ink, gray, red, orange, yellow, green, teal, blue, purple, pink, none. Actions: - list: Whiteboards you can open, newest first. - get: The whiteboard: title, your access, and every element as JSON. - create: A new whiteboard (title, workspace_id or folder_id), filed in Drive. - rename: Change the title. - add: Add elements: a list of objects (an id is made when missing). - update: Change elements by id: a list of {id, ...fields to change}. - remove: Remove elements by id (ids). Undo is in the editor's history. - replace: Replace the whole whiteboard content (content = {elements: [...]}). - trash: Move the whiteboard to Trash. (waits for approval: delete)

POST/api/external/tools/word_docs

Scopes: docs:read, docs:write

Read and write Word documents (.docx), as you: docs made in Plodder (id) or .docx files in Drive (drive_file). Content is simple markdown: # / ## / ### headings, - bullets, 1. numbered lines, > quotes, **bold**, *italic*, [link text](https://...) links. Every save keeps the replaced copy as a version. Actions: - list: Word docs you can open, newest first. - get: Title, access, where it sits, and the document text. - create: A new Word doc: title, content (markdown), workspace_id or folder_id. - append: Add paragraphs (content) at the end. - write: Replace the whole body with content (headers, footers and styles are kept). - replace_text: Replace old_text with new_text where it sits inside one run of text (all=true for every match). - rename: Change the title (Plodder docs). - move: Move in Drive: workspace_id and/or folder_id (Plodder docs). - versions: Earlier saved versions. - restore_version: Make an earlier version current (version_id); what it replaces is kept as a version. - trash: Move to Drive Trash (Plodder docs). (waits for approval: delete)

POST/api/external/tools/get_meeting

Scopes: meetings:read

One meeting: summary, action items, attendees, and the transcript if include_transcript is true.

POST/api/external/tools/list_meetings

Scopes: meetings:read

Recorded meetings with their AI summaries, newest first.

POST/api/external/tools/meetings_admin

Scopes: meetings:read, meetings:write

Make a meeting link (Plodder call, Google Meet or Zoom) for an event, re-run meeting-notes processing on a transcript, and set a recording's client (owner) (/api/meetings/*). Read meetings with list_meetings and get_meeting. Actions: - create_link: A meeting link (topic, start_time, duration, provider default zoom). Invites nobody by itself. - queue_status: Meeting-notes queue (owner). - process: Queue a transcript for meeting-notes processing (transcript_id, mode). Owner. - set_client: Set a recording's client by name (transcript_id, client, null clears). Owner.

POST/api/external/tools/clients_admin

Scopes: crm:read, crm:write

Create and delete client profiles and businesses, and manage a client's businesses, as you (/api/clients, /api/businesses, /api/clients/businesses). Change fields with update_client and update_business; list with list_clients and list_businesses. Actions: - create_client: A new client profile (name, workspace_id?, set?). - delete_client: Delete a client profile. (waits for approval: delete) - create_business: A new business (name, website?, client_id?, workspace_id?, set?). It is backed by a CRM company. - delete_business: Delete a business. (waits for approval: delete) - client_businesses: A client's businesses. - add_client_business: Add a business to a client (client_id, name, website?, set?). - update_client_business: Change one of a client's businesses (business_id, set). - remove_client_business: Delete one of a client's businesses (business_id). (waits for approval: delete)

POST/api/external/tools/crm_assign

Scopes: crm:read, crm:write

Round-robin rules that hand new deals and leads to teammates in turn, as you (/api/crm/assign). Members are team keys (deal_owner values). Actions: - list: Every rule. - save: Create, or change with rule_id: fields = {scope: pipeline|source, pipeline_id?, source_kind? form|booking|any, source_ref?, members: [..], away?: [..], enabled?}. - delete: Delete a rule. (waits for approval: delete)

POST/api/external/tools/crm_bulk_actions

Scopes: crm:read, crm:write, messages:send

Bulk actions on people (CRM > Bulk actions), as you: add / remove a tag, add to / remove from a workflow, email, text or delete a selection, a People filter or a smart list, now, at a set time, or in batches (N people every M minutes), with the log (counts, progress, errors) and pause / resume / cancel. Each person goes through the same rules as the app's own buttons (consent, Do not contact, Mailjet opted-in only, workflow rules, Recently deleted for 30 days). The people are fixed when it is made. Actions: - list: Bulk actions, newest first: kind, label, status (scheduled, running, paused, done, cancelled, failed), total, done, ok, skipped, failed, next batch, errors. - get: One bulk action (bulk_id). - create: kind tag_add | tag_remove | workflow_add | workflow_remove | email | sms | delete | instantly_add; who: contact_ids, filter (People filter) or segment_id; params: { tag } | { workflow_id } | instantly_add { campaign_id, custom? [{ field, as }] } | email { subject, body, via gmail | mailjet, account_id (Gmail), format rich | html | text, from_email?, from_name?, reply_to?, track? } | sms { body }; when now | at | batches, start_at, batch_size, batch_every_min. (may wait for approval) - pause: Stop a running or scheduled bulk action (bulk_id) until resume. - resume: Carry on (bulk_id): the batch that fell due goes now, the spacing after it stays. (may wait for approval) - cancel: Cancel (bulk_id): the people not reached yet are left as they are.

POST/api/external/tools/crm_companies

Scopes: crm:read, crm:write

Create, change, merge and delete CRM companies (businesses), as you (POST/PATCH/DELETE /api/crm/companies), and find them with the relational filter engine (query, filter_fields: deals, people, payments, tags, custom fields). List and read them with crm_list_companies and crm_get_company. Actions: - create: A new company from a domain (domain, optional name, stage_id). You own it. An existing domain returns that company (existed=true). - update: Change fields: fields = {name, stage_id, deal_owner, revenue, hidden, email_sync, notes, client_id, business_id}. - add_domain: Add a domain (value). - remove_domain: Remove a domain (value). - add_email: List a full email address on it (value). - remove_email: Remove a listed address (value). - add_address: An address lists it, a domain adds the domain (value). - enrich: Look its domain up again (name, icon). - refresh: Re-read its recent mail from your connected mailboxes. - merge: Merge company from_id into company_id (from_id is removed). (waits for approval: delete) - delete: Delete the company. (waits for approval: delete) - link_business: Link (or make) the CRM company for a business (business_id). - link_client: Link company_id (or null to unlink) to a client profile (client_id). - convert_to_client: Make company_id a client (optional workspace_id). - mark_churned: Mark company_id churned (PATCH /api/crm/companies/:id { churn }): churned_on (YYYY-MM-DD, default today), optional reason. Its won recurring deals churn from the same day (they stop counting in MRR), unless a deal also covers a business that has not churned. Fires the Client churned workflow trigger. - reactivate: Reactivate a churned company_id: clears the churn and reactivates the deals it churned (back in MRR). Fires Client reactivated. - query: Find businesses with the same engine as the CRM list: filter (the crm_contacts filter schema; field keys from action filter_fields), q (search), owner ("" | none | an owner key), stage ("" | none | open | closed | a stage id), activity (followup | recent), hidden (only | include), columns (field keys to return per row), sort (a field key) + dir, limit (<= 500), offset. Returns total and rows {id, name, values}. - filter_fields: Every business filter field and column (key, label, group, type, operators, options with their values), incl. custom fields f:<id> and the people fields p:<key> (a business matches when any of its people does).

POST/api/external/tools/crm_contacts

Scopes: crm:read, crm:write

Create, change, merge and delete people in the CRM, set do-not-contact flags and lead source, find duplicates, and SEARCH people with the smart-list filter engine (the People list, segments, smart lists and workflow filters run the same SQL), as you (/api/crm/contacts, /api/crm/contacts/query, /api/crm/duplicates). Filter schema: filter = { mode: "and"|"or", items: [ { field, op, value? } | a nested group (one level) ] }. field = a key from action filter_fields (contact info, tags, custom fields f:<id>, source / UTM, consent, SMS, email, calls, conversations, pipelines, calendars, forms, workflows, speed to lead, payments, business, activity). op by type: text contains|not_contains|is|is_not|empty|not_empty; number / money eq|ne|gt|gte|lt|lte|empty|not_empty; date last_days|older_days|next_days (value = days)|before|after|on (value = YYYY-MM-DD)|empty|not_empty; select / multi / person any|none|all|empty|not_empty (value = array of option values from filter_fields); bool true|false. Related-record fields (deal stage, workflow, form, calendar...) mean "has one that matches" for any and "has none that matches" for none. Actions: - search: People matching a filter (filter, q, owner, columns = extra field keys to return, sort = a field key, dir asc|desc, limit <= 500, offset). Returns total + the page. - filter_fields: Every people filter field (key, label, group, type, operators, options with their values) and the GHL filters that are not available. - get: One person with company, consent and lead source. - create: A new person (email, optional name, title, company_id). You own them; lead source "manual". - update: fields = {name, title, phone, notes, hidden, deal_owner, lead_source, lead_medium, lead_campaign, dnc_email, dnc_sms, dnc_call, unsubscribed, consent_reason, address_street, address_city, address_region, address_postal, address_country, timezone (IANA, like America/Vancouver: texting hours, pathways and the dialer use it), birthday (YYYY-MM-DD, or MM-DD with no year: the Birthday trigger reads it), website, email_label, phone_label}. - channels: Every email and phone of a person (contact_id), primary first, with labels. Sends use the primary; matching (forms, texts, payments, leads, replies), search, filters and duplicates use them all. - add_channel: Add an email or phone: contact_id, channel (email|phone), value, label (work|home|mobile|personal|other or your own), primary (true = make it the primary now). A person with no real primary gets it as the primary. A value another person has is refused (merge them instead). - remove_channel: Remove an email or phone (contact_id, channel, value). Removing the primary promotes the next one; their only email stays (change it instead). - make_primary: Make one of their emails or phones the primary (contact_id, channel, value); the old primary becomes an extra. - label_channel: Label an email or phone (contact_id, channel, value, label; empty clears). - matches: What is tied to a person (contact_id) through any of their emails: bookings (invitee email), payments (with the buyer email the provider gave) and payment customer records. Payments and closing calls (commissions) match by these emails. - changes: The change log of a person (contact_id): who changed which field, old -> new, when (90 days, newest first). field (e.g. email, timezone, f:<custom field id>, tags) and limit (<= 500) optional. - set_consent: Do-not-contact flags for one or many people: contact_ids + fields {dnc_email?, dnc_sms?, dnc_call?, unsubscribed?, consent_reason?}. - delete: Delete the person. They go to Recently deleted for 30 days (restore brings them back with their deals, tags, fields and timeline); their workflow runs end. Returns batch. (waits for approval: delete) - delete_many: Delete several people (contact_ids, at most 500) to Recently deleted. Returns batch: restore with that batch undoes it. (waits for approval: delete) - deleted: Recently deleted (last 30 days): people (id, name, email, deleted_at, deleted_by, days_left) and deals. q filters by name / email / title. - restore: Restore deleted people: contact_ids, or batch (from a delete). Someone added again with the same email at the same business since is not restored (the reason says so). - duplicates: Groups of companies or people that look like duplicates. - merge: Merge duplicates: kind company|person, into (kept), from (ids that go away, max 50). A person merged from another company keeps that company as one of their businesses. (waits for approval: delete) - businesses: Every business the person is part of (primary first, with their role there). - add_business: Add the person to a business (company_id, optional role). Their primary stays. - remove_business: Take the person out of a business (company_id). Not their primary: set another primary first. Their deals stay theirs (the business stays on them as recorded). - set_primary_business: Make one business (company_id) their primary; the old primary stays one of their businesses. - set_business_role: Their role at a business (company_id, role; empty clears).

POST/api/external/tools/crm_data

Scopes: crm:read, crm:write

Bulk edits, CSV import, sync from email, the company stages and the team activity report, as you (/api/crm/bulk, import, sync, settings, report). Actions: - bulk_edit: Set the same fields on many records: object people|deals|companies, ids, set = {field: value}. People: lead_source, lead_medium, lead_campaign, title, deal_owner, dnc_email, dnc_sms, dnc_call, unsubscribed, consent_reason. Deals: deal_owner, stage_id, status, lost_reason, close_date, source, probability, pipeline_id, recurring, currency. Companies: deal_owner, stage_id. Tags and custom fields: set_property. - import_preview: Plan a CSV import without saving: object companies|people|deals, csv, mapping? (one field key per column, "" skips), dedupe? skip|update|create. Shows the auto mapping and the first 50 rows. - import_run: Run the import (same inputs as import_preview). Max 5,000 rows, 5 MB. - sync_status: Email sync state per mailbox. - sync: Sync from email now (runs about 25 s, call again while a backfill is going). - settings: Company stages, closed and won stages, the workspace currency (settings.currency), the unknown-number lead setting and the speed to lead steps. - save_settings: Save stages: stages = [{id?, label, color}], closed_stage_ids?, won_stage_id? (max 50 stages); and / or unknown_number_lead = {on, pipeline_id, stage_id?} | null (texts / calls from unknown numbers make a lead); and / or speed_to_lead = {amber_min, red_min} | null (minutes before a waiting lead turns amber / red and alerts its owner; null = 5 / 15); and / or currency = USD | CAD | EUR | GBP | AUD | NZD | MXN | null (workspace currency: new deals and payments without one start in it, Reports show totals in it; null = USD). - report: Activity per teammate (calls, texts, emails, meetings, deals) for from..to (epoch s, default last 30 days, max 400). The workspace owner sees everyone.

POST/api/external/tools/crm_deals

Scopes: crm:read, crm:write

Deals in the CRM pipelines, as you (/api/crm/deals). Deals belong to people: every deal has a contact_id. One deal can cover several of their businesses: company_ids (primary first; company_id = the primary). Values are integer cents. Status follows the stage (the won stage = won). Pipelines and stages come from crm_pipelines. Actions: - list: Deals, optionally by pipeline_id, pipeline_kind (leads|sales: every pipeline of that kind), company_id (deals that cover that business), contact_id, person_id (their deals, plus older deals with no person at their businesses), status (open|won|lost|abandoned), waiting (true = open leads no person has texted, called or emailed yet), with the open forecast. Each deal has speed to lead: lead_started_at, first_response_at, first_response_channel (sms|call|email|logged_call), speed_to_lead_seconds, waiting. - speed_to_lead: Speed to lead numbers: leads that started in from..to (epoch s, default the last 24 h), scope me|team (default team), optional pipeline_id. Returns summary {leads, responded, waiting, median_seconds, avg_seconds, under_amber, under_amber_pct, oldest_waiting_seconds}, the same for every waiting lead, and thresholds {amber_min, red_min}. Only a person's own text, call, email or logged call counts as a response; workflows, notifications, agents (you), API sends and bulk sends never do. - get: One deal with its line items and stage history. - create: A new deal: fields = {title, value_cents, currency, recurring, close_date, probability, pipeline_id, stage_id, status, lost_reason, deal_owner, company_id, company_ids, contact_id, source, value_from_lines, notes}. You own it unless deal_owner is set. A deal belongs to a person: contact_id is required. company_ids = every business the deal covers, primary first ([] = none); company_id = one business; neither = all of the person's businesses. A business they are not part of adds them to it. - update: Change a deal: fields as in create (moving stage_id moves status; status won|lost moves the stage; status abandoned sets it aside in its stage, out of the open forecast, until it moves or is reopened with status open). contact_id cannot be cleared; company_ids replaces the business list (company_id = just that one; null or [] = no business). - set_lines: Replace every line item: lines = [{product_id?, name?, qty?, price_cents?, discount_pct?, recurring?}]. - delete: Delete the deal. It stays in Recently deleted for 30 days (restore puts it back). (waits for approval: delete) - deleted: Deals deleted in the last 30 days (merged ones are not listed). q filters by title. - restore: Restore deleted deals: deal_ids. Merged deals and deals whose pipeline was deleted are refused (the reason says so). - merge: Fold deal_id into into_id (kept): notes, line items, history, tasks, links, tags and fields move; deal_id is removed. (waits for approval: delete) - mark_churned: Mark a won recurring deal_id churned (PATCH /api/crm/deals/:id { churn }): churned_on (YYYY-MM-DD, default today), optional reason. It stops counting in MRR from that day. One-time deals are refused. Its business is not churned. - reactivate: Reactivate a churned deal_id (back in MRR). - query: Find deals with the same engine as the CRM list: filter (the crm_contacts filter schema; field keys from action filter_fields), q (search), owner ("" | none | an owner key), pipeline (id, blank = every pipeline), status (open | won | lost; leave it out for all), stage (a stage id), columns (field keys to return per row), sort (a field key) + dir, limit (<= 500), offset. Returns total and rows {id, name, values}. - filter_fields: Every deal filter field and column (key, label, group, type, operators, options with their values), incl. custom fields f:<id> and the person fields p:<key> (the deal's person: tags, texts, calls, bookings, forms, workflows, payments...).

POST/api/external/tools/crm_field_categories

Scopes: crm:read, crm:write

Custom field categories on CRM records (the field cards on person, business and deal pages, like a Forms card), as you: list (entity_type crm_contact | crm_company | crm_deal) gives the categories in order and which field (property definition id) sits in which; create, rename, reorder, delete (its fields go back to General), and place_field to move a field into a category (category_id null = General). Actions: - list: Categories and field placements (entity_type, default crm_contact). - create: New category (name, entity_type?). - rename: Rename (category_id, name). - reorder: Order the categories (order: ids first to last). - place_field: Put a field in a category (definition_id, category_id or null for General, sort_order?). - delete: Delete a category (category_id); its fields go back to General. (waits for approval: delete)

POST/api/external/tools/crm_forecast

Scopes: crm:read, crm:write

The deal forecast (CRM > Deals > Forecast): open deals by expected close month or quarter as commit (win chance >= commit_min), best case (>= best_min, commit included) and pipeline (every open deal), weighted by win chance (the deal's own, else its stage's), what was won per period, by pipeline or owner, and the deals that need attention: past due (close date passed, still open), stale (no change for stale_days), at risk (stale or past due; high = both), missing close date or value. One currency at a time (the most used, or currency). Leads pipelines are left out unless pipeline = all or a leads pipeline id. Actions: - get: The forecast: period (month | quarter), periods (1-12), group (none | pipeline | owner), pipeline (id, sales = every sales pipeline, all), owner (teammate key | none), currency, tz. - settings: The forecast rules: commit_min, best_min (win chance %), stale_days. - set_settings: Change the rules: commit_min?, best_min? (<= commit_min), stale_days?.

POST/api/external/tools/crm_get_company

Scopes: crm:read

One CRM company with its contacts.

POST/api/external/tools/crm_list_companies

Scopes: crm:read

Companies in your CRM (built from your email), with stage and deal owner.

POST/api/external/tools/crm_list_contacts

Scopes: crm:read

People in your CRM, optionally for one company or matching text.

POST/api/external/tools/crm_objects

Scopes: crm:read, crm:write

Custom objects (CRM > Objects), GHL style: your own record types next to people, businesses and deals (Properties, Vehicles, Policies...). A type has a name, plural, icon, fields (data_type: string, long_text, number, currency, percent, date, boolean, select, multi_select, email, phone, url, person) and link labels. Records have a name, owner (teammate key), notes and values ({ field key | field id | field name: value }; selects take option labels or ids; null clears). Records link many-to-many (with a label) to people (contact), businesses (company), deals (deal) and other records (object). query takes the CRM smart-list filter { mode: "and" | "or", items: [{ field, op, value }] } where field = name, owner, created_at, updated_at, people, businesses, deals, people_count, businesses_count, deals_count, records_count, assoc_label or f:<field id>. Creating / changing a record fires the Object record created / changed workflow triggers and the object.* webhooks. Actions: - list_types: Every object type with its fields (id, key, data_type, options) and record count. - get_type: One type (type_id) with its smart lists. - create_type: New type: name, plural?, icon?, description?, labels? (link labels), fields? [{ name, data_type, options?, required? }]. - update_type: Change a type (type_id): name, plural, icon, description, labels. - delete_type: Delete a type and all its records (type_id). (waits for approval: delete) - add_field: Add a field (type_id, name, data_type, options?, required?). - update_field: Rename a field, change its options or required (field_id, name?, options?, required?, sort_order?). A field keeps its type. - delete_field: Delete a field and its values (field_id). (waits for approval: delete) - query: Records of a type (type_id): filter?, q?, owner?, sort? (name, created_at, updated_at, f:<id>, people_count...), dir?, limit? (<= 1000), offset?. Returns records with values by field id and linked names. - get: One record (record_id) with its type and every link. - create: New record: type_id, name, values?, owner?, notes?, associations? [{ target_type, target_id, label? }]. - update: Change a record (record_id): name?, values? (merged), owner?, notes?. - delete: Delete a record (record_id). (waits for approval: delete) - associate: Link a record (record_id) to target_type contact | company | deal | object, target_id, label?. Again = changes the label. - unassociate: Remove a link: association_id, or record_id + target_type + target_id. - related: Records linked to a person / business / deal / record (target_type, target_id), grouped by type. - import: Import CSV text into a type (type_id, csv, mapping? { header: name | owner | notes | f:<id> | person_email | business_domain | "" }, update_existing? default true, label?). - views: Smart lists of a type (type_id) with live counts. - save_view: Save a smart list (type_id, name, config { filter, q?, owner?, sort?, dir? }); with view_id it updates that one. - delete_view: Delete a smart list (view_id). Records stay.

POST/api/external/tools/crm_pipelines

Scopes: crm:read, crm:write

Deal pipelines and their stages, as you (/api/crm/pipelines). Pipeline 0 is the default one (its stages are the company stages, always kind sales). A stage is {id?, label, color?, probability?}. LEADS ARE DEALS (GHL style): a pipeline is kind leads or sales; a leads pipeline's won_handoff {mode: move|create, pipeline_id, stage_id?} runs when a deal enters its won stage (move = the same deal goes to that pipeline + stage with its history; create = a new linked deal there). One open deal per person per pipeline for leads made by forms, calendars and unknown numbers (forms tool op lead_pipeline, calendars tool set_lead_pipeline, set_unknown_number_lead here). A workflow with Create / update deal can do the same. Actions: - list: Every pipeline with its stages, kind and won_handoff. - create: A new pipeline (name, kind leads|sales default sales, optional stages: leads start New, Contacted, Qualified, Booked, Won (handed off), Lost; optional won_handoff). - update: Change a pipeline: pipeline_id + any of name, stages, closed_stage_ids, won_stage_id, kind, won_handoff (null clears), access, card_fields. - set_access: Who can see a pipeline and its deals (pipeline_id, access = {mode: everyone | users | owner, users: team member keys, agent ids ai-<id>, or "api" for API keys}). owner = only the CRM owner signed in; agents and API keys do not see it. Lists, boards, filters, reports, the API and agents follow it. - set_card_fields: The fields its board cards show (pipeline_id, card_fields = up to 4 of value, win_chance, close_date, days_in_stage, source, person, business, owner, created, recurring, phone, f:<deal custom field id>; null = the standard card). - copy: Copy a pipeline (pipeline_id, name optional): the same stages, closed / won stages, kind, access and card fields; no deals and no automations. - reorder: New order: ids = every pipeline id (0 included). - delete: Delete a pipeline; its deals move to move_to (default 0). (waits for approval: delete) - unknown_number_lead: The setting "New texts / calls from unknown numbers create a lead": {on, pipeline_id, stage_id} or null. - set_unknown_number_lead: Set it: setting = {on, pipeline_id, stage_id?} or null to clear.

POST/api/external/tools/crm_products

Scopes: crm:read, crm:write

The product list deal line items pick from, as you (/api/crm/products). Prices are integer cents. Actions: - list: Products (include_archived to see archived ones). - save: Create a product, or change one with product_id: fields = {name, description?, price_cents, currency?, recurring? none|monthly|yearly, archived?}. Archive instead of deleting.

POST/api/external/tools/crm_tasks

Scopes: crm:read, crm:write

CRM tasks are normal tasks linked to a deal, person or company. Make the task with create_task, then link it here (/api/crm/tasks). Actions: - mine: Open tasks assigned to you that are linked to a CRM record, by due date. - link: Link task_id to records: links = [{type: crm_deal|crm_contact|crm_company, id}], remind_at? (epoch s, null clears).

POST/api/external/tools/crm_update_company

Scopes: crm:write

Change a CRM company: name, stage, revenue, notes, or hide it.

POST/api/external/tools/crm_update_contact

Scopes: crm:write

Change a CRM contact: name, title, phone or notes.

POST/api/external/tools/crm_views

Scopes: crm:read, crm:write

Saved CRM views (companies, people or pipeline, with filters in config) and segments (views with config.segment = true, the audiences for crm_send), and SMART LISTS (views with config.segment = true and config.smart = true: people lists use config.filter = the crm_contacts filter schema, config.psort / pdir = sort field key and direction; businesses (kind companies) and deals (kind pipeline) lists use config.filter with the crm_companies / crm_deals filter_fields keys, config.xsort / xdir, and for deals config.pipeline + config.status; list columns are each person's own setting, not part of the list), as you (/api/crm/views, /api/crm/segments, /api/crm/smart-lists). Actions: - list: Saved views. - segments: Segments with live counts. - smart_lists: Smart lists (people, businesses, deals) with live counts and their kind, and the starter lists you can add. - add_starters: Make starter smart lists (keys, default all): no_open_30, no_phone, textable, no_showed, upcoming_week, waiting_reply, unworked_7, clients, dnd. Already made ones are returned, not duplicated. - tag_list: Add (or with remove: true, take off) a CRM tag on everyone in a smart list (view_id, tag). - segment_people: Who is in a segment right now (view_id). - create: A new view: name, kind companies|people|pipeline, config (filters, columns, sort; segment: true makes it a segment). - update: Change a view (view_id, name?, config?). - set_consent: A smart list / segment's consent basis (view_id, consent: opt_in | customers | cold | not_set). Cold lists are refused by Mailjet bulk sends, and people added to a workflow from one skip its Mailjet marketing steps (Gmail one to one only). - delete: Delete a view. (waits for approval: delete)

POST/api/external/tools/get_business

Scopes: crm:read

One business profile: context, offer, audience, location, budgets, channels.

POST/api/external/tools/get_client

Scopes: crm:read

One client profile (context, goals, offer, audience, channels) and its businesses.

POST/api/external/tools/list_businesses

Scopes: crm:read

Businesses (a client can have several) in your workspaces.

POST/api/external/tools/list_clients

Scopes: crm:read

Clients in your workspaces with their status and industry: the Clients roster with its search, filters and sort (D 10-09).

POST/api/external/tools/meta

Scopes: crm:read, crm:write

Meta lead ads, Messenger / Instagram DMs and comments, Conversions API and Custom Audiences, as you. Pages the connected token reaches (with the linked Instagram account), which of leads / messages / comments each page sends here (turning any on subscribes the page to the Plodder app), lead forms with their field mapping (question key -> a target: email | phone | name | first_name | last_name | title | extra_email | extra_phone | website | timezone | birthday | notes | address_street | address_city | address_region | address_postal | address_country | business_name (find or make the business by name, link the person) | business_website | business_phone | deal_value | deal_title (lead pipeline on) | f:<person custom field id> | b:<business custom field id> | skip), answer rules per question (an answer is / contains a value -> add tags and / or move the lead deal to a stage), the workspace default mapping (question key / label patterns, applied to newly found forms), a Test lead dry run, and the lead pipeline ({ on, pipeline_id, stage_id?, title? }: every lead makes a deal there and starts the speed to lead clock), recent leads, the ad account for Custom Audiences, and the Conversions API pixel per workspace (workspace_id 0 = default). Workflows use the Facebook lead form submitted, Facebook / Instagram comment and DM received triggers and the Send Meta conversion, Meta audience and Send FB/IG DM steps (crm_automations). Actions: - status: Connection, pages, lead forms (questions, mapping, pipeline, on), Conversions API settings, the last 10 leads, the webhook URL. - leads: Recent leads (limit?): form, campaign, ad set, ad, person, deal, status (done | failed | skipped), via (webhook | poll). - ad_accounts: Ad accounts the token reaches. - audiences: Customer list Custom Audiences of the picked ad account. - available_pages: Facebook Pages the connected account reaches: picked (in this CRM), elsewhere (another Plodder account has it). No tokens. - sync: Re-read the pages the token manages (and the forms of pages with leads on). - sync_forms: Re-read one page's lead forms (page_id). - poll: Check every live lead form for leads the webhook missed (each lead lands once). - pick_pages: Keep exactly these Pages (page_ids, from available_pages) after Continue with Facebook: picked ones are added with switches off, the rest are unsubscribed and removed. - check_health: Check the Meta token and every page now: health (ok | expiring | missing | broken), expiry, missing permissions, still subscribed. Status shows the last check; a daily job alerts the owner. - set_page: Turn a page's leads_on / messages_on / comments_on on or off (page_id). Any on subscribes the page to the Plodder Meta app; all off unsubscribes it. - set_form: A lead form (form_id): on?, mapping? ({ question key: target }), rules? ({ question key: [{ op: is | contains, value, tags: [], stage_id? }] }, null clears), lead_pipeline? (object or null). Status lists each form's questions (with multiple-choice options), its unmapped count (questions added after the last save) and the targets (custom fields as f:<id> / b:<id>). - default_mapping: The workspace default lead form mapping: rules [{ by: key | label, pattern (* wildcard; label = contains), target }], auto (apply to newly found forms). - set_default_mapping: Save the default mapping: rules?, auto?, apply_now? (also fill forms whose mapping was never saved). - copy_mapping: Copy the targets and answer rules of another form (from_form_id) onto form_id: same question key, else the same label. - new_field: Make a person custom field from a question (form_id, question_key, name?, type? text | number | date | select (select gets the question choices), category_id? = a person field card) and map the question to it. - test_lead: Dry run (nothing saved, Meta not called): a fake lead (sample answers, or answers { question key: value }, platform? facebook | instagram) through the form's mapping, rules and pipeline. Returns the person (found or new, built-ins, extra emails / phones, notes, custom fields), the business (link or create), tags, the deal (pipeline, stage, title, value), the attribution and warnings. - set_ad_account: The ad account for Custom Audiences (ad_account_id, act_123...; empty clears). - set_capi: Conversions API for a workspace (workspace_id?, 0 = default): pixel_id (dataset id), test_event_code (empty clears). The access token is set in Settings by a person.

POST/api/external/tools/update_business

Scopes: crm:write

Update fields on a business profile. Only the fields you pass change.

POST/api/external/tools/update_client

Scopes: crm:write

Update fields on a client profile. Only the fields you pass change.

POST/api/external/tools/booking_links

Scopes: bookings:read, bookings:write

Create and edit booking (scheduling) pages people outside the app use to book time on the owner's calendar. A page is public, so creating one or turning one on waits for approval. List them with list_booking_links. Settings go in `fields` with the app's names: name, slug, page_title, page_intro, calendar_title_template, durations [min], slot_interval, custom_hours, daily_limit, start_delay_days, one_time, buffer_before, buffer_after, questions, reminder_minutes, reminder_method (popup|email), booking_mode (single|round_robin|collective|group), round_robin_strategy, capacity, max_days_ahead, timezone, location_type (none|google_meet|zoom|phone|custom|ctrlflow), location_value, cancel_cutoff_minutes, reschedule_cutoff_minutes, min_notice_minutes, phone_field (off|optional|required), notifications, theme, settings (calendar settings, see the calendars tool set_settings), active, hosts [{team_member_id|google_account_id|calendar_id, hours?}]. Per-host hours, date overrides, holidays, notification content, the look and bookings: the calendars tool. Actions: - get: One page with all its settings and hosts. - create: A new page (fields.name required; slug optional, random when left out). (waits for approval: external) - update: Change settings (link_id, fields). Turning it on or changing its link waits for approval. (may wait for approval) - delete: Delete a page. (waits for approval: delete)

POST/api/external/tools/calendar_events

Scopes: bookings:read, bookings:write

More on the owner's Google calendar: search events, the full create (repeat rules, out of office, visibility, travel time, which calendar, project), change a repeat rule, move an event, and sync now. Basic create/update/delete: create_calendar_event, update_calendar_event, delete_calendar_event. Actions: - search: Find events by words (mode title | description | exact). - create: Create an event with any field. Guests get invitations, so with guests it waits for approval. (may wait for approval) - set_recurrence: Set or clear the repeat rule on an event (whole series). Google emails guests about it, so an event with guests waits for approval. (may wait for approval) - move: Move an event to new_start / new_end (ISO). notify_guests emails the guests, so it waits for approval. (may wait for approval) - sync: Pull every connected Google calendar now (and the calendar sync links).

POST/api/external/tools/calendar_ooo

Scopes: bookings:read, bookings:write

Out of office: your auto-decline settings, marking yourself away (shows in Team out of office), and who on the team is away. For an out-of-office event on the Google calendar, use calendar_events create with busy_status out_of_office. Actions: - get: Your out-of-office settings and your upcoming away periods. - team: Who is away between start and end (default last 7 days to next 30). - settings: auto_decline (all | new | none), message, show_team. - add: Mark yourself away: start, end, title, all_day. - remove: Remove one of your away periods (ooo_id; the owner can remove anyone's). (waits for approval: delete)

POST/api/external/tools/calendar_sync_links

Scopes: bookings:read, bookings:write

Copy busy time between two connected Google calendars from different accounts (one-way or two-way), so each calendar shows the other's events. Actions: - list: Every sync link with its last sync and error. - create: Link source_calendar_id to destination_calendar_id (direction one_way | two_way). It syncs right away. - update: Turn a link on or off (enabled) or change direction. - delete: Remove a link. (waits for approval: delete) - sync_now: Sync one link now.

POST/api/external/tools/calendars

Scopes: bookings:read, bookings:write

Booking calendars in Automations > Calendars, beyond the page settings (create, rename, durations, hosts, type and limits are the booking_links tool). Types (booking_links booking_mode): single = personal, round_robin, collective (every host free), group = class or event (capacity seats). Open times come from, most specific first: a date override for a host, a date override for the calendar (holidays included), the host's own weekly hours, the calendar's weekly hours (custom_hours), the host's work schedule; minus their Google busy times and their other bookings. Weekly hours look like {"1":[{"start":"09:00","end":"17:00"}]} (0 = Sunday). Notification content uses custom values ({{contact.first_name}}, {{booking.start}}, {{booking.location}}, {{calendar.name}}, {{booking.reschedule_url}} in the confirmation). Text messages go only to guests who ticked "Text me" and respect STOP and Do not text. Actions: - list: Every calendar with type, hosts, bookings this week and upcoming. - get: One calendar: settings, hosts with their own hours, upcoming date overrides, notifications, look, public URL (calendar_id). - availability: Open times on a date as the public page shows them (calendar_id, date YYYY-MM-DD, duration?, exclude_booking_id? when moving one). - set_host_hours: A host's own weekly hours on this calendar (calendar_id, team_member_id, hours: object, or null to follow the calendar). - set_override: Close a date or give it custom hours, for the calendar or one host (calendar_id, date, closed?, hours? [{start,end}], team_member_id?, label?). Replaces that date. - delete_override: Remove a date override (calendar_id, override_id). (waits for approval: delete) - add_holidays: Close a year's public holidays (calendar_id, region us|ca, year?). - get_notifications: The notification matrix (calendar_id): events confirm (Booked, unconfirmed), confirmed (Booked, confirmed), reschedule, cancel, reminders[], follow_up; channels email + sms (guest) and in_app (the host's app notification), each {on, subject, body}; per event team_copy (host heads-up email). WhatsApp: no sender yet, never sent. - set_notifications: Change the matrix, merged over what is saved (calendar_id, notifications: { confirm|confirmed|reschedule|cancel: { email|sms|in_app: {on, subject, body}, team_copy }, reminders: [{ minutes, email, sms, in_app }], follow_up: { minutes after the end, after showed|any, email, sms, in_app }, reply_to }). Each cell sends once per booking. (waits for approval: external) - get_settings: The calendar settings (GHL parity): booking form, widget order, sticky contacts, prefill, consent box, guests, confirmation page, Meta pixel / Google tag, auto-confirm, payments (stored, no provider yet), owner assignment, guest cancel / reschedule policy, Google invite emails, invite notes. Plus payment_provider and form_problem (calendar_id). - set_settings: Change calendar settings, merged (calendar_id, settings). settings = { form_id (a form with its public link on, no screener or booking steps; null = default form), widget_order time_first|form_first, sticky_contacts, prefill_from_url, consent {on, required, text}, guests {on, max 1-10}, confirmation {mode message|redirect, message (custom values: {{contact.first_name}}, {{booking.start}}, {{calendar.name}}), redirect_url https, append_params}, tracking {meta_pixel_id, google_tag_id}, auto_confirm, payments {on, amount, currency, collect full|deposit, deposit_amount, hold_minutes 30-1440} (charged at booking through Stripe Checkout once Stripe is connected; on stays off while it is not), assign_owner {on, skip_if_assigned}, policy {allow_reschedule, allow_cancel} (cut-offs: cancel_cutoff_minutes / reschedule_cutoff_minutes), send_invites (Google invite + update emails to attendees), invite_notes {on, template with {{contact.phone}} {{contact.email}} {{reschedule_link}} {{cancellation_link}}}, recurring {on, frequencies [weekly, biweekly, monthly], max_count 2-52, allow_until} (guests may book a repeating series; each occurrence is its own booking; off while payments are on) }. Merged over what is saved. (waits for approval: external) - get_theme: The calendar's public page look (calendar_id). - set_theme: Change the public page look, merged (calendar_id, theme: { only the keys to change }), or theme null for the workspace default. Theme keys: mode light|dark|custom, background #hex (page colour in custom mode), brand #hex, text #hex or "" (auto), font system|inter|dm-sans|manrope|plus-jakarta|work-sans|lora|merriweather, heading_font "" (same as font) or a font key, radius sharp|soft|round, button filled|outline, button_text #hex or "" (auto), button_label up to 40 characters or "" (default label), button_shape auto (follows radius)|square|pill, button_width auto|full, button_size s|m|l, field_style outlined|filled|underline, field_bg / field_border / label_color #hex or "" (auto), show_card true|false, card_bg #hex or "" (auto), card_width auto|narrow|medium|wide, card_shadow none|soft|strong, card_border true|false, text_size s|m|l, align left|center (header and intro), page_fill solid|gradient, gradient_from / gradient_to #hex or "" (auto), gradient_angle 0-360, page_image / logo_url / cover_url (https or /uploads/ path, "" for none), page_overlay 0-80 (darkens page_image), logo_size s|m|l, logo_position left|center; forms: form_layout page|one, progress none|bar|steps, question_numbers true|false, required_color red|brand; calendars: booking_layout month|list, show_host true|false, slot_style outline|filled. A bad value is ignored and the current one stays. (waits for approval: external) - bookings: Bookings on a calendar with appt_status and needs_status (calendar_id, scope upcoming|past|cancelled|needs). - notices: What was sent for one booking (calendar_id, booking_id). - cancel_booking: Cancel a booking: removes the calendar event and sends the cancel notice (calendar_id, booking_id). (waits for approval: send email) - reschedule_booking: Move a booking to an open time on the same calendar (calendar_id, booking_id, start YYYY-MM-DDTHH:MM). (waits for approval: send email) - book: Book a time on a calendar for someone, once or repeating (calendar_id, name, email, phone?, start and end as the availability slots give them, notes?, recurrence? { frequency weekly|biweekly|monthly, count 2-52 | until YYYY-MM-DD } when the calendar recurring setting is on, skip_conflicts? to book the open dates when some are taken; without it a series with taken dates answers needs_confirm + conflicts). Same path as the public page: calendar event, CRM person, notices. (waits for approval: send email) - series: The repeating series a booking belongs to: how often, how many, and every booking in it with its status (calendar_id, booking_id). - cancel_series: Cancel a repeating booking: this one, this and the following ones, or every upcoming one (calendar_id, booking_id, series_scope this|following|all). One cancel notice goes to the guest. (waits for approval: send email) - external_calendars: Your Outlook / iCloud calendar accounts (each person connects their own in Settings > Calendars): which calendars block booking times (busy), which one gets booking events (write), and the status (ok, reconnect, error). - set_external_calendars: Pick an Outlook / iCloud account's busy calendars (busy: calendar ids) and the calendar booking events are written to (write: a calendar id, or null for none) (connection_id). - check_external_calendar: Read an Outlook / iCloud account again: refresh the token and its calendars, set the status (connection_id). - disconnect_external_calendar: Forget an Outlook / iCloud account (connection_id). Events already written stay on that calendar. (waits for approval: delete) - move_series: Move a repeating booking: this one, this and the following ones, or every upcoming one, each by the same amount as this one moves (calendar_id, booking_id, series_scope, start YYYY-MM-DDTHH:MM). Dates whose new time is taken stay and are listed in failed. (waits for approval: send email) - get_lead_pipeline: The calendar's CRM lead setting (calendar_id): {on, pipeline_id, stage_id, booked_stage_id, showed_stage_id, no_show_stage_id} or null. - set_lead_pipeline: Lead pipelines (calendar_id, setting = {on, pipeline_id, stage_id?, booked_stage_id?, showed_stage_id?, no_show_stage_id?} or null): on = a booking finds or makes the person and adds a deal in that CRM pipeline at stage_id, or, when they already have an open deal there, moves it to booked_stage_id (if set) and logs the booking. showed / no-show marks move it to those stages. One open deal per person per pipeline. A workflow with Create / update deal can do the same. - set_outcome: Mark a booking showed or no_show (or null to clear); fires the Showed / No-show workflow triggers (calendar_id, booking_id, outcome). (waits for approval: send email) - get_booking_status: One booking with its status (booked, confirmed, showed, no_show, cancelled, invalid), needs_status (ended and still booked / confirmed), calendar, guest, answers, source, and its status history incl. Rescheduled markers (booking_id; calendar_id optional). - set_booking_status: Set a booking's status (booking_id, status booked|confirmed|showed|no_show|cancelled|invalid, note?). The same path as the app: fires the status trigger (Appointment confirmed / showed / no-show / cancelled / invalid) and Appointment status changed once; cancelled removes the calendar event and sends the calendar's cancel notice; showed / no-show move the calendar's lead deal. A cancelled booking cannot be reopened. (waits for approval: send email) - needs_status: Past bookings still Booked / Confirmed (the meeting ended with no outcome), newest first (calendar_id optional). - event_crm: A calendar event's CRM links (people, businesses, deals, the client pages it shows on), its booking + status when it is one of our bookings, and guest suggestions matched by email (event_id, event_calendar_id?). - link_event: Link a calendar event to CRM records: a person (contact_id) and, in the same go, businesses (company_ids, e.g. the person's businesses), and / or a deal (deal_id). Clients' pages get the event too (event_id, event_calendar_id?). - unlink_event: Remove one CRM link from a calendar event (event_id, event_calendar_id?, link_type crm_contact|crm_company|crm_deal|client|business, link_id). - get_default_theme: The workspace default look that calendars and forms without their own follow. - set_default_theme: Change the workspace default look (theme, merged; same keys as set_theme: mode light|dark|custom, background #hex (page colour in custom mode), brand #hex, text #hex or "" (auto), font system|inter|dm-sans|manrope|plus-jakarta|work-sans|lora|merriweather, heading_font "" (same as font) or a font key, radius sharp|soft|round, button filled|outline, button_text #hex or "" (auto), button_label up to 40 characters or "" (default label), button_shape auto (follows radius)|square|pill, button_width auto|full, button_size s|m|l, field_style outlined|filled|underline, field_bg / field_border / label_color #hex or "" (auto), show_card true|false, card_bg #hex or "" (auto), card_width auto|narrow|medium|wide, card_shadow none|soft|strong, card_border true|false, text_size s|m|l, align left|center (header and intro), page_fill solid|gradient, gradient_from / gradient_to #hex or "" (auto), gradient_angle 0-360, page_image / logo_url / cover_url (https or /uploads/ path, "" for none), page_overlay 0-80 (darkens page_image), logo_size s|m|l, logo_position left|center; forms: form_layout page|one, progress none|bar|steps, question_numbers true|false, required_color red|brand; calendars: booking_layout month|list, show_host true|false, slot_style outline|filled. A bad value is ignored and the current one stays.) (waits for approval: external) - get_form_theme: A form's public look (form_id). - set_form_theme: Change a form's public look, merged (form_id, theme: the set_theme keys, incl. the form ones: form_layout, progress, question_numbers, required_color, button_label), or theme null for the default. (waits for approval: external) - list_email_templates: Your email templates. - save_email_template: Create or change an email template (template_id?, name, subject, body with custom values). - delete_email_template: Delete an email template (template_id). (waits for approval: delete)

POST/api/external/tools/create_calendar_event

Scopes: bookings:write

Add an event to your Google calendar. An event with guests sends them invitations, so it waits for your approval in Plodder first. An event with no guests is created right away.

POST/api/external/tools/delete_calendar_event

Scopes: bookings:write

Delete an event from your Google calendar (a repeating event: this occurrence, or every one with all_occurrences). Waits for your approval unless you allowed deletes; an event with guests emails them a cancellation, so it also follows the external-actions setting.

POST/api/external/tools/google_calendars

Scopes: bookings:write

Settings for each connected Google calendar in the app (see list_calendars for ids): shown or hidden, default busy or free, whether it blocks auto-scheduling, color, and the primary calendar new events go to. App-side only; nothing changes in Google. Actions: - set: visible, default_busy_status (busy | free), use_for_conflicts. Changes reshuffle auto-scheduled tasks. - set_color: color (hex). - set_primary: Make this the calendar new events go to.

POST/api/external/tools/list_booking_links

Scopes: bookings:read

Your scheduling (booking) pages: name, link, lengths, whether they take bookings. Share a link with someone so they can book time.

POST/api/external/tools/list_calendar_events

Scopes: bookings:read

Events on your connected Google calendars between two dates (default: today through the next 7 days). Times are ISO 8601.

POST/api/external/tools/list_calendars

Scopes: bookings:read

Your connected Google calendars: id, name, primary, shown in the app, used for conflicts. Pass a calendar_id to create_calendar_event-style tools when an event is not on the primary calendar.

No arguments.

POST/api/external/tools/update_calendar_event

Scopes: bookings:write

Change an event on your Google calendar: title, time, description, location, busy or free, guests. Only the fields you pass change; a repeating event changes this one occurrence. When the event has guests (or you add some) Google emails them the change, so it waits for your approval first.

POST/api/external/tools/forms

Scopes: forms:read, forms:write

Build forms, read their responses and answer them, as you. A form writes its answers into a database (one row per response). Find forms with list_items types ["form"]. Question types: short, paragraph, email, phone, url, choice, checkboxes, dropdown, checkbox, number, date, datetime, person, relation. Actions: - get: The form: questions (layout sections), settings, columns, counts, status. - create: A new form (name, optional workspace_id); with database_id it asks that database's columns, or returns the form that database already has (the database page's Form button). - edit: One builder change: op = meta {name, description} | add_question {type, label, sectionId?, afterQuestionId?, relationSheetId?} | add_existing {columnId} | rename_question {questionId, name} | set_type {questionId, type, convert?} | set_options {questionId, options:[..]} | remove_question {questionId, deleteColumn?} | add_section {kind: questions|gate|booking, bookingLinkId?} | layout {layout} | settings {settings} | public_link {enabled} | lead_pipeline {lead_pipeline: {on, pipeline_id, stage_id?, title? (custom values, default "{{form.name}}: {{contact.name}}"), value_question? (a question id whose number answer is the deal value)} or null}: on = each submission finds or makes the person from the email / phone answer and adds a deal in that CRM pipeline unless they already have an open one there (then the submission is logged on it); lead source from the page UTM. Put the op's fields in `fields`. (may wait for approval) - trash: Move the form to Trash. (waits for approval: delete) - responses: Every response (the linked database rows) with column names. - stats: Public link traffic (same numbers as the Responses tab): views (each visitor once a day), starts (first touch), submits (public link responses), start_rate and conversion (submits / views, 0..1), per-day series. days = only the last N days. - questions: What a respondent sees: sections and questions with their ids, for answer. - answer: Submit a response as you: answers = {questionId: value}. preview=true checks without saving.

POST/api/external/tools/chat_channel_bookmarks

Scopes: messages:read, messages:write

The links bar at the top of a chat channel that everyone in it sees: list, add, remove, reorder. Actions: - list: The channel's bookmarks. - add: Add one: title, and a url or a message_id. - remove: Remove one (bookmark_id). (waits for approval: delete) - reorder: ordered_ids = bookmark ids in order.

POST/api/external/tools/chat_channels

Scopes: messages:read, messages:write

Create and manage Plodder chat channels and DMs as you. Read and post with read_chat_messages and post_chat_message; list them with list_chat_channels. Members: chat_members; join links: chat_invites. Actions: - get: One channel: name, topic, type, members, your notification level, starred. - create: A new channel (name, optional description, workspace_id, private). You join it. - update: Change name, description, topic or type (public|private). Members only. - archive: Archive (delete) the channel. Members only; the default channel cannot be archived. (waits for approval: delete) - unarchive: Bring an archived channel back. Members only. - reorder: Sidebar order: ordered_ids = channel ids in order (channels you are in). - star: Star the channel for yourself. - unstar: Unstar it. - list_starred: Your starred channel ids. - set_notifications: Your notification level for the channel: level = all | mentions | nothing. - mark_read: Mark the channel read for you. - open_dm: Find or open a DM: user_ids (people who share a workspace with you), or with = a teammate's name, a bot's @username, or "botfather". Posts nothing. - open_bot_dm: Find or open the DM with one of your own bots (bot_id).

POST/api/external/tools/chat_invites

Scopes: messages:read, messages:write

Join links for a chat channel: anyone with the link can join, so making one waits for approval. Actions: - list: The channel's join links: url, uses, max uses, expiry. - create: A new join link (max_uses 1-1000 or none, expires_in_days 1-90, default 7). (waits for approval: external) - revoke: Turn a link off (invite_id).

POST/api/external/tools/chat_labels

Scopes: messages:read, messages:write

Your own chat sidebar labels (groups of channels and DMs). A label with a rule is a smart label: rule = {kind: name|unread|dms|channels|private|clients|workspace, value?}. Actions: - list: Your labels and which channel sits under which label. - create: A new label (name, optional rule). - update: Rename, change the rule, or collapse (label_id). - reorder: ordered_ids = label ids in order. - delete: Delete a label; its channels go back to Channels / DMs. (waits for approval: delete) - assign: Move a channel under a label (channel_id, label_id; label_id null = back to default).

POST/api/external/tools/chat_members

Scopes: messages:read, messages:write

Who is in a chat channel, and adding or removing people and agents, as you. Same access as the channel: anyone in a public channel, members of a private one. Actions: - list: Members with names and roles. - add: Add a person (user_id) or an agent (agent_id), optional role. Adding a guest from outside the channel's workspace waits for approval. (may wait for approval) - remove: Remove a person (user_id) or an agent (agent_id). Waits for approval. (waits for approval: delete)

POST/api/external/tools/chat_messages

Scopes: messages:read, messages:write

Everything you do to chat messages besides posting: edit or delete your own, reactions, pins, your bookmarks, scheduled messages and reminders, as you. Actions: - edit: Change the text of your own message (message_id, text). Everyone in the channel sees the edit. (waits for approval: post chat) - delete: Delete a message: your own, or any as a channel admin or owner. (waits for approval: delete) - react: Add an emoji reaction (message_id, emoji). - unreact: Remove your reaction. - pin: Pin a message in its channel. - unpin: Unpin it. - list_pins: Pinned messages in a channel (channel_id). - bookmark: Save a message to your bookmarks. - unbookmark: Remove it from your bookmarks. - list_bookmarks: Your bookmarked messages. - schedule: Schedule a message (channel_id, text, at = ISO time or epoch seconds in the future). It posts at that time. (waits for approval: post chat) - list_scheduled: Your scheduled messages that have not gone out. - cancel_scheduled: Cancel one of your scheduled messages (message_id). Nothing was posted yet. - remind: Remind you about a message later (message_id, at). Only you see it. - list_reminders: Your open reminders (due_only for the ones due now). - dismiss_reminder: Dismiss one of your reminders (reminder_id).

POST/api/external/tools/chat_polls

Scopes: messages:read, messages:write

Polls in chat: ask one (it posts in the channel), read results, vote, close or reopen. Actions: - create: Post a poll (channel_id, question, options 2-10, multi, anonymous). (waits for approval: post chat) - get: A poll with its tally and (unless anonymous) who voted what. - vote: Your vote: options = option indexes (0-based); an empty list withdraws your vote. - close: Close the poll (the person who asked, or the owner). - reopen: Reopen it.

POST/api/external/tools/crm_conversations

Scopes: messages:read, messages:send, messages:write

CRM Conversations (the team inbox of texts, email and Facebook / Instagram DMs), as you: saved views, the inbox with every filter, messages scheduled to send later, and response times. Scheduled texts keep texting hours (in the person's time zone): a text scheduled outside them goes at the start of the next window and note says so. A DM must go inside Meta's 24-hour window. Response times: with the target on, a message from a person that waits longer than N minutes of business time alerts the assignee (else the person's owner) and / or you, once. To reply now use the phone tool (reply, with cc / bcc for email). Actions: - threads: Threads in a box with filters ({ box?: team | mine | unassigned | unread | done | scheduled, q?, tag? (tag option id), owner? (owner key | none), pipeline? (id), stage?, channel? sms | email | messenger | instagram, assignee? (team member key | none), unread? true, last? them | us }) and the count in every box. - views: Saved inbox views (id, name, config). - save_view: Save a view: name, config = { box?: team | mine | unassigned | unread | done | scheduled, q?, tag? (tag option id), owner? (owner key | none), pipeline? (id), stage?, channel? sms | email | messenger | instagram, assignee? (team member key | none), unread? true, last? them | us }. - update_view: Rename a view or change its filters: view_id, name?, config?. - delete_view: Delete a saved view (view_id). The conversations stay. - scheduled: Scheduled messages, soonest first: contact_id? (one person), status? scheduled (default) | sent | failed | cancelled | all. - schedule: Schedule a message: contact_id, channel sms | email | messenger | instagram, body, send_at (ISO date-time or epoch seconds), email: subject? (else Re: their newest thread), account_id? (mailbox), cc?, bcc? (lists or comma separated). (may wait for approval) - update_scheduled: Change a waiting message (scheduled_id): body?, subject?, send_at?, cc?, bcc?, channel?. (may wait for approval) - send_scheduled_now: Send a waiting message now (scheduled_id); a text outside texting hours still waits for the window. (may wait for approval) - cancel_scheduled: Cancel a waiting message (scheduled_id). - settings: Response-time target, business hours and texting hours, with first-response stats over the last 30 days. - set_settings: Change them: settings = { sla_on?, sla_minutes?, notify? assignee | owner | both, business? { tz, days [0 Sun..6 Sat], start "09:00", end "17:00" }, texting_start?, texting_end?, texting_tz? }. - response_stats: First response over the last N days (days, default 30): answered, waiting, overdue, avg / median seconds, avg business seconds, % within target.

POST/api/external/tools/crm_send

Scopes: messages:read, messages:send

Email or text CRM people one by one (merge fields {{first_name}}, {{name}}, {{company}}, {{first_name|there}}), as you (/api/crm/send). Do-not-contact flags and missing addresses are skipped. At most 200 people per send. Email goes via gmail (your connected mailbox, account_id: personal, one to one) or via mailjet (bulk / marketing: a verified sender from_email or your default, Reply-to your Gmail, unsubscribe link + mailing address footer added, OPTED-IN PEOPLE ONLY: lists flagged cold are refused, people tagged cold / no-consent and the suppression list are skipped). Texts from your Twilio number. format: text (default), rich or html (sanitized). The audience can be a people filter (the People list filter schema) as well as ids or a segment / smart list. Actions: - preview: Dry run: who gets it and who is skipped and why. Nothing is sent. - send: Send it: channel email|sms, the audience (contact_ids, company_ids, deal_ids, segment_id or filter), via (gmail | mailjet), account_id (gmail), from_email / from_name / reply_to / track (mailjet), subject (email), body, format. (waits for approval: send email)

POST/api/external/tools/draft_email

Scopes: messages:write

Save a Gmail draft (new email, or a reply when thread_id is set). Nothing is sent; you can review it in Gmail or Plodder Email.

POST/api/external/tools/email_campaigns

Scopes: messages:read, messages:send, messages:write

Email campaigns through Mailjet (Email > Campaigns), as you: one email to an audience of OPTED-IN people (smart lists / segments, tags, people, a People filter; minus excluded smart lists and tags). People without an address, with do not email / unsubscribed, tagged cold / no-consent, or on the suppression list (bounced, complained, unsubscribed) are skipped with the reason; a smart list flagged cold is refused. Send now, schedule at a wall clock time in a time zone, or batches (batch.size people every batch.every_min minutes). Every email carries the unsubscribe link and your mailing address; links are click tracked per link; opens come from Mailjet. Stats: sent, delivered, opened, clicked (per link), bounced, unsubscribed, complained; recipients filterable by event; add those people to a tag or a workflow; resend to the ones who did not open after N hours (optionally a new subject). audience = { segment_ids?: number[], tag_ids?: number[] (tag option ids, crm_contacts filter_fields "tags"), contact_ids?: number[], filter?: People filter }; exclusions = { segment_ids?, tag_ids? }. A/B test: ab = { on, variants: [{ subject, body? }] (versions B and C; A is the campaign itself), test_pct 10-50 (share of people in the test, split evenly), metric open | click, wait_hours 1-72 }; the winner goes to everyone else after the wait (get shows per version results and the winner). Invalid, throwaway and no-mail-server addresses are skipped (the address check, email_domains validate). A client's own From address works once their sending domain is verified (email_domains). Actions: - list: Every campaign, newest first, with status, counts (total, sent, skipped, failed), delivered, opened and clicked. - get: One campaign (campaign_id) with stats, clicks per link and its resends. - create: A draft: name, subject, body (HTML for rich / html, merge fields {{first_name|there}}, {{name}}, {{company}}, {{unsubscribe_link}}, {{workspace.mailing_address}}), format (rich | html | text), from_email (a verified Mailjet sender, else your default), from_name, reply_to, track (opens and clicks, default true), audience, exclusions, batch, send_local + timezone. - update: Change a draft or scheduled campaign (same fields as create). After it starts only the name changes. - duplicate: Copy a campaign into a new draft (campaign_id). - delete: Delete a draft, sent or cancelled campaign (campaign_id). (waits for approval: delete) - preview: The email exactly as a send builds it, nothing sent: subject, body, format (rich | html | text), contact_id? (one person on the list; else sample values). Returns subject, html, text, person and a warning when the mailing address is missing. - preview_audience: Who it would reach: audience + exclusions (or campaign_id of a resend). Returns total, sendable, skipped reasons with counts, a sample. - test: Send the campaign (campaign_id; subject / body override optional) to yourself only, subject prefixed [Test]. (waits for approval: send email) - send: Send now (campaign_id). Batches go out on their schedule. (waits for approval: send email) - schedule: Schedule (campaign_id, send_local "YYYY-MM-DDTHH:mm", timezone e.g. America/Vancouver). (waits for approval: send email) - unschedule: A scheduled campaign back to draft (campaign_id). - pause: Stop sending (campaign_id). Nothing more goes out until resume. - resume: Carry on (campaign_id). Batches that fell due while paused go now, the rest keep their spacing. (waits for approval: send email) - cancel: Cancel (campaign_id): everyone not sent yet is skipped. - resend_unopened: Resend to people who did not open it: campaign_id, after_hours (1 to 720, from when it started), subject (optional new subject), name. Creates a scheduled campaign. (waits for approval: send email) - recipients: Recipients (campaign_id), filter event = sent | delivered | opened | clicked | bounced | unsubscribed | complained | not_opened | skipped | failed | queued, q, limit (<= 1000), offset. - add_to: Give the people behind an event (campaign_id, event) a tag (tag = the tag name) or add them to a workflow (workflow_id; it must be published and on). (may wait for approval)

POST/api/external/tools/email_domains

Scopes: messages:read, messages:write

Each client's own sending domain for Mailjet email (Settings > Email > Sending domains), as you: add a domain (it becomes a Mailjet domain sender; the DNS records to add come back: SPF include, DKIM key, ownership token), check DNS (SPF / DKIM status and errors; verified when both are OK), set who it belongs to (business_id = a client, null = your own company) and label. A domain has several senders (hello@, news@, support@ ... each with its own name and Reply-to, one the default; the Mailjet domain sender already covers every address, so a sender needs no Mailjet step): senders / add_sender / update_sender / remove_sender. Every sender of a verified domain shows in campaign, workflow and CRM From pickers, grouped by domain. validate: check an address (email) or people (contact_ids): syntax, a mail server for the domain (MX, cached 30 days), throwaway domains; the result (valid | invalid | no_mx | disposable | unknown) is flagged on each person and campaigns / bulk sends skip invalid, no_mx and disposable. Actions: - list: Every sending domain with its records, SPF / DKIM status, client and default From. - add: Add a domain: domain (client.com), business_id? (the client), label?, default_from? (address or local part on the domain), default_name?. - update: Change a domain (domain_id): label, business_id; default_from / default_name set the default sender (made when new). - senders: The domain's senders (domain_id): address, display_name, reply_to, is_default. - add_sender: Add a sender (domain_id, local_part = the part before the @, like news; display_name?, reply_to?, is_default?). Unique per domain; the first one is the default. - update_sender: Change a sender (domain_id, sender_id): display_name, reply_to, is_default: true makes it the default. - remove_sender: Remove a sender (domain_id, sender_id); when it was the default, the oldest one left becomes the default. (waits for approval: delete) - check: Ask Mailjet to check its DNS now (domain_id). - remove: Take a domain off the list (domain_id); the Mailjet sender stays on the account. (waits for approval: delete) - validate: Check an address (email) or people's primary addresses (contact_ids, <= 2000); fresh = skip the 30-day cache.

POST/api/external/tools/get_email_thread

Scopes: messages:read

Every message in a Gmail thread as plain text.

POST/api/external/tools/list_chat_channels

Scopes: messages:read

Plodder chat channels and DMs you can read.

POST/api/external/tools/list_email_labels

Scopes: messages:read

The Gmail labels of your connected accounts (system labels like INBOX and your own), with unread counts. Use the names with update_email_thread.

POST/api/external/tools/list_email_threads

Scopes: messages:read

Gmail threads from your connected accounts. Filter by folder (inbox, starred, sent, drafts, all, spam, trash), unread only, or a Gmail search query (from:, to:, subject:, label:, has:attachment, newer_than:7d).

POST/api/external/tools/list_inbox

Scopes: messages:read

Your Plodder inbox: notifications (assignments, mentions, leads...), recent task activity in your workspaces, and AI actions waiting for your approval.

POST/api/external/tools/mail_organize

Scopes: messages:read, messages:write

Organize email threads in your own mailboxes, as you: file a thread to a client, snooze it or set a follow-up reminder, shared tags, create or delete a Gmail label, delete a draft, share a thread into a chat channel. Gmail writes are dry runs while sending is off on the server. Read, archive, star or label a thread with update_email_thread. Actions: - client_links: Clients a thread is filed to (account_id + thread_id), or counts per client with neither. - file_to_client: File a thread to a client (account_id, thread_id, client_id). - unfile_from_client: Take a thread off a client. - reminders: Live reminders (snoozed and follow-ups), optionally for one thread. - remind: Snooze a thread or set a follow-up (account_id, thread_id, kind, due_at at least a minute out). - reminder_seen: Clear the "back in your inbox" marker on a thread. - cancel_reminder: Unsnooze (back to the inbox now) or cancel a follow-up (reminder_id). - tags: Tags used on your mail with counts. - set_tags: Set a thread's shared tags (account_id, thread_id, tag_ids; subject optional). - create_label: Create a Gmail label in a mailbox (account_id, name). - delete_label: Delete a Gmail label you made (account_id, label_id from list_email_labels). Gmail takes it off every thread; the email stays. (waits for approval: delete) - delete_draft: Delete a Gmail draft (account_id, draft_id). (waits for approval: delete) - share_to_chat: Post a thread as a link card in a chat channel or DM (account_id, thread_id, channel_id, note). (waits for approval: post chat)