← Back to all apps

Close

Sales And Marketingby Elastic, Inc.
Launched Jul 11, 2026 on ChatGPT

The Close MCP server is a secure, standardized interface that lets Claude directly access and interact with your Close data. Core functionality with Claude:

• Connects Close to Claude via the Model Context Protocol so Claude can use Close as a trusted system of record.

• Read data (e.g., leads, contacts, opportunities, activities) based on your Close permissions.

• Optionally write data — you can allow only safe writes (e.g., create a lead) or full writes (e.g., edit/delete) during setup.

• Enables Claude to answer questions, summarize information, and perform actions in Close.

121ChatGPT Tools
55Claude Tools
Elastic, Inc.Developer
Sales And MarketingCategory

Use Cases

sales-and-marketing

Available Tools

Activity Search

activity_search
Full Description

Search for activities. Results are returned ordered by date descending.

Examples:

  • To list activities on a lead, use the lead_ids filter.
  • To list conversations, filter for calls and meetings.
  • Filter for Email to get individual messages, or EmailThread to get one

result per conversation. An unfiltered search returns both.

Parameters (0 required, 10 optional)
Optional
activity_atobject

Filter activities by timestamp. For EmailThread, this is the timestamp of its most recent email.

Default: null
activity_typesarray
Default: null
agent_config_idsarray

Filter by voice agent config IDs. Matches Call, Email, and SMS activities that carry an agent_config_id; other activity types are filtered out implicitly because the field is not indexed for them.

Default: null
call_statusstring

Filter calls by status (e.g. completed, no-answer, busy). Only meaningful when activity_types includes Call; a no-op unless Call is searched. Other activity types use different status vocabularies, so they never match these values and are effectively excluded.

Default: null
contact_idsarray
Default: null
cursorstring

Pagination cursor, give only when more results are requested.

Default: null
directionstring

Filter activities by direction (inbound = received by the user, outbound = sent by the user). Applies to Call, SMS, Email, and WhatsApp activities; activity types that have no direction (e.g. Note, Task) are excluded when this filter is set.

Default: null
lead_idsarray
Default: null
lead_smart_view_idsarray
Default: null
user_idsarray
Default: null

Aggregate Objects

aggregation
Full Description

Perform an aggregation to answer questions like:

  • How many emails were sent this week?
  • Calls by user this week (Who made the most?)

You MUST first fetch the list of available fields using the get_fields tool.

Parameters (1 required, 5 optional)
Required
include_typesarray

Object types to include in aggregation

Optional
aggregationsarray

Aggregation specifications to compute

Default: null
display_modestring

Determined automatically by default.

Default: null
group_byarray

Reference or enum fields to group by, max 2

Default: null
intervalstring

Interval to aggregate by when using date fields. Determined automatically by default.

Default: null
time_bucketsobject

Time buckets

Default: null

Apply Voice Agent Update

apply_voice_agent_update
Full Description

Apply a previously proposed voice agent update.

This tool persists the server-stored proposal identified by proposal_id. It does not rerun the feedback processor, and it fails if the proposal has expired or the voice agent changed after the proposal was created.

Parameters (1 required)
Required
proposal_idstring

Proposal ID returned by propose_voice_agent_update.

Close Product Knowledge Search

close_product_knowledge_search
Full Description

Search Close product documentation and knowledge base for relevant information.

Use this tool when users ask about:

  • How to use specific Close features
  • Close API documentation and integration
  • Workflow automation and best practices
  • Product capabilities and limitations
  • Setup and configuration guidance

Example queries:

  • "How do I set up automated lead assignment?"
  • "What are Close's API rate limits?"
  • "How to create custom fields in Close?"
  • "Best practices for email templates in Close"
Parameters (1 required)
Required
querystring

Natural language query to search Close product documentation and knowledge

Create Address

create_address
Full Description

Add a new address to an existing lead (company).

Parameters (7 required, 1 optional)
Required
address_1string

Address line 1

citystring

City

countrystring

Country code (ISO 3166-1 alpha-2)

labelstring

Label for the address

lead_idstring

ID of the lead to add the address to

statestring

State or province

zipcodestring

ZIP or postal code

Optional
address_2string

Address line 2

Default: null

Create Call Task

create_call_task
Full Description

Schedule a call task on a lead, assigned to either a user or a voice agent (Chloe).

A call task represents a scheduled outbound call that will be made to the specified contact at the given time. The task can be assigned to a specific user or dispatched to a voice agent.

Parameters (2 required, 4 optional)
Required
contact_idstring

ID of the contact to call. Must belong to the specified lead.

lead_idstring

ID of the lead this call task belongs to

Optional
agent_config_idstring

ID of the voice agent (Chloe) to dispatch the call task to. Mutually exclusive with assigned_to.

Default: null
assigned_tostring

ID of the user to assign the call task to. Mutually exclusive with agent_config_id.

Default: null
due_datestring

Due date or datetime for the call task. Can be a date (YYYY-MM-DD) or datetime (ISO 8601). If not provided, the task will be due immediately.

Default: null
textstring

The call task description/instructions.

Default: null

Create Comment

create_comment
Full Description

Add a comment to a commentable object (note, call, opportunity, task, custom object, etc.).

If the object already has a comment thread, the new comment is appended to it. Otherwise a new thread is started for the object. Use this tool for both starting a conversation and replying to an existing one — the object_id alone determines which.

Comments support @-mentions of users and groups. The body is HTML.

Parameters (2 required)
Required
bodystring

Body of the comment as Close rich text (HTML). Must be a valid Close rich-text document: wrap the whole content in a single <body> tag and put each line/paragraph in a block-level tag. Supported tags include <p>, <h1>-<h6>, <ul>/<ol> with <li>, <blockquote>, <hr>, <a href=...>, <br>, and inline formatting <strong>/<b>, <em>/<i>, <u>, <s>, <code>, <span>. Emoji and unicode are accepted. Escape literal '&' as '&amp;' and literal '<' as '&lt;' in text content. To @-mention a user, call the `org_users` tool to look up the target user and embed their `mention_html` value verbatim in the body. To @-mention a group, call the `find_groups` tool to look up the target group and embed their `mention_html` value verbatim in the body. Example: <body><p>Nice work <span data-type="mention" data-id="user_abc123" data-label="Jane Doe" class="mention">@Jane Doe</span> on closing this!</p></body>

object_idstring

ID of the commentable object: an activity ID (acti_..., e.g. a note, call, email, SMS, meeting, or custom activity), an opportunity ID (oppo_...), a task notification ID (task_...), or a custom object ID (custobj_...). One comment thread exists per object; this tool adds to it or creates it if none exists yet.

Create Contact

create_contact
Full Description

Create a new contact for a lead.

A contact represents a person associated with a lead (company).

Parameters (1 required, 6 optional)
Required
lead_idstring

ID of the lead this contact belongs to

Optional
custom_fieldsarray

Custom field values to set on this object. Only the custom fields included are modified; omitted fields are left unchanged.

emailsarray

List of email addresses for the contact

Default: null
namestring

Name of the contact

Default: null
phonesarray

List of phone numbers for the contact

Default: null
titlestring

Job title of the contact

Default: null
urlsarray

List of URLs for the contact

Default: null

Create Custom Activity Instance

create_custom_activity_instance
Full Description

Create a new custom activity instance on a lead.

A custom activity instance is an activity of a custom activity type, holding the custom field values defined by that type. Use the find_custom_activities tool to look up the available custom activity types.

If in an interactive session, ask the user for the relevant field values (including custom fields) before creating, even if they are not required.

Parameters (2 required, 7 optional)
Required
custom_activity_type_idstring

ID of the custom activity type. Use the find_custom_activities tool to look up the available custom activity types.

lead_idstring

ID of the lead this custom activity belongs to

Optional
activity_atstring

When the custom activity occurred

Default: null
contact_idstring

ID of the contact to associate with the custom activity

Default: null
custom_fieldsarray

Custom field values to set on this object. Only the custom fields included are modified; omitted fields are left unchanged.

date_createdstring

When the custom activity was created. Defaults to now; set this to backfill an activity at a past time.

Default: null
pinnedboolean

Whether to pin the custom activity to the top of the lead's timeline

Default: False
statusstring

Status of the custom activity. Published activities validate required custom fields; draft activities do not.

Options:draftpublished
Default: published
user_idstring

ID of the user to attribute the custom activity to (defaults to the caller)

Default: null

Create Custom Object Instance

create_custom_object_instance
Full Description

Create a new custom object instance on a lead.

A custom object instance is a record of a custom object type, attached to a lead and holding the custom field values defined by that type. Use the find_custom_object_types tool to look up the available custom object types.

If in an interactive session, ask the user for the relevant field values (including custom fields) before creating, even if they are not required.

Parameters (3 required, 1 optional)
Required
custom_object_type_idstring

ID of the custom object type that defines this instance's shape and custom fields. Use the find_custom_object_types tool to look up the available custom object types.

lead_idstring

ID of the lead this custom object belongs to

namestring

Display name for the custom object instance

Optional
custom_fieldsarray

Custom field values to set on this object. Only the custom fields included are modified; omitted fields are left unchanged.

Create Draft Email

create_draft_email
Full Description

Create a draft email on a lead.

The email is saved as an unsent draft for the user to review, edit, and send from Close; it is never sent automatically. Provide the body as Close rich text (HTML) via body_html; the sender's saved email signature is appended automatically. To create a reply in an existing thread, provide the ID of the email being replied to via in_reply_to_id.

Parameters (1 required, 9 optional)
Required
lead_idstring

ID of the lead this draft email belongs to

Optional
bccarray

List of BCC email addresses

Default: null
body_htmlstring

Draft body as Close rich text (HTML). Wrap the whole content in a single <body> tag and put each line/paragraph in a block-level tag. Supported tags include <p>, <h1>-<h6>, <ul>/<ol> with <li>, <blockquote>, <hr>, <a href=...>, <br>, and inline formatting <strong>/<b>, <em>/<i>, <u>, <s>, <code>, <span>. Escape literal ampersands as '&amp;'. Example: <body><p>Hi <strong>Jane</strong>,</p><p>Following up on our call.</p></body>. Do not include a signature block (name, title, company, contact details); the sender's saved email signature is appended automatically. A short closing line such as 'Best,' is fine.

Default: null
body_textstring

Plaintext body content. Prefer body_html; if only one of body_html/body_text is provided the other is derived automatically.

Default: null
ccarray

List of CC email addresses

Default: null
contact_idstring

ID of the contact this draft email is addressed to

Default: null
in_reply_to_idstring

ID of the email this draft replies to. The draft joins that email's thread.

Default: null
senderstring

Email address of a connected sending identity, including aliases. Must match an available sender for the current user.

Default: null
subjectstring

Subject line of the email

Default: null
toarray

List of recipient email addresses

Default: null

Create Email Template

create_email_template
Full Description

Create a new email template.

Handling of attachments and unsubscribe links via this tool is currently unsupported.

Email template body should be HTML formatted.

Use template tags as placeholders, for example: {{ organization.name }} to refer to the sender's organization name. {{ user.first_name }} {{ user.last_name }} {{ user.email }} {{ user.phone }} to refer to the user sending the email. {{ lead.display_name }} to refer to the lead name (recipient's name/company). {{ contact.first_name }} {{ contact.last_name }} to refer to the recipient.

Parameters (3 required, 3 optional)
Required
bodystring
namestring
subjectstring
Optional
bccarray
Default: null
ccarray
Default: null
is_sharedboolean

Share this template with the organization (required for use in workflows)

Default: False

Create Lead

create_lead
Full Description

Create a new lead (company).

After creating a lead, you should usually add an address or contact (including phone or email) to the lead.

Parameters (0 required, 5 optional)
Optional
custom_fieldsarray

Custom field values to set on this object. Only the custom fields included are modified; omitted fields are left unchanged.

descriptionstring

Description of the lead

Default: null
namestring

Name of the lead

Default: null
status_idstring

ID of the lead status

Default: null
urlstring

URL of the lead's website

Default: null

Create Lead Status

create_lead_status
Full Description

Create a new lead status.

Parameters (1 required)
Required
labelstring

Label for the lead status

Create Note

create_note
Full Description

Create a new note on a lead.

A note is a text-based activity attached to a lead. At least one of note (plaintext) or note_html (rich text) must be provided.

Parameters (1 required, 7 optional)
Required
lead_idstring

ID of the lead this note belongs to

Optional
activity_atstring

When the note activity occurred

Default: null
contact_idstring

ID of the contact to associate with the note

Default: null
notestring

Plaintext note content

Default: null
note_htmlstring

Rich-text (HTML) note content

Default: null
pinnedboolean

Whether to pin the note to the top of the lead

Default: null
titlestring

Title of the note

Default: null
user_idstring

ID of the user to attribute the note to (defaults to caller)

Default: null

Create Opportunity

create_opportunity
Full Description

Create a new opportunity.

Requires a lead ID and status ID. Other fields are optional. The value should be specified in cents (e.g., $100.00 = 10000).

Parameters (2 required, 9 optional)
Required
lead_idstring

ID of the lead this opportunity belongs to

status_idstring

ID of the opportunity status

Optional
close_atstring

Expected close date

Default: null
confidenceinteger

Confidence percentage (0-100)

Default: null
contact_idstring

ID of the primary contact for this opportunity

Default: null
custom_fieldsarray

Custom field values to set on this object. Only the custom fields included are modified; omitted fields are left unchanged.

notestring

Plaintext version of the note.

Default: null
note_htmlstring

Rich-text HTML version of the note, wrapped in `<body>...</body>` (e.g. `<body><p>text with <strong>bold</strong></p></body>`). When set, `note` is automatically derived from it, overriding any `note` value passed in the same request.

Default: null
user_idstring

ID of the user assigned to this opportunity. Defaults to the current user.

Default: null
valueinteger

Value in cents

Default: null
value_periodstring

Period for the value

Default: null

Create Opportunity Status

create_opportunity_status_tool
Full Description

Create a new opportunity status.

Parameters (3 required)
Required
labelstring

Label for the opportunity status

pipeline_idstring

ID of the pipeline to add the status to

typestring

Type of the opportunity status

Options:wonlostactive

Create Pipeline

create_pipeline
Full Description

Create a new opportunity pipeline.

Use the create_opportunity_status tool to add statuses to the pipeline.

Parameters (1 required)
Required
namestring

Name of the pipeline

Create SMS Template

create_sms_template
Full Description

Create a new SMS template.

Handling of attachments via this tool is currently unsupported.

Use template tags as placeholders, for example: {{ organization.name }} to refer to the sender's organization name. {{ user.first_name }} {{ user.last_name }} {{ user.email }} {{ user.phone }} to refer to the user sending the message. {{ lead.display_name }} to refer to the lead name (recipient's name/company). {{ contact.first_name }} {{ contact.last_name }} to refer to the recipient.

Parameters (2 required, 1 optional)
Required
namestring
textstring
Optional
is_sharedboolean

Share this template with the organization (required for use in workflows)

Default: False

Create Task

create_task
Full Description

Create a new task for a lead.

A task represents a to-do item that can be assigned to a user and optionally associated with a contact.

Parameters (2 required, 5 optional)
Required
lead_idstring

ID of the lead this task belongs to

textstring

The task description

Optional
assigned_tostring

ID of the user to assign the task to. Defaults to the current user if not provided.

Default: null
contact_idstring

ID of the contact associated with this task. Must belong to the specified lead.

Default: null
due_datestring

Due date or datetime for the task. Can be a date (YYYY-MM-DD) or datetime (ISO 8601). If not provided, the task will be due immediately.

Default: null
prioritystring

Task priority: 'high' or 'medium'. Defaults to 'medium'. Only set to high if the user explicitly says it's a high priority task.

Default: null
send_notificationboolean

Send an email notification to the assigned user. Assume notifications should be sent unless the user explicitly tells you not to.

Default: True

Create Workflow

create_workflow
Full Description

Create a new workflow (a.k.a. sequence) with Draft status.

Parameters (2 required, 2 optional)
Required
namestring

Workflow name. Must be unique.

stepsarray

Steps in the workflow. The `step_type` of each step has to exactly match one of the defined types in the mapping.

Optional
goal_criteriaobject

Conditions that stop a workflow run early, before its remaining steps run. Any one of them stops the run; they are never AND-ed. Use the defaults when the user does not specify what should stop the workflow.

trigger

The trigger that determines when and how the workflow fires. The `trigger_type` must exactly match one of the defined types. Use 'contact-manual' (the default) when the user does not specify a trigger.

Default: {'trigger_type': 'contact-manual'}

Customized Builtin Labels

customized_builtin_labels
Full Description

Return the customized builtin labels.

Only renamed labels are returned - an empty result means the default names apply.

Delete Address

delete_address
Full Description

Delete an address from an existing lead (company) if there is an exact match.

Parameters (7 required, 1 optional)
Required
address_1string

Address line 1

citystring

City

countrystring

Country code (ISO 3166-1 alpha-2)

labelstring

Label for the address

lead_idstring

ID of the lead to delete the address from

statestring

State or province

zipcodestring

ZIP or postal code

Optional
address_2string

Address line 2

Default: null

Delete Call Task

delete_call_task
Full Description

Delete a call task. Does not affect sibling tasks.

Parameters (1 required)
Required
idstring

The ID of the call task to delete.

Delete Contact

delete_contact
Full Description

Permanently delete an existing contact.

This will remove the contact from its lead including its email addresses, phone numbers, and URLs will be removed. Activities on the lead are not affected.

This action cannot be undone.

ONLY call this if the user specifically instructed you to delete the contact.

Parameters (1 required)
Required
idstring

ID of the contact to delete

Delete Custom Activity Instance

delete_custom_activity_instance
Full Description

Permanently delete an existing custom activity instance.

This action cannot be undone.

ONLY call this if the user specifically instructed you to delete the custom activity instance.

Parameters (1 required)
Required
idstring

ID of the custom activity instance to delete

Delete Custom Object Instance

delete_custom_object_instance
Full Description

Permanently delete an existing custom object instance.

A custom object instance is a record of a custom object type, attached to a lead and holding the custom field values defined by that type. This action cannot be undone.

ONLY call this if the user specifically instructed you to delete the custom object instance.

Parameters (1 required)
Required
idstring

ID of the custom object instance to delete

Delete Email Template

delete_email_template
Full Description

Permanently delete an email template.

If the template is used in any workflows (sequences), it cannot be deleted.

Parameters (1 required)
Required
idstring

ID of the email template to delete

Delete Lead

delete_lead
Full Description

Permanently delete an existing lead (company) by ID including all of its addresses, contacts, opportunities, tasks, and activities.

ONLY call this if the user specifically instructed you to delete the lead, and you confirmed what the deletion will entail and that it cannot be reversed.

Parameters (1 required)
Required
idstring

ID of the lead to delete

Delete Lead Smart View

delete_lead_smart_view
Full Description

Permanently delete a lead smart view (saved search).

Parameters (1 required)
Required
idstring

ID of the lead smart view to delete

Delete Lead Status

delete_lead_status
Full Description

Permanently delete a lead status.

Cannot delete if it's the last lead status in the organization or there are leads currently using this status.

Parameters (1 required)
Required
idstring

ID of the lead status to delete

Delete Note

delete_note
Full Description

Permanently delete an existing note.

This action cannot be undone.

ONLY call this if the user specifically instructed you to delete the note.

Parameters (1 required)
Required
idstring

ID of the note to delete

Delete Opportunity

delete_opportunity
Full Description

Permanently delete an opportunity.

This action cannot be undone. All data associated with the opportunity will be removed.

Parameters (1 required)
Required
idstring

ID of the opportunity to delete

Delete Opportunity Status

delete_opportunity_status_tool
Full Description

Permanently delete an opportunity status.

Cannot delete if it's the last opportunity status in the organization or there are opportunities currently using this status.

Parameters (1 required)
Required
idstring

ID of the opportunity status to delete

Delete Pipeline

delete_pipeline
Full Description

Permanently delete an opportunity pipeline.

A pipeline can only be deleted if it has no statuses. The last pipeline cannot be deleted.

Parameters (1 required)
Required
idstring

ID of the pipeline to delete

Delete SMS Template

delete_sms_template
Full Description

Permanently delete an SMS template.

If the template is used in any workflows (sequences), it cannot be deleted.

Parameters (1 required)
Required
idstring

ID of the SMS template to delete

Delete Task

delete_task
Full Description

Permanently delete an existing task by ID.

This action cannot be undone.

ONLY call this if the user specifically instructed you to delete the task.

Parameters (1 required)
Required
idstring

ID of the task to delete

Enrich Field

enrich_field
Full Description

Use AI to determine and set the value of a field on a lead or contact.

The field is enriched using available data on the object and external sources, and the enriched value is written back to the object. By default the value is only written if the field is currently empty; set overwrite_existing_value to True to replace an existing value.

Returns the enriched value along with the model's reasoning and confidence.

Parameters (3 required, 1 optional)
Required
field_idstring

The ID of the field to enrich. This may be a built-in field name or a custom field ID.

object_idstring

The ID of the lead or contact to enrich (e.g. 'lead_xxx' or 'cont_xxx').

object_typestring

The type of object whose field should be enriched.

Options:leadcontact
Optional
overwrite_existing_valueboolean

Whether to overwrite an existing value. When False, the field is only written if it is currently empty.

Default: False

Fetch Object

fetch
Full Description

Retrieve the contents of an arbitrary object by its ID.

Currently supported are leads and contacts.

Parameters (1 required)
Required
idstring

Fetch Call

fetch_call
Full Description

Fetch a single call activity by ID.

Returns the call's direction, outcome, participants, and (if available) its transcript.

Parameters (1 required)
Required
idstring

The ID of the call to fetch.

Fetch Call Task

fetch_call_task
Full Description

Fetch a single call task by ID.

Parameters (1 required)
Required
idstring

The ID of the call task to fetch.

Fetch Comment

fetch_comment
Full Description

Fetch a single comment by ID.

Returns the comment's rich-text (HTML) body, the thread and lead it belongs to, its @-mentions, and the resolved author and last-editor names.

Parameters (1 required)
Required
idstring

ID of the comment to fetch.

Fetch Contact

fetch_contact
Full Description

Fetch an existing contact by ID.

Returns the contact's details including name, title, email addresses, phone numbers, and URLs.

Parameters (1 required)
Required
idstring

ID of the contact to fetch

Fetch Custom Activity Instance

fetch_custom_activity_instance
Full Description

Fetch an existing custom activity instance by ID.

A custom activity instance is an activity of a custom activity type, holding the custom field values defined by that type. Returns the full instance, including its custom field values and the resolved lead, contact, and user names.

Parameters (1 required)
Required
idstring

ID of the custom activity instance to fetch

Fetch Custom Object Instance

fetch_custom_object_instance
Full Description

Fetch an existing custom object instance by ID.

A custom object instance is a record of a custom object type, attached to a lead and holding the custom field values defined by that type. Returns the full instance, including its custom field values and the resolved lead, custom object type, and creator/updater names.

Parameters (1 required)
Required
idstring

ID of the custom object instance to fetch

Fetch Custom Object Type

fetch_custom_object_type
Full Description

Fetch a single custom object type by its ID.

A custom object type defines the shape of a category of custom objects, including the custom fields its instances hold. Returns the type with its custom fields.

Parameters (1 required)
Required
idstring

ID of the custom object type to fetch.

Fetch Email

fetch_email
Full Description

Fetch a single email activity by ID.

Parameters (1 required, 2 optional)
Required
idstring

The ID of the email to fetch.

Optional
body_formatstring

Which representation of the body to return. Request 'html' to preserve formatting, e.g. when quoting the email in a reply.

Options:texthtml
Default: text
include_quoted_chainboolean

Whether to include the quoted chain of earlier replies if present. May be necessary if the author replied inline or if quoting the full body when generating a reply.

Default: False

Fetch Email Template

fetch_email_template
Full Description

Fetch an email template by ID.

Returns the complete email template with all its details.

Parameters (1 required)
Required
idstring

ID of the email template to fetch

Fetch Email Thread

fetch_email_thread
Full Description

Fetch a single Email Thread by ID.

Returns thread metadata plus its most recent emails, newest first, with plaintext bodies. Returns only IDs for older messages.

Parameters (1 required)
Required
idstring

The ID of the Email Thread to fetch.

Fetch Invoice

fetch_invoice
Full Description

Fetch one of the organization's billing invoices by id.

Parameters (1 required)
Required
invoice_idstring

Fetch Lead

fetch_lead
Full Description

Fetch an existing lead (company) by ID.

Parameters (1 required)
Required
idstring

ID of the lead to fetch

Fetch Lead Smart View

fetch_lead_smart_view
Full Description

Fetch a lead smart view (saved search) by ID.

Parameters (1 required)
Required
idstring

ID of the lead smart view to fetch

Fetch Lead Status

fetch_lead_status
Full Description

Fetch a lead status by ID.

Parameters (1 required)
Required
idstring

ID of the lead status to fetch

Fetch Meeting Transcript

fetch_meeting_transcript
Full Description

Fetch a meeting's Notetaker transcript(s) by meeting activity ID.

Returns the meeting's speaker breakdown, summary, and full speaker-labeled transcript text. Only covers Notetaker (meeting) transcripts; call transcripts are served by fetch_call.

Parameters (1 required)
Required
idstring

The ID of the meeting activity to fetch transcripts for.

Fetch Membership

fetch_membership
Full Description

Fetch one of the organization's members by user id.

Parameters (1 required)
Required
user_idstring

The id of the user whose membership to fetch.

Fetch Note

fetch_note
Full Description

Fetch an existing note by ID.

Returns the full note details including title, text, and metadata.

Parameters (1 required)
Required
idstring

ID of the note to fetch

Fetch Opportunity

fetch_opportunity
Full Description

Fetch a specific opportunity by ID.

Returns the complete opportunity with all its details.

Parameters (1 required)
Required
idstring

ID of the opportunity to fetch

Fetch Opportunity Status

fetch_opportunity_status
Full Description

Fetch an opportunity status by ID.

Parameters (1 required)
Required
idstring

ID of the opportunity status to fetch

Fetch Pipeline

fetch_pipeline_and_opportunity_statuses
Full Description

Fetch an opportunity pipeline, including its opportunity statuses, by ID.

Parameters (1 required)
Required
idstring

ID of the pipeline to fetch

Fetch Role

fetch_role
Full Description

Fetch one of the organization's roles by id, with every permission it grants.

Use list_roles to resolve a role name to its id.

Parameters (1 required)
Required
role_idstring

The id of the role to fetch.

Fetch SMS

fetch_sms
Full Description

Fetch a single SMS activity by ID.

Returns the complete SMS, including message text and attachments.

Parameters (1 required)
Required
idstring

The ID of the SMS to fetch.

Fetch SMS Template

fetch_sms_template
Full Description

Fetch an SMS template by ID.

Returns the complete SMS template with all its details.

Parameters (1 required)
Required
idstring

ID of the SMS template to fetch

Fetch Task

fetch_task
Full Description

Fetch an existing task by ID.

Returns the task's details including the associated lead, contact, assignee, due date, priority, and completion status.

Parameters (1 required)
Required
idstring

ID of the task to fetch

Fetch Workflow

fetch_workflow
Full Description

Fetch a single workflow by ID.

Parameters (1 required)
Required
idstring

ID of the workflow to fetch

Find Agent Configs

find_agent_configs
Full Description

List all voice agents configured for the organization. Voice agents are AI callers that place outbound calls to leads' contacts on the user's behalf.

Returns each voice agent's ID and name. Use this to find the right voice agent ID when scheduling a call or assigning a call step in a workflow.

Users may refer to voice agents as "voice agents", "Chloe", or by their configured name. When more than one agent exists, pick the most appropriate one based on the name.

Find Call Outcomes

find_call_outcomes
Full Description

List currently configured call outcomes and their descriptions.

Omit agent_config_id for all organization call outcomes. Supply it for a voice agent's available outcomes; agents without a conversation type use all organization call outcomes. Requires ViewVoiceAgents when supplied.

Parameters (0 required, 1 optional)
Optional
agent_config_idstring
Default: null

Find Call Tasks

find_call_tasks
Full Description

Find call tasks based on various filters. You can filter by lead, contact, assignee (a user or a voice agent), completion state, and scheduled/created/updated dates.

Parameters (0 required, 9 optional)
Optional
agent_config_idstring

Filter by the ID of the voice agent the call task is dispatched to

Default: null
assigned_tostring

Filter by the ID of the user the call task is assigned to

Default: null
contact_idstring

Filter by contact ID

Default: null
created_atobject

Filter by call task creation date range

Default: null
cursorstring

Pagination cursor, give only when more results are requested.

Default: null
due_dateobject

Filter by the scheduled call date range

Default: null
is_completeboolean

Filter by completion status. If not provided, both complete and incomplete call tasks are returned.

Default: null
lead_idstring

Filter by lead ID

Default: null
updated_atobject

Filter by call task last updated date range

Default: null

List Contact Custom Fields

find_contact_custom_fields
Full Description

List all contact custom fields defined for the organization.

Includes both contact-specific fields and shared fields associated with contacts. Returns each field's ID, name, description, type, allowed choices (for choice fields), whether multiple values are accepted, and whether it is a shared field. Useful for deciding which custom field to read or write when working with contacts.

Find Custom Activity Types

find_custom_activities
Full Description

List all active (non-archived) Custom Activity Types in the organization, along with the custom fields defined on each type.

Call this before creating a workflow with a "custom-activity-event" trigger so you can look up the correct Custom Activity Type ID.

Find Custom Activity Instances

find_custom_activity_instances
Full Description

Find a lead's custom activity instances based on various filters.

A custom activity instance is an activity of a custom activity type, holding the custom field values defined by that type. Always scoped to a single lead; optionally filter by attributed user, one or more custom activity types, or activity date. Results are sorted by most recent activity first and are cursor-paginated.

Parameters (1 required, 4 optional)
Required
lead_idstring

The lead whose custom activity instances to find

Optional
activity_atobject

Filter custom activity instances by their activity date range

Default: null
cursorstring

Pagination cursor for retrieving the next page

Default: null
custom_activity_type_idsarray

Filter by the custom activity types the instances belong to. Provide one or more type IDs to match instances of any of them.

Default: null
user_idstring

Filter custom activity instances by the user they are attributed to (their owner)

Default: null

Find Custom Object Instances

find_custom_object_instances
Full Description

Find a lead's custom object instances.

A custom object instance is a record of a custom object type, attached to a lead and holding the custom field values defined by that type. Always scoped to a single lead; optionally filter to a single custom object type. Results are ordered by creation date (oldest first) and are cursor-paginated.

Parameters (1 required, 2 optional)
Required
lead_idstring

The lead whose custom object instances to find

Optional
cursorstring

Pagination cursor for retrieving the next page

Default: null
custom_object_type_idstring

Filter to instances of a single custom object type. Use the find_custom_object_types tool to look up the available types.

Default: null

Find Custom Object Types

find_custom_object_types
Full Description

List all custom object types in the organization, along with the custom fields defined on each type.

Find Email Templates

find_email_templates
Full Description

List or find email templates

Parameters (0 required, 3 optional)
Optional
cursorstring

Pagination cursor, give only when more results are requested.

Default: null
name_searchstring

Template name case-insensitive contains search

Default: null
statusstring

Use all to return all except archived.

Options:allprivatesharedWithUserarchived
Default: all

Find Web Forms

find_forms
Full Description

List all web forms in the organization.

Call this before creating a workflow with a "form-submission-event" trigger so you can look up the correct Form ID.

Find Groups

find_groups
Full Description

List all groups in the organization.

Find Invoices

find_invoices
Full Description

Find the organization's billing invoices, newest first.

Invoices without a date sort first.

Parameters (0 required, 2 optional)
Optional
limitinteger
Default: 50
offsetinteger
Default: 0

List Lead Custom Fields

find_lead_custom_fields
Full Description

List all lead custom fields defined for the organization.

Returns each field's ID, name, description, type, allowed choices (for choice fields), whether multiple values are accepted, and whether it is a shared field. Useful for deciding which custom field to read or write when working with leads.

Find Lead Smart Views

find_lead_smart_views
Full Description

List lead smart views (saved searches).

Parameters (0 required, 3 optional)
Optional
cursorstring

Pagination cursor, give only when more results are requested.

Default: null
filterstring

Filter to show only pinned smart views (those shown in the sidebar), or all available smart views. When the user asks about smart views you should filter for pinned smart views unless the user is requesting to see all views or searches by name.

Options:pinnedall
Default: pinned
name_searchstring

Smart view name case-insensitive contains search. When using name search you should filter by all smart views.

Default: null

Find Lead Statuses

find_lead_statuses
Full Description

List or find lead statuses for the organization

Find Meeting Outcomes

find_meeting_outcomes
Full Description

List all outcomes applicable to meetings available in the organization.

Find Memberships

find_memberships
Full Description

List the organization's members with each member's role name, whether the role is built-in or custom, active/inactive status, and join date. Richer than org_users — prefer this unless you only need a name or email. Most recent members first.

Parameters (0 required, 1 optional)
Optional
include_inactiveboolean

If true, also return deactivated members.

Default: False

Find Notes

find_notes
Full Description

Find notes based on various filters.

Parameters (0 required, 6 optional)
Optional
activity_atobject

Filter notes by activity date range

Default: null
contact_idstring

Filter notes by associated contact ID

Default: null
cursorstring

Pagination cursor for retrieving the next page

Default: null
date_createdobject

Filter notes by creation date range

Default: null
lead_idstring

Filter notes by lead ID

Default: null
user_idstring

Filter notes by the user who created them

Default: null

Find Opportunities

find_opportunities
Full Description

Find opportunities by status (active/won/lost), owner, lead, or close-date range, optionally only those needing attention, sorted by soonest close, largest value, or highest confidence. Returns each opportunity with resolved lead, contact, owner, and status names; cursor-paginated.

Parameters (0 required, 11 optional)
Optional
close_atobject

Filter by when the opportunity is expected to close (the won or lost date for closed deals). Use this to answer time-bounded questions such as 'closing soon' or 'closing this month' by passing a date window. Sorting alone does not restrict the range: to only return deals closing within a period, set this filter.

Default: null
created_atobject
Default: null
cursorstring

Pagination cursor, give only when more results are requested.

Default: null
lead_idstring
Default: null
lead_view_idstring
Default: null
needs_attentionboolean

Filter by opportunities that may be stalled and need attention. To see why the an opportunity is stalled, direct the user to the opportunities pipeline page.

Default: null
sort_bystring

Order the results; this does not filter them. Ordering by closing_soonest still returns far-out deals, so to restrict to a time window (e.g. 'closing soon') also set close_at.

Default: null
status_idsarray
Default: null
status_typestring
Default: null
updated_atobject
Default: null
user_idsarray
Default: null

List Opportunity Custom Fields

find_opportunity_custom_fields
Full Description

List all opportunity custom fields defined for the organization.

Includes both opportunity-specific fields and shared fields associated with opportunities. Returns each field's ID, name, description, type, allowed choices (for choice fields), whether multiple values are accepted, and whether it is a shared field. Useful for deciding which custom field to read or write when working with opportunities.

Find Pipelines

find_pipelines_and_opportunity_statuses
Full Description

List all opportunity pipelines and their opportunity statuses in the organization.

Find Scheduling Links

find_scheduling_links
Full Description

List available scheduling links for the user and org.

User-owned personal links come with a URL. Shared links come with a special template tag. Each can be inserted into generated templates.

Parameters (0 required, 2 optional)
Optional
cursorstring

Pagination cursor. Give only when more results are desired.

Default: null
name_searchstring

Scheduling Link name. Case-insensitive substring search.

Default: null

Find SMS Templates

find_sms_templates
Full Description

List or find SMS templates

Parameters (0 required, 3 optional)
Optional
cursorstring

Pagination cursor, give only when more results are requested.

Default: null
name_searchstring

Template name case-insensitive contains search

Default: null
statusstring

Use all to return all except archived.

Options:allprivatesharedWithUserarchived
Default: all

Find Tasks

find_tasks
Full Description

Find tasks based on various filters. You can filter by lead, assignee, completion state, and due/created/ updated dates.

Parameters (0 required, 7 optional)
Optional
assigned_tostring

Filter by the ID of the user the task is assigned to

Default: null
created_atobject

Filter by task creation date range

Default: null
cursorstring

Pagination cursor, give only when more results are requested.

Default: null
due_dateobject

Filter by task due date range

Default: null
is_completeboolean

Filter by completion status. If not provided, both complete and incomplete tasks are returned.

Default: null
lead_idstring

Filter by lead ID

Default: null
updated_atobject

Filter by task last updated date range

Default: null

Find Voice Agents

find_voice_agents
Full Description

List all voice agents configured for the organization. Voice agents are AI callers that place outbound calls to leads' contacts on the user's behalf.

Returns each voice agent's ID and name. Use this to find the right voice agent ID when scheduling a call or assigning a call step in a workflow.

Users may refer to voice agents as "voice agents", "Chloe", or by their configured name. When more than one agent exists, pick the most appropriate one based on the name.

Find Workflows

find_workflows
Full Description

List or find workflows

Parameters (0 required, 3 optional)
Optional
cursorstring

Pagination cursor, give only when more results are requested.

Default: null
name_searchstring

Workflow name case-insensitive contains search

Default: null
statusstring
Options:allactivepauseddraft
Default: all

Get AI Credit Usage

get_ai_credit_usage
Full Description

AI credit usage for the billing account, broken down by feature.

Reports total credits used and a per-feature breakdown. Credits are the billing unit for AI features. Usage covers the whole billing account, not a single organization. Omit start/end for the current billing period; the result's start/end report the window actually measured. Explicit ranges must be timezone-aware and span at most 366 days. Older ranges may return empty or partial data — zero usage for an old range does not mean no activity. On a rate-limited error, retry after retry_after seconds.

Parameters (0 required, 2 optional)
Optional
endstring

End of the period. Timezone-aware; seconds are ignored. Provide both start and end, or neither; omit both for the current billing period.

Default: null
startstring

Start of the period. Timezone-aware; seconds are ignored. Provide both start and end, or neither; omit both for the current billing period.

Default: null

Get Billing Summary

get_billing_summary
Full Description

Billing summary for the organization's billing account.

Reports the subscription plan, billing status with the trial end date, seat counts, and AI usage availability, tier, and credit allowance for the current billing cycle. Whether the account is on trial is status, not anything under ai_usage. Use get_ai_credit_usage for the credits actually used.

Get Fields

get_fields
Full Description

Use this tool ONLY to get a list of fields for the aggregation tool.

Get Voice Agent Overview Report

get_voice_agent_overview_report
Full Description

Cross-agent rollup for the Voice Agents list page.

Returns one row per active agent — agents with completed calls in date_range or queued upcoming calls. Cumulative funnel counts (answered, engaged, objective_met) plus total_calls. upcoming_calls is the agent's queued (not yet completed) calls and is not bound by date_range — open tasks are open regardless of when scheduled (so an agent with only upcoming calls still appears). Use this to compare agents; for one agent's outcomes, sentiment, or time saved use get_voice_agent_performance_report. For an inventory of all configured voice agents regardless of activity, use find_agent_configs.

The Voice Agents list (Agents tab) shows all-time stats, so leave date_range at its default (all_time) unless the user asks for a specific window. (The Upcoming and Recent tabs are call lists, not this rollup — search Calls for those.)

Rows are sorted server-side per the sort field (default most_calls); pass a different mode rather than re-sorting in your reply. Set reverse=True to invert (e.g. sort=most_calls, reverse=True for least active first) — necessary to surface the bottom of the ordering, since rows are capped before they reach you. truncated and total_agent_count flag in-scope active agents; dormant_agent_count reports in-scope agents with neither completed calls in the date range nor queued upcoming calls (not included in rows).

Parameters (0 required, 4 optional)
Optional
agent_config_idsarray
Default: null
date_rangestring
Options:yesterdaylast_weeklast_monthlast_quarterlast_yeartodaythis_weekthis_monththis_quarterthis_yeartomorrownext_weeknext_monthnext_quarternext_yearclosest_mondayclosest_tuesdayclosest_wednesdayclosest_thursdayclosest_fridayclosest_saturdayclosest_sundayall_time
Default: all_time
reverseboolean
Default: False
sortstring
Options:most_callsagent_namemost_recently_usedmost_answeredmost_engagedmost_objective_met
Default: most_calls

Get Voice Agent Performance Report

get_voice_agent_performance_report
Full Description

Performance metrics for one voice agent.

Returns the numbers shown on the Performance tab of a Voice Agent detail page. Passing multiple agent_config_ids pools metrics into a single aggregate (not a per-agent breakdown — for that, use get_voice_agent_overview_report). For per-call drill-down, search Calls filtered by agent_config_id.

When the user is on a Voice Agent page, pull date_range from page_context.date_range so the numbers match the UI. Accepts a relative range such as last_week or an absolute period with type="absolute", start, and end. For a stored recap, use its inclusive timeframe_start and exclusive timeframe_end. Outcome coverage uses answered_by_disposition_count; answered_count is the funnel's Human Reached count.

Percentages: *_pct is over total_calls; engaged_over_answered_pct and objective_met_over_answered_pct are over answered (tier-to-tier conversion). For any other denominator, compute from *_count.

funnel_previous_period_deltas is null when the date range has no defined previous period (e.g. all_time).

Parameters (1 required, 1 optional)
Required
agent_config_idsarray
Optional
date_rangestring

Predefined relative range (e.g. 'last_week') or an absolute period with inclusive start and exclusive end.

Default: all_time

Get Voice Agents

get_voice_agents
Full Description

Return detailed configuration for one or more voice agents.

Includes each agent's objective, user instructions, and which skills are enabled. Use this as the follow-up to find_voice_agents once one or more agent IDs have been selected.

Parameters (1 required)
Required
agent_config_idsarray

IDs of the voice agents (AgentConfig) to fetch details for. Up to 30 IDs per call. Use `find_voice_agents` to discover available agent IDs.

Lead Search

lead_search
Full Description

Perform a simple lead search and return the initial set of results.

Use this to retrieve all leads, most recent leads, search leads by keyword, or filter by lead status and smart view. For more complex searches use the search tool instead.

Leads will be returned by last updated first.

Parameters (0 required, 4 optional)
Optional
full_textstring

Full text search

Default: null
lead_status_idstring

Filter by lead status

Default: null
namestring

Search lead name or contact name

Default: null
smart_view_idstring

Filter by smart view

Default: null

List Membership Requests

list_membership_requests
Full Description

List pending requests to join the current organization.

Each entry includes the requesting user's name and email, the request id, and when the request was created.

List Roles

list_roles
Full Description

List the roles that can be assigned in the organization.

Covers Close's built-in roles plus any custom roles the org defines. Use this to resolve a role name to its id, or to see which roles grant organization management access.

Org Info

org_info
Full Description

Return general information about the organization and the user.

Org Users

org_users
Full Description

Return active users (memberships) which are part of the current org.

Paginate Search Results

paginate_search
Full Description

Paginate a search to retrieve more results.

Provide exactly one of:

  • search_id: a share_* id from a previous search or shared entry, or
  • smart_view_id: a save_* Smart View (saved search) id the user is

viewing.

Parameters (0 required, 3 optional)
Optional
cursorstring

Pagination cursor

Default: null
search_idstring

Shared-entry/search id (share_*) to paginate

Default: null
smart_view_idstring

Smart View (saved search) id (save_*) to paginate

Default: null

Propose Voice Agent Update

propose_voice_agent_update
Full Description

Propose a voice agent configuration update from natural-language feedback.

This tool does not apply changes to the voice agent. It returns a short behavioral summary and proposal ID when the requested edit is clear. If the feedback is ambiguous, it returns clarification questions instead of making a proposal. Use apply_voice_agent_update with the proposal ID only after the user approves the proposal.

Parameters (2 required, 1 optional)
Required
agent_config_idstring

ID of the voice agent to update.

feedbackstring

Natural-language feedback describing how the voice agent should change.

Optional
proposal_idstring

Existing proposal ID to refine. Omit when creating a new proposal.

Default: null

Render Email Template

render_email_template
Full Description

Render an email template for a lead, including any template variables.

Body HTML already contains the user's email signature, denoted with a <span data-system-generated="signature"> tag. Leave this tag intact or the signature could get duplicated later.

Parameters (2 required, 1 optional)
Required
idstring

ID of the email template to render

lead_idstring

ID of the lead to render the template for

Optional
contact_idstring

ID of the contact to render the template for. Must belong to the given lead.

Default: null

Schedule Voice Agent Call

schedule_voice_agent_call
Full Description

Schedule a voice agent to call a lead's contact.

Creates a call task assigned to the voice agent. The voice agent will place the call automatically at the scheduled time, or as soon as the queue picks it up when no time is given.

Use find_voice_agents first to discover which voice agents are available in this organization.

Parameters (2 required, 2 optional)
Required
agent_config_idstring

ID of the voice agent (AgentConfig) that should make the call. Use `find_voice_agents` to discover available agents.

lead_idstring

ID of the lead to call.

Optional
contact_idstring

Optional contact to call. If omitted, the first contact on the lead that has a phone number will be selected.

Default: null
scheduled_atstring

When the call should be made. ISO 8601 datetime, timezone-aware. If omitted, the call is scheduled to run as soon as the voice agent queue picks it up (ASAP).

Default: null

Search Objects

search
Full Description

Perform a natural language search for leads or contacts.

If a more specific search tool (like lead_search or activity_search) satisfies the request, use that tool instead.

You can reference related objects like activities (such as calls, emails, meetings, notes, custom activities, etc.), opportunities, tasks as long as they are part of a lead query.

Example queries:

  • leads not contacted in the past week
  • leads assigned to me with uncompleted tasks
  • leads with an active opportunity over $500
  • contacts with CTO title

Each returned result will contain a title label, preview text, object ID, and URL.

The initial set of results, total count of all results, and a URL to open the results in Close is returned. To retrieve more results, use the returned cursor and call the paginate_search tool using the cursor and search ID returned in this response.

Parameters (1 required)
Required
querystring

Update Call Task

update_call_task
Full Description

Update a call task.

Only fields that are provided will be updated. Reassigning to a user or voice agent (agent_config_id) affects only this task. Completing a call task also completes every sibling task sharing its deduplication key.

Parameters (1 required, 6 optional)
Required
idstring

The ID of the call task to update.

Optional
agent_config_idstring

Reassign (dispatch) the call task to this voice agent. Mutually exclusive with assigned_to.

Default: null
assigned_tostring

Reassign the call task to this user. Mutually exclusive with agent_config_id.

Default: null
due_datestring

Updated due date or datetime for the call task. Can be a date (YYYY-MM-DD) or datetime (ISO 8601).

Default: null
is_completeboolean

Mark the call task as complete (true) or reopen it (false). Completing a call task also completes every sibling task sharing its deduplication key.

Default: null
resolutionstring

Resolution to set when completing the call task, e.g. 'skipped'.

Default: null
textstring

Updated call task text.

Default: null

Update Contact

update_contact
Full Description

Update an existing contact.

You can update a contact's name, title, email addresses, phone numbers, and URLs. Only fields that are provided will be updated.

Parameters (1 required, 6 optional)
Required
idstring

ID of the contact to update

Optional
custom_fieldsarray

Custom field values to set on this object. Only the custom fields included are modified; omitted fields are left unchanged.

emailsarray

When providing this field, you must provide the full updated list of email addresses for the contact.

Default: null
namestring

Name of the contact

Default: null
phonesarray

When providing this field, you must provide the full updated list of phone numbers for the contact.

Default: null
titlestring

Job title of the contact

Default: null
urlsarray

When providing this field, you must provide the full updated list of URLs for the contact.

Default: null

Update Custom Activity Instance

update_custom_activity_instance
Full Description

Update an existing custom activity instance.

A custom activity instance is an activity of a custom activity type, holding the custom field values defined by that type.

Only fields that are provided will be updated. For custom fields, only the custom fields included are modified; pass null to clear one. Pass 'clear' for contact_id to detach the contact.

Parameters (1 required, 5 optional)
Required
idstring

ID of the custom activity instance to update

Optional
activity_atstring

When the custom activity occurred

Default: null
contact_idstring

ID of the contact to associate with the custom activity; must belong to the same lead. Pass 'clear' to remove the existing contact.

Default: null
custom_fieldsarray

Custom field values to set on this object. Only the custom fields included are modified; omitted fields are left unchanged.

pinnedboolean

Whether to pin the custom activity to the top of the lead's timeline

Default: null
statusstring

New status of the custom activity. Publishing a draft validates required custom fields; leave unset to keep the current status.

Default: null

Update Custom Object Instance

update_custom_object_instance
Full Description

Update an existing custom object instance.

A custom object instance is a record of a custom object type, attached to a lead and holding the custom field values defined by that type.

Only fields that are provided will be updated. For custom fields, only the custom fields included are modified; pass null to clear one.

Parameters (1 required, 2 optional)
Required
idstring

ID of the custom object instance to update

Optional
custom_fieldsarray

Custom field values to set on this object. Only the custom fields included are modified; omitted fields are left unchanged.

namestring

New display name for the custom object instance; leave unset to keep the current name.

Default: null

Update Draft Email

update_draft_email
Full Description

Update an existing draft email.

Only draft emails can be updated; sent or scheduled emails are rejected. Only fields that are provided are changed. When the body is replaced the sender's saved email signature is appended again. This never sends the email.

Parameters (1 required, 8 optional)
Required
idstring

ID of the draft email to update

Optional
bccarray

List of BCC email addresses

Default: null
body_htmlstring

Draft body as Close rich text (HTML). Wrap the whole content in a single <body> tag and put each line/paragraph in a block-level tag. Supported tags include <p>, <h1>-<h6>, <ul>/<ol> with <li>, <blockquote>, <hr>, <a href=...>, <br>, and inline formatting <strong>/<b>, <em>/<i>, <u>, <s>, <code>, <span>. Escape literal ampersands as '&amp;'. Example: <body><p>Hi <strong>Jane</strong>,</p><p>Following up on our call.</p></body>. Do not include a signature block (name, title, company, contact details); the sender's saved email signature is appended automatically. A short closing line such as 'Best,' is fine.

Default: null
body_textstring

Plaintext body content. Prefer body_html; if only one of body_html/body_text is provided the other is derived automatically.

Default: null
ccarray

List of CC email addresses

Default: null
contact_idstring

ID of the contact this draft email is addressed to

Default: null
senderstring

Email address of a connected sending identity, including aliases. Must match an available sender for the current user.

Default: null
subjectstring

Subject line of the email

Default: null
toarray

List of recipient email addresses

Default: null

Update Email Template

update_email_template
Full Description

Update an existing email template.

Only fields that are provided and not None will be updated.

Handling of attachments and unsubscribe links via this tool is currently unsupported.

Email template body should be HTML formatted.

Use template tags as placeholders, for example: {{ organization.name }} to refer to the sender's organization name. {{ user.first_name }} {{ user.last_name }} {{ user.email }} {{ user.phone }} to refer to the user sending the email. {{ lead.display_name }} to refer to the lead name (recipient's name/company). {{ contact.first_name }} {{ contact.last_name }} to refer to the recipient.

Parameters (1 required, 7 optional)
Required
idstring

ID of the email template to update

Optional
bccarray
Default: null
bodystring
Default: null
ccarray
Default: null
is_archivedboolean
Default: null
is_sharedboolean
Default: null
namestring
Default: null
subjectstring
Default: null

Update Lead

update_lead
Full Description

Update an existing lead (company).

Only fields that are provided and not None will be updated.

Parameters (1 required, 5 optional)
Required
idstring

ID of the lead to update

Optional
custom_fieldsarray

Custom field values to set on this object. Only the custom fields included are modified; omitted fields are left unchanged.

descriptionstring

Description of the lead

Default: null
namestring

Name of the lead

Default: null
status_idstring

ID of the lead status

Default: null
urlstring

URL of the lead's website

Default: null

Update Lead Smart View

update_lead_smart_view
Full Description

Update a lead smart view (saved search).

Only fields that are provided and not None will be updated.

Parameters (1 required, 2 optional)
Required
idstring

ID of the lead smart view to update

Optional
descriptionstring

New description for the smart view

Default: null
namestring

New name for the smart view

Default: null

Update Lead Status

update_lead_status
Full Description

Update the label of an existing lead status.

Parameters (2 required)
Required
idstring

ID of the lead status to update

labelstring

New label for the lead status

Update Note

update_note
Full Description

Update an existing note.

Only fields that are provided will be updated. Note content is provided as rich text (HTML) via note_html; the plaintext note is automatically derived.

Parameters (1 required, 5 optional)
Required
idstring

ID of the note to update

Optional
activity_atstring

When the note activity occurred

Default: null
contact_idstring

ID of the contact to associate with the note. Pass 'clear' to remove the existing contact.

Default: null
note_htmlstring

Updated note content as Close rich text (HTML). Must be a valid Close rich-text document: wrap the whole content in a single <body> tag and put each line/paragraph in a block-level tag. Supported tags include <p>, <h1>-<h6>, <ul>/<ol> with <li>, <blockquote>, <hr>, <a href=...>, <br>, and inline formatting <strong>/<b>, <em>/<i>, <u>, <s>, <code>, <span>. Escape literal ampersands as '&amp;'. Example: <body><p>Spoke with <strong>Jane</strong> about pricing.</p><ul><li>Wants a demo</li><li>Budget approved</li></ul></body>

Default: null
pinnedboolean

Whether to pin the note to the top of the lead

Default: null
titlestring

Title of the note. Pass an empty string to remove the existing title.

Default: null

Update Opportunity

update_opportunity
Full Description

Update an existing opportunity.

Only fields that are provided will be updated. The value should be specified in cents (e.g., $100.00 = 10000).

Parameters (1 required, 10 optional)
Required
idstring

ID of the opportunity to update

Optional
close_atstring

Expected close date. Pass clear to clear an existing date.

Default: null
confidenceinteger

Confidence percentage (0-100)

Default: null
contact_idstring

ID of the primary contact for this opportunity

Default: null
custom_fieldsarray

Custom field values to set on this object. Only the custom fields included are modified; omitted fields are left unchanged.

notestring

Plaintext version of the note.

Default: null
note_htmlstring

Rich-text HTML version of the note, wrapped in `<body>...</body>` (e.g. `<body><p>text with <strong>bold</strong></p></body>`). When set, `note` is automatically derived from it, overriding any `note` value passed in the same request.

Default: null
status_idstring

ID of the opportunity status

Default: null
user_idstring

ID of the user assigned to this opportunity

Default: null
valueinteger

Value in cents. Pass clear to clear an existing value.

Default: null
value_periodstring

Period for the value

Default: null

Update Opportunity Status

update_opportunity_status_tool
Full Description

Update the label of an existing opportunity status.

Parameters (2 required)
Required
idstring

ID of the opportunity status to update

labelstring

New label for the opportunity status

Update Pipeline

update_pipeline
Full Description

Update an existing opportunity pipeline.

Only fields that are provided will be updated.

Parameters (1 required, 1 optional)
Required
idstring

ID of the pipeline to update

Optional
namestring

New name for the pipeline

Default: null

Update SMS Template

update_sms_template
Full Description

Update an existing SMS template.

Only fields that are provided will be updated. Fields that are not provided will remain unchanged.

Handling of attachments via this tool is currently unsupported.

Use template tags as placeholders, for example: {{ organization.name }} to refer to the sender's organization name. {{ user.first_name }} {{ user.last_name }} {{ user.email }} {{ user.phone }} to refer to the user sending the message. {{ lead.display_name }} to refer to the lead name (recipient's name/company). {{ contact.first_name }} {{ contact.last_name }} to refer to the recipient.

Parameters (1 required, 4 optional)
Required
idstring

ID of the SMS template to update

Optional
is_archivedboolean
Default: null
is_sharedboolean
Default: null
namestring
Default: null
textstring
Default: null

Update Task

update_task
Full Description

Update an existing task.

Only fields that are provided will be updated. Pass 'clear' for contact_id or due_date to clear those values.

Parameters (1 required, 6 optional)
Required
idstring

ID of the task to update

Optional
assigned_tostring

ID of the user to assign the task to. Tasks must always have an assignee, so this cannot be cleared.

Default: null
contact_idstring

ID of the contact associated with this task. Must belong to the task's lead. Pass 'clear' to remove the existing contact.

Default: null
due_datestring

Due date or datetime for the task. Can be a date (YYYY-MM-DD) or datetime (ISO 8601). Pass 'clear' to make the task dateless (due immediately).

Default: null
is_completeboolean

Mark the task as complete (true) or reopen it (false).

Default: null
prioritystring

Task priority: 'high' or 'medium'. Only set to 'high' if the user explicitly says it's a high priority task.

Default: null
textstring

Updated task description. Cannot be blank.

Default: null