Tools Reference

Authentication

All tools authenticate using the X-API-KEY passed in the MCP server header, or with sign-in. No additional auth is needed per-tool call. The agency custom fields tools work only with sign-in.

Workspace Tools

`list_clients`

List all available RevyOps workspaces accessible via your API key(s). Call this first to discover which workspaces you can query, then pass the workspace name to other tools. Parameters: none Returns: List of workspace names and IDs, each workspace’s time_zone, and a flag indicating the default workspace. A key that doesn’t resolve to one workspace, such as an agency master (ML-) key or a mistyped key, is left out of the list without an error.

Filter & Query Tools

The universal filter engine answers “which records match X” for any entity (contact, company, opportunity, email, and more). Use get_filter_schema to discover entities and fields, get_field_options to see real values for a field, then query_entity to run the filter.

`get_filter_schema`

List the entities you can filter, or get one entity’s fields, relations and operators. Call with no entity first (small answer: entity ids and labels), then call again with an entity id for the fields you need to build a filter.

Parameter	Type	Description
`client_name`	string	Workspace name
`entity`	string	Entity id to describe, e.g. `contact`. Omit to list all entities.

Returns: With an entity: each field’s id, label, type, allowed operators, options and their display names (option_labels, e.g. revyops → API), whether get_field_options works on it, sortable/searchable/custom/aggregatable flags. Each relation’s name, target entity, cardinality. Also agg_columns (ready-made aggregate column specs) and the entity’s params and default_columns/default_sort.

`get_field_options`

List the values that actually occur in one filter field, to turn a vague ask into exact values for an eq/neq condition. Only useful for fields whose schema entry says dynamic_options: true.

Parameter	Type	Description
`entity`	string	Required. Entity id the field belongs to
`field`	string	Required. Field id, e.g. `status` or `custom.Persona`
`client_name`	string	Workspace name

Returns: {"options": [...], "truncated": bool}. An empty list doesn’t necessarily mean no values exist. truncated: true means there are more distinct values than can be listed.

`query_entity`

Filter any entity with the full filter engine (the one the web UI uses). Prefer this over search_contacts/search_companies for anything beyond an exact email/domain/name lookup: boolean logic, ranges, dates, custom fields, conditions on related records, or any entity other than contact/company.

Parameter	Type	Description
`entity`	string	Required. Entity id from `get_filter_schema`, e.g. `contact`
`where`	object	Condition tree (see below). Omit to match every row.
`search`	string	Free text matched against searchable fields
`sort`	array	`[{"field": "...", "dir": "asc"\|"desc"}]`
`columns`	array	Field ids to return; omit for every field
`page`	integer	1-based page number (default: 1)
`per_page`	integer	Rows per page, 1..1000 (default: 50)
`params`	object	Query-level params the schema lists under `params`
`client_name`	string	Workspace name

The where condition tree has four node kinds, tagged by node:

{"node": "group", "op": "and"|"or", "children": [...]}
{"node": "not", "child": {...}}
{"node": "cond", "field": "status", "op": "eq", "value": [...]}
{"node": "rel", "relation": "emails", "quantifier": "any", "where": {...}}

Operators:

eq, neq, contains, not_contains: always take a non-empty list of alternatives, even for a single value. There is no in/not_in operator.
lt, lte, gt, gte: a single scalar.
between, not_between: {"from": x, "to": y}; one side may be omitted for an open range.
within, not_within: {"anchor": <anchor>, "n": <int>}, date/datetime fields only. Anchors: today, yesterday, this_week, last_week, this_month, last_month, this_quarter, last_quarter, this_year, last_year, last_days. Days are the workspace’s calendar days in its time zone, and weeks start on Monday.
is_empty, is_not_empty: no value key.

rel quantifiers: any/none (no op/value), count (op + value), min/max (op + value + field), latest/earliest (op + value + field + order_field). Limits: depth 8, 100 nodes, 3 relation hops, 200 columns, per_page 1..1000. Returns: {count, num_pages, current_page, results}. A custom.<name> column lands under each row’s custom_fields.<name>; a multi-value custom field arrives as a JSON-encoded string.

`list_activity_conditions`

The activity phrases the app’s filter builder speaks for one entity. verbs are shortcuts over the activity stream, such as “has replied” or “has not accepted our LinkedIn request in the last 5 days”. “has replied” counts email and LinkedIn replies, while linkedin_messaged_us (“has messaged us on LinkedIn”) counts only LinkedIn messages the person sent us. Each verb says whether it can be counted (“at least 3 times”) and which activity entities it reads. rollups are named dates computed from activity, such as “Last email sent is not in the last 14 days”.

Parameter	Type	Description
`entity`	string	Required. The entity the filter is on, e.g. `person`
`client_name`	string	Workspace name

`activity_condition`

Builds one activity condition as a where node, in exactly the shape the app’s filter builder writes. A view saved from it opens in the builder as that phrase and stays editable. Combine several in a group node. For example, “accepted our LinkedIn request 5 to 30 days ago and has not replied” is three conditions: accepted_linkedin with has over 30 days, accepted_linkedin with has not over 5 days, and replied with has never.

Parameter	Type	Description
`entity`	string	Required. The entity the filter is on
`verb`	string	A verb id from `list_activity_conditions`. Pass `verb` or `rollup`.
`quantifier`	string	For a verb: `has`, `has not`, `has never`, `has at least`, `has at most`, `has exactly` (default `has`)
`window`	object	For a verb: `{"anchor": "last_days", "n": 30}`, `{"anchor": "today"\|"yesterday"}` or `{"anchor": "this_week"\|"this_month"\|"this_quarter"}`, on the workspace’s calendar days. Omit for at any time.
`count`	integer	For the at least / at most / exactly quantifiers
`rollup`	string	A named date id, e.g. `last_email_sent`
`op`	string	For a rollup: `within`, `not_within`, `lt`, `gt`, `between`
`value`	any	For a rollup: a window, a date, or `{"from": date, "to": date}`
`client_name`	string	Workspace name

Returns: {"where": <node>, "reads": "<the phrase>"}. The builder may word a windowed single-channel verb as its named date: “has been emailed by us in the last 30 days” opens as “Last email sent is in the last 30 days”.

`list_saved_views`

The saved views this workspace sees in the app’s sidebar, for the contact, company and people lists. Each has id, name, description, entity, the where tree and sort, the visible columns, editable (whether this key may change it) and synced. Views shared from the agency to several workspaces are listed but are read-only to a key.

Parameter	Type	Description
`client_name`	string	Workspace name

`save_view`

Save a filter as a saved view in the workspace’s sidebar, or update one. Build and check the filter with query_entity first, then pass the same where tree: it’s stored exactly as given and runs the same on the list page, in workflow triggers and in sync. The filter is checked before saving. A bad field or operator is refused with the path of the bad node, and nothing is saved. The reply includes match_count, how many records match right now. People open and edit saved views in the app’s filter builder, which speaks a narrower language than query_entity. The view is stored in the form the builder reads: not is folded into the conditions, and a count of at least 1 or exactly 0 becomes any or none. Both forms match the same records, and the reply’s where is the stored form. A filter the builder still can’t open is refused with problems: each one gives a path into that where and a hint on how to say it. The usual case is a second relative date inside one activity relation. “Accepted 5 to 30 days ago” is two conditions, which activity_condition builds.

Parameter	Type	Description
`name`	string	View name; required on create
`entity`	string	`contact`, `company` or `person` (the People list); required on create, fixed afterwards
`where`	object	Condition tree, exactly as `query_entity` takes it. Omit to match every record.
`sort`	array	`{field, dir}` objects, `dir` `asc` or `desc`
`columns`	array	Field ids to show as columns, in order. On create, omitted means the list’s default columns; on update, the columns stay as they are.
`description`	string	Shown on the Saved Views page
`view_id`	string	Id from `list_saved_views`; omit to create
`client_name`	string	Workspace name

A new view is visible to everyone in the workspace and shows API as its creator.

`delete_saved_view`

Delete a saved view this workspace owns. Refused with 409 while a workflow starts from the view or it syncs to a webhook; the message says which.

Parameter	Type	Description
`view_id`	string	Id from `list_saved_views`
`client_name`	string	Workspace name

Workflow Tools

A workflow does something when a record enters a saved view. Your agent builds and changes workflows whose trigger view belongs to this workspace alone (owned_by_client: true), such as views it saved with save_view. A workflow the agency shares across several workspaces takes only this workspace’s own values and its on/off switch; its steps, name and trigger are changed in the builder, or by an agent an Agency admin signed in with Agency workflows ticked. editable says which workflows your agent may change. A step’s settings stay each workspace’s own even then, so the agent sets them per workspace. Every change needs a read & write (RV-) key. Everything your agent builds shows in the builder exactly as if it had been built there. Webhook URLs always come back redacted to their host. Sending a redacted value back keeps the real URL.

`list_workflows`

Workflows on saved views shared with this workspace: id, name, status, trigger (the saved view), owned_by_client, editable, enabled_for_client, step_count, has_draft, last_run.

Parameter	Type	Description
`status`	string	`draft`, `active` or `paused`
`client_name`	string	Workspace name

`get_workflow`

One workflow’s steps: steps (the version it runs), draft_steps (unpublished edits of a live workflow), client_overrides (this workspace’s own values) and readiness, the problems that still stop it running, by step id. Empty readiness means it can run.

Parameter	Type	Description
`workflow_id`	integer	Required. Id from `list_workflows`
`client_name`	string	Workspace name

`create_workflow`

Create a workflow, off and without steps, on a saved view of this workspace with at least one condition.

Parameter	Type	Description
`name`	string	Required. Workflow name
`saved_view_id`	string	Required. Id from `save_view` or `list_saved_views`
`client_name`	string	Workspace name

`update_workflow`

Rename a workflow or change its trigger. The trigger changes only while the workflow is off, to a view on the same list.

Parameter	Type	Description
`workflow_id`	integer	Required.
`name`	string	New name
`saved_view_id`	string	New trigger view
`client_name`	string	Workspace name

`add_workflow_step`

Add one step: filter, branch (If / Else), webhook, alert, ai-agent, send-to, find-data, verify-phone or verify-email. It goes last, right after after_step_id, or into an If / Else path with path_id. New steps start with the builder’s defaults; an If / Else comes with Path 1 and Everyone else. The reply is the whole workflow with created_id and readiness.

Parameter	Type	Description
`workflow_id`	integer	Required.
`type`	string	Required. Step type
`config`	object	The step’s settings: webhook `url`, `rate_per_sec`; alert `alert_method` (`slack` or `email`), `email_to`, `subject`, `message`; ai-agent `prompt`, `provider`, `model`, `label`, `web_search`, `outputs`; send-to `destination` (`closecrm`), `create_if_missing`, `overwrite`, `mappings`, `start_workflow`; find-data `provider` (`moltsets`, `aiark` or `apollo`), `find`, `only_if_missing`; verify-phone `only_unchecked`, `line_status`; verify-email `provider` (`millionverifier` or `bounceban`), `only_unchecked`
`conditions`	array	Filter steps: `{field, op, value}` objects
`match`	string	Filter steps: `all` or `any`
`after_step_id`	string	Put the step after this one
`path_id`	string	Put the step inside this path
`position`	integer	0-based place in the top level or in `path_id`
`client_name`	string	Workspace name

Conditions use the workflow operators: is, is not, contains, does not contain, starts with, ends with, gt, lt, is one of, is known, is unknown. Field keys come from get_workflow_fields. A send-to step sends each person to Close CRM. mappings is a list of {target, close_field, source}: target is contact or lead, close_field is the Close field’s name, and source is the value to write, text with merge fields such as {{First Name}}. With start_workflow on, the Close workflow (sequence_id) and sender (sender_account_id, sender_email, sender_name) are set per workspace with set_workflow_client_values. Testing the step and turning the workflow on really write to Close. An AI Agent step can start from a saved agent prompt: your agent copies the document’s text into prompt and its id into prompt_template_id, the same as Insert template in the builder. The step keeps its own copy, so a later edit to the document reaches the step only when the template is inserted again. Ideal Customer Profiles go into the prompt as {{Company ICP: <name>}} or {{Person ICP: <name>}} and are read in each time the step runs. A find-data step looks the person up with a data provider and adds what it finds as the person’s own identifiers, as Add identifier does, on contact and people workflows only. find is a list of email, phone (mobile) and linkedin_url; only_if_missing (on by default) skips what the person already has. A value another person already holds is left with them. The step needs the provider’s API key connected for this workspace in the app, under Integrations; your agent can’t set one. A verify-phone step checks each of the person’s phones with Twilio and stores its phone status (valid, unreachable, invalid, unknown) and line type (mobile, landline, voip, other); the phone itself is never changed. only_unchecked (on by default) skips phones Twilio already checked; line_status also asks whether the line is in service (beta, costs more). It needs Twilio connected for this workspace in the app. A verify-email step checks each of the person’s emails with millionverifier or bounceban and stores the result as that provider’s email status, through the status mapping the workspace chose in the app; the email itself is never changed. only_unchecked (on by default) skips emails that provider already checked. It needs the provider connected and its results classified for this workspace in the app.

`update_workflow_step`

Change one step. config keys you pass replace the current ones, null removes one, and the rest stay. conditions replace a filter step’s whole list.

Parameter	Type	Description
`workflow_id`	integer	Required.
`step_id`	string	Required.
`config`	object	Keys to set
`conditions`	array	Filter steps: the new list
`match`	string	Filter steps: `all` or `any`
`client_name`	string	Workspace name

`move_workflow_step`

Move a step, with everything inside it, right after another step, into an If / Else path, or to a place in the top level.

Parameter	Type	Description
`workflow_id`	integer	Required. Id from `list_workflows`
`step_id`	string	Required. The step to move
`after_step_id`	string	Put it right after this step
`path_id`	string	Put it inside this path
`position`	integer	0-based place in the top level or in `path_id`
`client_name`	string	Workspace name

`remove_workflow_step`

Remove a step. Removing an If / Else removes its paths and their steps too.

Parameter	Type	Description
`workflow_id`	integer	Required. Id from `list_workflows`
`step_id`	string	Required.
`client_name`	string	Workspace name

`add_workflow_path`

Add a named path to an If / Else step, before Everyone else, which takes every record no other path matched. The reply’s created_id is the new path’s id.

Parameter	Type	Description
`workflow_id`	integer	Required. Id from `list_workflows`
`branch_step_id`	string	Required. The If / Else step
`name`	string	Required. Path name
`conditions`	array	`{field, op, value}` objects, operators as in `add_workflow_step`
`match`	string	`all` (default) or `any`
`client_name`	string	Workspace name

`update_workflow_path`

Rename a path or replace its conditions. Everyone else has no conditions.

Parameter	Type	Description
`workflow_id`	integer	Required. Id from `list_workflows`
`path_id`	string	Required.
`name`	string	New name
`conditions`	array	The new list
`match`	string	`all` or `any`
`client_name`	string	Workspace name

`remove_workflow_path`

Remove a path and its steps. Everyone else and the last remaining path can’t be removed; remove the If / Else step instead.

Parameter	Type	Description
`workflow_id`	integer	Required. Id from `list_workflows`
`path_id`	string	Required.
`client_name`	string	Workspace name

`set_workflow_client_values`

Set the workspace’s own values on a workflow of this workspace or a shared one: webhook url and rate_per_sec, alert email_to and message, send-to sequence_id, sender_account_id, sender_name and sender_email, per step, plus flow_speed (1 to 10). A Slack alert’s account and channel come from the Slack the workspace connected in the app, so they are picked in the builder. They override the shared values for this workspace only, and null clears one back to the shared value. On a live workflow they wait in the draft until publish_workflow_draft.

Parameter	Type	Description
`workflow_id`	integer	Required. Id from `list_workflows`
`step_values`	object	`{step_id: {field: value}}`
`flow_speed`	integer	1 (slowest) to 10
`client_name`	string	Workspace name

`get_workflow_fields`

The fields conditions and merge fields use for one list, with the operators conditions take. The list also holds the workspace’s Ideal Customer Profiles (source: "icp") with the exact token to put in a prompt. Profiles and recent activities are prompt tokens only, not condition fields.

Parameter	Type	Description
`entity_type`	string	Required. `contact`, `company` or `person`
`client_name`	string	Workspace name

`get_workflow_ai_options`

The AI providers and models an AI Agent step can use, and whether the workspace has each provider’s API key connected. Keys are connected in the app, not by the agent, and a step without one can’t be tested or turned on.

Parameter	Type	Description
`client_name`	string	Workspace name

`list_workflow_test_records`

Records to test steps on: the trigger view’s records for this workspace, or a search.

Parameter	Type	Description
`workflow_id`	integer	Required. Id from `list_workflows`
`query`	string	Search by name, email or domain instead
`limit`	integer	Up to 25 (default 5)
`client_name`	string	Workspace name

`test_workflow_step`

Run one saved step, with the workspace’s own values, on records of the trigger view. Webhook and Alert steps really send, so your agent asks first and tests on one record. An AI Agent step shows what it would write, writes nothing, and lists under unresolved_tokens any merge field or profile in the prompt that didn’t resolve. Filter and If / Else steps show which records match.

Parameter	Type	Description
`workflow_id`	integer	Required. Id from `list_workflows`
`step_id`	string	Required.
`record_ids`	array	Record ids from `list_workflow_test_records`, up to 5 for Webhook, Alert, AI Agent and Find data steps. Omitted, the view’s first record
`client_name`	string	Workspace name

A Find data step calls the provider for real on up to 5 records, so it can use the account’s credits, and adds nothing.

`turn_workflow_on`

Turn a workflow on for this workspace, after you agree. A workflow of this workspace goes live as a whole. A shared workflow must already be on, and only this workspace’s part is switched. Readiness is checked again first, and the call is refused with the problems if anything is missing.

Parameter	Type	Description
`workflow_id`	integer	Required. Id from `list_workflows`
`client_name`	string	Workspace name

`turn_workflow_off`

Turn a workflow off for this workspace. A workflow of this workspace pauses as a whole; on a shared workflow only this workspace stops.

Parameter	Type	Description
`workflow_id`	integer	Required. Id from `list_workflows`
`client_name`	string	Workspace name

`publish_workflow_draft`

Make a live workflow’s draft the version it runs. Records already inside finish the version they started on. On a shared workflow only the workspace’s own values are applied.

Parameter	Type	Description
`workflow_id`	integer	Required. Id from `list_workflows`
`client_name`	string	Workspace name

`discard_workflow_draft`

Drop a live workflow’s unpublished edits. On a shared workflow only the workspace’s own pending values are dropped.

Parameter	Type	Description
`workflow_id`	integer	Required. Id from `list_workflows`
`client_name`	string	Workspace name

`delete_workflow`

Delete a workflow of this workspace, with its run history. Refused with 409 while it’s on.

Parameter	Type	Description
`workflow_id`	integer	Required. Id from `list_workflows`
`client_name`	string	Workspace name

`list_workflow_runs`

The workspace’s runs of a workflow, newest first, with counts by status and each step’s result and error.

Parameter	Type	Description
`workflow_id`	integer	Required. Id from `list_workflows`
`status`	string	`running`, `success`, `failed`, `skipped`, `waiting_http` or `scheduled`
`limit`	integer	Up to 100 (default 20)
`client_name`	string	Workspace name

Custom Fields Tools

`list_custom_fields`

List the custom fields defined for contacts, companies or opportunities, with each one’s type (text, number, date, dropdown_singleselect, dropdown_multiselect), dropdown options, and whether the agency master schema or this workspace defines it. Needs a read & write (RV-) key; with a read-only (RO-) key the call is refused.

Parameter	Type	Description
`object`	string	Required. `contact`, `company` or `opportunity`
`client_name`	string	Workspace name

`create_custom_field`

Define a custom field for this workspace and set its type, so it exists on every record and in the filter schema before any value is written. Values already stored are validated against the type; the call fails and names them when they don’t fit. Repeat the call to change the type of a field this workspace owns (type: "text" clears the type and keeps the field and its values). A field the agency master schema owns keeps the agency’s type, and the call answers 409 agency_master_field. An Agency admin changes that type in Schema Settings, or with update_agency_custom_field. Field names ignore case: a new name that matches a standard field in any case, such as LinkedIn URL for linkedin_url, answers 400 duplicate_field_name, and one that matches another field in a different case answers 409 duplicate_field_name, naming the field to use instead. Needs a read & write (RV-) key.

Parameter	Type	Description
`object`	string	Required. `contact`, `company` or `opportunity`
`field_name`	string	Required. The field to define, e.g. `fit_score`
`type`	string	`text` (default), `number`, `date` (YYYY-MM-DD), `dropdown_singleselect`, or `dropdown_multiselect`
`available_options`	array	Allowed values, required for dropdown types (max 50)
`client_name`	string	Workspace name

Agency Custom Fields Tools

The agency custom fields tools change the agency’s master schema, so every change reaches every workspace in the agency at once, including workspaces added later. Claude lists them only when an Agency admin signed in and ticked Agency custom fields, which needs read and write access to all workspaces. An API key never has them. Each call checks again that the person who signed in is still an admin of the agency and that the app still has the access, so a change in Connected AI agents or to the person’s role applies to the next call. They don’t rename or delete a field, rename an option, or change a value on a record; an Agency admin does that in Schema Settings.

`list_agency_custom_fields`

List the master schema for contacts, companies or opportunities, with the type and dropdown options the agency set for each field. type is text when the agency set none. in_master_schema is false for a field the agency typed but never added to the master schema. workspace_types lists the workspaces that set their own type for the field: the agency’s type wins everywhere, and a workspace’s own type applies there only while the agency sets none.

Parameter	Type	Description
`object`	string	Required. `contact`, `company` or `opportunity`

`update_agency_custom_field`

Set or change a master field’s type, or add and remove its dropdown options. A refused call changes nothing.

Setting or changing the type first checks every value stored in every active workspace, and fails with 400 existing_values_invalid, naming values that don’t fit. Archived workspaces aren’t checked. A field with no agency type needs one before its options can change.
Removing an option is refused with 409 options_in_use while any record in an active workspace holds it. The answer lists each option with the number of records holding it. Change those records first.
The agency type can’t be removed with this tool.

Parameter	Type	Description
`object`	string	Required. `contact`, `company` or `opportunity`
`field_name`	string	Required. The field’s exact name, case-sensitive
`type`	string	`number`, `date` (YYYY-MM-DD), `dropdown_singleselect` or `dropdown_multiselect`. Leave it out to keep the current type
`add_options`	array	Options to add to a dropdown (max 50 options in total)
`remove_options`	array	Options to remove from a dropdown

For example, adding Bounced to the contact field Email Search Result in every workspace:

update_agency_custom_field(object="contact", field_name="Email Search Result", add_options=["Bounced"])

`promote_custom_field`

Add a field that one or more workspaces have to the master schema, the same as Add to master schema in Schema Settings. Only the name moves: each workspace keeps the type it set, and the other workspaces read the field as text, until you give it an agency type with update_agency_custom_field. After promoting, a workspace can no longer change the field’s type with create_custom_field. The field must already exist in at least one workspace. Removing a field from the master schema is done in Schema Settings.

Parameter	Type	Description
`object`	string	Required. `contact`, `company` or `opportunity`
`field_name`	string	Required. The field’s exact name, case-sensitive

A name that matches a master field or a standard field in another case is refused with duplicate_field_name.

Campaign Tools

`get_campaigns`

Get all campaigns with performance metrics.

Parameter	Type	Description
`client_name`	string	Workspace name (from `list_clients`). Uses default if omitted.
`date_from`	string	Filter start date (`YYYY-MM-DD`)
`date_to`	string	Filter end date (`YYYY-MM-DD`)
`origin`	string	Platform filter: `instantly`, `smartlead`, `emailbison`, `lemlist`
`date_grouping`	string	Group timeseries: `daily`, `weekly`, `monthly`

Returns: Per-campaign metrics, sent, replies, bounces, interested, reply rate, open rate, click rate, unsubscribes, start/end dates.

`get_campaign_drilldown`

Drill into a specific campaign to see individual contacts or companies.

Parameter	Type	Description
`campaign_id`	string	Required. Campaign identifier
`origin`	string	Required. Platform: `instantly`, `smartlead`, `emailbison`, `lemlist`
`metric_type`	string	What to show: `sends`, `prospects`, `replies`, `interested`, `bounces` (default: `sends`)
`client_name`	string	Workspace name
`date_start`	string	Filter start date
`date_end`	string	Filter end date
`search`	string	Search by email, name, or company
`group_by`	string	`contacts` or `companies` (default: `contacts`)
`limit`	integer	Max results (default: 100, max: 5000)

`get_campaign_stats`

Get high-level campaign statistics across all campaigns.

Parameter	Type	Description
`client_name`	string	Workspace name
`date_start`	string	Filter start date
`date_end`	string	Filter end date

`add_campaign_note`

Add or update a note on a campaign. Needs a read & write (RV-) key; with a read-only (RO-) key the call is refused.

Parameter	Type	Description
`campaign_id`	string	Required. Campaign identifier
`origin`	string	Required. Platform
`note`	string	Required. Note text
`client_name`	string	Workspace name

`archive_campaign`

Archive or unarchive a campaign. Needs a read & write (RV-) key; with a read-only (RO-) key the call is refused.

Parameter	Type	Description
`campaign_id`	string	Required. Campaign identifier
`origin`	string	Required. Platform
`archived`	boolean	`true` to archive, `false` to unarchive (default: `true`)
`client_name`	string	Workspace name

Contact Tools

`search_contacts`

Search contacts by email, name, domain, or LinkedIn URL.

Parameter	Type	Description
`client_name`	string	Workspace name
`email`	string	Filter by email address
`first_name`	string	Filter by first name
`last_name`	string	Filter by last name
`domain`	string	Filter by company domain
`linkedin_url`	string	Filter by LinkedIn URL

`get_contact`

Get full contact details including custom fields. email_statuses lists every source’s result for the contact’s email, newest check first, beside the email_status that wins. See Email Statuses.

Parameter	Type	Description
`contact_id`	string	Required. Contact ID
`client_name`	string	Workspace name

`update_contact`

Update a contact’s fields. Text such as \u00b7 that an agent sends as literal escape characters is saved as the real character, so a value with a middle dot matches a filter on it.

Parameter	Type	Description
`contact_id`	string	Required. Contact ID
`first_name`	string	New first name
`last_name`	string	New last name
`title`	string	New job title
`phone`	string	New phone number
`phone_type`	string	A phone contact’s type: `office`, `mobile`, `home`, `direct`, `fax`, `url` or `other`. An empty string clears it
`status`	string	New contact status. A real change is also recorded in the `api_status` custom field (Status Source Fields)
`custom_fields`	object	Key-value pairs of custom field updates
`email_status`	string	One source’s result for the contact’s email: `valid`, `invalid`, `risky`, `catchall`, `unknown`, `bounced` or `unsubscribed`. Map the tool’s own word to one of these; any other word is refused. An empty string removes that source’s result. Needs `email_status_source` and `email_status_checked_at`, or the call is refused before anything is sent
`email_status_source`	string	Who produced the result: `millionverifier`, `bounceban`, `leadmagic`, `apollo`, another integration, or a key added with `create_source`. `revyops` is kept for hand edits in the app and is refused
`email_status_checked_at`	string	When the source checked the email, ISO 8601 with a timezone such as `Z` or `+02:00`, taken from the tool’s own result. A time without a timezone is refused. A time earlier than that source’s stored result is ignored
`client_name`	string	Workspace name

Write a verifier’s result with email_status, not as a custom field such as “Million Verifier Result”: each source keeps its own result, and Email Statuses explains which one Email Status shows.

`create_person`

Create a person from their emails, LinkedIn URLs and phones, or add new ones to the person who already has the others. Calls POST /public/people, so sending the same call twice changes nothing.

Parameter	Type	Description
`emails`	array	Email addresses. Each item is a plain value or `{value, company_id, job_title, statuses}`; `statuses` is a list of `{source, status, observed_at, raw_value, live}`
`linkedin_urls`	array	LinkedIn profile URLs, plain or as objects like `emails` without `statuses`
`phones`	array	Phone numbers with their country code, plain or as objects; a phone object can also carry `phone_type`
`first_name`	string	First name
`last_name`	string	Last name
`job_title`	string	Job title for every identifier that doesn’t set its own
`company`	string or integer	Company ID or domain for every identifier that doesn’t set its own. The company must exist
`contact_status`	string	Contact status for the whole person
`custom_fields`	object	Key-value pairs of custom field values
`merge_into_person_ids`	array	Only after the user confirmed they are the same person: the `existing_person_ids` from a 409 `identifier_exists`
`client_name`	string	Workspace name

At least one identifier is needed and at most 20 are allowed. A value that already belongs to another person is refused with 409 identifier_exists, naming that person. The tool tells the agent to ask the user before merging.

`update_person`

Edit one person. Calls PATCH /public/people/{person_id}.

Parameter	Type	Description
`person_id`	integer	Required. Person ID
`first_name`	string	New first name, for every identifier
`last_name`	string	New last name, for every identifier
`contact_status`	string	New contact status for the whole person
`custom_fields`	object	Custom field updates; an empty value deletes the field
`emails`	object	`{add, update, remove}`. `add` takes values like `create_person`; `update` takes `{value, to, company_id, job_title, statuses}`, where `to` fixes the value in place; `remove` takes values or `{value, mode}`
`linkedin_urls`	object	Same as `emails`, without `statuses`
`phones`	object	Same as `emails`, without `statuses`; `add` and `update` items can carry `phone_type`
`merge_into_person_ids`	array	Only after the user confirmed a 409 `identifier_exists` on an add: its `existing_person_ids`
`client_name`	string	Workspace name

Removing an identifier with emails, activity, a CRM link or a do-not-contact mark is refused first with 409 would_delete_history; call again with mode detach (move it and its history to a new person) or delete. The last identifier can’t be removed.

Company Tools

`search_companies`

Search companies by domain or name.

Parameter	Type	Description
`client_name`	string	Workspace name
`domain`	string	Filter by company domain
`name`	string	Filter by company name

`get_company`

Get full company details including custom fields.

Parameter	Type	Description
`company_id`	string	Required. Company ID
`client_name`	string	Workspace name

`update_company`

Update a company’s fields.

Parameter	Type	Description
`company_id`	string	Required. Company ID
`name`	string	New company name
`status`	string	New status
`custom_fields`	object	Key-value pairs of custom field updates
`client_name`	string	Workspace name

Opportunity Tools

Opportunities synced from Close CRM or HubSpot are read-only except custom_fields; everything else is edited in that CRM. Creating, updating and deleting need a read & write (RV-) key. Field values are described on Opportunities.

`create_opportunity`

Create an opportunity linked to at least one contact or company. Linking contacts also links their companies unless company_ids is given.

Parameter	Type	Description
`name`	string	Required. Deal name
`client_name`	string	Workspace name
`amount`, `stage`, `status_type`, `stage_normalized`, `pipeline`, `confidence`, `value_period`, `dealtype`, `note`, `close_date`, `lost_reason`, `lost_reason_class`	various	Standard fields; see Opportunities
`contact_ids`	list	Contact IDs to link
`company_ids`	list	Company IDs to link
`custom_fields`	object	Opportunity custom field values. The fields must exist and each value must fit its type

`get_opportunity`

Get one opportunity with its linked contact and company IDs and custom fields. editable is false for synced opportunities.

Parameter	Type	Description
`opportunity_id`	integer	Required. Opportunity ID
`client_name`	string	Workspace name

`update_opportunity`

Update an opportunity. Only the arguments you pass change; contact_ids and company_ids replace the current links. Moving to a new stage records previous_stage and stage_changed_at, and won or lost sets closed_at once.

Parameter	Type	Description
`opportunity_id`	integer	Required. Opportunity ID
`client_name`	string	Workspace name
Same fields as `create_opportunity`	various	Synced opportunities accept only `custom_fields`
`clear_fields`	list	Field names to empty, for example `["close_date", "note"]`

`delete_opportunity`

Delete an opportunity created in RevyOps. Synced ones must be deleted in the CRM.

Parameter	Type	Description
`opportunity_id`	integer	Required. Opportunity ID
`client_name`	string	Workspace name

Email Tools

`search_emails`

Search email records by campaign, contact, or type.

Parameter	Type	Description
`client_name`	string	Workspace name
`campaign_id`	string	Filter by campaign
`contact_email`	string	Filter by contact email address
`email_type`	string	`INBOUND`, `OUTBOUND`, or `BOUNCED`
`limit`	integer	Max results (default: 50)

`mark_email_interested`

Mark a contact’s reply as interested. It marks the newest reply from that address, or the newest reply with exactly the subject you give. If the contact never replied but was emailed, it adds a placeholder reply, which counts as a reply for scoring. The change is queued, so it can take a few seconds to show. It cannot be undone from here; unmark in the app.

Parameter	Type	Description
`email`	string	Required. The contact’s email address
`subject`	string	Only mark the reply with exactly this subject. Leave out for the newest reply
`disposition`	string	Optional label to record with it
`client_name`	string	Workspace name

`get_email_thread`

Get the full email thread between your team and a contact.

Parameter	Type	Description
`contact_id`	string	Required. Contact ID
`client_name`	string	Workspace name
`campaign_id`	string	Filter to a specific campaign
`origin`	string	Filter to a specific platform

LinkedIn Tools

`get_linkedin_campaigns`

Get all LinkedIn campaigns with performance metrics for a workspace.

Parameter	Type	Description
`client_name`	string	Workspace name (from `list_clients`). Uses default if omitted.
`date_from`	string	Filter start date (`YYYY-MM-DD`)
`date_to`	string	Filter end date (`YYYY-MM-DD`)
`origin`	string	Platform filter, e.g. `heyreach`
`date_grouping`	string	Group timeseries: `daily`, `weekly`, `monthly`

Returns: Per-campaign metrics: messages sent, InMails sent, connection requests, profiles viewed, posts liked, replies, interested count, disposition breakdown, campaign dates.

`get_linkedin_campaign_drilldown`

Drill into a specific LinkedIn campaign to see individual contacts or companies.

Parameter	Type	Description
`campaign_id`	string	Required. Campaign identifier
`origin`	string	Required. Platform, e.g. `heyreach`
`metric_type`	string	What to show: `sends`, `prospects`, `replies`, `interested`, `connection_requests_sent`, `connection_requests_accepted`, `messages_sent`, `inmails_sent`, `message_replies`, `inmail_replies`, `profiles_viewed`, or `posts_liked` (default: `sends`)
`client_name`	string	Workspace name
`date_start`	string	Filter start date
`date_end`	string	Filter end date
`search`	string	Search by name, LinkedIn URL, or company
`group_by`	string	`contacts` or `companies` (default: `contacts`)
`limit`	integer	Max results (default: 100, max: 5000)

`get_linkedin_thread`

Get the full LinkedIn message thread between your team and a contact.

Parameter	Type	Description
`contact_id`	string	Required. The contact’s ID in RevyOps
`client_name`	string	Workspace name
`campaign_id`	string	Filter to a specific campaign
`origin`	string	Filter to a specific platform

Analytics Tools

`get_deliverability`

Get deliverability metrics broken down by sending domain and inbox.

Parameter	Type	Description
`client_name`	string	Workspace name
`date_start`	string	Filter start date
`date_end`	string	Filter end date

`get_contacts_stats`

Get contact-level aggregate statistics.

Parameter	Type	Description
`client_name`	string	Workspace name
`date_start`	string	Filter start (ISO datetime)
`date_end`	string	Filter end (ISO datetime)

`get_variable_report_variables`

Get available tracking variables and campaigns for A/B reporting.

Parameter	Type	Description
`client_name`	string	Workspace name
`start_date`	string	Filter start
`end_date`	string	Filter end

`get_variable_report`

Generate an A/B test style report grouped by tracking variables.

Parameter	Type	Description
`campaign_origin_pairs`	array	List of `[campaign_id, origin]` pairs
`variable_fields`	array	Tracking field names to group by
`variable_values`	array	Allowed values for each field
`client_name`	string	Workspace name
`start_date`	string	Filter start
`end_date`	string	Filter end

Integrations Tools

`list_integrations`

List every integration the workspace can connect (sequencers, CRMs and signals), whether it is connected, when it last synced, and the activity types it supplies with the newest record of each in the last 30 days. Call it before designing a play that depends on deal stage, customer status, replies or website visits. A connected integration whose last_received_at is null is connected but silent. Sequencers record emails sent, replied and bounced, never opens. Same data as List Integrations.

Parameter	Type	Description
`client_name`	string	Workspace name

Opportunity Mapping Tools

Normalized Stage and Lost Reason Category put every CRM’s deals on one scale. Each workspace maps its own stage and lost reason names once; unmapped values leave both fields empty. Won and lost deals are always closed. Both tools need a read & write (RV-) key.

`list_opportunity_mappings`

List the open deal stages and lost reasons this workspace’s synced deals carry, how many deals carry each, and the standard value each maps to (null when unmapped). Same data as List Opportunity Mappings.

Parameter	Type	Description
`client_name`	string	Workspace name

`map_opportunity_values`

Map stages or lost reasons onto the standard values. Only the values you send change, null removes a mapping, and stored deals update before the call returns. The answer lists every value with its deal count, so a mapping with deals: 0 is a typo or a stage no deal has reached yet. Same as Save Opportunity Mappings.

Parameter	Type	Description
`kind`	string	Required. `stage` or `lost_reason`
`origin`	string	Required. `closecrm` or `hubspot`
`mappings`	object	Required. Source value to standard value, e.g. `{"Proposal Sent": "proposal"}`. `stage` takes `qualification`, `discovery`, `evaluation`, `proposal` or `negotiation`; `lost_reason` takes `price`, `product_gap`, `timing`, `competitor`, `no_decision`, `disqualified` or `other`
`client_name`	string	Workspace name

Activity Sources Tools

Sources (origins) are the keys incoming activities are tagged with. A source’s scored_activities lists what it may send: standard types (email, call, linkedin_message, sms, whatsapp) plus custom:<activity type id> entries. revyops is the implicit source used when ingestion omits source.

`list_sources`

List the activity sources (origins) registered for a workspace. Each source has an id, a key (the value senders put in source), a display_name, and scored_activities.

Parameter	Type	Description
`client_name`	string	Workspace name

`create_source`

Register a new activity source (origin). Needs a read & write (RV-) key; with a read-only (RO-) key the call is refused.

Parameter	Type	Description
`key`	string	Required. Source key senders will use, 1-50 chars of lowercase letters, digits, `_` or `-`, starting with a letter or digit. Lower-cased automatically. Integration names such as `hubspot`, `instantly` and `millionverifier`, and `api`, are reserved. A source also names the tool behind an email status.
`display_name`	string	Required. Human-readable name
`scored_activities`	array	Activity types this source may send. Omit to bind it to every existing activity type; pass `[]` for a source bound to nothing yet.
`client_name`	string	Workspace name

`update_source`

Update a source’s display name or the activity types it may send. scored_activities replaces the whole list. Dropping a type stops the source from sending it and drops it from that type’s scoring rules. Needs a read & write (RV-) key; with a read-only (RO-) key the call is refused.

Parameter	Type	Description
`source_id`	integer	Required. Source id from `list_sources`
`display_name`	string	New display name
`scored_activities`	array	New full list of activity types
`client_name`	string	Workspace name

`delete_source`

Delete an activity source. Fails (409) if activities tagged with this source already exist. Needs a read & write (RV-) key; with a read-only (RO-) key the call is refused.

Parameter	Type	Description
`source_id`	integer	Required. Source id from `list_sources`
`client_name`	string	Workspace name

`set_activity_sources`

Set which sources feed a custom activity type. source_keys replaces the current set: keys not listed are unbound. Passing [] leaves the type on the built-in revyops source only. Only the workspace’s own custom activity types can be bound this way. Needs a read & write (RV-) key; with a read-only (RO-) key the call is refused.

Parameter	Type	Description
`activity_type_id`	string	Required. The type’s id from `list_custom_activity_types`
`source_keys`	array	Required. Source keys from `list_sources` that should feed this type
`client_name`	string	Workspace name

Custom Activity Types Tools

Custom activity types (“Activities”) are user-defined activities you can log against contacts/companies. Creating one also creates its scoring rule.

`list_custom_activity_types`

List the custom activity types defined for a workspace: id (external_object_type), name, applies_to (contact/company), field schema, and the source keys currently bound to it.

Parameter	Type	Description
`client_name`	string	Workspace name

`create_custom_activity_type`

Create a new custom activity type and its scoring rule. Needs a read & write (RV-) key; with a read-only (RO-) key the call is refused.

Parameter	Type	Description
`name`	string	Required. Display name of the activity type
`schema`	array	Field definitions, each `{field_name, type, available_options?}`. Type is one of `text`, `number`, `date`, `dropdown_singleselect`, `dropdown_multiselect`.
`applies_to`	string	`contact` or `company` (default: `contact`)
`weight`	integer	Score weight for the rule, -1000..1000
`decay_profile`	integer	Decay profile id (see `list_decay_profiles`). Omit for none.
`enabled`	boolean	Whether the scoring rule is active (default: `false`, so the new type scores nothing until you turn the rule on)
`source_keys`	array	Source keys (see `list_sources`) that may send this activity; sources must already exist. Omit to leave the type on `revyops` only.
`cap_mode`	string	Frequency cap, see `update_scoring_rule`. Omit for `every`.
`cap_n`	integer	Window size for `cap_mode="window"` (default: 1)
`cap_unit`	string	Window unit for `cap_mode="window"` (default: `day`)
`cap_identity_field`	string	Schema field for `cap_mode="identity"`; must match a `field_name` in `schema` exactly. A name that doesn’t match isn’t rejected, and the cap never applies, so every occurrence scores
`client_name`	string	Workspace name

`update_custom_activity_type`

Update a custom activity type’s name, field schema, or applies_to. Needs a read & write (RV-) key; with a read-only (RO-) key the call is refused.

Parameter	Type	Description
`activity_type_id`	string	Required. The type’s id (external_object_type) from `list_custom_activity_types`
`name`	string	New display name
`schema`	array	New list of field definitions
`applies_to`	string	`contact` or `company`
`client_name`	string	Workspace name

`delete_custom_activity_type`

Delete a custom activity type. Fails (409) if existing logged activities still use this type. Needs a read & write (RV-) key; with a read-only (RO-) key the call is refused.

Parameter	Type	Description
`activity_type_id`	string	Required. The type’s id (external_object_type)
`client_name`	string	Workspace name

`get_activity`

One logged activity: its type, properties, occured_at and linked contact, person and company IDs. Find IDs with query_entity on the type’s custom_activity_<id> entity, filtering on its fields as custom.<field_name>; the id column is the activity ID. editable is false for activities synced from another tool.

Parameter	Type	Description
`activity_id`	integer	Required. The activity’s ID
`client_name`	string	Workspace name

`update_activity`

Change one custom activity logged in RevyOps in place, such as a meeting’s outcome, without logging a new one. Properties you leave out keep their value and null clears one; values are checked against the activity type. The linked people and companies are rescored. Needs a read & write (RV-) key.

Parameter	Type	Description
`activity_id`	integer	Required. The activity’s ID
`properties`	object	Fields to change, e.g. `{"outcome": "Held"}`
`occured_at`	string	New date and time, ISO 8601
`client_name`	string	Workspace name

`delete_activity`

Delete one custom activity logged in RevyOps. The type and the person’s other activities stay, and the linked people and companies are rescored. Synced activities are deleted at their source. Needs a read & write (RV-) key.

Parameter	Type	Description
`activity_id`	integer	Required. The activity’s ID
`client_name`	string	Workspace name

Scoring Rules Tools

`list_scoring_rules`

List a workspace’s scoring rules. Auto-provisions any missing standard/custom rules. One rule per logical activity event; its origins lists every source it scores. Each rule carries a frequency_cap.

Parameter	Type	Description
`client_name`	string	Workspace name

`update_scoring_rule`

Update a scoring rule’s weight, decay profile, enabled state, or frequency cap. The rule’s activity type, condition, and origins are system-owned. Needs a read & write (RV-) key; with a read-only (RO-) key the call is refused. The frequency cap limits how often the rule adds points to one person:

every: each occurrence scores (no cap).
window: one occurrence per cap_n x cap_unit bucket (UTC-anchored, fixed buckets).
identity: one occurrence per distinct value of cap_identity_field. Only rules carrying a field schema (custom activities, meetings) can cap this way; email/LinkedIn/SMS/WhatsApp/call rules reject this mode.

Parameter	Type	Description
`rule_id`	integer	Required. Rule id from `list_scoring_rules`
`weight`	integer	New weight, -1000..1000
`decay_profile`	integer	New decay profile id (see `list_decay_profiles`)
`enabled`	boolean	True to activate, false to disable
`cap_mode`	string	`every`, `window`, or `identity`
`cap_n`	integer	Window size, >= 1. Required with `cap_mode="window"`.
`cap_unit`	string	`hour`, `day`, `week`, or `month`. Required with `cap_mode="window"`.
`cap_identity_field`	string	Activity field name, required for `identity`. Must match a schema `field_name` exactly. A misspelled name isn’t rejected: the cap never applies, so every occurrence scores, and an occurrence sent without the field scores every time too.
`client_name`	string	Workspace name

Decay Profiles Tools

Decay profiles define how a score contribution fades: period is in days, where -1 means persistent (no decay).

`list_decay_profiles`

List scoring decay profiles for a workspace.

Parameter	Type	Description
`client_name`	string	Workspace name

`create_decay_profile`

Create a custom scoring decay profile. Needs a read & write (RV-) key; with a read-only (RO-) key the call is refused.

Parameter	Type	Description
`name`	string	Required. Profile name (must be unique for the workspace)
`period`	integer	Required. Decay period in whole days (>= 1)
`client_name`	string	Workspace name

`update_decay_profile`

Update a scoring decay profile’s name or period. System profiles may forbid editing name and/or period. Needs a read & write (RV-) key; with a read-only (RO-) key the call is refused.

Parameter	Type	Description
`profile_id`	integer	Required. The decay profile id
`name`	string	New name
`period`	integer	New period in whole days (>= 1)
`client_name`	string	Workspace name

`delete_decay_profile`

Delete a custom scoring decay profile. System (built-in) profiles cannot be deleted (400). Needs a read & write (RV-) key; with a read-only (RO-) key the call is refused.

Parameter	Type	Description
`profile_id`	integer	Required. The decay profile id
`client_name`	string	Workspace name

Scoring Settings Tools

Workspace-wide scoring settings. A company’s score is its own activities plus the scores of its top N people by Activity Score; people with a negative score always count.

`get_scoring_settings`

Get the workspace’s scoring settings: company_top_people, the roll-up limit (default 10).

Parameter	Type	Description
`client_name`	string	Workspace name

`update_scoring_settings`

Set how many top people roll up into a company’s score. Changing it recalculates the workspace’s scores in the background. Needs a read & write (RV-) key; with a read-only (RO-) key the call is refused.

Parameter	Type	Description
`company_top_people`	integer	Required. People counted per company, 1-500
`client_name`	string	Workspace name

Settings Documents Tools

Settings documents are the agency’s Markdown AI agent prompts, guides, shared documents, and Ideal Customer Profiles (ICPs), assigned per workspace. kind is agent_prompt (prompts, guides, shared documents) or icp.

`list_folders`

List the folders holding settings documents assigned to a workspace: id, name, and how many of the workspace’s documents sit in each.

Parameter	Type	Description
`kind`	string	`agent_prompt` (default) or `icp`
`client_name`	string	Workspace name

`list_documents`

List the settings documents assigned to a workspace: id, name, folder, type, rev, locked and owner_level (content is null; read it with get_document). locked is worked out for the key calling: true means this key cannot write the document. owner_level is platform (Guides and the Your Setup templates), agency (shared across the agency’s workspaces) or client (this workspace’s alone). Each API key belongs to one workspace, so you see that workspace’s view only.

Parameter	Type	Description
`kind`	string	`agent_prompt` (default) or `icp`
`folder`	string	Only documents in the folder with this name (from `list_folders`)
`client_name`	string	Workspace name

`get_document`

Read one settings document (name, rev, locked, and Markdown content). For long documents, call with outline=True first to get the headings, then read just the part you need with section.

Parameter	Type	Description
`document_id`	integer	Required. Id from `list_documents` or `search_documents`
`kind`	string	`agent_prompt` (default) or `icp`
`section`	string	A heading’s exact title (case-insensitive); returns that heading down to the next heading of the same or higher level
`outline`	boolean	True returns headings (level, title, line) and content length, no content (default: `false`)
`client_name`	string	Workspace name

`search_documents`

Find which settings documents mention something, without reading them all. Matches names and content (case-insensitive substring); returns id, name, folder, rev, match count, and the first few matching lines with line numbers. Up to 20 documents, most recently updated first.

Parameter	Type	Description
`query`	string	Required. Text to look for, at least 2 characters
`kind`	string	`agent_prompt` (default) or `icp`
`folder`	string	Only search the folder with this name
`client_name`	string	Workspace name

`put_document`

Create a settings document, or update one. Only the fields passed change. Without document_id, creates a document assigned to this workspace only (name required). With document_id, content you pass replaces the whole body (to change a few lines, use patch_document). Content is capped at 64,000 characters. Locked documents (Guides) and documents shared with other workspaces are read-only. Needs a read & write (RV-) key; with a read-only (RO-) key the call is refused.

Parameter	Type	Description
`kind`	string	`agent_prompt` (default) or `icp`
`document_id`	integer	Id from `list_documents`; omit to create
`name`	string	Document name
`content`	string	Full Markdown body
`entity_type`	string	`contact`, `company`, or `person`. agent_prompt default: `contact`. icp default: `company`.
`folder`	string	Folder name, created if it doesn’t exist yet; `""` moves the document out of its folder
`type`	string	agent_prompt kind only, on create: `agent_prompt` (default) or `shared_document`. Fixed afterwards.
`rev`	string	On update: the rev from your last read. If the document changed since, the write is refused with 409. Without rev the write always goes through.
`client_name`	string	Workspace name
`folder_id`	integer	The `folder_id` a read returned. Same as `folder`, by id. Pass one or the other.
`document_type`	string	The `document_type` a read returned. Same as `type`.
`owner_level`	string	Accepted so a read can be written back unchanged, but never set: it follows from the type and folder. When passed, the reply lists it under `ignored_parameters`.

Every document in a reply carries kind (agent_prompt or icp), so a read holds everything needed to write it back: send the same kind, folder_id and document_type.

`patch_document`

Change part of a settings document: replace exact snippets and/or append text. Edits run in order, then append. Each find must appear exactly once (after prior edits run); otherwise nothing changes. Locked documents are refused. Needs a read & write (RV-) key; with a read-only (RO-) key the call is refused.

Parameter	Type	Description
`document_id`	integer	Required. Id from `list_documents` or `search_documents`
`kind`	string	`agent_prompt` (default) or `icp`
`edits`	array	Find/replace pairs, each `{find, replace}`, applied in order
`append`	string	Text added at the end, starting on its own line
`rev`	string	The rev from your last read; refused with 409 (and the current rev) if the document changed since
`client_name`	string	Workspace name

`delete_document`

Permanently delete a settings document this workspace owns alone. There is no undo. Locked documents and documents shared with other workspaces cannot be deleted here. Needs a read & write (RV-) key; with a read-only (RO-) key the call is refused.

Parameter	Type	Description
`document_id`	integer	Required. Id from `list_documents` or `search_documents`
`kind`	string	`agent_prompt` (default) or `icp`
`client_name`	string	Workspace name

`document_versions`

List a document’s saved versions, newest first (id, name, who saved it, when, length), or read one version in full with version_id. Every save is kept; the list comes a page at a time.

Parameter	Type	Description
`document_id`	integer	Required. Id from `list_documents` or `search_documents`
`kind`	string	`agent_prompt` (default) or `icp`
`version_id`	integer	A version id from the list, to read that version’s content
`before`	integer	Only versions older than this version id (the next page)
`limit`	integer	Versions per page, 1 to 200 (default 20)

`restore_document_version`

Put an earlier version of a document back. The restore is saved as a new version, so nothing is lost and it can itself be undone. Needs the same rights as editing the document. Returns the new rev and the length, not the content. Needs a read & write (RV-) key; with a read-only (RO-) key the call is refused.

Parameter	Type	Description
`document_id`	integer	Required. Id from `list_documents` or `search_documents`
`version_id`	integer	Required. The version to restore, from `document_versions`
`kind`	string	`agent_prompt` (default) or `icp`
`rev`	string	The rev from your last read; refused with 409 if the document changed since

​Authentication

​Workspace Tools

​list_clients

​Filter & Query Tools

​get_filter_schema

​get_field_options

​query_entity

​list_activity_conditions

​activity_condition

​list_saved_views

​save_view

​delete_saved_view

​Workflow Tools

​list_workflows

​get_workflow

​create_workflow

​update_workflow

​add_workflow_step

​update_workflow_step

​move_workflow_step

​remove_workflow_step

​add_workflow_path

​update_workflow_path

​remove_workflow_path

​set_workflow_client_values

​get_workflow_fields

​get_workflow_ai_options

​list_workflow_test_records

​test_workflow_step

​turn_workflow_on

​turn_workflow_off

​publish_workflow_draft

​discard_workflow_draft

​delete_workflow

​list_workflow_runs

​Custom Fields Tools

​list_custom_fields

​create_custom_field

​Agency Custom Fields Tools

​list_agency_custom_fields

​update_agency_custom_field

​promote_custom_field

​Campaign Tools

​get_campaigns

​get_campaign_drilldown

​get_campaign_stats

​add_campaign_note

​archive_campaign

​Contact Tools

​search_contacts

​get_contact

​update_contact

​create_person

​update_person

​Company Tools

​search_companies

​get_company

​update_company

​Opportunity Tools

​create_opportunity

​get_opportunity

​update_opportunity

​delete_opportunity

​Email Tools

​search_emails

​mark_email_interested

​get_email_thread

​LinkedIn Tools

​get_linkedin_campaigns

​get_linkedin_campaign_drilldown

​get_linkedin_thread

​Analytics Tools

​get_deliverability

​get_contacts_stats

​get_variable_report_variables

​get_variable_report

​Integrations Tools

​list_integrations

​Opportunity Mapping Tools

​list_opportunity_mappings