Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Nutshell

Nutshell is a CRM platform for accounts, contacts, leads, sales tasks, and pipeline workflows.

Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

Connector
Authentication

Nutshell

Credentials

Nutshell

Connect to Nutshell with a user email and API key.

Set up in Nutshell

  1. Prepare the Nutshell account or service that the workflow will access. Grant access to the required resources and operations.

  2. API Key: The API key generated in Nutshell setup.

Set up in StackAI

  1. Open Settings → Connections, add a connection, and select Nutshell.

  2. Enter the credentials and connection details in the fields below.

  3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

Connection fields

StackAI field
Required
What to enter

Email

Yes

The Nutshell user email associated with the API key.

API Key

Yes

The API key generated in Nutshell setup. Provider instructions.

Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

Use an action

  1. Add the required Nutshell action to the workflow.

  2. Select a connection when the action requests one.

  3. Complete the required fields. Use the reference picker when a value comes from another workflow step.

  4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

Actions

Create Account

Create a Nutshell account.

Inputs

Field
Type
Required
Description

Account Name

string

Yes

Company or organization name.

Description

textarea

No

Optional account description.

Email

string

No

Optional primary account email.

Phone

string

No

Optional primary account phone number.

Website

string

No

Optional account website.

Outputs

Field
Type
Description

Account ID

string

Created Nutshell account ID.

Account

dict

Created Nutshell account object.

Create Activity

Create a Nutshell activity.

Inputs

Field
Type
Required
Description

Name

string

Yes

Activity name.

Activity Type ID

string

Yes

Nutshell activity type API ID.

Start Time

integer

Yes

Activity start Unix timestamp.

End Time

integer

Yes

Activity end Unix timestamp.

Description

textarea

No

Optional activity description.

Note

textarea

No

Optional internal activity note.

Location

string

No

Optional activity location.

Participant IDs

array

No

Optional Nutshell user/contact/account IDs participating.

Is Logged

boolean

No

Whether this activity is already logged/completed.

Is Flagged

boolean

No

Whether this activity should be flagged.

Outputs

Field
Type
Description

Activity ID

string

Created Nutshell activity ID.

Activity

dict

Created Nutshell activity object.

Create Contact

Create a Nutshell contact.

Inputs

Field
Type
Required
Description

Contact Name

string

Yes

Person name.

Description

textarea

No

Optional contact description.

Email

string

No

Optional contact email.

Phone

string

No

Optional contact phone number.

Account IDs

array

No

Optional Nutshell account IDs to link to this contact.

Owner ID

string

No

Optional Nutshell user ID to own this contact.

Tag IDs

array

No

Optional Nutshell tag IDs to apply to this contact.

Outputs

Field
Type
Description

Contact ID

string

Created Nutshell contact ID.

Contact

dict

Created Nutshell contact object.

List Contacts

List Nutshell contacts.

Inputs

Field
Type
Required
Description

Search Query

string

No

Optional full-text contact search query.

Email

string

No

Optional email filter.

Sort

string

No

Optional Nutshell sort expression.

Page

integer

Yes

Zero-based page number. Default: 0.

Limit

integer

Yes

Maximum number of contacts to return. Default: 25.

Outputs

Field
Type
Description

Contacts

array

Returned Nutshell contact objects.

Count

integer

Number of contacts returned.

Total

integer

Total contacts when provided by Nutshell.

Has More

boolean

Whether another page appears to be available.

Create Lead

Create a Nutshell lead.

Inputs

Field
Type
Required
Description

Description

textarea

Yes

Lead description or opportunity name.

Value

number

No

Optional lead value.

Account IDs

array

No

Optional account IDs to link to the lead.

Contact IDs

array

No

Optional contact IDs to link to the lead.

Owner ID

string

No

Optional Nutshell user ID to own this lead.

Source IDs

array

No

Optional source IDs to link to the lead.

Tag IDs

array

No

Optional tag IDs to apply to the lead.

Outputs

Field
Type
Description

Lead ID

string

Created Nutshell lead ID.

Lead

dict

Created Nutshell lead object.

List Leads

List Nutshell leads.

Inputs

Field
Type
Required
Description

Search Query

string

No

Optional full-text lead search query.

Sort

string

No

Optional Nutshell sort expression.

Page

integer

Yes

Zero-based page number. Default: 0.

Limit

integer

Yes

Maximum number of leads to return. Default: 25.

Outputs

Field
Type
Description

Leads

array

Returned Nutshell lead objects.

Count

integer

Number of leads returned.

Total

integer

Total leads when provided by Nutshell.

Has More

boolean

Whether another page appears to be available.

Update Lead

Update a Nutshell lead.

Inputs

Field
Type
Required
Description

Lead ID

string

Yes

Nutshell lead API ID, for example 1003-leads.

Description

textarea

No

Optional replacement lead description/name.

Value

number

No

Optional replacement lead value.

Outputs

Field
Type
Description

Lead ID

string

Updated Nutshell lead ID.

Updated

boolean

Whether the update request completed successfully.

Create Task

Create a Nutshell task.

Inputs

Field
Type
Required
Description

Title

string

Yes

Task title.

Description

textarea

No

Optional task description.

Due Time

integer

No

Optional Unix timestamp due time.

Related Entity ID

string

No

Optional Nutshell API ID of the related contact, account, or lead.

Assignee ID

string

No

Optional Nutshell user ID to assign the task.

Outputs

Field
Type
Description

Task ID

string

Created Nutshell task ID.

Task

dict

Created Nutshell task object.

Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.

Last updated

Was this helpful?