The noCRM connector lets your AI agent act in each user's noCRM account. Each user connects their own noCRM API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 46 tools.
- Tools
- 46
- What they doRead · write · destructive
- 27 · 16 · 327 read16 write3 destructive
- Users sign in with
- API key
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 noCRM connection
In AgentKit > Connections, create a noCRM 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 = 'nocrmio'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize noCRM:', 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: 'nocrmio_find_prospects',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 = "nocrmio"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize noCRM:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="nocrmio_find_prospects",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their noCRM credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolnocrmio_find_prospectsFind prospects across all prospecting lists by email address or by a field value.Read-onlyFind Prospects
Find prospects across all prospecting lists by email address or by a field value. Returns an array of prospects with id, lead_id, is_active, content and spreadsheet_id. Provide email, or provide field_key together with field_value.
Inputs
emailstring- Email address held in a prospect column. Provide this or field_key with field_value. Example: albert@example.com.
field_keystring- Column name to search in; must be used with field_value. Example: Phone.
field_valuestring- Value to look for in the column named by field_key. Example: 0387123456.
nocrmio_get_client_folderRetrieve one client folder by ID.Read-onlyGet Client Folder
Retrieve one client folder by ID. Returns the folder with id, name, description, is_active, user_id and extended_info (permalink, fields, user). Use nocrmio_list_client_folders to find IDs.
Inputs
idintegerrequired- ID of the client folder. Example: 12.
nocrmio_get_leadRetrieve one lead by ID with full detail.Read-onlyGet Lead
Retrieve one lead by ID with full detail. Returns the lead with id, title, step, step_id, status, amount, probability, currency, starred, next_action_at, reminder fields, tags, description, user_id, team_id, client_folder_id and extended_info. Use nocrmio_list_leads to find a lead ID first.
Inputs
idintegerrequired- ID of the lead. Example: 8113.
nocrmio_get_lead_attachmentGet a temporary download link for one attachment of a lead.Read-onlyGet Lead Attachment
Get a temporary download link for one attachment of a lead. Returns an object with a signed url that expires after about three minutes. Use nocrmio_list_lead_attachments to find the attachment ID.
Inputs
idintegerrequired- ID of the attachment. Example: 422.
lead_idintegerrequired- ID of the lead. Example: 8113.
nocrmio_get_lead_business_cardGet a temporary download link for the business card image stored on a lead.Read-onlyGet Lead Business Card
Get a temporary download link for the business card image stored on a lead. Returns an object with a signed url that expires after a few minutes. Use it only for leads created from a scanned business card.
Inputs
idintegerrequired- ID of the lead. Example: 8113.
nocrmio_get_prospecting_listRetrieve one prospecting list with its prospect rows.Read-onlyGet Prospecting List
Retrieve one prospecting list with its prospect rows. Returns the list with id, title, column_names, tags, user and spreadsheet_rows (id, lead_id, content, comment_count). Use nocrmio_list_prospecting_lists to find the ID.
Inputs
idintegerrequired- ID of the prospecting list. Example: 112.
nocrmio_get_stepRetrieve one pipeline step by ID or exact name.Read-onlyGet Step
Retrieve one pipeline step by ID or exact name. Returns the step with id, name, position, pipeline_id and the pipeline object. Use nocrmio_list_steps to see all steps.
Inputs
idstringrequired- Step ID or exact step name; URL special characters are encoded automatically. Example: 1189.
nocrmio_get_teamRetrieve one team by ID or name with its members.Read-onlyGet Team
Retrieve one team by ID or name with its members. Returns the team with id, name, users and timestamps; returns 403 when the Teams feature is off. Use nocrmio_list_teams to browse teams.
Inputs
idstringrequired- Team ID or exact team name. Example: 5.
nocrmio_get_userRetrieve one user by ID or email address.Read-onlyGet User
Retrieve one user by ID or email address. Returns the user with id, names, email, phone, job_title, locale, time_zone, is_admin and is_disabled. Use nocrmio_list_users to browse users.
Inputs
idstringrequired- User ID or email address; special characters are encoded automatically. Example: 514.
nocrmio_list_activitiesList activity types such as Call, E-mail and Meeting configured in the account.Read-onlyList Activities
List activity types such as Call, E-mail and Meeting configured in the account. Returns an array with id, name, icon, parent_id, kind and is_disabled. Use the id as activity_id on comments, reminders and nocrmio_log_lead_activity.
Inputs
This tool takes no inputs.
nocrmio_list_categoriesList tag categories, optionally with the predefined tags inside each.Read-onlyList Categories
List tag categories, optionally with the predefined tags inside each. Returns an array with id, name, is_required and, when requested, supertags. Use nocrmio_list_predefined_tags for a flat list of tags.
Inputs
include_tagsboolean- Include the predefined tags under each category. Defaults to false. Example: true.
nocrmio_list_client_foldersList the client folders of the account.Read-onlyList Client Folders
List the client folders of the account. Returns an array of folders with id, name, description, is_active, created_at and user_id. Use nocrmio_get_client_folder for fields and permalink.
Inputs
directionstring- Sort direction, asc or desc. Defaults to asc when omitted. Example: desc.one of
ascdesc orderstring- Attribute to sort by. Defaults to name. Example: id.one of
nameid
nocrmio_list_fieldsList the custom and standard fields defined on leads or client folders.Read-onlyList Fields
List the custom and standard fields defined on leads or client folders. Returns an array with id, name, type, parent_type and position. Use the names with the fields parameter of nocrmio_update_lead.
Inputs
typestring- Restrict to fields of leads or client folders. Example: lead.one of
leadclient
nocrmio_list_follow_upsList post-sales processes for a lead or for a user.Read-onlyList Post-Sales Tasks
List post-sales processes for a lead or for a user. Returns an array with id, title, status, tags, tasks_count, tasks_done_count, lead_id and user_id. Provide lead_id or user_id; use nocrmio_update_follow_up_task to change a task inside one.
Inputs
lead_idinteger- Return post-sales processes of this lead. Provide this or user_id. Example: 8113.
statusstring- Comma-separated statuses to include: todo, standby, done. Example: todo,standby.
user_idstring- Email address or numeric ID of the noCRM user. Provide this or lead_id. Use nocrmio_list_users to find users. Example: stef@example.com.
nocrmio_list_lead_attachmentsList files and linked documents attached to a lead.Read-onlyList Lead Attachments
List files and linked documents attached to a lead. Returns an array with id, name, url, content_type and kind for each attachment. Use nocrmio_get_lead_attachment for a temporary download link.
Inputs
lead_idintegerrequired- ID of the lead. Example: 8113.
nocrmio_list_lead_commentsList the comments on a lead.Read-onlyList Lead Comments
List the comments on a lead. Returns an array of comments with id, content, created_at, attachments, activity_id, is_pinned and user. Use nocrmio_create_lead_comment to add one.
Inputs
lead_idintegerrequired- ID of the lead. Example: 8113.
directionstring- Sort direction, asc or desc. Defaults to desc when omitted. Example: desc.one of
ascdesc
nocrmio_list_lead_duplicatesList leads that noCRM flags as potential duplicates of a given lead.Read-onlyList Lead Duplicates
List leads that noCRM flags as potential duplicates of a given lead. Returns an array of entries, each holding a lead object. Duplicates are detected on fields marked as keys; use nocrmio_list_fields to see which.
Inputs
lead_idintegerrequired- ID of the lead to check. Example: 8113.
nocrmio_list_lead_historyList the action history of a lead, such as creation, step changes, status changes, assignments, comments and emails.Read-onlyList Lead History
List the action history of a lead, such as creation, step changes, status changes, assignments, comments and emails. Returns an array of entries with id, action_type, action_item, created_at and user. Use nocrmio_list_lead_comments to read comment text.
Inputs
lead_idintegerrequired- ID of the lead. Example: 8113.
action_typestring- Only return this kind of action. Example: status_changed.one of
client_assignedstep_changedstatus_changedamount_setuser_assignedlead_createdcomment_addedemail_sent action_valuestring- Filter on the new step name or new status, valid only with action_type step_changed or status_changed. Example: won.
directionstring- Sort direction, asc or desc. Defaults to asc when omitted. Example: desc.one of
ascdesc fromstring- Start date of the range. Example: 2024-01-01.
limitinteger- Number of entries to return, between 1 and 100. Defaults to 100 when omitted. Example: 50.
offsetinteger- Number of records to skip, used together with limit to page through results. Example: 100.
tostring- End date of the range; used alone it returns everything up to that date. Example: 2024-03-31.
user_idsstring- Comma-separated user IDs or emails who performed the actions. Example: 514,stef@example.com.
nocrmio_list_leadsList leads in the noCRM account, optionally filtered by status, step, owner, tags, email or date range.Read-onlyList Leads
List leads in the noCRM account, optionally filtered by status, step, owner, tags, email or date range. Returns an array of leads (id, title, step, status, amount, probability, tags, description, user_id); up to 100 per request. Use nocrmio_get_lead for one lead with full detail, or nocrmio_list_unassigned_leads for leads with no owner.
Inputs
date_range_typestring- Which date start_date and end_date apply to. Defaults to creation when omitted. Example: update.one of
creationupdatenext_actionclosed directionstring- Sort direction, asc or desc. Defaults to desc when omitted. Example: desc.one of
ascdesc emailstring- Return leads whose description or comments contain this email address. Example: john.doe@acme.com.
end_datestring- End of the date range, applied to the field chosen by date_range_type. Example: 2024-03-31.
include_unassignedboolean- Include leads with no owner in the results. Defaults to false when omitted. Example: true.
limitinteger- Maximum number of records to return. Defaults to 100 when omitted. Example: 50.
offsetinteger- Number of records to skip, used together with limit to page through results. Example: 100.
orderstring- Attribute to sort by. Defaults to id. Example: last_update.one of
idcreation_datelast_updatenext_actionsale_stepamountprobabilityprobalized_amountalphabetically starredboolean- When true, return only starred leads. Example: true.
start_datestring- Start of the date range, applied to the field chosen by date_range_type. Example: 2024-01-01.
statusstring- Comma-separated lead statuses to include. Allowed values: todo, standby, won, cancelled, lost. Example: todo,standby.
stepstring- Comma-separated step names or step IDs to include. Names must match exactly and names and IDs cannot be mixed. Use nocrmio_list_steps to find them. Example: Incoming,Contacted.
tagsstring- Comma-separated tags; only leads carrying all of them are returned. Predefined tags are allowed. Example: prospect,google.
updated_afterstring- Only return leads updated after this date. Example: 2024-01-31.
user_idstring- Return only leads owned by this user, given as user ID or email. Example: stef@example.com.
nocrmio_list_pipelinesList the sales pipelines of the account.Read-onlyList Pipelines
List the sales pipelines of the account. Returns an array of pipelines with id, name, is_default and timestamps. Use nocrmio_list_steps for the steps inside them.
Inputs
This tool takes no inputs.
nocrmio_list_prospecting_listsList the prospecting lists (cold-contact spreadsheets) of the account.Read-onlyList Prospecting Lists
List the prospecting lists (cold-contact spreadsheets) of the account. Returns an array with id, title, description, column_names, tags, total_row_count, to_qualify_row_count and user. Use nocrmio_get_prospecting_list for the rows inside one.
Inputs
directionstring- Sort direction, asc or desc. Defaults to desc when omitted. Example: desc.one of
ascdesc limitinteger- Maximum number of records to return. Defaults to 100 when omitted. Example: 50.
offsetinteger- Number of records to skip, used with limit. Defaults to 0. Example: 100.
orderstring- Attribute to sort by. Defaults to id. Example: created_at.one of
idcreated_atupdated_at titlestring- Exact-match filter on the list title. Example: Circle prospects.
nocrmio_list_stepsList the pipeline steps of the account.Read-onlyList Steps
List the pipeline steps of the account. Returns an array of steps with id, name, position, pipeline_id and the pipeline object. Use the step id or name when creating or filtering leads.
Inputs
directionstring- Sort direction, asc or desc. Defaults to asc when omitted. Example: desc.one of
ascdesc
nocrmio_list_teamsList the teams of the account with their members.Read-onlyList Teams
List the teams of the account with their members. Returns an array of teams with id, name and users (each with is_manager); returns 403 when the Teams feature is off. Use the team id to filter users or assign leads.
Inputs
This tool takes no inputs.
nocrmio_list_unassigned_leadsList leads that have no owner yet.Read-onlyList Unassigned Leads
List leads that have no owner yet. Returns an array of leads (id, title, step, status, description), up to 100 per request. Use nocrmio_assign_lead to give one an owner.
Inputs
limitinteger- Maximum number of records to return. Defaults to 100 when omitted. Example: 50.
nocrmio_list_usersList users of the account, optionally filtered by name, email, status, role or team.Read-onlyList Users
List users of the account, optionally filtered by name, email, status, role or team. Returns an array of users with id, firstname, lastname, email, is_admin, has_activated and is_disabled. Use the id or email as user_id on lead tools.
Inputs
directionstring- Sort direction, asc or desc. Defaults to asc when omitted. Example: desc.one of
ascdesc emailstring- Filter by exact email address. Example: john.doe@mycompany.com.
firstnamestring- Filter by first name. Example: John.
lastnamestring- Filter by last name. Example: Doe.
rolestring- Filter by role. Defaults to all. Example: admin.one of
alladminnon-admin statusstring- Filter by account status. Defaults to all. Example: activated.one of
allactivateddeactivated teamsstring- Comma-separated team IDs or names the users belong to. Example: Web Sales.
nocrmio_pingCheck that the API key and domain are valid.Read-onlyPing API
Check that the API key and domain are valid. Returns status 200 with a message confirming the key is correct. Use it to verify the connection before other calls.
Inputs
This tool takes no inputs.
nocrmio_add_lead_to_client_folderAttach a lead to a client folder.WriteAdd Lead to Client Folder
Attach a lead to a client folder. Returns the lead with id, title, step, step_id, status, amount, probability, currency, starred, next_action_at, reminder fields, tags, description, user_id, team_id, client_folder_id and extended_info. Use nocrmio_list_client_folders to find folder IDs.
Inputs
client_idintegerrequired- ID of the client folder. Example: 12.
idintegerrequired- ID of the lead to attach. Example: 8113.
nocrmio_assign_leadAssign a lead to a user and notify that user.WriteAssign Lead
Assign a lead to a user and notify that user. Returns the lead with id, title, step, step_id, status, amount, probability, currency, starred, next_action_at, reminder fields, tags, description, user_id, team_id, client_folder_id and extended_info. Use this instead of nocrmio_update_lead when the new owner must receive a notification.
Inputs
idintegerrequired- ID of the lead to assign. Example: 8113.
user_idstringrequired- Email address or numeric ID of the noCRM user. This user becomes the lead owner. Use nocrmio_list_users to find users. Example: stef@example.com.
nocrmio_create_client_folderCreate a client folder, optionally assigned to a user.WriteCreate Client Folder
Create a client folder, optionally assigned to a user. Returns the created folder with id, name, description, is_active and user_id. Use nocrmio_add_lead_to_client_folder to attach leads afterwards.
Inputs
namestringrequired- Folder name. Example: Acme.
descriptionstring- Folder description. Example: Address: 2344 Paradise Av, Eden CA 90001.
user_idstring- Email address or numeric ID of the noCRM user. The folder is assigned to this user. Use nocrmio_list_users to find users. Example: stef@example.com.
nocrmio_create_follow_up_from_templateCreate a post-sales process on a lead from a saved template.WriteCreate Post-Sales Process
Create a post-sales process on a lead from a saved template. Returns the process with id, title, status, tasks_count and the generated tasks. Use after a lead is won to start onboarding or shipping tasks.
Inputs
lead_idintegerrequired- ID of the lead. Example: 8113.
post_sales_template_idintegerrequired- ID of the post-sales process template. Example: 10.
nocrmio_create_leadCreate a new lead in noCRM, optionally assigned to a user and placed in a pipeline step.WriteCreate Lead
Create a new lead in noCRM, optionally assigned to a user and placed in a pipeline step. Returns the lead with id, title, step, step_id, status, amount, probability, currency, starred, next_action_at, reminder fields, tags, description, user_id, team_id, client_folder_id and extended_info. Use nocrmio_update_lead to change an existing lead. A lead created without user_id is unassigned and cannot be placed in a step.
Inputs
descriptionstringrequired- Lead description, usually the contact details as 'Label: value' lines separated by newlines. Example: Firstname: John\nLastname: Doe\nEmail: john.doe@company.com.
titlestringrequired- Lead title, usually the company name. Example: Awesome Company.
created_atstring- Backdate the lead's creation, as YYYY-MM-DD HH:MM:SS in the account time zone or YYYY-MM-DDTHH:MM:SS.sssZ in UTC. Leave empty for now. Example: 2024-01-15 09:30:00.
stepstring- Step ID or exact step name to place the lead in; only valid when the lead is assigned. Prefer the ID when step names repeat across pipelines. Example: Contacted.
tagsarray- Tags to attach; missing tags are created automatically and predefined tags are allowed. Example: ["prospect", "google"].
user_idstring- Email address or numeric ID of the noCRM user. Assigns the lead to that user without notifying them. Use nocrmio_list_users to find users. Example: stef@example.com.
nocrmio_create_lead_commentAdd a comment to a lead, optionally tagged with an activity type.WriteCreate Lead Comment
Add a comment to a lead, optionally tagged with an activity type. Returns the created comment with id, content, created_at, activity_id, is_pinned and user. Use nocrmio_list_activities to find activity_id values.
Inputs
contentstringrequired- Comment text. Example: Called John, sending the quote tomorrow.
lead_idintegerrequired- ID of the lead to comment on. Example: 8113.
activity_idinteger- Activity type to tag the comment with. Example: 271.
created_atstring- Backdate the comment as YYYY-MM-DD HH:MM:SS. Leave empty for now. Example: 2024-01-15 09:30:00.
user_idstring- Email address or numeric ID of the noCRM user. The comment is attributed to this user. Use nocrmio_list_users to find users. Example: stef@example.com.
nocrmio_create_lead_from_prospectTurn a prospect in a prospecting list into a lead.WriteCreate Lead From Prospect
Turn a prospect in a prospecting list into a lead. Returns the lead with id, title, step, step_id, status, amount, probability, currency, starred, next_action_at, reminder fields, tags, description, user_id, team_id, client_folder_id and extended_info. Use nocrmio_find_prospects or nocrmio_get_prospecting_list to find the prospect first.
Inputs
idintegerrequired- ID of the prospect. Example: 108.
spreadsheet_idintegerrequired- ID of the prospecting list. Example: 112.
nocrmio_create_predefined_tagCreate a predefined tag inside a category.WriteCreate Predefined Tag
Create a predefined tag inside a category. Returns the created tag with id, name, category and category_id. Use nocrmio_list_categories to find category_id.
Inputs
category_idintegerrequired- ID of the category that will contain the tag. Example: 12.
namestringrequired- Tag name. Example: Europe.
nocrmio_duplicate_leadCreate a copy of an existing lead, optionally placed in a chosen step.WriteDuplicate Lead
Create a copy of an existing lead, optionally placed in a chosen step. Returns the lead with id, title, step, step_id, status, amount, probability, currency, starred, next_action_at, reminder fields, tags, description, user_id, team_id, client_folder_id and extended_info. Without step the copy goes to the first step of the original lead's pipeline.
Inputs
idintegerrequired- ID of the lead to duplicate. Example: 8113.
stepstring- Step ID or exact step name for the copy; prefer the ID when names repeat across pipelines. Example: In Touch.
nocrmio_log_lead_activityLog an activity such as a call or meeting on a lead through the Simplified API.WriteLog Lead Activity
Log an activity such as a call or meeting on a lead through the Simplified API. Returns the activity entry that was logged. Use nocrmio_list_activities to find activity_id and nocrmio_list_users for user_id.
- Idempotent
Inputs
activity_idintegerrequired- ID of the activity type to log. Example: 271.
lead_idintegerrequired- ID of the lead. Example: 8113.
user_idintegerrequired- ID of the user who performed the activity. Example: 514.
contentstring- Notes about the activity. Example: Left a voicemail.
nocrmio_send_email_from_templateSend an email to a lead's contact using a saved email template; delivery is asynchronous.WriteSend Email From Template
Send an email to a lead's contact using a saved email template; delivery is asynchronous. Returns a message confirming that sending has started. Available on the Dreamteam edition; the sender must have a connected inbox and access to the template.
Inputs
email_template_idintegerrequired- ID of the email template to send. Example: 12.
from_user_idintegerrequired- ID of the user the email is sent from. Example: 1.
lead_idintegerrequired- ID of the lead to email. Example: 8113.
nocrmio_send_lead_emailSend a custom email with a subject and body to a lead's contact through the Simplified API.WriteSend Custom Email to Lead
Send a custom email with a subject and body to a lead's contact through the Simplified API. Returns a message confirming that sending has started. Use nocrmio_send_email_from_template to send a saved template instead.
- Idempotent
Inputs
contentstringrequired- Email body text. Example: Hi John, please find the quote attached.
from_user_idintegerrequired- ID of the user the email is sent from. Example: 1.
lead_idintegerrequired- ID of the lead to email. Example: 8113.
subjectstringrequired- Email subject line. Example: Your quote.
bccstring- Email address to blind copy. Example: archive@example.com.
ccstring- Email address to copy. Example: manager@example.com.
nocrmio_update_client_folderRename a client folder, change its description or activate and deactivate it.WriteUpdate Client Folder
Rename a client folder, change its description or activate and deactivate it. Returns the updated folder. Use nocrmio_delete_client_folder to remove it entirely.
- Idempotent
Inputs
idintegerrequired- ID of the client folder to update. Example: 12.
descriptionstring- New folder description. Example: Key account.
is_activeboolean- true to activate the folder, false to deactivate it. Example: false.
namestring- New folder name. Example: Acme Corp.
nocrmio_update_follow_up_taskChange the status or reminder of one task inside a post-sales process.WriteUpdate Post-Sales Task
Change the status or reminder of one task inside a post-sales process. Returns the updated task with id, content, status, done_at and next_action_at. Use nocrmio_list_follow_ups to find the process and nocrmio_create_follow_up_from_template for task IDs.
- Idempotent
Inputs
follow_up_idintegerrequired- ID of the post-sales process. Example: 23.
task_idintegerrequired- ID of the task. Example: 35.
remind_datestring- Reminder date as YYYY-MM-DD in the account time zone. Required when status becomes standby. Example: 2024-06-01.
remind_timestring- Reminder time as HH:MM in 24h format, on a 15-minute step. Example: 09:30.
reminder_durationinteger- Reminder duration in minutes. Allowed values: 0, 15, 30, 45, 60, 90, 120, 150, 180, 240, 480, 720. Example: 30.one of
01530456090120150180240480720 statusstring- New task status. Moving to standby requires remind_date. Example: done.one of
todostandbydone
nocrmio_update_leadUpdate fields of an existing lead: title, status, amount, probability, step, owner, tags, reminder or description.WriteUpdate Lead
Update fields of an existing lead: title, status, amount, probability, step, owner, tags, reminder or description. Returns the lead with id, title, step, step_id, status, amount, probability, currency, starred, next_action_at, reminder fields, tags, description, user_id, team_id, client_folder_id and extended_info. Use nocrmio_assign_lead to notify the new owner when reassigning. Send either description, or fields and append_desc, never description together with them. Moving a lead to standby requires remind_date.
- Idempotent
Inputs
idintegerrequired- ID of the lead to update. Example: 8113.
amountnumber- New deal amount. Example: 2400.
append_descstring- Text appended to the end of the existing description. Cannot be combined with description. Example: Asked for a discount.
descriptionstring- Replacement for the whole description. Cannot be combined with fields or append_desc. Example: Firstname: John\nEmail: john@acme.com.
estimated_closing_datestring- Expected closing date as YYYY-MM-DD in the account time zone. Example: 2024-09-30.
fieldsarray- List of description fields to update, each an object with key and value. Cannot be combined with description. Example: [{"key": "Phone", "value": "06 07 08 09 04"}].
probabilityinteger- New win probability as a percentage. Example: 70.
remind_datestring- Reminder date as YYYY-MM-DD in the account time zone. Required when status becomes standby. Example: 2024-06-01.
remind_timestring- Reminder time as HH:MM in 24h format, on a 15-minute step, used with remind_date. Example: 09:30.
reminder_activity_idinteger- ID of the activity attached to the reminder. Use nocrmio_list_activities to find IDs. Example: 271.
reminder_durationinteger- Reminder duration in minutes. Allowed values: 0, 15, 30, 45, 60, 90, 120, 150, 180, 240, 480, 720. Example: 30.one of
01530456090120150180240480720 reminder_notestring- Note stored with the reminder. Example: Call back about the quote.
starredboolean- true to star the lead, false to unstar it. Example: true.
statusstring- New status. Moving to standby requires remind_date. Example: won.one of
todostandbywonlostcancelled stepstring- New step ID or exact step name; prefer the ID when names repeat across pipelines. Example: Closing.
tagsarray- Full list of tags for the lead; missing tags are created and predefined tags are allowed. Example: ["small", "US"].
titlestring- New lead title. Example: Acme Corp - renewal.
user_idstring- Email address or numeric ID of the noCRM user. Reassigns the lead without notifying the user. Use nocrmio_list_users to find users. Example: stef@example.com.
nocrmio_update_lead_commentReplace the text of a comment on a lead, or pin or unpin it.WriteUpdate Lead Comment
Replace the text of a comment on a lead, or pin or unpin it. Returns the updated comment. Use nocrmio_list_lead_comments to find the comment ID.
- Idempotent
Inputs
contentstringrequired- New comment text, replacing the existing one. Example: Quote sent on Monday.
idintegerrequired- ID of the comment to update. Example: 13834.
lead_idintegerrequired- ID of the lead that owns the comment. Example: 8113.
activity_idinteger- Activity type to tag the comment with. Example: 271.
is_pinnedboolean- true to pin the comment, false to unpin. Example: true.
nocrmio_delete_client_folderPermanently delete a client folder.DestructiveDelete Client Folder
Permanently delete a client folder. Returns an empty success response. Use nocrmio_update_client_folder with is_active false to hide a folder without deleting it.
- Idempotent
Inputs
idintegerrequired- ID of the client folder to delete. Example: 12.
nocrmio_delete_leadPermanently delete a lead by ID.DestructiveDelete Lead
Permanently delete a lead by ID. Returns an empty success response when the lead is deleted. Use nocrmio_update_lead with status lost or cancelled to close a lead without deleting it.
- Idempotent
Inputs
idintegerrequired- ID of the lead to delete. Example: 8113.
nocrmio_delete_lead_commentPermanently delete a comment from a lead.DestructiveDelete Lead Comment
Permanently delete a comment from a lead. Returns an empty success response. Use nocrmio_list_lead_comments to find the comment ID.
- Idempotent
Inputs
idintegerrequired- ID of the comment to delete. Example: 13834.
lead_idintegerrequired- ID of the lead that owns the comment. Example: 8113.
No tools match.
