Nutshell

These are the Nutshell actions available to the apps you build with Snow. Connecting an account does not make Snow run these on its own.

• Create Accounts

  Tool to create one or more accounts in Nutshell. Use when you need to add new company accounts. Each account must have at least one of: name, phone, email, address, or url.

• Create Contacts

  Tool to create one or more contacts in Nutshell CRM. Use when you need to add new contacts to the system. Each contact must have at least one identifier field (name, phone, email, address, or url).

• Create Lead

  Tool to create a lead in Nutshell CRM using the JSON-RPC API. Use when you need to add a new lead to the system. The description field is required, while other fields like manualValue, dueTime, customFields, and links are optional.

• Get Account

  Tool to retrieve an account from Nutshell. Use when you need to get details about a specific account. Supports retrieving multiple accounts by providing comma-separated IDs.

• Get Contact

  Tool to retrieve a specific contact by ID from Nutshell CRM. Use when you need to get detailed information about a contact.

• Get Lead

  Tool to retrieve a specific lead by ID from Nutshell CRM. Use when you need to get detailed information about a lead.

• List Contacts

  Tool to get a list of contacts from Nutshell CRM. Use when you need to retrieve multiple contacts with optional filtering, searching, sorting, and pagination.

• List Leads

  Tool to get a list of leads from Nutshell CRM. Use when you need to retrieve multiple leads with optional filtering, searching, sorting, and pagination.

• Update Lead

  Tool to update a lead in Nutshell CRM using JSON Patch operations. Use when you need to modify specific fields of a lead without replacing the entire resource. Supports standard JSON Patch operations (add, remove, replace, move, copy) and can update custom fields.

• Update Nutshell Contact

  Tool to update a contact using JSON Patch operations. Use when you need to modify specific fields of an existing contact such as name, description, or links to other entities. Supports updating custom fields and standard fields.

• Create Activities

  Tool to create one or more activities in Nutshell CRM. Use when you need to log a completed activity or schedule a future activity such as phone calls, meetings, emails, or notes. All activity fields are optional except the activities array itself. At minimum, provide a name or activityType for meaningful activities.

• Create Custom Field for Accounts

  Tool to create a custom field for accounts in Nutshell. Use when you need to add new custom fields to track additional information on company accounts. Supports Text, LongText, Currency, Date, and Decision field types.

• Create Custom Field for Leads

  Tool to create a custom field for leads in Nutshell. Use when you need to add new custom fields to track additional information on leads. Supports Text, Email, Currency, and Date field types.

• Create Notes

  Tool to create a note in Nutshell. Use when you need to add notes to contacts, leads, accounts, or other entities in Nutshell CRM. The note will be attached to the specified parent entity.

• Create Sources

  Tool to create new sources in Nutshell CRM. Use when you need to add source tracking for leads or contacts. Sources help categorize where leads originate (e.g., organic search, paid ads).

• Create Tags

  Tool to create one or more tags in Nutshell. Use when you need to create new tags for categorizing leads, contacts, or accounts. Each tag requires a name and tagType (1=leads, 2=contacts, 3=accounts).

• Delete Account

  Tool to delete an account from Nutshell. Use when you need to permanently remove an account. Deletion is permanent and cannot be undone.

• Delete Contact

  Tool to delete a contact by ID. Use when you need to remove a contact from Nutshell. Returns success confirmation upon deletion.

• Delete Lead

  Tool to delete a lead from Nutshell CRM. Use when you need to remove a lead. Note: Nutshell soft-deletes leads by default, allowing for potential recovery.

• Delete Note

  Tool to delete a note from Nutshell CRM. Use when you need to permanently remove a note. Returns the deleted note information including deletion timestamp.

• Delete Product Map

  Tool to delete a product on a lead. Use when you need to remove a product mapping from a lead. The deletion is permanent and returns the details of the deleted product map.

• Delete Task

  Tool to delete a task from Nutshell CRM. Use when you need to remove a task. Note: Nutshell soft-deletes tasks by default, allowing for potential recovery.

• Edit Nutshell Account

  Tool to edit an existing account in Nutshell CRM. Updates specified fields of an account using the account ID and revision identifier. Supports file uploads via two-step process: specify file in request, receive upload URI in response, POST file to URI. Use when you need to modify account details like name, description, tags, contact information, or associations.

• Get Account Custom Fields

  Tool to retrieve custom fields for a specific account in Nutshell. Use when you need to view custom field definitions and values associated with an account.

• Get Activity

  Tool to retrieve a single activity by ID from Nutshell CRM. Use when you need to get details about a specific activity. The activity ID must be in the format '{integer}-activities' (e.g., '7-activities').

• Get Contact Custom Fields

  Tool to retrieve custom fields for a specific contact in Nutshell. Use when you need to view custom field definitions and values associated with a contact.

• Get Lead's Custom Fields

  Tool to retrieve custom fields for a specific lead in Nutshell CRM. Use when you need to get all custom field data associated with a lead. The lead ID must be in the format '{integer}-leads' (e.g., '1003-leads').

• Get Leads Report

  Tool to get reports for leads from Nutshell CRM. Use when you need to generate analytics or reporting data about leads, such as sales reports, losses, new leads, forecasts, or attribution reports with optional segmentation and time bucketing.

• Get Note

  Tool to retrieve a single note by ID from Nutshell CRM. Use when you need to get details about a specific note. The note ID must be in the format '{integer}-notes' (e.g., '3-notes').

• Get Product Category

  Tool to retrieve a single product category by ID from Nutshell CRM. Use when you need to get details about a specific product category. The product category ID must be in the format '{integer}-productCategories' (e.g., '3-productCategories').

• Get Task

  Tool to retrieve a single task by ID from Nutshell CRM. Use when you need to get details about a specific task. The task ID must be in the format '{integer}-tasks' (e.g., '7-tasks').

• List Account Custom Field Attributes

  Tool to retrieve all account custom field attributes from Nutshell CRM. Use when you need to discover what custom fields are available for account records and their metadata.

• List Account Fields

  Tool to retrieve all available fields for accounts in Nutshell. Use when you need to discover what fields are available for account records, their types, and capabilities.

• List Account Types

  Tool to retrieve a list of all account types from Nutshell CRM. Use when you need to see available account type options or get account type IDs.

• List Accounts

  Tool to retrieve list items for all accounts in Nutshell CRM. Use when you need to get a list of accounts with optional filtering and sorting.

• List Activities

  Tool to retrieve a list of activities from Nutshell CRM. Use when you need to get multiple activities with optional filtering by participants, status, date range, or other criteria.

• List Activity Types

  Tool to retrieve a list of all activity types from Nutshell CRM. Use when you need to see available activity type options or get activity type IDs.

• List Competitor Maps

  Tool to get a list of lead-competitor relationships from Nutshell CRM. Use when you need to retrieve competitor mapping information for leads.

• List Competitors

  Tool to get a list of competitors from Nutshell CRM. Use when you need to retrieve all competitors or search for specific competitors by name.

• List Contact Custom Field Attributes

  Tool to retrieve all available custom field attributes for contacts in Nutshell. Use when you need to discover which custom fields can be used with contacts.

• List Contact Fields

  Tool to retrieve all available fields for contacts in Nutshell. Use when you need to discover what fields are available for contact records, their types, and capabilities.

• List Contacts

  Tool to retrieve list items for all contacts in Nutshell CRM. Use when you need to get a list of contacts with optional filtering and sorting.

• List Deleted Events

  Tool to get a feed of deletion events from Nutshell CRM. Use when you need to track which entities have been deleted and when.

• List Editions

  Tool to retrieve a list of all editions from Nutshell CRM. Use when you need to see available edition options or get edition IDs.

• List Events

  Tool to get a list of events from Nutshell CRM. Use when you need to retrieve activity feed events with optional filtering by time range, entity, event types, or creator.

• List Filters

  Tool to get saved filters from Nutshell CRM. Use when you need to retrieve saved filters for reports or entity lists (leads, contacts, accounts).

• List Forms

  Tool to get all forms from Nutshell. Use when you need to retrieve the complete list of available forms in the Nutshell instance.

• List Industries

  Tool to retrieve a list of all industries from Nutshell CRM. Use when you need to see available industry options or get industry IDs.

• List Invoices

  Tool to get a list of invoices from Nutshell CRM. Use when you need to retrieve invoices with optional filtering by lead, date range, and pagination.

• List Lead Custom Field Attributes

  Tool to retrieve all applicable custom field attributes for leads in Nutshell CRM. Use when you need to see available custom field definitions, types, and configuration for leads.

• List Lead Fields

  Tool to retrieve all available fields for leads in Nutshell. Use when you need to discover what fields are available for lead records, their types, and capabilities.

• List Lead Outcomes

  Tool to retrieve a list of lead outcomes from Nutshell CRM. Use when you need to see available outcome options for leads or get outcome IDs.

• List Lead Stages

  Tool to retrieve all stages associated with a specific lead in Nutshell CRM. Use when you need to get the stage progression or workflow stages for a lead.

• List Leads

  Tool to retrieve list items for all leads in Nutshell CRM. Use when you need to get a list of leads with optional filtering and sorting.

• List Markets

  Tool to retrieve a list of all markets from Nutshell CRM. Use when you need to see available markets or get market IDs and currency information.

• List Notes

  Tool to get a list of notes from Nutshell CRM. Use when you need to retrieve multiple notes with optional pagination.

• List Pipelines

  Tool to retrieve a list of all pipelines (stagesets) from Nutshell CRM. Use when you need to see available pipelines or get pipeline IDs for lead management.

• List Product Categories

  Tool to get a list of all product categories from Nutshell CRM. Use when you need to retrieve all available product categories.

• List Product Maps

  Tool to get a list of lead products from Nutshell CRM. Use when you need to retrieve product mapping information for leads.

• List Products

  Tool to get a list of products from Nutshell CRM. Use when you need to retrieve multiple products with optional filtering by name/SKU and sorting.

• List Quotes

  Tool to get a list of quotes from Nutshell CRM. Use when you need to retrieve quotes with optional filtering by lead, date range, and pagination.

• List Sources

  Tool to retrieve a list of sources from Nutshell CRM. Use when you need to get all possible sources for leads in your Nutshell instance, with optional filtering by name.

• List Stages

  Tool to retrieve a list of all stages from Nutshell CRM. Use when you need to see available pipeline stages or get stage IDs for lead management.

• List Tags

  Tool to retrieve a list of tags from Nutshell CRM. Use when you need to get tags with optional filtering by name or type (leads, contacts, accounts).

• List Territories

  Tool to retrieve a list of all territories from Nutshell CRM. Use when you need to see available territories or get territory IDs for assignment or filtering purposes.

• List Users

  Tool to get a list of all users from Nutshell CRM. Use when you need to retrieve all users in the account.

• Reopen Lead

  Tool to reopen a lead in Nutshell CRM. Use when you need to reopen a previously closed or won lead.

• Set Lead Pipeline

  Tool to set the pipeline (stageset) for a lead in Nutshell CRM. Use when you need to assign a lead to a specific pipeline. Requires the lead ID and stageset ID to update the lead's pipeline assignment.

• Undelete Account

  Tool to undelete a previously deleted account in Nutshell. Use when you need to restore a deleted account. Returns the restored account object with deletedTime set to null.

• Undelete Contact

  Tool to undelete a previously deleted contact in Nutshell CRM. Use when you need to restore a contact that was deleted.

• Undelete Lead

  Tool to undelete a previously deleted lead from Nutshell CRM. Use when you need to restore a soft-deleted lead.

• Undelete Note

  Tool to undelete a previously deleted note in Nutshell CRM. Use when you need to restore a note that was deleted. The note ID must be in the format '{integer}-notes' (e.g., '75-notes').

• Undelete Source

  Tool to undelete a source by ID. Use when you need to restore a previously deleted source in Nutshell.

• Undelete Tag

  Tool to undelete a previously deleted tag in Nutshell. Use when you need to restore a deleted tag.

• Update Account with JSON Patch

  Tool to update an account in Nutshell using JSON Patch operations. Use when you need to modify specific account fields like description, name, or relationships. Supports RFC 6902 JSON Patch format with operations: add, remove, replace, move, copy.

• Update Lead Status

  Tool to update the status of a lead in Nutshell CRM. Use when you need to change the outcome status of a lead (e.g., mark as won, lost, or other custom outcomes). Optionally associate competitor maps and product maps when updating the status.

• Update Task with JSON Patch

  Tool to update a task in Nutshell using JSON Patch operations. Use when you need to modify task fields like title, description, or due time. Supports RFC 6902 JSON Patch format with operations: add, remove, replace, move, copy.

• Watch Lead

  Tool to watch a lead in Nutshell CRM. Use when you need to start watching a lead for updates and notifications.