Close

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.

create_custom_object_instance

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.

create_draft_email

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.

create_email_template

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

create_lead

Create a new lead status.

create_lead_status

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.

create_note

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).

create_opportunity

Create a new opportunity status.

create_opportunity_status_tool

Create a new opportunity pipeline. Use the create_opportunity_status tool to add statuses to the pipeline.

create_pipeline

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.

create_sms_template

Save a search as a smart view (saved search). Pass the ID of a search result that lists one object type: leads, contacts, opportunities, or one kind of activity. The smart view gets that search's filters, sort, and columns, so it lists exactly what was previewed. Confirm the name and criteria with the user before creating the view.

create_smart_view

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.

create_task

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

create_workflow

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

customized_builtin_labels

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

delete_address

Delete a call task. Does not affect sibling tasks.

delete_call_task

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.

delete_contact

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.

delete_custom_activity_instance

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.

delete_custom_object_instance

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

delete_email_template

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.

delete_lead

Permanently delete a lead smart view (saved search).

delete_lead_smart_view

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.

delete_lead_status

Permanently delete an existing note. This action cannot be undone. ONLY call this if the user specifically instructed you to delete the note.

delete_note

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

delete_opportunity

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.

delete_opportunity_status_tool

Permanently delete an opportunity pipeline. A pipeline can only be deleted if it has no statuses. The last pipeline cannot be deleted.

delete_pipeline

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

delete_sms_template

Permanently delete a smart view (saved search).

delete_smart_view

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.

delete_task

List the fields of one object type for list_objects and aggregate_objects: built-in fields, smart fields (num_*, last_*, first_*, time_to_*, ...) and the organization's custom fields, with their value types, enum values and choices. Call it when the field you need is not in the field list of your instructions, to get the exact option strings of a choices custom field, after a validation error names an unknown field, or before concluding that nothing matches a question. Narrow with name_contains: words of the field name, of its display name, or of one of its enum values or choices. When no field has every word, the closest fields are returned and `status` says so.

describe_fields

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.

enrich_field

Fetch a single call activity by ID. Returns the call's direction, outcome, participants, and (if available) its transcript.

fetch_call

Fetch a single call task by ID.

fetch_call_task

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.

fetch_comment

Fetch an existing contact by ID. Returns the contact's details including name, title, email addresses, phone numbers, and URLs.

fetch_contact

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.

fetch_custom_activity_instance

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.

fetch_custom_object_instance

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.

fetch_custom_object_type

Fetch a single email activity by ID.

fetch_email