Nutshell

App · 20 actions

Work with your Nutshell CRM: find, add and update leads, people and companies, close and reopen leads, log activities, add notes and tasks, and start workflows when a lead, person or company is added.

Actions

ActionWhat it does
Add noteAdd a note to a lead, person or company.
Close leadClose a lead as won, lost or cancelled by giving it one of your Nutshell outcomes.
Create companyAdd a company (an account) to Nutshell, with an email, phone, website and an owner.
Create leadAdd a lead (a deal) to Nutshell, with the people and companies it's with, an owner, a source and a value.
Create personAdd a person (a contact) to Nutshell, with an email, phone, companies and an owner.
Create taskAdd a to-do for a Nutshell user, with a due time, about a lead, person or company.
Delete recordDelete a lead, person, company, note or task.
Get companyGet one company with its emails, phones, website, people and leads.
Get leadGet one lead with its status, value, owner, people and companies.
Get personGet one person with their emails, phones, job title, companies and leads.
List activitiesFind activities by words, status, a person or user taking part, or dates.
List companiesFind companies (accounts) by words or email address.
List leadsFind leads by words, owner, person, company or the dates they were created.
List peopleFind people (contacts) by words, email address or company.
List usersList your company's Nutshell users with their ids, for assigning leads, tasks and activities.
Log activityLog a call, meeting or other activity that happened, or schedule one that's coming up, with the people and leads it involves.
Reopen leadOpen a closed lead again.
Update companyRename a company, change its description or owner, add an email or phone, or set custom fields.
Update leadRename a lead, change its value or owner, add a person or company, or set custom fields.
Update personRename a person, change their description or owner, add an email, phone or company, or set custom fields.

Add note

Add a note to a lead, person or company.

Inputs

Record typerecord_typetextRequired
Whether the record is a lead, a person or a company.One of: lead, contact (Person), account (Company).
Recordrecord_idtextRequired
The record's Nutshell id (such as 12-leads), the number alone, or its address in Nutshell.
NotebodytextRequired
The note's text.

Outputs

bodytext
The note's text
created_attext
When it was added (ISO 8601, UTC)
idtext
The note's Nutshell id
parent_idtext
The id of the record it's on
parent_typetext
What kind of record it's on
urltext
Its page in Nutshell
Example output
{
  "body": "Andy asked for pricing by Friday.",
  "created_at": "2026-10-15T09:00:00Z",
  "id": "9-notes",
  "parent_id": "1006-leads",
  "parent_type": "leads",
  "url": "https://app.nutshell.com/lead/1006"
}

Close lead

Close a lead as won, lost or cancelled by giving it one of your Nutshell outcomes.

Inputs

Leadlead_idtextRequired
The lead's Nutshell id (such as 12-leads), the number alone, or its address in Nutshell. Find one with 'List leads'.
Outcomeoutcome_idtextRequired
How the lead ended. Pick one, or type its name, such as Won.

Outputs

account_idslist
The ids of the companies on the lead
closed_attext
When it was closed; empty while open
confidencenumber
How likely it is to close, as a percentage
contact_idslist
The ids of the people on the lead
created_attext
When it was created (ISO 8601, UTC)
currencytext
The value's currency code, such as USD
descriptiontext
The lead's description
due_attext
When it is due to close; empty if not set
idtext
The lead's Nutshell id, such as 12-leads
is_hottrue/false
Whether the lead is marked hot
is_overduetrue/false
Whether the lead is past its due date
nametext
The lead's name
numbernumber
The lead number shown in Nutshell (Lead-1001)
owner_idtext
The id of the user it's assigned to
source_idslist
The ids of the lead's sources
statustext
Open, won, lost or cancelled
urltext
The lead's page in Nutshell
value_amounttext
The lead's value as a number, such as 1500.00
value_formattedtext
The value as Nutshell shows it, such as $1,500.00
Example output
{
  "account_ids": [
    "5-accounts"
  ],
  "closed_at": "2026-10-30T09:00:00Z",
  "confidence": 25,
  "contact_ids": [
    "3-contacts"
  ],
  "created_at": "2026-10-15T09:00:00Z",
  "currency": "USD",
  "description": "Car Wash Inc. expansion",
  "due_at": "",
  "id": "1006-leads",
  "is_hot": false,
  "is_overdue": false,
  "name": "Car Wash Inc. expansion",
  "number": 1006,
  "owner_id": "1-users",
  "source_ids": [],
  "status": "won",
  "url": "https://app.nutshell.com/lead/1006",
  "value_amount": "1500.00",
  "value_formatted": "$1,500.00"
}

Create company

Add a company (an account) to Nutshell, with an email, phone, website and an owner.

Inputs

NamenametextRequired
The company's name.
Emailemailtext
The company's email address.
Phonephonetext
The company's phone number.
Websitewebsitetext
The company's website.
Descriptiondescriptiontext
A line shown under its name.
Ownerowner_idtext
The Nutshell user who owns it.
Custom fieldscustom_fieldsobject
Values for your Nutshell custom fields, by the field's name, such as {"Favorite Number": "12"}.

Outputs

account_type_idtext
The id of its company type
contact_idslist
The ids of the people at the company
created_attext
When it was created (ISO 8601, UTC)
descriptiontext
The description shown under the name
emailtext
The primary email address
emailslist
Every email address
idtext
The company's Nutshell id, such as 3-accounts
industry_idtext
The id of its industry
lead_idslist
The ids of the company's leads
nametext
The full name
owner_idtext
The id of the user who owns it
phonetext
The primary phone number
phoneslist
Every phone number
urltext
Its page in Nutshell
websitetext
The primary website
Example output
{
  "account_type_id": "1-accountTypes",
  "contact_ids": [
    "3-contacts"
  ],
  "created_at": "2026-10-15T09:00:00Z",
  "description": "Regional car wash chain",
  "email": "hello@example.com",
  "emails": [
    "hello@example.com"
  ],
  "id": "5-accounts",
  "industry_id": "",
  "lead_ids": [
    "1006-leads"
  ],
  "name": "Car Wash Inc.",
  "owner_id": "1-users",
  "phone": "123-456-7890",
  "phones": [
    "123-456-7890"
  ],
  "url": "https://app.nutshell.com/company/5",
  "website": "https://www.example.com"
}

Create lead

Add a lead (a deal) to Nutshell, with the people and companies it's with, an owner, a source and a value.

Inputs

NamenametextRequired
What the lead is called in Nutshell.
Valuevaluetext
The lead's value, such as 1500. Leave empty to add up its products.
Peoplecontact_idstext
The people on the lead: their ids (such as 3-contacts) separated by commas.
Companiesaccount_idstext
The companies on the lead: their ids (such as 5-accounts) separated by commas.
Ownerowner_idtext
The user the lead is assigned to.
Sourcesource_idtext
Where the lead came from.
Custom fieldscustom_fieldsobject
Values for your Nutshell custom fields, by the field's name, such as {"Favorite Number": "12"}.

Outputs

account_idslist
The ids of the companies on the lead
closed_attext
When it was closed; empty while open
confidencenumber
How likely it is to close, as a percentage
contact_idslist
The ids of the people on the lead
created_attext
When it was created (ISO 8601, UTC)
currencytext
The value's currency code, such as USD
descriptiontext
The lead's description
due_attext
When it is due to close; empty if not set
idtext
The lead's Nutshell id, such as 12-leads
is_hottrue/false
Whether the lead is marked hot
is_overduetrue/false
Whether the lead is past its due date
nametext
The lead's name
numbernumber
The lead number shown in Nutshell (Lead-1001)
owner_idtext
The id of the user it's assigned to
source_idslist
The ids of the lead's sources
statustext
Open, won, lost or cancelled
urltext
The lead's page in Nutshell
value_amounttext
The lead's value as a number, such as 1500.00
value_formattedtext
The value as Nutshell shows it, such as $1,500.00
Example output
{
  "account_ids": [
    "5-accounts"
  ],
  "closed_at": "",
  "confidence": 25,
  "contact_ids": [
    "3-contacts"
  ],
  "created_at": "2026-10-15T09:00:00Z",
  "currency": "USD",
  "description": "Car Wash Inc. expansion",
  "due_at": "",
  "id": "1006-leads",
  "is_hot": false,
  "is_overdue": false,
  "name": "Car Wash Inc. expansion",
  "number": 1006,
  "owner_id": "1-users",
  "source_ids": [],
  "status": "open",
  "url": "https://app.nutshell.com/lead/1006",
  "value_amount": "1500.00",
  "value_formatted": "$1,500.00"
}

Create person

Add a person (a contact) to Nutshell, with an email, phone, companies and an owner.

Inputs

NamenametextRequired
The person's full name.
Emailemailtext
Their email address.
Phonephonetext
Their phone number, with the country code if outside the US.
Descriptiondescriptiontext
A line shown under their name, such as their role.
Companiesaccount_idstext
Their companies: ids (such as 5-accounts) separated by commas.
Ownerowner_idtext
The Nutshell user who owns it.
Custom fieldscustom_fieldsobject
Values for your Nutshell custom fields, by the field's name, such as {"Favorite Number": "12"}.

Outputs

account_idslist
The ids of their companies
created_attext
When it was created (ISO 8601, UTC)
descriptiontext
The description shown under the name
emailtext
The primary email address
emailslist
Every email address
first_nametext
The given name
idtext
The person's Nutshell id, such as 3-contacts
job_titletext
Their role at their company
last_nametext
The family name
lead_idslist
The ids of their leads
nametext
The full name
owner_idtext
The id of the user who owns it
phonetext
The primary phone number
phoneslist
Every phone number
urltext
Its page in Nutshell
Example output
{
  "account_ids": [
    "5-accounts"
  ],
  "created_at": "2026-10-15T09:00:00Z",
  "description": "CEO",
  "email": "andy@example.com",
  "emails": [
    "andy@example.com"
  ],
  "first_name": "Andy",
  "id": "3-contacts",
  "job_title": "CEO",
  "last_name": "Fowler",
  "lead_ids": [
    "1006-leads"
  ],
  "name": "Andy Fowler",
  "owner_id": "1-users",
  "phone": "734-123-4567",
  "phones": [
    "734-123-4567"
  ],
  "url": "https://app.nutshell.com/person/3"
}

Create task

Add a to-do for a Nutshell user, with a due time, about a lead, person or company.

Inputs

TitletitletextRequired
What needs doing.
Descriptiondescriptiontext
More detail.
Duedue_timedate and time
When it's due.
Assigned toassignee_idtext
The user who should do it.
About arelated_typetext
Whether it's about a lead, a person or a company.One of: lead, contact (Person), account (Company).
Aboutrelated_idtext
The lead, person or company's Nutshell id, or its address in Nutshell.

Outputs

assignee_idtext
The id of the user it's assigned to
descriptiontext
The task's description
due_attext
When it is due (ISO 8601, UTC); empty if not set
idtext
The task's Nutshell id, such as 5-tasks
related_idtext
The id of the lead, person or company it's about
titletext
The task's title
urltext
Its page in Nutshell
Example output
{
  "assignee_id": "1-users",
  "description": "",
  "due_at": "2026-10-23T17:00:00Z",
  "id": "5-tasks",
  "related_id": "1006-leads",
  "title": "Send Andy the pricing sheet",
  "url": "https://app.nutshell.com/task/5"
}

Delete record

Delete a lead, person, company, note or task. It stays in Nutshell's trash for 30 days.

Inputs

Record typerecord_typetextRequired
What kind of record to delete.One of: lead, contact (Person), account (Company), note, task.
Recordrecord_idtextRequired
The record's Nutshell id (such as 12-leads), the number alone, or its address in Nutshell.

Outputs

deletedtrue/false
True once deleted
record_idtext
The id deleted
record_typetext
What kind of record
Example output
{
  "deleted": true,
  "record_id": "1006-leads",
  "record_type": "lead"
}

Get company

Get one company with its emails, phones, website, people and leads.

Inputs

Companyaccount_idtextRequired
The company's Nutshell id (such as 12-accounts), the number alone, or its address in Nutshell. Find one with 'List companies'.

Outputs

account_type_idtext
The id of its company type
contact_idslist
The ids of the people at the company
created_attext
When it was created (ISO 8601, UTC)
descriptiontext
The description shown under the name
emailtext
The primary email address
emailslist
Every email address
idtext
The company's Nutshell id, such as 3-accounts
industry_idtext
The id of its industry
lead_idslist
The ids of the company's leads
nametext
The full name
owner_idtext
The id of the user who owns it
phonetext
The primary phone number
phoneslist
Every phone number
urltext
Its page in Nutshell
websitetext
The primary website
Example output
{
  "account_type_id": "1-accountTypes",
  "contact_ids": [
    "3-contacts"
  ],
  "created_at": "2026-10-15T09:00:00Z",
  "description": "Regional car wash chain",
  "email": "hello@example.com",
  "emails": [
    "hello@example.com"
  ],
  "id": "5-accounts",
  "industry_id": "",
  "lead_ids": [
    "1006-leads"
  ],
  "name": "Car Wash Inc.",
  "owner_id": "1-users",
  "phone": "123-456-7890",
  "phones": [
    "123-456-7890"
  ],
  "url": "https://app.nutshell.com/company/5",
  "website": "https://www.example.com"
}

Get lead

Get one lead with its status, value, owner, people and companies.

Inputs

Leadlead_idtextRequired
The lead's Nutshell id (such as 12-leads), the number alone, or its address in Nutshell. Find one with 'List leads'.

Outputs

account_idslist
The ids of the companies on the lead
closed_attext
When it was closed; empty while open
confidencenumber
How likely it is to close, as a percentage
contact_idslist
The ids of the people on the lead
created_attext
When it was created (ISO 8601, UTC)
currencytext
The value's currency code, such as USD
descriptiontext
The lead's description
due_attext
When it is due to close; empty if not set
idtext
The lead's Nutshell id, such as 12-leads
is_hottrue/false
Whether the lead is marked hot
is_overduetrue/false
Whether the lead is past its due date
nametext
The lead's name
numbernumber
The lead number shown in Nutshell (Lead-1001)
owner_idtext
The id of the user it's assigned to
source_idslist
The ids of the lead's sources
statustext
Open, won, lost or cancelled
urltext
The lead's page in Nutshell
value_amounttext
The lead's value as a number, such as 1500.00
value_formattedtext
The value as Nutshell shows it, such as $1,500.00
Example output
{
  "account_ids": [
    "5-accounts"
  ],
  "closed_at": "",
  "confidence": 25,
  "contact_ids": [
    "3-contacts"
  ],
  "created_at": "2026-10-15T09:00:00Z",
  "currency": "USD",
  "description": "Car Wash Inc. expansion",
  "due_at": "",
  "id": "1006-leads",
  "is_hot": false,
  "is_overdue": false,
  "name": "Car Wash Inc. expansion",
  "number": 1006,
  "owner_id": "1-users",
  "source_ids": [],
  "status": "open",
  "url": "https://app.nutshell.com/lead/1006",
  "value_amount": "1500.00",
  "value_formatted": "$1,500.00"
}

Get person

Get one person with their emails, phones, job title, companies and leads.

Inputs

Personcontact_idtextRequired
The person's Nutshell id (such as 12-contacts), the number alone, or its address in Nutshell. Find one with 'List people'.

Outputs

account_idslist
The ids of their companies
created_attext
When it was created (ISO 8601, UTC)
descriptiontext
The description shown under the name
emailtext
The primary email address
emailslist
Every email address
first_nametext
The given name
idtext
The person's Nutshell id, such as 3-contacts
job_titletext
Their role at their company
last_nametext
The family name
lead_idslist
The ids of their leads
nametext
The full name
owner_idtext
The id of the user who owns it
phonetext
The primary phone number
phoneslist
Every phone number
urltext
Its page in Nutshell
Example output
{
  "account_ids": [
    "5-accounts"
  ],
  "created_at": "2026-10-15T09:00:00Z",
  "description": "CEO",
  "email": "andy@example.com",
  "emails": [
    "andy@example.com"
  ],
  "first_name": "Andy",
  "id": "3-contacts",
  "job_title": "CEO",
  "last_name": "Fowler",
  "lead_ids": [
    "1006-leads"
  ],
  "name": "Andy Fowler",
  "owner_id": "1-users",
  "phone": "734-123-4567",
  "phones": [
    "734-123-4567"
  ],
  "url": "https://app.nutshell.com/person/3"
}

List activities

Find activities by words, status, a person or user taking part, or dates.

Inputs

Searchquerytext
Words to look for in names, emails, places and more.
Statusstatustext
Only scheduled, logged or cancelled activities.One of: scheduled, logged, cancelled.
Taking partparticipant_idtext
Only activities with this person (such as 3-contacts) or user (such as 1-users).
On or afterfrom_datedate
Only activities on or after this date.
On or beforeto_datedate
Only activities on or before this date.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 25.From 1 to 100.

Outputs

activitieslist
The activities
countnumber
How many on this page
Example output
{
  "activities": [
    {
      "activity_type_id": "1-activityTypes",
      "agenda": "Discuss the new feature set",
      "end_at": "2026-10-20T14:30:00Z",
      "id": "7-activities",
      "is_all_day": false,
      "is_cancelled": false,
      "is_flagged": false,
      "is_logged": true,
      "lead_ids": [
        "1006-leads"
      ],
      "name": "Call with Andy Fowler",
      "participant_ids": [
        "3-contacts",
        "1-users"
      ],
      "start_at": "2026-10-20T14:00:00Z",
      "url": "https://app.nutshell.com/activity/7"
    }
  ],
  "count": 1
}

List companies

Find companies (accounts) by words or email address. Gets one page; to see more, run it again with the next page.

Inputs

Searchquerytext
Words to look for in names, emails, places and more.
Emailemailtext
Only records with this email address.
Ordersorttext
How to order the results. Defaults to name, A to Z.One of: name (Name, A to Z), -name (Name, Z to A), -createdTime (Newest first), createdTime (Oldest first), -lastContactedTime (Last contacted, most recent first).
Pagepagenumber
Which page of results, from 1.At least 1.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 25.From 1 to 100.

Outputs

accountslist
The companies
countnumber
How many on this page
has_moretrue/false
Whether another page follows
pagenumber
Which page this is, from 1
Example output
{
  "accounts": [
    {
      "account_type_id": "1-accountTypes",
      "contact_ids": [
        "3-contacts"
      ],
      "created_at": "2026-10-15T09:00:00Z",
      "description": "Regional car wash chain",
      "email": "hello@example.com",
      "emails": [
        "hello@example.com"
      ],
      "id": "5-accounts",
      "industry_id": "",
      "lead_ids": [
        "1006-leads"
      ],
      "name": "Car Wash Inc.",
      "owner_id": "1-users",
      "phone": "123-456-7890",
      "phones": [
        "123-456-7890"
      ],
      "url": "https://app.nutshell.com/company/5",
      "website": "https://www.example.com"
    }
  ],
  "count": 1,
  "has_more": false,
  "page": 1
}

List leads

Find leads by words, owner, person, company or the dates they were created. Gets one page; to see more, run it again with the next page.

Inputs

Searchquerytext
Words to look for in names, emails, places and more.
Ownerowner_idtext
Only leads assigned to this user.
Personcontact_idtext
The person's Nutshell id (such as 12-contacts), the number alone, or its address in Nutshell. Find one with 'List people'.
Companyaccount_idtext
The company's Nutshell id (such as 12-accounts), the number alone, or its address in Nutshell. Find one with 'List companies'.
Created on or aftercreated_fromdate
Only leads created on or after this date.
Created on or beforecreated_todate
Only leads created on or before this date.
Ordersorttext
How to order the leads.One of: name (Name, A to Z), -name (Name, Z to A), -value (Value, highest first), value (Value, lowest first), -confidence (Confidence, highest first), age (Age, newest first), -age (Age, oldest first), -closedTime (Closed, most recent first).
Pagepagenumber
Which page of results, from 1.At least 1.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many on this page
has_moretrue/false
Whether another page follows
leadslist
The leads
pagenumber
Which page this is, from 1
Example output
{
  "count": 1,
  "has_more": false,
  "leads": [
    {
      "account_ids": [
        "5-accounts"
      ],
      "closed_at": "",
      "confidence": 25,
      "contact_ids": [
        "3-contacts"
      ],
      "created_at": "2026-10-15T09:00:00Z",
      "currency": "USD",
      "description": "Car Wash Inc. expansion",
      "due_at": "",
      "id": "1006-leads",
      "is_hot": false,
      "is_overdue": false,
      "name": "Car Wash Inc. expansion",
      "number": 1006,
      "owner_id": "1-users",
      "source_ids": [],
      "status": "open",
      "url": "https://app.nutshell.com/lead/1006",
      "value_amount": "1500.00",
      "value_formatted": "$1,500.00"
    }
  ],
  "page": 1
}

List people

Find people (contacts) by words, email address or company. Gets one page; to see more, run it again with the next page.

Inputs

Searchquerytext
Words to look for in names, emails, places and more.
Emailemailtext
Only records with this email address.
Companyaccount_idtext
The company's Nutshell id (such as 12-accounts), the number alone, or its address in Nutshell. Find one with 'List companies'.
Ordersorttext
How to order the results. Defaults to name, A to Z.One of: name (Name, A to Z), -name (Name, Z to A), -createdTime (Newest first), createdTime (Oldest first), -lastContactedTime (Last contacted, most recent first).
Pagepagenumber
Which page of results, from 1.At least 1.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 25.From 1 to 100.

Outputs

contactslist
The people
countnumber
How many on this page
has_moretrue/false
Whether another page follows
pagenumber
Which page this is, from 1
Example output
{
  "contacts": [
    {
      "account_ids": [
        "5-accounts"
      ],
      "created_at": "2026-10-15T09:00:00Z",
      "description": "CEO",
      "email": "andy@example.com",
      "emails": [
        "andy@example.com"
      ],
      "first_name": "Andy",
      "id": "3-contacts",
      "job_title": "CEO",
      "last_name": "Fowler",
      "lead_ids": [
        "1006-leads"
      ],
      "name": "Andy Fowler",
      "owner_id": "1-users",
      "phone": "734-123-4567",
      "phones": [
        "734-123-4567"
      ],
      "url": "https://app.nutshell.com/person/3"
    }
  ],
  "count": 1,
  "has_more": false,
  "page": 1
}

List users

List your company's Nutshell users with their ids, for assigning leads, tasks and activities.

Inputs

None.

Outputs

countnumber
How many on this page
userslist
The users
Example output
{
  "count": 1,
  "users": [
    {
      "email": "jim@example.com",
      "id": "1-users",
      "is_administrator": true,
      "is_enabled": true,
      "name": "Jim Halpert"
    }
  ]
}

Log activity

Log a call, meeting or other activity that happened, or schedule one that's coming up, with the people and leads it involves.

Inputs

NamenametextRequired
What the activity is called.
Startstart_timedate and timeRequired
When it starts or started.
Endend_timedate and time
When it ends. Defaults to 30 minutes after the start.
Happened or coming upstatetext
Log it as done, or schedule it. Defaults to logging it.One of: logged (It happened (log it)), scheduled (It's coming up (schedule it)). Default: logged.
Typeactivity_type_idtext
The kind of activity, such as a phone call or meeting.
Agendaagendatext
What it's about.
Notenotetext
A note only your team sees.
Locationlocationtext
Where it takes place.
Peoplecontact_idstext
The people taking part: ids (such as 3-contacts) separated by commas.
Userparticipant_user_idtext
A Nutshell user taking part.
Leadslead_idstext
The leads it's about: ids separated by commas. Leave empty to relate it to every open lead of its people.
Importantflaggedtrue/false
Mark the activity as important.

Outputs

activity_type_idtext
The id of its type, such as a call or meeting
agendatext
What the activity is about
end_attext
When it ends (ISO 8601, UTC)
idtext
The activity's Nutshell id, such as 7-activities
is_all_daytrue/false
Whether it lasts all day
is_cancelledtrue/false
Whether it was cancelled
is_flaggedtrue/false
Whether it is marked important
is_loggedtrue/false
Whether it has been logged as having happened
lead_idslist
The ids of the leads it's about
nametext
The activity's name
participant_idslist
The ids of the people and users taking part
start_attext
When it starts (ISO 8601, UTC)
urltext
Its page in Nutshell
Example output
{
  "activity_type_id": "1-activityTypes",
  "agenda": "Discuss the new feature set",
  "end_at": "2026-10-20T14:30:00Z",
  "id": "7-activities",
  "is_all_day": false,
  "is_cancelled": false,
  "is_flagged": false,
  "is_logged": true,
  "lead_ids": [
    "1006-leads"
  ],
  "name": "Call with Andy Fowler",
  "participant_ids": [
    "3-contacts",
    "1-users"
  ],
  "start_at": "2026-10-20T14:00:00Z",
  "url": "https://app.nutshell.com/activity/7"
}

Reopen lead

Open a closed lead again.

Inputs

Leadlead_idtextRequired
The lead's Nutshell id (such as 12-leads), the number alone, or its address in Nutshell. Find one with 'List leads'.

Outputs

account_idslist
The ids of the companies on the lead
closed_attext
When it was closed; empty while open
confidencenumber
How likely it is to close, as a percentage
contact_idslist
The ids of the people on the lead
created_attext
When it was created (ISO 8601, UTC)
currencytext
The value's currency code, such as USD
descriptiontext
The lead's description
due_attext
When it is due to close; empty if not set
idtext
The lead's Nutshell id, such as 12-leads
is_hottrue/false
Whether the lead is marked hot
is_overduetrue/false
Whether the lead is past its due date
nametext
The lead's name
numbernumber
The lead number shown in Nutshell (Lead-1001)
owner_idtext
The id of the user it's assigned to
source_idslist
The ids of the lead's sources
statustext
Open, won, lost or cancelled
urltext
The lead's page in Nutshell
value_amounttext
The lead's value as a number, such as 1500.00
value_formattedtext
The value as Nutshell shows it, such as $1,500.00
Example output
{
  "account_ids": [
    "5-accounts"
  ],
  "closed_at": "",
  "confidence": 25,
  "contact_ids": [
    "3-contacts"
  ],
  "created_at": "2026-10-15T09:00:00Z",
  "currency": "USD",
  "description": "Car Wash Inc. expansion",
  "due_at": "",
  "id": "1006-leads",
  "is_hot": false,
  "is_overdue": false,
  "name": "Car Wash Inc. expansion",
  "number": 1006,
  "owner_id": "1-users",
  "source_ids": [],
  "status": "open",
  "url": "https://app.nutshell.com/lead/1006",
  "value_amount": "1500.00",
  "value_formatted": "$1,500.00"
}

Update company

Rename a company, change its description or owner, add an email or phone, or set custom fields. Only the fields given change.

Inputs

Companyaccount_idtextRequired
The company's Nutshell id (such as 12-accounts), the number alone, or its address in Nutshell. Find one with 'List companies'.
Namenametext
A new name. Leave empty to keep it.
Descriptiondescriptiontext
A new description. Leave empty to keep it.
Add emailadd_emailtext
An email address to add to the company's.
Add phoneadd_phonetext
A phone number to add to the company's.
Ownerowner_idtext
A new owner. Leave empty to keep it.
Custom fieldscustom_fieldsobject
Values for your Nutshell custom fields, by the field's name, such as {"Favorite Number": "12"}.

Outputs

account_type_idtext
The id of its company type
contact_idslist
The ids of the people at the company
created_attext
When it was created (ISO 8601, UTC)
descriptiontext
The description shown under the name
emailtext
The primary email address
emailslist
Every email address
idtext
The company's Nutshell id, such as 3-accounts
industry_idtext
The id of its industry
lead_idslist
The ids of the company's leads
nametext
The full name
owner_idtext
The id of the user who owns it
phonetext
The primary phone number
phoneslist
Every phone number
urltext
Its page in Nutshell
websitetext
The primary website
Example output
{
  "account_type_id": "1-accountTypes",
  "contact_ids": [
    "3-contacts"
  ],
  "created_at": "2026-10-15T09:00:00Z",
  "description": "Regional car wash chain",
  "email": "hello@example.com",
  "emails": [
    "hello@example.com"
  ],
  "id": "5-accounts",
  "industry_id": "",
  "lead_ids": [
    "1006-leads"
  ],
  "name": "Car Wash Inc.",
  "owner_id": "1-users",
  "phone": "123-456-7890",
  "phones": [
    "123-456-7890"
  ],
  "url": "https://app.nutshell.com/company/5",
  "website": "https://www.example.com"
}

Update lead

Rename a lead, change its value or owner, add a person or company, or set custom fields. Only the fields given change.

Inputs

Leadlead_idtextRequired
The lead's Nutshell id (such as 12-leads), the number alone, or its address in Nutshell. Find one with 'List leads'.
Namenametext
A new name. Leave empty to keep it.
Valuevaluetext
A new value, such as 1500. Leave empty to keep it.
Ownerowner_idtext
A new owner. Leave empty to keep it.
Add personadd_contact_idtext
The person's Nutshell id (such as 12-contacts), the number alone, or its address in Nutshell. Find one with 'List people'.
Add companyadd_account_idtext
The company's Nutshell id (such as 12-accounts), the number alone, or its address in Nutshell. Find one with 'List companies'.
Custom fieldscustom_fieldsobject
Values for your Nutshell custom fields, by the field's name, such as {"Favorite Number": "12"}.

Outputs

account_idslist
The ids of the companies on the lead
closed_attext
When it was closed; empty while open
confidencenumber
How likely it is to close, as a percentage
contact_idslist
The ids of the people on the lead
created_attext
When it was created (ISO 8601, UTC)
currencytext
The value's currency code, such as USD
descriptiontext
The lead's description
due_attext
When it is due to close; empty if not set
idtext
The lead's Nutshell id, such as 12-leads
is_hottrue/false
Whether the lead is marked hot
is_overduetrue/false
Whether the lead is past its due date
nametext
The lead's name
numbernumber
The lead number shown in Nutshell (Lead-1001)
owner_idtext
The id of the user it's assigned to
source_idslist
The ids of the lead's sources
statustext
Open, won, lost or cancelled
urltext
The lead's page in Nutshell
value_amounttext
The lead's value as a number, such as 1500.00
value_formattedtext
The value as Nutshell shows it, such as $1,500.00
Example output
{
  "account_ids": [
    "5-accounts"
  ],
  "closed_at": "",
  "confidence": 25,
  "contact_ids": [
    "3-contacts"
  ],
  "created_at": "2026-10-15T09:00:00Z",
  "currency": "USD",
  "description": "Car Wash Inc. expansion",
  "due_at": "",
  "id": "1006-leads",
  "is_hot": false,
  "is_overdue": false,
  "name": "Car Wash Inc. expansion",
  "number": 1006,
  "owner_id": "1-users",
  "source_ids": [],
  "status": "open",
  "url": "https://app.nutshell.com/lead/1006",
  "value_amount": "2000.00",
  "value_formatted": "$2,000.00"
}

Update person

Rename a person, change their description or owner, add an email, phone or company, or set custom fields. Only the fields given change.

Inputs

Personcontact_idtextRequired
The person's Nutshell id (such as 12-contacts), the number alone, or its address in Nutshell. Find one with 'List people'.
Namenametext
A new full name. Leave empty to keep it.
Descriptiondescriptiontext
A new description. Leave empty to keep it.
Add emailadd_emailtext
An email address to add to theirs.
Add phoneadd_phonetext
A phone number to add to theirs.
Add companyadd_account_idtext
The company's Nutshell id (such as 12-accounts), the number alone, or its address in Nutshell. Find one with 'List companies'.
Ownerowner_idtext
A new owner. Leave empty to keep it.
Custom fieldscustom_fieldsobject
Values for your Nutshell custom fields, by the field's name, such as {"Favorite Number": "12"}.

Outputs

account_idslist
The ids of their companies
created_attext
When it was created (ISO 8601, UTC)
descriptiontext
The description shown under the name
emailtext
The primary email address
emailslist
Every email address
first_nametext
The given name
idtext
The person's Nutshell id, such as 3-contacts
job_titletext
Their role at their company
last_nametext
The family name
lead_idslist
The ids of their leads
nametext
The full name
owner_idtext
The id of the user who owns it
phonetext
The primary phone number
phoneslist
Every phone number
urltext
Its page in Nutshell
Example output
{
  "account_ids": [
    "5-accounts"
  ],
  "created_at": "2026-10-15T09:00:00Z",
  "description": "CEO",
  "email": "andy@example.com",
  "emails": [
    "andy@example.com"
  ],
  "first_name": "Andy",
  "id": "3-contacts",
  "job_title": "CEO",
  "last_name": "Fowler",
  "lead_ids": [
    "1006-leads"
  ],
  "name": "Andy Fowler",
  "owner_id": "1-users",
  "phone": "734-123-4567",
  "phones": [
    "734-123-4567"
  ],
  "url": "https://app.nutshell.com/person/3"
}

On this page