The SureContact connector lets your AI agent act in each user's SureContact account. Each user connects their own SureContact access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 126 tools.
- Tools
- 126
- What they doRead · write · destructive
- 61 · 55 · 1061 read55 write10 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the SureContact connection
In AgentKit > Connections, create a SureContact connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'surecontact'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize SureContact:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'surecontact_automations_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "surecontact"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize SureContact:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="surecontact_automations_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their SureContact credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolsurecontact_activity_getRetrieve one contact activity by its UUID.Read-onlyGet Activity
Retrieve one contact activity by its UUID. Returns the activity with its type, type label, description, metadata and timestamps. Use activity_get when you have an activity UUID from contact_activities_list.
Inputs
activity_uuidstringrequired- UUID of the activity. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_automation_getRetrieve one automation by its UUID.Read-onlyGet Automation
Retrieve one automation by its UUID. Returns the automation definition and status. Use automation_get when you have an automation UUID from automations_list.
Inputs
automation_uuidstringrequired- UUID of the automation. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_automations_listList the automations of the workspace, with page-based pagination.Read-onlyList Automations
List the automations of the workspace, with page-based pagination. Returns automations with uuid, name and status. Use automations_list to find automation UUIDs for contact_automation_start. Use sequences_list for email sequences only.
Inputs
pageinteger- Page number of results to return, starting at 1. Use with per_page to walk through large result sets.
per_pageinteger- Number of records to return per page, from 1 to 100. Example: 25.
surecontact_campaign_contacts_listList the contacts a campaign was sent to, with per-contact engagement and page-based pagination.Read-onlyList Campaign Contacts
List the contacts a campaign was sent to, with per-contact engagement and page-based pagination. Returns contacts with sent, opened and clicked timestamps and delivery status. Use campaign_contacts_list to analyse engagement per contact. Use campaign_get for aggregate stats.
Inputs
campaign_uuidstringrequired- UUID of the campaign. Example: 550e8400-e29b-41d4-a716-446655440000.
pageinteger- Page number of results to return, starting at 1. Use with per_page to walk through large result sets.
per_pageinteger- Number of records to return per page, from 1 to 100. Example: 25.
surecontact_campaign_getRetrieve one campaign by its UUID, including content, recipient filters and stats.Read-onlyGet Campaign
Retrieve one campaign by its UUID, including content, recipient filters and stats. Returns the full campaign record. Use campaign_get for details. Use campaign_progress_get while a campaign is sending.
Inputs
campaign_uuidstringrequired- UUID of the campaign. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_campaign_progress_getGet live sending progress for a campaign that is currently sending.Read-onlyGet Campaign Sending Progress
Get live sending progress for a campaign that is currently sending. Returns total, sent, failed and remaining counts with the completion percentage. Use campaign_progress_get to poll a send in real time; it returns an error for campaigns not in sending status.
Inputs
campaign_uuidstringrequired- UUID of the campaign. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_campaign_recipients_count_getCount the contacts that match a campaign's recipient filters.Read-onlyGet Campaign Recipient Count
Count the contacts that match a campaign's recipient filters. Returns a count. Use campaign_recipients_count_get when you need only the number. Use campaign_recipients_list to see sample contacts.
Inputs
campaign_uuidstringrequired- UUID of the campaign. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_campaign_recipients_listGet a sample of up to 100 contacts that match a campaign's recipient filters.Read-onlyList Campaign Recipients
Get a sample of up to 100 contacts that match a campaign's recipient filters. Returns contacts with uuid, email and name. Use campaign_recipients_list to confirm the audience before sending. Use campaign_recipients_count_get for only the total.
Inputs
campaign_uuidstringrequired- UUID of the campaign. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_campaigns_listList email and SMS campaigns of the workspace, with page-based pagination.Read-onlyList Campaigns
List email and SMS campaigns of the workspace, with page-based pagination. Returns campaigns with uuid, name, subject, sender, status and recipient count. Use campaigns_list to browse campaigns. Use campaign_get for one campaign with its content and stats.
Inputs
pageinteger- Page number of results to return, starting at 1. Use with per_page to walk through large result sets.
per_pageinteger- Number of records to return per page, from 1 to 100. Example: 25.
surecontact_companies_listList companies in the workspace with page-based pagination.Read-onlyList Companies
List companies in the workspace with page-based pagination. Returns a paginated list of companies with their uuid, name and key profile fields. Use companies_list to browse companies. Use company_get for one company by UUID. Requires a SureContact plan that includes the Companies module.
Inputs
pageinteger- Page number of results to return, starting at 1. Use with per_page to walk through large result sets.
per_pageinteger- Number of records to return per page, from 1 to 100. Example: 25.
surecontact_company_contacts_listList the contacts linked to a company, primary contact first, with page-based pagination.Read-onlyList Company Contacts
List the contacts linked to a company, primary contact first, with page-based pagination. Returns contacts with link details such as is_primary, role and linked_via. Use company_contacts_list to see who works at a company. Use company_contact_link to add one.
Inputs
company_uuidstringrequired- UUID of the company. Example: 550e8400-e29b-41d4-a716-446655440000.
pageinteger- Page number of results to return, starting at 1. Use with per_page to walk through large result sets.
per_pageinteger- Number of records to return per page, from 1 to 100. Example: 25.
surecontact_company_custom_field_getRetrieve one company custom field definition by UUID.Read-onlyGet Company Custom Field
Retrieve one company custom field definition by UUID. Returns the custom field with its uuid, name and type. Use company_custom_field_get when you have a field UUID from company_custom_fields_list.
Inputs
company_custom_field_uuidstringrequired- UUID of the company custom field. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_company_custom_fields_listList the company custom field definitions of the workspace.Read-onlyList Company Custom Fields
List the company custom field definitions of the workspace. Returns each company custom field with its uuid, name and type. Use company_custom_fields_list to discover company custom fields. Use custom_fields_list for contact custom fields.
Inputs
This tool takes no inputs.
surecontact_company_deals_listList the deals associated with a company, with page-based pagination.Read-onlyList Company Deals
List the deals associated with a company, with page-based pagination. Returns the deals linked to the company. Use company_deals_list to see a company's pipeline. Use deal_get for one deal.
Inputs
company_uuidstringrequired- UUID of the company. Example: 550e8400-e29b-41d4-a716-446655440000.
pageinteger- Page number of results to return, starting at 1. Use with per_page to walk through large result sets.
per_pageinteger- Number of records to return per page, from 1 to 100. Example: 25.
surecontact_company_getRetrieve one company by its UUID, including its creator, parent company and custom values.Read-onlyGet Company
Retrieve one company by its UUID, including its creator, parent company and custom values. Returns the company record. Use company_get for one company. Use companies_list to browse.
Inputs
company_uuidstringrequired- UUID of the company. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_company_note_getRetrieve one company note by its UUID.Read-onlyGet Company Note
Retrieve one company note by its UUID. Returns the note with its title, content, creator and timestamps. Use company_note_get when you have a note UUID from company_notes_list.
Inputs
company_note_uuidstringrequired- UUID of the company note. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_company_notes_listList the notes on one company, newest first, with page-based pagination.Read-onlyList Company Notes
List the notes on one company, newest first, with page-based pagination. Returns notes with uuid, title, content, creator and timestamps. Use company_notes_list to read a company's notes. Use company_note_get for one note.
Inputs
company_uuidstringrequired- UUID of the company. Example: 550e8400-e29b-41d4-a716-446655440000.
pageinteger- Page number of results to return, starting at 1. Use with per_page to walk through large result sets.
per_pageinteger- Number of records to return per page, from 1 to 100. Example: 25.
surecontact_company_tasks_listList the tasks associated with a company, with page-based pagination.Read-onlyList Company Tasks
List the tasks associated with a company, with page-based pagination. Returns the tasks linked to the company. Use company_tasks_list to see open work for a company. Use task_get for one task.
Inputs
company_uuidstringrequired- UUID of the company. Example: 550e8400-e29b-41d4-a716-446655440000.
pageinteger- Page number of results to return, starting at 1. Use with per_page to walk through large result sets.
per_pageinteger- Number of records to return per page, from 1 to 100. Example: 25.
surecontact_contact_activities_listList the activity timeline of one contact, newest first, with page-based pagination.Read-onlyList Contact Activities
List the activity timeline of one contact, newest first, with page-based pagination. Returns activities with uuid, type, type label, description, metadata and timestamps. Use contact_activities_list to review what a contact did. Use activity_get for one activity by UUID.
Inputs
contact_uuidstringrequired- UUID of the contact. Example: 550e8400-e29b-41d4-a716-446655440000.
pageinteger- Page number of results to return, starting at 1. Use with per_page to walk through large result sets.
per_pageinteger- Number of records to return per page, from 1 to 100. Example: 25.
surecontact_contact_getRetrieve one contact by its UUID.Read-onlyGet Contact
Retrieve one contact by its UUID. Returns the contact record with its uuid, email, name fields, status and timestamps. Use contact_get when you have the contact UUID. Use contact_get_by_email when you only have the email address.
Inputs
contact_uuidstringrequired- UUID of the contact. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_contact_get_by_emailLook up one contact by its exact email address.Read-onlyGet Contact by Email
Look up one contact by its exact email address. Returns the contact record (uuid, email, first and last name, full name, status, timestamps), or a 404 error when no contact has that email. Use contact_get_by_email when you know the email. Use contacts_list to search by partial text.
Inputs
emailstringrequired- Exact email address of the contact to look up. Example: jane@example.com.
surecontact_contact_notes_listList the notes on one contact, newest first, with page-based pagination.Read-onlyList Contact Notes
List the notes on one contact, newest first, with page-based pagination. Returns notes with uuid, content, creator and timestamps. Use contact_notes_list to read all notes on a contact. Use note_get for one note by UUID.
Inputs
contact_uuidstringrequired- UUID of the contact. Example: 550e8400-e29b-41d4-a716-446655440000.
pageinteger- Page number of results to return, starting at 1. Use with per_page to walk through large result sets.
per_pageinteger- Number of records to return per page, from 1 to 100. Example: 25.
surecontact_contact_purchase_stats_getRetrieve purchase statistics for one contact.Read-onlyGet Contact Purchase Stats
Retrieve purchase statistics for one contact. Returns total purchases, total spent, average order value and the first and last purchase dates. Use contact_purchase_stats_get for totals. Use contact_purchases_list for the individual purchases.
Inputs
contact_uuidstringrequired- UUID of the contact. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_contact_purchases_listList the purchase history of one contact, newest first, with page-based pagination.Read-onlyList Contact Purchases
List the purchase history of one contact, newest first, with page-based pagination. Returns purchases with uuid, source, source order ID, status, total amount, currency and products. Use contact_purchases_list for one contact. Use purchases_list for purchases across the workspace. Use contact_purchase_stats_get for totals only.
Inputs
contact_uuidstringrequired- UUID of the contact. Example: 550e8400-e29b-41d4-a716-446655440000.
pageinteger- Page number of results to return, starting at 1. Use with per_page to walk through large result sets.
per_pageinteger- Number of records to return per page, from 1 to 100. Example: 25.
surecontact_contacts_listList contacts in the SureContact workspace, with optional text search, company exclusion and custom-field sorting, plus page-based pagination.Read-onlyList Contacts
List contacts in the SureContact workspace, with optional text search, company exclusion and custom-field sorting, plus page-based pagination. Returns a paginated list of contacts with each contact's uuid, email, name, status and timestamps. Use contacts_list to browse or search. Use contact_get_by_email when you already know the exact email address.
Inputs
exclude_company_uuidstring- UUID of a company whose linked contacts should be excluded from the results. Example: 550e8400-e29b-41d4-a716-446655440000.
pageinteger- Page number of results to return, starting at 1. Use with per_page to walk through large result sets.
per_pageinteger- Number of records to return per page, from 1 to 100. Example: 25.
searchstring- Free-text search term used to filter results by name or email. Max 100 characters. Example: acme.
sort_by_custom_fieldstring- UUID of a contact custom field to sort the results by. Find it with the custom fields list tool. Example: 550e8400-e29b-41d4-a716-446655440000.
sort_orderstring- Sort direction, asc for ascending or desc for descending. Example: desc.
surecontact_custom_field_getRetrieve one contact custom field definition by UUID.Read-onlyGet Custom Field
Retrieve one contact custom field definition by UUID. Returns the custom field with its uuid, name and type. Use custom_field_get when you have a UUID from custom_fields_list.
Inputs
custom_field_uuidstringrequired- UUID of the custom field. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_custom_fields_listList the contact custom field definitions of the workspace, flat or grouped by section.Read-onlyList Custom Fields
List the contact custom field definitions of the workspace, flat or grouped by section. Returns each custom field with its uuid, name and type. Use custom_fields_list to find field UUIDs and names before setting custom_fields on a contact. Use company_custom_fields_list for company fields.
Inputs
groupedboolean- Set to true to receive custom fields nested under their sections. Leave empty for the default flat list.
surecontact_deal_activities_listList the activity history of one deal, with page-based pagination.Read-onlyList Deal Activities
List the activity history of one deal, with page-based pagination. Returns the deal's activities. Use deal_activities_list to see what changed on a deal. Use deal_get for its current state.
Inputs
deal_uuidstringrequired- UUID of the deal. Example: 550e8400-e29b-41d4-a716-446655440000.
pageinteger- Page number of results to return, starting at 1. Use with per_page to walk through large result sets.
per_pageinteger- Number of records to return per page, from 1 to 100. Example: 25.
surecontact_deal_getRetrieve one deal by its UUID.Read-onlyGet Deal
Retrieve one deal by its UUID. Returns the deal record. Use deal_get when you have a deal UUID from deals_list.
Inputs
deal_uuidstringrequired- UUID of the deal. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_deal_note_getRetrieve one deal note by its UUID.Read-onlyGet Deal Note
Retrieve one deal note by its UUID. Returns the note with its title, content and timestamps. Use deal_note_get when you have a note UUID from deal_notes_list.
Inputs
deal_note_uuidstringrequired- UUID of the deal note. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_deal_notes_listList the notes on one deal, with page-based pagination.Read-onlyList Deal Notes
List the notes on one deal, with page-based pagination. Returns notes with title, content, creator and timestamps. Use deal_notes_list to read a deal's notes. Use deal_note_get for one note.
Inputs
deal_uuidstringrequired- UUID of the deal. Example: 550e8400-e29b-41d4-a716-446655440000.
pageinteger- Page number of results to return, starting at 1. Use with per_page to walk through large result sets.
per_pageinteger- Number of records to return per page, from 1 to 100. Example: 25.
surecontact_deals_listList deals in the workspace with page-based pagination.Read-onlyList Deals
List deals in the workspace with page-based pagination. Returns a paginated list of deals. Use deals_list to browse the pipeline. Use deal_get for one deal by UUID.
Inputs
pageinteger- Page number of results to return, starting at 1. Use with per_page to walk through large result sets.
per_pageinteger- Number of records to return per page, from 1 to 100. Example: 25.
surecontact_email_template_getRetrieve one email template by its UUID.Read-onlyGet Email Template
Retrieve one email template by its UUID. Returns the template with its subject and HTML content. Use email_template_get when you have a template UUID from email_templates_list.
Inputs
template_uuidstringrequired- UUID of the template. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_email_templates_listList email templates, with optional search, type, folder and sorting.Read-onlyList Email Templates
List email templates, with optional search, type, folder and sorting. Returns templates with uuid, name and type. Use email_templates_list to find template UUIDs for email_send. Use email_template_get for one template.
Inputs
folder_uuidstring- UUID of a folder to restrict results to. Example: 550e8400-e29b-41d4-a716-446655440000.
per_pageinteger- Number of records to return per page, from 1 to 100. Example: 25.
searchstring- Free-text search term used to filter results by name or email. Max 100 characters. Example: acme. Max 255 characters.
sort_bystring- Field name to sort the results by. Example: created_at.
sort_orderstring- Sort direction, asc for ascending or desc for descending. Example: desc.
typestring- Filter by template type. Example: email.
surecontact_form_getRetrieve one form by its UUID.Read-onlyGet Form
Retrieve one form by its UUID. Returns the form definition and settings. Use form_get when you have a form UUID from forms_list.
Inputs
form_uuidstringrequired- UUID of the form. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_form_submissions_listList submissions of one form, with optional search, status and date range filters.Read-onlyList Form Submissions
List submissions of one form, with optional search, status and date range filters. Returns the form submissions. Use form_submissions_list to read leads captured by a form. Use form_get for the form itself.
Inputs
form_uuidstringrequired- UUID of the form. Example: 550e8400-e29b-41d4-a716-446655440000.
fromstring- Only return records on or after this date, as an ISO 8601 date or datetime. Example: 2026-01-01. Must be a valid date.
per_pageinteger- Number of records to return per page, from 1 to 100. Example: 25.
searchstring- Free-text search term used to filter results by name or email. Max 100 characters. Example: acme. Must match the regex /^[\w\s-@.]+$/. Max 100 characters.
statusstring- Filter by status value. Example: published.
tostring- Only return records on or before this date, as an ISO 8601 date or datetime. Example: 2026-01-31. Must be a valid date.
surecontact_forms_listList the forms of the workspace, with optional search, status filter and sorting.Read-onlyList Forms
List the forms of the workspace, with optional search, status filter and sorting. Returns forms with uuid, name, status and submission count. Use forms_list to find form UUIDs. Use form_get for one form.
Inputs
per_pageinteger- Number of records to return per page, from 1 to 100. Example: 25.
searchstring- Free-text search term used to filter results by name or email. Max 100 characters. Example: acme. Must match the regex /^[\w\s-@.]+$/. Max 100 characters.
sort_bystring- Field name to sort the results by. Example: created_at.
sort_orderstring- Sort direction, asc for ascending or desc for descending. Example: desc.
statusstring- Filter by status value. Example: published.
surecontact_list_contacts_listList the contacts in a list, evaluating filters at request time for dynamic lists, with page-based pagination.Read-onlyList List Contacts
List the contacts in a list, evaluating filters at request time for dynamic lists, with page-based pagination. Returns the list's contacts. Use list_contacts_list to see list members. Use contacts_list for all contacts.
Inputs
list_uuidstringrequired- UUID of the list. Example: 550e8400-e29b-41d4-a716-446655440000.
pageinteger- Page number of results to return, starting at 1. Use with per_page to walk through large result sets.
per_pageinteger- Number of records to return per page, from 1 to 100. Example: 25.
surecontact_list_getRetrieve one contact list by its UUID.Read-onlyGet List
Retrieve one contact list by its UUID. Returns the list with uuid, name, type, description and filters. Use list_get when you have a list UUID from lists_list.
Inputs
list_uuidstringrequired- UUID of the list. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_list_refresh_status_getGet the refresh status of a dynamic list.Read-onlyGet List Refresh Status
Get the refresh status of a dynamic list. Returns the current refresh state of the list. Use list_refresh_status_get to check whether a dynamic list has finished recalculating.
Inputs
list_uuidstringrequired- UUID of the list. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_lists_listList the static and dynamic contact lists of the workspace, with page-based pagination.Read-onlyList Lists
List the static and dynamic contact lists of the workspace, with page-based pagination. Returns lists with uuid, name, type and description. Use lists_list to find list UUIDs. Use list_get for one list.
Inputs
pageinteger- Page number of results to return, starting at 1. Use with per_page to walk through large result sets.
per_pageinteger- Number of records to return per page, from 1 to 100. Example: 25.
surecontact_note_getRetrieve one contact note by its UUID.Read-onlyGet Contact Note
Retrieve one contact note by its UUID. Returns the note with its uuid, content, creator and timestamps. Use note_get when you have a note UUID. Use contact_notes_list to find notes on a contact.
Inputs
note_uuidstringrequired- UUID of the note. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_page_getRetrieve one landing page by its UUID, including its full design JSON.Read-onlyGet Landing Page
Retrieve one landing page by its UUID, including its full design JSON. Returns the page with its status, SEO settings and design JSON. Use page_get when you have a page UUID from pages_list.
Inputs
page_uuidstringrequired- UUID of the page. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_pages_listList the landing pages of the workspace, with optional search, status filter and sorting.Read-onlyList Landing Pages
List the landing pages of the workspace, with optional search, status filter and sorting. Returns pages with uuid, name, slug, description and status. Use pages_list to find landing page UUIDs. Use page_get for one page with its design JSON.
Inputs
per_pageinteger- Number of records to return per page, from 1 to 100. Example: 25.
searchstring- Free-text search term used to filter results by name or email. Max 100 characters. Example: acme. Must match the regex /^[\w\s-@.]+$/. Max 100 characters.
sort_bystring- Field name to sort the results by. Example: created_at.
sort_orderstring- Sort direction, asc for ascending or desc for descending. Example: desc.
statusstring- Filter by status value. Example: published.
surecontact_pipeline_getRetrieve one pipeline by its UUID.Read-onlyGet Pipeline
Retrieve one pipeline by its UUID. Returns the pipeline with its stages. Use pipeline_get when you have a pipeline UUID from pipelines_list.
Inputs
pipeline_uuidstringrequired- UUID of the pipeline. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_pipeline_stages_listList the stages of one pipeline as a flat list.Read-onlyList Pipeline Stages
List the stages of one pipeline as a flat list. Returns each stage with its uuid and name. Use pipeline_stages_list to find the stage UUIDs that deal_create, deal_stage_update and deal_reopen need. Requires a pipeline UUID from pipelines_list.
Inputs
pipeline_uuidstringrequired- UUID of the pipeline whose stages to list. Get it from the pipelines list tool. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_pipelines_listList the deal pipelines of the workspace.Read-onlyList Pipelines
List the deal pipelines of the workspace. Returns each pipeline with its uuid, name and stages. Use pipelines_list to find pipeline UUIDs. Use pipeline_stages_list for a flat list of stages.
Inputs
This tool takes no inputs.
surecontact_purchase_getRetrieve one purchase by its UUID.Read-onlyGet Purchase
Retrieve one purchase by its UUID. Returns the purchase with its source, order ID, status, amounts and products. Use purchase_get when you have a purchase UUID from purchases_list.
Inputs
purchase_uuidstringrequired- UUID of the purchase. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_purchases_listList purchases across the workspace, newest first, with optional status, source and contact filters.Read-onlyList Purchases
List purchases across the workspace, newest first, with optional status, source and contact filters. Returns purchases with uuid, source, source order ID, status, total amount, currency and products. Use purchases_list for the whole workspace. Use contact_purchases_list for one contact.
Inputs
contact_uuidstring- UUID of the contact. Get it from the contacts list or get-by-email tool. Example: 550e8400-e29b-41d4-a716-446655440000.
pageinteger- Page number of results to return, starting at 1. Use with per_page to walk through large result sets.
per_pageinteger- Number of records to return per page, from 1 to 100. Example: 25.
sourcestring- Where the record came from. Example: api.
statusstring- Filter by status value. Example: published.
surecontact_report_campaign_summary_getGet aggregated metrics across all campaigns for a date range, optionally filtered by campaign status.Read-onlyGet Campaign Performance Summary
Get aggregated metrics across all campaigns for a date range, optionally filtered by campaign status. Returns the aggregated campaign metrics. Use report_campaign_summary_get to compare campaign performance overall. Use campaign_get for one campaign.
Inputs
compare_end_datestring- End of a custom comparison window as a date. Example: 2025-12-31. Must be a valid date. Must be a date after or equal to compare_start_date . Must be a date before or equal to today .
compare_start_datestring- Start of a custom comparison window as a date. Example: 2025-12-01. Must be a valid date. Must be a date before or equal to today .
compare_withstring- Comparison period to include, such as previous_period. Example: previous_period.
date_rangestring- Preset reporting window such as last_7_days or last_30_days. Leave empty to use start_date and end_date or the default window. Example: last_30_days.
end_datestring- End of a custom reporting window as a date. Example: 2026-01-31. Must be a valid date. Must be a date after or equal to start_date . Must be a date before or equal to today .
group_bystring- Time bucket for the report series, such as day, week or month. Example: day.
start_datestring- Start of a custom reporting window as a date. Example: 2026-01-01. Must be a valid date. Must be a date before or equal to today .
statusstring- Filter by status value. Example: published.
surecontact_report_contact_growth_getGet contact growth statistics for a date range, optionally filtered by tag or list.Read-onlyGet Contact Growth Report
Get contact growth statistics for a date range, optionally filtered by tag or list. Returns the contact growth series. Use report_contact_growth_get to see audience growth. Use report_overview_get for a broader summary.
Inputs
compare_end_datestring- End of a custom comparison window as a date. Example: 2025-12-31. Must be a valid date. Must be a date after or equal to compare_start_date . Must be a date before or equal to today .
compare_start_datestring- Start of a custom comparison window as a date. Example: 2025-12-01. Must be a valid date. Must be a date before or equal to today .
compare_withstring- Comparison period to include, such as previous_period. Example: previous_period.
date_rangestring- Preset reporting window such as last_7_days or last_30_days. Leave empty to use start_date and end_date or the default window. Example: last_30_days.
end_datestring- End of a custom reporting window as a date. Example: 2026-01-31. Must be a valid date. Must be a date after or equal to start_date . Must be a date before or equal to today .
filter_typestring- Restrict the growth report to contacts by tag or list. Example: tag.
group_bystring- Time bucket for the report series, such as day, week or month. Example: day.
start_datestring- Start of a custom reporting window as a date. Example: 2026-01-01. Must be a valid date. Must be a date before or equal to today .
surecontact_report_email_engagement_getGet email engagement statistics for a date range.Read-onlyGet Email Engagement Report
Get email engagement statistics for a date range. Returns opens, clicks and engagement rates. Use report_email_engagement_get for opens and clicks. Use report_email_sending_get for delivery volume.
Inputs
compare_end_datestring- End of a custom comparison window as a date. Example: 2025-12-31. Must be a valid date. Must be a date after or equal to compare_start_date . Must be a date before or equal to today .
compare_start_datestring- Start of a custom comparison window as a date. Example: 2025-12-01. Must be a valid date. Must be a date before or equal to today .
compare_withstring- Comparison period to include, such as previous_period. Example: previous_period.
date_rangestring- Preset reporting window such as last_7_days or last_30_days. Leave empty to use start_date and end_date or the default window. Example: last_30_days.
end_datestring- End of a custom reporting window as a date. Example: 2026-01-31. Must be a valid date. Must be a date after or equal to start_date . Must be a date before or equal to today .
group_bystring- Time bucket for the report series, such as day, week or month. Example: day.
start_datestring- Start of a custom reporting window as a date. Example: 2026-01-01. Must be a valid date. Must be a date before or equal to today .
surecontact_report_email_sending_getGet email sending statistics for a date range.Read-onlyGet Email Sending Report
Get email sending statistics for a date range. Returns sent, delivered, failed and bounced counts. Use report_email_sending_get for delivery volume. Use report_email_engagement_get for opens and clicks.
Inputs
compare_end_datestring- End of a custom comparison window as a date. Example: 2025-12-31. Must be a valid date. Must be a date after or equal to compare_start_date . Must be a date before or equal to today .
compare_start_datestring- Start of a custom comparison window as a date. Example: 2025-12-01. Must be a valid date. Must be a date before or equal to today .
compare_withstring- Comparison period to include, such as previous_period. Example: previous_period.
date_rangestring- Preset reporting window such as last_7_days or last_30_days. Leave empty to use start_date and end_date or the default window. Example: last_30_days.
end_datestring- End of a custom reporting window as a date. Example: 2026-01-31. Must be a valid date. Must be a date after or equal to start_date . Must be a date before or equal to today .
group_bystring- Time bucket for the report series, such as day, week or month. Example: day.
start_datestring- Start of a custom reporting window as a date. Example: 2026-01-01. Must be a valid date. Must be a date before or equal to today .
surecontact_report_overview_getGet high-level KPIs across contacts, emails, engagement and revenue for a date range, with optional comparison to another period.Read-onlyGet Reports Overview
Get high-level KPIs across contacts, emails, engagement and revenue for a date range, with optional comparison to another period. Returns the overview KPIs. Use report_overview_get for a dashboard summary. Use the other report tools for one area in depth.
Inputs
compare_end_datestring- End of a custom comparison window as a date. Example: 2025-12-31. Must be a valid date. Must be a date after or equal to compare_start_date . Must be a date before or equal to today .
compare_start_datestring- Start of a custom comparison window as a date. Example: 2025-12-01. Must be a valid date. Must be a date before or equal to today .
compare_withstring- Comparison period to include, such as previous_period. Example: previous_period.
date_rangestring- Preset reporting window such as last_7_days or last_30_days. Leave empty to use start_date and end_date or the default window. Example: last_30_days.
end_datestring- End of a custom reporting window as a date. Example: 2026-01-31. Must be a valid date. Must be a date after or equal to start_date . Must be a date before or equal to today .
group_bystring- Time bucket for the report series, such as day, week or month. Example: day.
start_datestring- Start of a custom reporting window as a date. Example: 2026-01-01. Must be a valid date. Must be a date before or equal to today .
surecontact_sequence_getRetrieve one sequence by its UUID; a workflow automation UUID returns a 404.Read-onlyGet Sequence
Retrieve one sequence by its UUID; a workflow automation UUID returns a 404. Returns the sequence definition and status. Use sequence_get when you have a sequence UUID from sequences_list.
Inputs
automation_uuidstringrequired- UUID of the automation. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_sequences_listList email sequences (automations of type sequence), with page-based pagination.Read-onlyList Sequences
List email sequences (automations of type sequence), with page-based pagination. Returns sequences with uuid, name and status. Use sequences_list to find sequence UUIDs for sequence_enroll. Use automations_list for all automations.
Inputs
pageinteger- Page number of results to return, starting at 1. Use with per_page to walk through large result sets.
per_pageinteger- Number of records to return per page, from 1 to 100. Example: 25.
surecontact_tag_contacts_listList the contacts that have a tag applied, with page-based pagination.Read-onlyList Tag Contacts
List the contacts that have a tag applied, with page-based pagination. Returns contacts with uuid, email, name, phone and status. Use tag_contacts_list to see who has a tag. Use contacts_list for all contacts.
Inputs
tag_uuidstringrequired- UUID of the tag. Example: 550e8400-e29b-41d4-a716-446655440000.
pageinteger- Page number of results to return, starting at 1. Use with per_page to walk through large result sets.
per_pageinteger- Number of records to return per page, from 1 to 100. Example: 25.
surecontact_tag_getRetrieve one tag by its UUID.Read-onlyGet Tag
Retrieve one tag by its UUID. Returns the tag with uuid, name, slug, color, description and usage count. Use tag_get when you have a tag UUID from tags_list.
Inputs
tag_uuidstringrequired- UUID of the tag. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_task_getRetrieve one task by its UUID.Read-onlyGet Task
Retrieve one task by its UUID. Returns the task record. Use task_get when you have a task UUID from tasks_list.
Inputs
task_uuidstringrequired- UUID of the task. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_tasks_listList tasks in the workspace with page-based pagination.Read-onlyList Tasks
List tasks in the workspace with page-based pagination. Returns a paginated list of tasks. Use tasks_list to browse tasks. Use task_get for one task by UUID.
Inputs
pageinteger- Page number of results to return, starting at 1. Use with per_page to walk through large result sets.
per_pageinteger- Number of records to return per page, from 1 to 100. Example: 25.
surecontact_company_archiveArchive a company so it is hidden from the active list; it can be restored with company_unarchive.WriteArchive Company
Archive a company so it is hidden from the active list; it can be restored with company_unarchive. Returns the API response for the archived company. Use company_archive to hide a company reversibly. Use company_delete to remove it.
Inputs
company_uuidstringrequired- UUID of the company. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_company_contact_linkLink one existing contact to a company, with an optional role and primary flag.WriteLink Contact to Company
Link one existing contact to a company, with an optional role and primary flag. Returns the API response for the new link. Use company_contact_link for a single contact. Use company_contacts_attach to link several contacts at once.
Inputs
company_uuidstringrequired- UUID of the company. Example: 550e8400-e29b-41d4-a716-446655440000.
contact_uuidstringrequired- UUID of the contact. Get it from the contacts list or get-by-email tool. Example: 550e8400-e29b-41d4-a716-446655440000.
is_primaryboolean- Set to true to mark this as the contact's primary company link.
linked_viastring- How the link was created. Defaults to manual.one of
manualauto_domain_matchimportapiformmigration rolestring- Role label of the contact at the company. Max 255 characters. Example: Procurement Lead.
surecontact_company_contacts_attachLink several contacts to a company in one call, with an optional role label.WriteAttach Contacts to Company
Link several contacts to a company in one call, with an optional role label. Returns the API response for the new links. Use company_contacts_attach for many contacts. Use company_contact_link for one contact.
Inputs
company_uuidstringrequired- UUID of the company. Example: 550e8400-e29b-41d4-a716-446655440000.
contact_uuidsarrayrequired- Array of contact UUIDs. Example: ["550e8400-e29b-41d4-a716-446655440000"].
is_primaryboolean- Set to true to mark this as the contact's primary company link.
linked_viastring- How the link was created. Defaults to manual.one of
manualauto_domain_matchimportapiformmigration rolestring- Role label of the contact at the company. Max 255 characters. Example: Procurement Lead.
surecontact_company_createCreate a company in the workspace, optionally linking existing contacts.WriteCreate Company
Create a company in the workspace, optionally linking existing contacts. Returns the created company record. Use company_create to add a new company. Use company_update to change an existing one. Requires a SureContact plan that includes the Companies module; company names must be unique per workspace.
Inputs
contact_uuidsarrayrequired- Array of contact UUIDs. Example: ["550e8400-e29b-41d4-a716-446655440000"].
namestringrequired- Name of the company; names are unique per workspace, case-insensitive. Max 255 characters. Example: Acme Corporation.
aboutstring- Short blurb shown in the company header. Max 5,000 characters. Example: B2B SaaS platform for managing customers.
addressobject- Postal address object with the optional keys street, city, state, country and postal_code. Example: {"city": "San Francisco", "country": "US"}.
annual_revenue_rangestring- Annual revenue bucket (under_1m, 1m_10m, 10m_50m, 50m_100m, 100m_500m, 500m_1b, 1b_plus).one of
under_1m1m_10m10m_50m50m_100m100m_500m500m_1b1b_plus descriptionstring- Long-form description or overview of the company. Max 10,000 characters. Example: Acme builds tools that help teams manage customers.
employee_rangestring- Employee headcount bucket (1-10, 11-50, 51-200, 201-500, 501-1000, 1001-5000, 5001-10000, 10001+).one of
1-1011-5051-200201-500501-10001001-50005001-1000010001+ facebook_urlstring- Facebook page URL. Example: https://www.facebook.com/acme.
industrystring- Industry as free text. Example: Software.
lead_statusstring- Lead status (new, open, in_progress, open_deal, unqualified, attempted_to_contact, connected, bad_timing).one of
newopenin_progressopen_dealunqualifiedattempted_to_contactconnectedbad_timing lifecycle_stagestring- Lifecycle stage (subscriber, lead, marketing_qualified_lead, sales_qualified_lead, opportunity, customer, evangelist, other).one of
subscriberleadmarketing_qualified_leadsales_qualified_leadopportunitycustomerevangelistother linkedin_urlstring- LinkedIn company page URL. Example: https://www.linkedin.com/company/acme.
logo_urlstring- Logo image URL. Setting it makes the logo manual so the favicon fetcher no longer overwrites it. Example: https://cdn.acme.com/logo.png.
metadataobject- Free-form key-value metadata object stored with the record. Example: {"utm_source": "google"}.
parent_company_uuidstring- UUID of a parent company for hierarchy; must be in the same workspace. Example: 550e8400-e29b-41d4-a716-446655440000.
phonestring- Primary phone number. Example: +1-555-0100.
sourcestring- Where the record came from. Example: api. Allowed values: manual, import, api, mcp, auto_domain_match, form, migration.one of
manualimportapimcpauto_domain_matchformmigration source_idstring- Identifier of the record in the originating system. Max 255 characters. Example: hubspot-12345.
twitter_handlestring- Twitter / X handle without the leading @. Example: acmecorp.
typestring- Company type (prospect, customer, partner, reseller, vendor, other).one of
prospectcustomerpartnerresellervendorother websitestring- Company website URL; the domain is extracted automatically. Example: https://acme.com.
year_foundedinteger- Founding year, from 1700 to the current year. Example: 2015.
surecontact_company_note_createAdd a note to a company.WriteCreate Company Note
Add a note to a company. Returns the created note. Use company_note_create for company notes. Use contact_note_create for contact notes.
Inputs
company_uuidstringrequired- UUID of the company. Example: 550e8400-e29b-41d4-a716-446655440000.
contentstringrequired- Body text of the note. Max 10,000 characters. Example: Customer requested a callback next week.
titlestring- Short title for the record. Max 255 characters. Example: Renewal Discussion.
surecontact_company_note_updateUpdate a company note; the creator can always edit their own note, other users need the manager role.WriteUpdate Company Note
Update a company note; the creator can always edit their own note, other users need the manager role. Returns the updated note. Use company_note_update to edit. Use company_note_delete to remove.
- Idempotent
Inputs
company_note_uuidstringrequired- UUID of the company note. Example: 550e8400-e29b-41d4-a716-446655440000.
contentstringrequired- Body text of the note. Max 10,000 characters. Example: Customer requested a callback next week.
titlestring- Short title for the record. Max 255 characters. Example: Renewal Discussion.
surecontact_company_primary_setMark a company as a contact's primary company and clear the primary flag from the contact's other company links.WriteSet Contact Primary Company
Mark a company as a contact's primary company and clear the primary flag from the contact's other company links. Returns the API response for the updated link. Use company_primary_set when a contact works at several companies and one should be primary.
Inputs
company_uuidstringrequired- UUID of the company. Example: 550e8400-e29b-41d4-a716-446655440000.
contact_uuidstringrequired- UUID of the contact. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_company_unarchiveRestore a previously archived company to the active list.WriteUnarchive Company
Restore a previously archived company to the active list. Returns the API response for the restored company. Use company_unarchive to undo company_archive.
Inputs
company_uuidstringrequired- UUID of the company. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_company_updateUpdate an existing company; only the fields you supply change.WriteUpdate Company
Update an existing company; only the fields you supply change. Returns the updated company record. Use company_update to edit a company. Use company_archive to hide it instead.
- Idempotent
Inputs
company_uuidstringrequired- UUID of the company. Example: 550e8400-e29b-41d4-a716-446655440000.
aboutstring- Short blurb shown in the company header. Max 5,000 characters. Example: B2B SaaS platform for managing customers.
addressobject- Postal address object with the optional keys street, city, state, country and postal_code. Example: {"city": "San Francisco", "country": "US"}.
annual_revenue_rangestring- Annual revenue bucket (under_1m, 1m_10m, 10m_50m, 50m_100m, 100m_500m, 500m_1b, 1b_plus).one of
under_1m1m_10m10m_50m50m_100m100m_500m500m_1b1b_plus descriptionstring- Long-form description or overview of the company. Max 10,000 characters. Example: Acme builds tools that help teams manage customers.
employee_rangestring- Employee headcount bucket (1-10, 11-50, 51-200, 201-500, 501-1000, 1001-5000, 5001-10000, 10001+).one of
1-1011-5051-200201-500501-10001001-50005001-1000010001+ facebook_urlstring- Facebook page URL. Example: https://www.facebook.com/acme.
industrystring- Industry as free text. Example: Software.
lead_statusstring- Lead status (new, open, in_progress, open_deal, unqualified, attempted_to_contact, connected, bad_timing).one of
newopenin_progressopen_dealunqualifiedattempted_to_contactconnectedbad_timing lifecycle_stagestring- Lifecycle stage (subscriber, lead, marketing_qualified_lead, sales_qualified_lead, opportunity, customer, evangelist, other).one of
subscriberleadmarketing_qualified_leadsales_qualified_leadopportunitycustomerevangelistother linkedin_urlstring- LinkedIn company page URL. Example: https://www.linkedin.com/company/acme.
logo_urlstring- Logo image URL. Setting it makes the logo manual so the favicon fetcher no longer overwrites it. Example: https://cdn.acme.com/logo.png.
metadataobject- Free-form key-value metadata object stored with the record. Example: {"utm_source": "google"}.
namestring- Name of the company; names are unique per workspace, case-insensitive. Max 255 characters. Example: Acme Corporation.
parent_company_uuidstring- UUID of a parent company for hierarchy; must be in the same workspace. Example: 550e8400-e29b-41d4-a716-446655440000.
phonestring- Primary phone number. Example: +1-555-0100.
twitter_handlestring- Twitter / X handle without the leading @. Example: acmecorp.
typestring- Company type (prospect, customer, partner, reseller, vendor, other).one of
prospectcustomerpartnerresellervendorother websitestring- Company website URL; the domain is extracted automatically. Example: https://acme.com.
year_foundedinteger- Founding year, from 1700 to the current year. Example: 2015.
surecontact_contact_activity_createLog a custom activity on a contact's timeline, such as a form submission or a note event from an external system.WriteCreate Contact Activity
Log a custom activity on a contact's timeline, such as a form submission or a note event from an external system. Returns the created activity with its uuid, type, description and metadata. Use contact_activity_create to record external events. Use contact_note_create to add a free-text note instead.
Inputs
activity_typestringrequired- Activity type to log. Must be one of the allowed values. Example: form_submitted. Allowed values: email_sent, email_opened, email_clicked, form_submitted, note_added, note_updated, note_deleted, tag_added, tag_removed, contact_created, contact_updated, list_added, list_removed, custom_field_added, custom_field_updated, custom_field_deleted, purchase_completed, purchase_cancelled, purchase_refunded.one of
email_sentemail_openedemail_clickedform_submittednote_addednote_updatednote_deletedtag_addedtag_removedcontact_createdcontact_updatedlist_addedlist_removedcustom_field_addedcustom_field_updatedcustom_field_deletedpurchase_completedpurchase_cancelledpurchase_refunded contact_uuidstringrequired- UUID of the contact. Example: 550e8400-e29b-41d4-a716-446655440000.
descriptionstringrequired- Free-text description of the record. Example: High-value customers.
metadataobject- Free-form key-value metadata object stored with the record. Example: {"utm_source": "google"}.
surecontact_contact_automation_startManually trigger an active automation for a contact; it runs asynchronously.WriteStart Automation for Contact
Manually trigger an active automation for a contact; it runs asynchronously. Returns the scheduled automation's UUID and name. Use contact_automation_start to run a workflow automation for one contact. Use sequence_enroll to put a contact into an email sequence. Requires an active automation UUID from automations_list.
Inputs
automation_uuidstringrequired- UUID of the automation. Example: 550e8400-e29b-41d4-a716-446655440000.
contact_uuidstringrequired- UUID of the contact. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_contact_companies_attachLink one contact to several companies in a single call, with an optional role label.WriteAttach Contact to Companies
Link one contact to several companies in a single call, with an optional role label. Returns the API response for the company links. Use contact_companies_attach to link one contact to many companies. Use company_contacts_attach to link many contacts to one company. Requires company UUIDs from companies_list.
Inputs
company_uuidsarrayrequired- Array of company UUIDs. Example: ["550e8400-e29b-41d4-a716-446655440000"].
contact_uuidstringrequired- UUID of the contact. Example: 550e8400-e29b-41d4-a716-446655440000.
is_primaryboolean- Set to true to mark this as the contact's primary company link.
linked_viastring- How the link was created. Defaults to manual.one of
manualauto_domain_matchimportapiformmigration rolestring- Role label of the contact at the company. Max 255 characters. Example: Procurement Lead.
surecontact_contact_double_opt_in_resendRegenerate the opt-in token and resend the double opt-in confirmation email to a contact.WriteResend Double Opt-in Email
Regenerate the opt-in token and resend the double opt-in confirmation email to a contact. Returns the API response with the contact whose confirmation was resent. Use contact_double_opt_in_resend only for contacts in pending status.
Inputs
contact_uuidstringrequired- UUID of the contact. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_contact_find_or_createFind a contact by email, or create it when no contact has that email; an existing contact is returned without any field being overwritten.WriteFind or Create Contact
Find a contact by email, or create it when no contact has that email; an existing contact is returned without any field being overwritten. Returns the contact record plus an is_created flag showing whether a new contact was made. Use contact_find_or_create to make sure a contact exists without changing existing data. Use contact_upsert to also update an existing contact's fields.
Inputs
primary_fieldsobjectrequired- Object with the contact's core fields; email is required for create and upsert. Supported keys: email, first_name, last_name, phone, company, job_title, birthdate (YYYY-MM-DD), gender (male, female, other, prefer_not_to_say), anniversary (MM-DD), prefix, suffix, source (manual, import, api, form, integration), status (active, unsubscribed, bounced, invalid, complained), language (ISO 639-1 code), timezone (IANA name), created_at and updated_at (ISO 8601). Example: {"email": "jane@example.com", "first_name": "Jane", "last_name": "Doe"}.
custom_fieldsobject- Custom field values as an object keyed by the custom field name. Example: {"industry": "Technology"}.
list_uuidsarray- Array of list UUIDs. Get them from the lists tool. Example: ["550e8400-e29b-41d4-a716-446655440000"].
metadataobject- Free-form key-value metadata object stored with the record. Example: {"utm_source": "google"}.
tag_uuidsarray- Array of tag UUIDs. Get them from the tags list tool. Example: ["550e8400-e29b-41d4-a716-446655440000"].
surecontact_contact_lists_attachAdd a contact to one or more static lists.WriteAttach Lists to Contact
Add a contact to one or more static lists. Returns the API response for the list membership change. Use contact_lists_attach to add a single contact to lists. Use list_contacts_add to add many contacts to one list. Requires list UUIDs from lists_list.
Inputs
contact_uuidstringrequired- UUID of the contact. Example: 550e8400-e29b-41d4-a716-446655440000.
list_uuidsarrayrequired- Array of list UUIDs. Get them from the lists tool. Example: ["550e8400-e29b-41d4-a716-446655440000"].
surecontact_contact_lists_detachRemove a contact from one or more static lists.WriteDetach Lists from Contact
Remove a contact from one or more static lists. Returns the API response for the list membership change. Use contact_lists_detach to remove a single contact from lists. Use list_contacts_remove to remove many contacts from one list. Requires list UUIDs from lists_list.
Inputs
contact_uuidstringrequired- UUID of the contact. Example: 550e8400-e29b-41d4-a716-446655440000.
list_uuidsarrayrequired- Array of list UUIDs. Get them from the lists tool. Example: ["550e8400-e29b-41d4-a716-446655440000"].
surecontact_contact_note_createAdd a note to a contact, attributed to the API key owner.WriteCreate Contact Note
Add a note to a contact, attributed to the API key owner. Returns the created note with its uuid, content, creator and timestamps. Use contact_note_create for free-text notes. Use contact_activity_create to log a typed timeline event.
Inputs
contact_uuidstringrequired- UUID of the contact. Example: 550e8400-e29b-41d4-a716-446655440000.
contentstringrequired- Body text of the note. Max 10,000 characters. Example: Customer requested a callback next week.
titlestring- Short title for the record. Max 255 characters. Example: Renewal Discussion.
surecontact_contact_status_updateChange a contact's subscription status to active, unsubscribed, bounced, invalid or complained.WriteUpdate Contact Status
Change a contact's subscription status to active, unsubscribed, bounced, invalid or complained. Returns the API response for the updated contact. Use contact_status_update to change only the status. Use contact_update to edit other fields.
- Idempotent
Inputs
contact_uuidstringrequired- UUID of the contact. Example: 550e8400-e29b-41d4-a716-446655440000.
statusstringrequired- The new status for the contact. Values: active, unsubscribed, bounced, invalid, complained.one of
activeunsubscribedbouncedinvalidcomplained
surecontact_contact_updateUpdate an existing contact's primary fields, metadata or custom field values; only the fields you supply change.WriteUpdate Contact
Update an existing contact's primary fields, metadata or custom field values; only the fields you supply change. Returns the updated contact record. Use contact_update to edit a known contact by UUID. Use contact_status_update to change only the subscription status. Requires the contact UUID from contacts_list or contact_get_by_email.
- Idempotent
Inputs
contact_uuidstringrequired- UUID of the contact. Example: 550e8400-e29b-41d4-a716-446655440000.
custom_fieldsobject- Custom field values as an object keyed by the custom field name. Example: {"industry": "Technology"}.
metadataobject- Free-form key-value metadata object stored with the record. Example: {"utm_source": "google"}.
primary_fieldsobject- Object with the contact's core fields; only the keys you supply are changed. Supported keys: email, first_name, last_name, phone, company, job_title, birthdate (YYYY-MM-DD), gender (male, female, other, prefer_not_to_say), anniversary (MM-DD), prefix, suffix, source (manual, import, api, form, integration), status (active, unsubscribed, bounced, invalid, complained), language (ISO 639-1 code), timezone (IANA name), created_at and updated_at (ISO 8601). Example: {"email": "jane@example.com", "first_name": "Jane", "last_name": "Doe"}.
surecontact_contact_upsertCreate a contact, or update the existing contact that has the same email address.WriteUpsert Contact
Create a contact, or update the existing contact that has the same email address. Returns the resulting contact record plus an is_created flag showing whether a new contact was made. Use contact_upsert to sync contact data from another system. Use contact_find_or_create to avoid changing an existing contact.
Inputs
primary_fieldsobjectrequired- Object with the contact's core fields; email is required for create and upsert. Supported keys: email, first_name, last_name, phone, company, job_title, birthdate (YYYY-MM-DD), gender (male, female, other, prefer_not_to_say), anniversary (MM-DD), prefix, suffix, source (manual, import, api, form, integration), status (active, unsubscribed, bounced, invalid, complained), language (ISO 639-1 code), timezone (IANA name), created_at and updated_at (ISO 8601). Example: {"email": "jane@example.com", "first_name": "Jane", "last_name": "Doe"}.
custom_fieldsobject- Custom field values as an object keyed by the custom field name. Example: {"industry": "Technology"}.
list_uuidsarray- Array of list UUIDs. Get them from the lists tool. Example: ["550e8400-e29b-41d4-a716-446655440000"].
metadataobject- Free-form key-value metadata object stored with the record. Example: {"utm_source": "google"}.
tag_uuidsarray- Array of tag UUIDs. Get them from the tags list tool. Example: ["550e8400-e29b-41d4-a716-446655440000"].
surecontact_deal_companies_attachLink companies to a deal.WriteAttach Companies to Deal
Link companies to a deal. Returns the API response for the links. Use deal_companies_attach to associate companies with a deal. Use deal_companies_detach to remove them.
Inputs
company_uuidsarrayrequired- Array of company UUIDs. Example: ["550e8400-e29b-41d4-a716-446655440000"].
deal_uuidstringrequired- UUID of the deal. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_deal_companies_detachRemove companies from a deal.WriteDetach Companies from Deal
Remove companies from a deal. Returns the API response for the removal. Use deal_companies_detach to unlink companies from a deal. Use deal_companies_attach to add them.
Inputs
company_uuidsarrayrequired- Array of company UUIDs. Example: ["550e8400-e29b-41d4-a716-446655440000"].
deal_uuidstringrequired- UUID of the deal. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_deal_contacts_attachLink contacts to a deal.WriteAttach Contacts to Deal
Link contacts to a deal. Returns the API response for the links. Use deal_contacts_attach to associate people with a deal. Use deal_contacts_detach to remove them.
Inputs
contact_uuidsarrayrequired- Array of contact UUIDs. Example: ["550e8400-e29b-41d4-a716-446655440000"].
deal_uuidstringrequired- UUID of the deal. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_deal_contacts_detachRemove contacts from a deal.WriteDetach Contacts from Deal
Remove contacts from a deal. Returns the API response for the removal. Use deal_contacts_detach to unlink people from a deal. Use deal_contacts_attach to add them.
Inputs
contact_uuidsarrayrequired- Array of contact UUIDs. Example: ["550e8400-e29b-41d4-a716-446655440000"].
deal_uuidstringrequired- UUID of the deal. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_deal_createCreate a deal in a pipeline stage, optionally linking contacts and companies.WriteCreate Deal
Create a deal in a pipeline stage, optionally linking contacts and companies. Returns the created deal. Use deal_create to open a new deal. Use deal_update to change an existing one. Requires a pipeline stage UUID from pipeline_stages_list.
Inputs
namestringrequired- Name of the deal. Max 255 characters. Example: Acme Annual Renewal.
pipeline_stage_uuidstringrequired- UUID of the pipeline stage the deal starts in. Get it from the pipeline stages list tool. Example: 550e8400-e29b-41d4-a716-446655440000.
amountnumber- Monetary value of the deal as a non-negative number in the deal currency. Example: 5000.
close_datestring- Expected close date of the deal as an ISO 8601 date or datetime. Example: 2026-12-31.
company_uuidsarray- Array of company UUIDs. Example: ["550e8400-e29b-41d4-a716-446655440000"].
contact_uuidsarray- Array of contact UUIDs. Example: ["550e8400-e29b-41d4-a716-446655440000"].
currencystring- Three-letter ISO 4217 currency code. Example: USD.
custom_fieldsobject- Custom field values as an object keyed by the custom field name. Example: {"industry": "Technology"}.
owner_uuidstring- UUID of the workspace user who owns the deal. Example: 550e8400-e29b-41d4-a716-446655440000.
sourcestring- Where the deal came from, max 100 characters. Example: website.
source_idstring- Identifier of the record in the originating system. Max 255 characters. Example: hubspot-12345.
win_probabilityinteger- Probability of winning, as a whole number from 0 to 100. Example: 60.
surecontact_deal_lostMark a deal as lost with a reason and optional notes.WriteMark Deal Lost
Mark a deal as lost with a reason and optional notes. Returns the updated deal. Use deal_lost when the deal did not close. Use deal_reopen to bring it back.
Inputs
deal_uuidstringrequired- UUID of the deal. Example: 550e8400-e29b-41d4-a716-446655440000.
loss_reasonstringrequired- Short reason the deal was lost. Max 255 characters. Example: Budget constraints.
loss_notesstring- Longer notes about why the deal was lost. Max 2000 characters. Example: Chose a competitor with a lower price.
surecontact_deal_note_createAdd a note to a deal.WriteCreate Deal Note
Add a note to a deal. Returns the created note. Use deal_note_create for deal notes. Use contact_note_create for contact notes.
Inputs
contentstringrequired- Body text of the note. Max 10,000 characters. Example: Sent the revised quote.
deal_uuidstringrequired- UUID of the deal. Example: 550e8400-e29b-41d4-a716-446655440000.
titlestring- Optional title of the note. Max 255 characters. Example: Pricing discussion.
surecontact_deal_note_updateUpdate the title or content of a deal note.WriteUpdate Deal Note
Update the title or content of a deal note. Returns the updated note. Use deal_note_update to edit. Use deal_note_delete to remove.
- Idempotent
Inputs
deal_note_uuidstringrequired- UUID of the deal note. Example: 550e8400-e29b-41d4-a716-446655440000.
contentstring- Body text of the note. Max 10,000 characters. Example: Sent the revised quote.
titlestring- Optional title of the note. Max 255 characters. Example: Pricing discussion.
surecontact_deal_reopenReopen a won or lost deal by placing it back into a pipeline stage.WriteReopen Deal
Reopen a won or lost deal by placing it back into a pipeline stage. Returns the updated deal. Use deal_reopen to undo deal_won or deal_lost. Requires a stage UUID from pipeline_stages_list.
Inputs
deal_uuidstringrequired- UUID of the deal. Example: 550e8400-e29b-41d4-a716-446655440000.
stage_uuidstringrequired- UUID of the pipeline stage. Get it from the pipeline stages list tool. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_deal_stage_updateMove a deal to another pipeline stage.WriteMove Deal to Stage
Move a deal to another pipeline stage. Returns the updated deal. Use deal_stage_update to progress a deal. Use deal_won or deal_lost to close it. Requires a stage UUID from pipeline_stages_list.
- Idempotent
Inputs
deal_uuidstringrequired- UUID of the deal. Example: 550e8400-e29b-41d4-a716-446655440000.
stage_uuidstringrequired- UUID of the pipeline stage. Get it from the pipeline stages list tool. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_deal_updateUpdate a deal's name, amount, currency, close date, win probability, owner, loss details or custom fields; only supplied fields change.WriteUpdate Deal
Update a deal's name, amount, currency, close date, win probability, owner, loss details or custom fields; only supplied fields change. Returns the updated deal. Use deal_update for field changes. Use deal_stage_update to move the deal between stages, and deal_won or deal_lost to close it.
- Idempotent
Inputs
deal_uuidstringrequired- UUID of the deal. Example: 550e8400-e29b-41d4-a716-446655440000.
amountnumber- Monetary value of the deal as a non-negative number in the deal currency. Example: 5000.
close_datestring- Expected close date of the deal as an ISO 8601 date or datetime. Example: 2026-12-31.
currencystring- Three-letter ISO 4217 currency code. Example: USD.
custom_fieldsobject- Custom field values as an object keyed by the custom field name. Example: {"industry": "Technology"}.
loss_notesstring- Longer notes about why the deal was lost. Max 2000 characters. Example: Chose a competitor with a lower price.
loss_reasonstring- Short reason the deal was lost. Max 255 characters. Example: Budget constraints.
namestring- Name of the deal. Max 255 characters. Example: Acme Annual Renewal.
owner_uuidstring- UUID of the workspace user who owns the deal. Example: 550e8400-e29b-41d4-a716-446655440000.
win_probabilityinteger- Probability of winning, as a whole number from 0 to 100. Example: 60.
surecontact_deal_wonMark a deal as won.WriteMark Deal Won
Mark a deal as won. Returns the updated deal. Use deal_won when the deal closed successfully. Use deal_lost when it did not.
Inputs
deal_uuidstringrequired- UUID of the deal. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_email_sendSend a one-off email to one contact, either with a raw subject and HTML body or from a template; delivery is queued and asynchronous.WriteSend Email
Send a one-off email to one contact, either with a raw subject and HTML body or from a template; delivery is queued and asynchronous. Returns the queued email with its uuid, status and subject. Use email_send for a transactional message to a single contact. Campaigns are for bulk sends. Requires a contact UUID or email, and a subject and body unless template_uuid is supplied.
Inputs
bodystring- HTML email body. Merge tags such as {{first_name}} are supported. Example: <p>Hi {{first_name}}, welcome aboard.</p>.
contact_emailstring- Email address of the contact. Use this instead of contact_uuid when you only know the email. Example: jane@example.com.
contact_uuidstring- UUID of the contact. Get it from the contacts list or get-by-email tool. Example: 550e8400-e29b-41d4-a716-446655440000.
from_emailstring- Sender email address; falls back to the SMTP configuration default. Example: hello@example.com.
from_namestring- Sender display name; falls back to the SMTP configuration default. Example: Acme Marketing.
reply_tostring- Reply-to email address. Example: support@example.com.
smtp_configuration_uuidstring- UUID of the SMTP configuration to send with; falls back to the workspace default when omitted. Example: 550e8400-e29b-41d4-a716-446655440000.
subjectstring- Email subject line. Max 255 characters. Example: Welcome to our newsletter.
template_uuidstring- UUID of an email template in the workspace. Get it from the email templates list tool. Example: 550e8400-e29b-41d4-a716-446655440000.
track_clicksboolean- Whether to track link clicks. Defaults to true.
track_opensboolean- Whether to track opens. Defaults to true.
surecontact_list_contacts_addAdd many contacts to a static list.WriteAdd Contacts to List
Add many contacts to a static list. Returns the API response for the membership change. Use list_contacts_add for many contacts. Use contact_lists_attach to put one contact into several lists.
Inputs
contact_uuidsarrayrequired- Array of contact UUIDs. Example: ["550e8400-e29b-41d4-a716-446655440000"].
list_uuidstringrequired- UUID of the list. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_list_contacts_removeRemove many contacts from a static list.WriteRemove Contacts from List
Remove many contacts from a static list. Returns the API response for the membership change. Use list_contacts_remove for many contacts. Use contact_lists_detach to remove one contact from several lists.
Inputs
contact_uuidsarrayrequired- Array of contact UUIDs. Example: ["550e8400-e29b-41d4-a716-446655440000"].
list_uuidstringrequired- UUID of the list. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_list_createCreate a static or dynamic contact list.WriteCreate List
Create a static or dynamic contact list. Returns the created list. Use list_create to add a list. Use list_update to change an existing list.
Inputs
namestringrequired- Name of the list; must be unique within the workspace. Max 255 characters. Example: Newsletter Subscribers.
descriptionstring- Optional description of the list. Max 1000 characters. Example: Contacts subscribed to the weekly newsletter.
filtersobject- Filter criteria object for a dynamic list. Only used when type is dynamic. Example: {"include_tags": ["550e8400-e29b-41d4-a716-446655440000"]}.
public_namestring- Name shown to contacts on the preferences page. Example: Weekly Newsletter.
show_in_preferencesboolean- Set to true to show the list on the public email preferences page.
typestring- The type of list. "static" for manually managed lists, "dynamic" for filter-based lists.one of
staticdynamic
surecontact_list_updateUpdate a list's name, description, type, filters or preference-page settings; only supplied fields change.WriteUpdate List
Update a list's name, description, type, filters or preference-page settings; only supplied fields change. Returns the updated list. Use list_update to edit a list. Use list_delete to remove it.
- Idempotent
Inputs
list_uuidstringrequired- UUID of the list. Example: 550e8400-e29b-41d4-a716-446655440000.
descriptionstring- Optional description of the list. Max 1000 characters. Example: Contacts subscribed to the weekly newsletter.
filtersobject- Filter criteria object for a dynamic list. Only used when type is dynamic. Example: {"include_tags": ["550e8400-e29b-41d4-a716-446655440000"]}.
namestring- Name of the list; must be unique within the workspace. Max 255 characters. Example: Newsletter Subscribers.
public_namestring- Name shown to contacts on the preferences page. Example: Weekly Newsletter.
show_in_preferencesboolean- Set to true to show the list on the public email preferences page.
typestring- The type of list. "static" for manually managed lists, "dynamic" for filter-based lists.one of
staticdynamic
surecontact_note_updateUpdate the title or content of an existing contact note; only the note creator or workspace managers can do this.WriteUpdate Contact Note
Update the title or content of an existing contact note; only the note creator or workspace managers can do this. Returns the updated note. Use note_update to edit a note. Use note_delete to remove it.
- Idempotent
Inputs
contentstringrequired- Body text of the note. Max 10,000 characters. Example: Customer requested a callback next week.
note_uuidstringrequired- UUID of the note. Example: 550e8400-e29b-41d4-a716-446655440000.
titlestring- Short title for the record. Max 255 characters. Example: Renewal Discussion.
surecontact_purchase_createTrack a purchase for a contact identified by UUID or email; an unknown email creates the contact automatically.WriteCreate Purchase
Track a purchase for a contact identified by UUID or email; an unknown email creates the contact automatically. Returns the purchase UUID, contact UUID and contact email. Use purchase_create to record an order from an external store.
Inputs
order_idstringrequired- Unique order identifier from your system. Example: ORD-12345.
total_amountnumberrequired- Total order amount as a number. Example: 99.99.
billing_addressobject- Billing address object. Example: {"street": "123 Main St", "city": "New York"}.
contact_emailstring- Email address of the contact. Use this instead of contact_uuid when you only know the email. Example: jane@example.com.
contact_uuidstring- UUID of the contact. Get it from the contacts list or get-by-email tool. Example: 550e8400-e29b-41d4-a716-446655440000.
coupon_amountnumber- Coupon discount amount. Example: 10.
coupon_codestring- Applied coupon code. Example: SAVE10.
currencystring- Three-letter ISO 4217 currency code. Example: USD.
customer_notestring- Customer notes for the order. Example: Please gift wrap.
discountnumber- Total discount amount. Example: 10.
metadataobject- Free-form key-value metadata object stored with the record. Example: {"utm_source": "google"}.
payment_methodstring- Payment method used. Example: credit_card.
productsarray- Array of product names or identifiers in the purchase. Example: ["T-Shirt", "Mug"].
purchase_idstring- Optional secondary purchase identifier. Example: PUR-001.
purchased_atstring- When the purchase happened, as an ISO 8601 datetime. Example: 2025-01-15T10:30:00Z.
shipping_addressobject- Shipping address object. Example: {"street": "123 Main St", "city": "New York"}.
shipping_amountnumber- Shipping cost. Example: 5.
shipping_methodstring- Shipping method. Example: standard.
statusstring- Purchase status (completed, cancelled, refunded, pending). Default: completed.one of
completedcancelledrefundedpending subtotalnumber- Subtotal before tax and shipping. Example: 94.99.
tax_amountnumber- Tax amount. Example: 8.5.
transaction_idstring- Payment transaction ID. Example: TXN-ABC123.
surecontact_sequence_enrollEnroll a contact, identified by UUID or email, in an active sequence; the first email goes out shortly after.WriteEnroll Contact in Sequence
Enroll a contact, identified by UUID or email, in an active sequence; the first email goes out shortly after. Returns the sequence and the enrolled contact. Use sequence_enroll to start a drip sequence. Use contact_automation_start to run a workflow automation instead. Requires an active sequence UUID from sequences_list.
Inputs
automation_uuidstringrequired- UUID of the automation. Example: 550e8400-e29b-41d4-a716-446655440000.
contact_emailstring- Email address of the contact. Use this instead of contact_uuid when you only know the email. Example: jane@example.com.
contact_uuidstring- UUID of the contact. Get it from the contacts list or get-by-email tool. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_sequence_unenrollCancel a contact's active runs in a sequence; calling it for a contact who is not enrolled succeeds with zero cancelled executions.WriteUnenroll Contact from Sequence
Cancel a contact's active runs in a sequence; calling it for a contact who is not enrolled succeeds with zero cancelled executions. Returns the number of cancelled executions and the sequence. Use sequence_unenroll to stop a drip sequence for a contact. Use sequence_enroll to start one.
Inputs
automation_uuidstringrequired- UUID of the automation. Example: 550e8400-e29b-41d4-a716-446655440000.
contact_emailstring- Email address of the contact. Use this instead of contact_uuid when you only know the email. Example: jane@example.com.
contact_uuidstring- UUID of the contact. Get it from the contacts list or get-by-email tool. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_tag_contacts_addApply a tag to many contacts at once, up to 10,000 per request; contacts that already have it are skipped.WriteAdd Contacts to Tag
Apply a tag to many contacts at once, up to 10,000 per request; contacts that already have it are skipped. Returns the updated tag. Use tag_contacts_add to tag many contacts. Use contact_tags_attach to give one contact several tags.
Inputs
contact_uuidsarrayrequired- Array of contact UUIDs. Example: ["550e8400-e29b-41d4-a716-446655440000"].
tag_uuidstringrequired- UUID of the tag. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_tag_contacts_removeRemove a tag from many contacts at once, up to 10,000 per request; contacts without it are skipped.WriteRemove Contacts from Tag
Remove a tag from many contacts at once, up to 10,000 per request; contacts without it are skipped. Returns the updated tag. Use tag_contacts_remove to untag many contacts. Use contact_tags_detach to remove several tags from one contact.
Inputs
contact_uuidsarrayrequired- Array of contact UUIDs. Example: ["550e8400-e29b-41d4-a716-446655440000"].
tag_uuidstringrequired- UUID of the tag. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_tag_createCreate a tag in the workspace.WriteCreate Tag
Create a tag in the workspace. Returns the created tag with uuid, name, slug, color and description. Use tag_create to add a new tag. Use tag_update to change an existing tag.
Inputs
namestringrequired- Name of the tag. Max 255 characters. Example: VIP Customer.
colorstring- Hex color code. Example: #10B981.
descriptionstring- Optional description of the tag. Example: High-value customers.
slugstring- URL-friendly slug; auto-generated from the name when omitted. Example: vip-customer.
surecontact_tag_updateUpdate a tag's name, color, description or slug; only supplied fields change.WriteUpdate Tag
Update a tag's name, color, description or slug; only supplied fields change. Returns the updated tag. Use tag_update to edit a tag. Use tag_delete to remove it.
- Idempotent
Inputs
tag_uuidstringrequired- UUID of the tag. Example: 550e8400-e29b-41d4-a716-446655440000.
colorstring- Hex color code. Example: #10B981.
descriptionstring- Optional description of the tag. Example: High-value customers.
namestring- Name of the tag. Max 255 characters. Example: VIP Customer.
slugstring- URL-friendly slug; auto-generated from the name when omitted. Example: vip-customer.
surecontact_task_companies_attachLink companies to a task.WriteAttach Companies to Task
Link companies to a task. Returns the API response for the links. Use task_companies_attach to associate companies with a task. Use task_companies_detach to remove them.
Inputs
company_uuidsarrayrequired- Array of company UUIDs. Example: ["550e8400-e29b-41d4-a716-446655440000"].
task_uuidstringrequired- UUID of the task. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_task_companies_detachRemove companies from a task.WriteDetach Companies from Task
Remove companies from a task. Returns the API response for the removal. Use task_companies_detach to unlink companies from a task. Use task_companies_attach to add them.
Inputs
company_uuidsarrayrequired- Array of company UUIDs. Example: ["550e8400-e29b-41d4-a716-446655440000"].
task_uuidstringrequired- UUID of the task. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_task_contacts_attachLink contacts to a task.WriteAttach Contacts to Task
Link contacts to a task. Returns the API response for the links. Use task_contacts_attach to associate people with a task. Use task_contacts_detach to remove them.
Inputs
contact_uuidsarrayrequired- Array of contact UUIDs. Example: ["550e8400-e29b-41d4-a716-446655440000"].
task_uuidstringrequired- UUID of the task. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_task_contacts_detachRemove contacts from a task.WriteDetach Contacts from Task
Remove contacts from a task. Returns the API response for the removal. Use task_contacts_detach to unlink people from a task. Use task_contacts_attach to add them.
Inputs
contact_uuidsarrayrequired- Array of contact UUIDs. Example: ["550e8400-e29b-41d4-a716-446655440000"].
task_uuidstringrequired- UUID of the task. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_task_createCreate a task, optionally linked to deals, contacts and companies.WriteCreate Task
Create a task, optionally linked to deals, contacts and companies. Returns the created task. Use task_create to add a to-do. Use task_update to change an existing task.
Inputs
titlestringrequired- Short title of the task. Max 255 characters. Example: Follow up with Acme.
assigned_to_uuidstring- UUID of the workspace user the task is assigned to. Example: 550e8400-e29b-41d4-a716-446655440000.
company_uuidsarray- Array of company UUIDs. Example: ["550e8400-e29b-41d4-a716-446655440000"].
contact_uuidsarray- Array of contact UUIDs. Example: ["550e8400-e29b-41d4-a716-446655440000"].
deal_uuidsarray- Array of deal UUIDs to link. Example: ["550e8400-e29b-41d4-a716-446655440000"].
descriptionstring- Longer description of the task. Max 10,000 characters. Example: Send the revised proposal and confirm the next call.
due_datestring- When the task is due, as an ISO 8601 datetime. Example: 2026-12-31T17:00:00Z.
reminder_offset_minutesinteger- Minutes before the due date to send a reminder, at least 1. Example: 30.
task_type_uuidstring- UUID of the task type (such as call or email) from your workspace. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_task_doneMark a task as completed.WriteMark Task Done
Mark a task as completed. Returns the API response for the task. Use task_done to complete a task. Use task_undone to reopen it.
Inputs
task_uuidstringrequired- UUID of the task. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_task_undoneReopen a completed task.WriteMark Task Not Done
Reopen a completed task. Returns the API response for the task. Use task_undone to undo task_done.
Inputs
task_uuidstringrequired- UUID of the task. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_task_updateUpdate a task's fields, links or done state; only supplied fields change.WriteUpdate Task
Update a task's fields, links or done state; only supplied fields change. Returns the updated task. Use task_update for edits. Use task_done to complete a task in one step.
- Idempotent
Inputs
task_uuidstringrequired- UUID of the task. Example: 550e8400-e29b-41d4-a716-446655440000.
assigned_to_uuidstring- UUID of the workspace user the task is assigned to. Example: 550e8400-e29b-41d4-a716-446655440000.
company_uuidsarray- Array of company UUIDs. Example: ["550e8400-e29b-41d4-a716-446655440000"].
contact_uuidsarray- Array of contact UUIDs. Example: ["550e8400-e29b-41d4-a716-446655440000"].
deal_uuidsarray- Array of deal UUIDs to link. Example: ["550e8400-e29b-41d4-a716-446655440000"].
descriptionstring- Longer description of the task. Max 10,000 characters. Example: Send the revised proposal and confirm the next call.
doneboolean- Set to true to mark the task completed or false to reopen it.
due_datestring- When the task is due, as an ISO 8601 datetime. Example: 2026-12-31T17:00:00Z.
reminder_offset_minutesinteger- Minutes before the due date to send a reminder, at least 1. Example: 30.
task_type_uuidstring- UUID of the task type (such as call or email) from your workspace. Example: 550e8400-e29b-41d4-a716-446655440000.
titlestring- Short title of the task. Max 255 characters. Example: Follow up with Acme.
surecontact_company_contact_unlinkRemove the link between a contact and a company; if it was the primary link another link is promoted automatically.DestructiveUnlink Contact from Company
Remove the link between a contact and a company; if it was the primary link another link is promoted automatically. Returns the API response for the removed link. Use company_contact_unlink to detach a contact. Use contact_delete to delete the contact itself.
- Idempotent
Inputs
company_uuidstringrequired- UUID of the company. Example: 550e8400-e29b-41d4-a716-446655440000.
contact_uuidstringrequired- UUID of the contact. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_company_deleteDelete a company; links to contacts are preserved.DestructiveDelete Company
Delete a company; links to contacts are preserved. Returns an empty response on success. Use company_delete to remove a company. Use company_archive to hide it reversibly instead.
- Idempotent
Inputs
company_uuidstringrequired- UUID of the company. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_company_note_deleteDelete a company note.DestructiveDelete Company Note
Delete a company note. Returns an empty response on success. Use company_note_delete to remove a note. Use company_note_update to edit it instead.
- Idempotent
Inputs
company_note_uuidstringrequired- UUID of the company note. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_contact_deleteDelete a contact from the workspace.DestructiveDelete Contact
Delete a contact from the workspace. Returns the API response confirming the deletion. Use contact_delete to remove a contact permanently. Use contact_status_update to unsubscribe a contact instead of deleting.
- Idempotent
Inputs
contact_uuidstringrequired- UUID of the contact. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_deal_deleteDelete a deal.DestructiveDelete Deal
Delete a deal. Returns the API response confirming the deletion. Use deal_delete to remove a deal. Use deal_lost to close it while keeping the record.
- Idempotent
Inputs
deal_uuidstringrequired- UUID of the deal. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_deal_note_deleteDelete a deal note.DestructiveDelete Deal Note
Delete a deal note. Returns the API response confirming the deletion. Use deal_note_delete to remove a note. Use deal_note_update to edit it instead.
- Idempotent
Inputs
deal_note_uuidstringrequired- UUID of the deal note. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_list_deleteDelete a contact list.DestructiveDelete List
Delete a contact list. Returns the API response confirming the deletion. Use list_delete to remove a list. Use list_contacts_remove to take only some contacts out.
- Idempotent
Inputs
list_uuidstringrequired- UUID of the list. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_note_deleteSoft-delete a contact note; only the note creator or workspace managers can do this.DestructiveDelete Contact Note
Soft-delete a contact note; only the note creator or workspace managers can do this. Returns an empty response on success. Use note_delete to remove a note. Use note_update to edit it instead.
- Idempotent
Inputs
note_uuidstringrequired- UUID of the note. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_tag_deletePermanently delete a tag, removing it from all contacts.DestructiveDelete Tag
Permanently delete a tag, removing it from all contacts. Returns an empty response on success. Use tag_delete to remove a tag everywhere. Use tag_contacts_remove to untag only some contacts.
- Idempotent
Inputs
tag_uuidstringrequired- UUID of the tag. Example: 550e8400-e29b-41d4-a716-446655440000.
surecontact_task_deleteDelete a task.DestructiveDelete Task
Delete a task. Returns the API response confirming the deletion. Use task_delete to remove a task. Use task_done to complete it instead.
- Idempotent
Inputs
task_uuidstringrequired- UUID of the task. Example: 550e8400-e29b-41d4-a716-446655440000.
No tools match.
