# Nutshell

Nutshell is a flexible CRM and email marketing platform that helps small businesses manage contacts, sales pipelines, and customer relationships.

- **Category:** crm
- **Auth:** BASIC
- **Composio Managed App Available?** N/A
- **Tools:** 78
- **Triggers:** 0
- **Slug:** `NUTSHELL`
- **Version:** 20260313_00

## Tools

### Create Accounts

**Slug:** `NUTSHELL_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `accounts` | array | Yes | Array of account objects to create. Each account must have at least one of: name, phone, email, address, or url. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Custom Field for Accounts

**Slug:** `NUTSHELL_CREATE_ACCOUNTS_CUSTOMFIELDS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name/ID of the custom field to create. Must be unique within accounts. |
| `type` | string | Yes | The type of custom field. For accounts, valid values are: 'Text', 'LongText', 'Currency', 'Date', 'Decision' (for dropdowns). IMPORTANT: Values must be capitalized exactly as shown (e.g., 'Text' not 'text' or 'string'). Note: Email, location, phone, and URL types are only applicable to leads, not accounts. |
| `title` | string | No | Display title for the custom field. If not provided, defaults to the name value. |
| `choices` | array | No | For Decision (enum) type only. The possible values for the dropdown. Required when creating Decision-type custom fields. |
| `isMultiple` | boolean | No | For Decision (enum) type only. Whether the custom field can have multiple values selected. Only applicable when field_type is 'Decision' and choices are provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Activities

**Slug:** `NUTSHELL_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `activities` | array | Yes | Array of activities to create. At least one activity is required. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Contacts

**Slug:** `NUTSHELL_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).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contacts` | array | Yes | Array of contact objects to create. Each contact must have at least one of: name, phone, email, address, or url |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Lead

**Slug:** `NUTSHELL_CREATE_LEADS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `links` | object | No | Links to related entities. |
| `dueTime` | object | No | Due time information for the lead. |
| `description` | string | Yes | Description of the lead. This is the only required field |
| `manualValue` | string | No | Manual value or estimated revenue for the lead |
| `customFields` | object | No | Custom field values as key-value pairs |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Custom Field for Leads

**Slug:** `NUTSHELL_CREATE_LEADS_CUSTOMFIELD`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name/title of the custom field to create |
| `type` | string | Yes | The type of custom field. For leads, valid values are: Text, Email, Currency, Date. Note: Values must be capitalized exactly as shown (case-sensitive). |
| `choices` | array | No | Reserved for future use. Currently not applicable for leads custom fields. |
| `isMultiple` | boolean | No | Reserved for future use. Currently not applicable for leads custom fields. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Notes

**Slug:** `NUTSHELL_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | The text content to display on the note. |
| `parent` | string | Yes | The entity ID to attach the note to. Format: '{id}-{entity_type}' where entity_type can be 'contacts', 'leads', 'accounts', 'competitors', etc. Example: '3-contacts' attaches the note to contact with ID 3. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Sources

**Slug:** `NUTSHELL_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).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sources` | array | Yes | Array of source objects to create. Each source must have a name and optionally a channel ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Tags

**Slug:** `NUTSHELL_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).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | Yes | Array of tag objects to create. Each tag requires a name and tagType (1=leads, 2=contacts, 3=accounts) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Account

**Slug:** `NUTSHELL_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the account to delete. IDs are of the form 'n-accounts', where n is an integer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Contact

**Slug:** `NUTSHELL_DELETE_CONTACTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the contact to delete. Example: '23-contacts' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Lead

**Slug:** `NUTSHELL_DELETE_LEADS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Lead ID to delete. The unique identifier of the lead in Nutshell CRM |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Note

**Slug:** `NUTSHELL_DELETE_NOTES`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the note to delete. Format: numeric-id followed by '-notes' (e.g., '71-notes') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Product Map

**Slug:** `NUTSHELL_DELETE_PRODUCTMAPS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the product map to delete. Format: {number}-productMaps (e.g., '7-productMaps') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Task

**Slug:** `NUTSHELL_DELETE_TASKS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Task ID to delete. The unique identifier of the task in Nutshell CRM |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Nutshell Account

**Slug:** `NUTSHELL_EDIT_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rev` | string | Yes | The revision identifier of the account. This must match the current revision of the account (obtained from getAccount or findAccounts). Used for optimistic concurrency control. |
| `account` | object | Yes | Object containing the fields to update. Only include fields you want to change. |
| `account_id` | integer | Yes | The ID of the account to edit |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account

**Slug:** `NUTSHELL_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the account to retrieve. API IDs are of the form 'n-accounts', where n is an integer. Multiple IDs can be listed in comma-separated format to retrieve multiple accounts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Custom Fields

**Slug:** `NUTSHELL_GET_ACCOUNTS_CUSTOMFIELDS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the account to retrieve custom fields for. IDs are of the form 'n-accounts', where n is an integer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Activity

**Slug:** `NUTSHELL_GET_ACTIVITIES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Activity ID in the format '{integer}-activities'. Example: '7-activities' for activity with ID 7. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact

**Slug:** `NUTSHELL_GET_CONTACTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Contact ID in the format 'number-contacts' (e.g., '3-contacts', '23-contacts') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact Custom Fields

**Slug:** `NUTSHELL_GET_CONTACTS_CUSTOMFIELDS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the contact to retrieve custom fields for. IDs are of the form 'n-contacts', where n is an integer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Lead

**Slug:** `NUTSHELL_GET_LEADS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Lead ID in the format 'number-leads' (e.g., '1003-leads', '45-leads') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Lead's Custom Fields

**Slug:** `NUTSHELL_GET_LEADS_CUSTOMFIELDS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Lead ID in the format '{integer}-leads'. Example: '1003-leads' for lead with ID 1003. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Note

**Slug:** `NUTSHELL_GET_NOTES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Note ID in the format '{integer}-notes'. Example: '3-notes' for note with ID 3. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Product Category

**Slug:** `NUTSHELL_GET_PRODUCTCATEGORIES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Product Category ID in the format '{integer}-productCategories'. Example: '3-productCategories' for product category with ID 3. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Task

**Slug:** `NUTSHELL_GET_TASKS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Task ID in the format '{integer}-tasks'. Example: '7-tasks' for task with ID 7. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Account Custom Field Attributes

**Slug:** `NUTSHELL_LIST_ACCOUNTS_CUSTOMFIELD_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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Account Fields

**Slug:** `NUTSHELL_LIST_ACCOUNTS_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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Accounts

**Slug:** `NUTSHELL_LIST_ACCOUNTS_LIST_ITEMS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Used to search all related info on an entity. Returns all entities that are similar to the query term. |
| `sort` | array | No | Sort the returned list by a chosen field. Use a '-' before the field name to sort in descending order. |
| `filter` | object | No | Filter the returned accounts based on various criteria. Use /rest/accounts/list/fields to get a full list of valid filter keys. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Account Types

**Slug:** `NUTSHELL_LIST_ACCOUNTTYPES`

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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Activities

**Slug:** `NUTSHELL_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | String search query to find activities across related information. |
| `limit` | integer | No | Maximum number of activities to return. |
| `filter_status` | array | No | Filter activities by status. Provide a list of status values. |
| `filter_flagged` | boolean | No | When true, only return flagged activities. |
| `filter_date_max` | string | No | Filter for the latest activity to return. Provide date in ISO format (e.g., '2024-12-31'). |
| `filter_date_min` | string | No | Filter for the earliest activity to return. Provide date in ISO format (e.g., '2024-01-01'). |
| `filter_participant` | array | No | Filter activities by participant IDs. Provide a list of participant IDs to filter by. |
| `filter_is_important` | boolean | No | When true, only return activities marked as important. |
| `filter_activity_type` | array | No | Filter by activity types. Provide a list of activity type values. |
| `filter_lead_priority` | string | No | Filter to only return activities related to hot leads. Must be 'hot'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Activity Types

**Slug:** `NUTSHELL_LIST_ACTIVITYTYPES`

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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Competitor Maps

**Slug:** `NUTSHELL_LIST_COMPETITORMAPS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Competitors

**Slug:** `NUTSHELL_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | String to search for in competitor name. Use this to filter competitors by name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contacts

**Slug:** `NUTSHELL_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Returns contacts with a piece of information similar to the provided string, such as name, email, location, etc. |
| `sort` | string ("accountType" | "-accountType" | "accounts" | "-accounts" | "createdTime" | "-createdTime" | "email" | "-email" | "industry" | "-industry" | "lastContactedTime" | "-lastContactedTime" | "name" | "-name" | "owner" | "-owner" | "phone" | "-phone" | "postalCode" | "-postalCode" | "territory" | "-territory") | No | What criteria to order the returned list of results. Use '-' prefix for descending order. |
| `email` | string | No | Returns contacts with the provided email address. |
| `filter` | object | No | Filter the returned contacts based on various criteria. Use /rest/contacts/list/fields to get a full list of valid filter keys. |
| `page_page` | integer | No | The page of results to return. Indexing is 0-based. |
| `page_limit` | integer | No | How many results to return per page |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contact Custom Field Attributes

**Slug:** `NUTSHELL_LIST_CONTACTS_CUSTOMFIELD_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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contact Fields

**Slug:** `NUTSHELL_LIST_CONTACTS_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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contacts

**Slug:** `NUTSHELL_LIST_CONTACTS_LIST_ITEMS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Used to search all related info on an entity. Returns all entities that are similar to the query term. |
| `sort` | array | No | Sort the returned list by a chosen field. Use a '-' before the field name to sort in descending order. |
| `filter` | object | No | Filter the returned contacts based on various criteria. Use /rest/contacts/list/fields to get a full list of valid filter keys. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Deleted Events

**Slug:** `NUTSHELL_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Reverse the order of returned results. Use '-change_time' to sort by change time in descending order. |
| `filter_types` | string | No | Retrieve a feed of events related to a specific type of entity. Must be one of the supported entity types. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Editions

**Slug:** `NUTSHELL_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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Events

**Slug:** `NUTSHELL_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | The maximum number of events to return. Use for controlling pagination size. |
| `events` | array | No | Opt in to additional event types. Available types: comments, mailchimp, followup, constantContact, emailInteraction, assignments, formSubmissions. |
| `max_id` | string | No | Retrieve a feed of events with an ID less than or equal to the specified ID. Used for pagination. |
| `max_time` | integer | No | Retrieve a feed of events that occurred before the specified Unix timestamp (in seconds). |
| `since_id` | string | No | Retrieve a feed of events with an ID greater than the specified ID. Used for pagination. |
| `entity_id` | string | No | Retrieve a feed of events related to a specific entity. Use entity ID format like '{integer}-{entityType}'. |
| `since_time` | integer | No | Retrieve a feed of events that occurred after the specified Unix timestamp (in seconds). |
| `filters_creator` | array | No | Retrieve a feed of events caused by a specific user or team. Use user/team IDs. |
| `filters_payload` | array | No | Retrieve a feed of events related to a type of entity. Filter by payload type. |
| `filters_email_entity_type` | array | No | Whether to receive email sent or received events. Requires a creator filter. Values can be 'sent' or 'received'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Filters

**Slug:** `NUTSHELL_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).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | No | Additional filter options to apply when retrieving saved filters. |
| `userId` | string | No | The user ID to get saved filters for. If not provided, returns filters for all users. |
| `reportType` | string ("report_*" | "entity_list_leads" | "entity_list_contacts" | "entity_list_accounts") | No | The type of saved filters to get. Use 'report_*' to get all report filters, or 'entity_list_leads', 'entity_list_contacts', 'entity_list_accounts' to get filters for the given entity type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Forms

**Slug:** `NUTSHELL_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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Industries

**Slug:** `NUTSHELL_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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Invoices

**Slug:** `NUTSHELL_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_page` | string | No | Request a specific page of results, for pagination. Used in conjunction with page_limit. Indexing is 0-based. |
| `page_limit` | string | No | Limit the number of results returned, for pagination. |
| `filter_lead` | string | No | Filter invoices by lead ID. |
| `filter_date_max` | string | No | Filter invoices created before this date. Date expected in the format YYYY-MM-DD. |
| `filter_date_min` | string | No | Filter invoices created after this date. Date expected in the format YYYY-MM-DD. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Leads

**Slug:** `NUTSHELL_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Search query to find leads. Returns all entities similar to the query term across all related info. |
| `sort` | string | No | Sort the returned list by a chosen field. Use a '-' before the field name to sort in descending order. Examples: 'name', '-value', '-closedTime' |
| `filter` | object | No | Filter the returned leads based on various criteria. Use /rest/leads/list/fields to get a full list of valid filter keys. |
| `page_page` | integer | No | The page of results to return. Indexing is 0-based. Used for pagination. |
| `page_limit` | integer | No | How many results to return per page. Used for pagination. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Lead Custom Field Attributes

**Slug:** `NUTSHELL_LIST_LEADS_CUSTOMFIELD_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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Lead Fields

**Slug:** `NUTSHELL_LIST_LEADS_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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Leads

**Slug:** `NUTSHELL_LIST_LEADS_LIST_ITEMS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Used to search all related info on an entity. Returns all entities that are similar to the query term. |
| `sort` | array | No | Sort the returned list by a chosen field. Use a '-' before the field name to sort in descending order. |
| `filter` | object | No | Filter the returned leads based on various criteria. Use /rest/leads/list/fields to get a full list of valid filter keys. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Leads Report

**Slug:** `NUTSHELL_LIST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Search query to find reports. Returns all reports that are similar to the query term. |
| `gap` | string ("d" | "w" | "m" | "y" | "q") | No | The bucket size of the report. Options: 'd' (day), 'w' (week), 'm' (month), 'y' (year), 'q' (quarter). |
| `sort` | string | No | Sort the returned list by a chosen field. Use a '-' before the field name to sort in descending order. |
| `format` | string | No | The format of the report output. Only 'json' is supported. |
| `pivotFacet` | string | No | The facet to sort values on. |
| `reportType` | string ("sales" | "losses" | "newleads" | "forecast" | "attribution" | "custom") | No | The type of report to generate. Options: sales, losses, newleads, forecast, attribution, custom. |
| `filter_name` | string | No | Filter results by lead name. Visit the filters guide for more information on how to filter by other terms. |
| `groupByField` | string | No | The field to group leads by. Sales or losses reports should use 'closedTime', new leads and custom reports should use 'createdTime'. |
| `useConfidence` | boolean | No | When calculating lead values, use their weighted confidence value or not. |
| `segmentByField` | string ("outcomes" | "competitors" | "products" | "productCategories" | "assignees" | "territories" | "sources" | "tags" | "channels") | No | Ways to break down the report to compare across different variables. Use to answer questions like: Who has made the most sales? Which products are earning the most? Where are our leads coming from? |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Lead Stages

**Slug:** `NUTSHELL_LIST_LEADS_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Lead ID in the format 'number-leads' (e.g., '1003-leads', '45-leads') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Markets

**Slug:** `NUTSHELL_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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Notes

**Slug:** `NUTSHELL_LIST_NOTES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_page` | string | No | Request a specific page of results, for pagination. Used in conjunction with page_limit. Indexing is 0-based. |
| `page_limit` | string | No | Limit the number of results returned, for pagination. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Lead Outcomes

**Slug:** `NUTSHELL_LIST_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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Product Categories

**Slug:** `NUTSHELL_LIST_PRODUCTCATEGORIES`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Product Maps

**Slug:** `NUTSHELL_LIST_PRODUCTMAPS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Products

**Slug:** `NUTSHELL_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Filter for matching name or SKU. Returns products where the name or SKU contains the query string. |
| `sort` | string ("name" | "-name" | "sku" | "-sku") | No | Sort the returned list by name or SKU. Use '-' prefix for descending order. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Quotes

**Slug:** `NUTSHELL_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_page` | string | No | Request a specific page of results, for pagination. Used in conjunction with page_limit. Indexing is 0-based. |
| `page_limit` | string | No | Limit the number of results returned, for pagination. |
| `filter_lead` | string | No | Filter quotes by lead ID. |
| `filter_date_max` | string | No | Filter quotes created before this date. Date expected in the format YYYY-MM-DD. |
| `filter_date_min` | string | No | Filter quotes created after this date. Date expected in the format YYYY-MM-DD. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Sources

**Slug:** `NUTSHELL_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Query string to search for sources that match a specific string. Filters sources by name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Stages

**Slug:** `NUTSHELL_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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Pipelines

**Slug:** `NUTSHELL_LIST_STAGESETS`

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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tags

**Slug:** `NUTSHELL_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).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Search query string to filter tags by name. Returns tags that match the query string. |
| `filter_tag_type` | string ("leads" | "contacts" | "accounts") | No | Filter tags by their type. Use 'leads' for lead tags, 'contacts' for contact tags, or 'accounts' for account tags. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Territories

**Slug:** `NUTSHELL_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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Users

**Slug:** `NUTSHELL_LIST_USERS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reopen Lead

**Slug:** `NUTSHELL_REOPEN_LEADS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Lead ID to reopen. The unique identifier of the lead in Nutshell CRM in the format 'number-leads' (e.g., '1003-leads', '45-leads') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Lead Pipeline

**Slug:** `NUTSHELL_SET_PIPELINE_LEADS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Lead ID to update. The unique identifier of the lead in Nutshell CRM |
| `stageset` | string | Yes | ID of the stageset (pipeline) to set for the lead. Identifies which pipeline to assign the lead to |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Undelete Account

**Slug:** `NUTSHELL_UNDELETE_ACCOUNTS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the account to undelete. IDs are of the form 'n-accounts', where n is an integer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Undelete Contact

**Slug:** `NUTSHELL_UNDELETE_CONTACTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Contact ID to undelete. Must be the numeric ID of a previously deleted contact |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Undelete Lead

**Slug:** `NUTSHELL_UNDELETE_LEADS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Lead ID to undelete. The unique identifier of the lead in Nutshell CRM |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Undelete Note

**Slug:** `NUTSHELL_UNDELETE_NOTES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Note ID in the format '{integer}-notes'. Example: '75-notes' for note with ID 75. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Undelete Source

**Slug:** `NUTSHELL_UNDELETE_SOURCES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the source to undelete. IDs are of the form 'n-sources', where n is an integer |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Undelete Tag

**Slug:** `NUTSHELL_UNDELETE_TAGS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Tag ID to undelete in the format 'n-tags' where n is an integer (e.g., '83-tags', '123-tags') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Account with JSON Patch

**Slug:** `NUTSHELL_UPDATE_ACCOUNTS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the account to update. IDs are of the form 'n-accounts', where n is an integer. |
| `operations` | array | Yes | Array of JSON Patch operations to apply to the account. Each operation specifies what change to make. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Nutshell Contact

**Slug:** `NUTSHELL_UPDATE_CONTACTS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the contact to update. Format: 'n-contacts' where n is an integer. |
| `operations` | array | Yes | Array of JSON Patch operations to apply to the contact. Each operation modifies a specific field or relationship. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Lead

**Slug:** `NUTSHELL_UPDATE_LEADS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Lead ID to update. The unique identifier of the lead in Nutshell CRM in the format 'number-leads' (e.g., '1007-leads', '123-leads') |
| `patches` | array | Yes | Array of JSON Patch operations to apply to the lead. Each operation specifies how to modify a specific field |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Lead Status

**Slug:** `NUTSHELL_UPDATE_STATUS_LEADS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Lead ID to update status. The unique identifier of the lead in Nutshell CRM in the format 'number-leads' (e.g., '1003-leads', '45-leads') |
| `outcomeId` | string | Yes | ID of the outcome to set for the lead. Required field that determines the status outcome in the format 'number-outcomes' (e.g., '1-outcomes') |
| `productMaps` | array | No | Array of product maps to associate with the lead. Each product map can specify product ID, price, quantity, and other properties. When specifying price, quantity, or other root level productMap properties, you need to specify the productType as well |
| `competitorMaps` | array | No | Array of competitor map IDs to associate with the lead when updating status |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Task with JSON Patch

**Slug:** `NUTSHELL_UPDATE_TASKS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the task to update. IDs are of the form 'n-tasks', where n is an integer. |
| `operations` | array | Yes | Array of JSON Patch operations to apply to the task. Each operation specifies what change to make. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Watch Lead

**Slug:** `NUTSHELL_WATCH_LEADS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Lead ID to watch. The unique identifier of the lead in Nutshell CRM in the format 'number-leads' (e.g., '1003-leads', '45-leads') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |