# Nutshell

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

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/nutshell

## Actions

### Add note

Add a note to a lead, person or company.

**Inputs**

- Record type (`record_type`, text, required): Whether the record is a lead, a person or a company. One of: `lead`, `contact` (Person), `account` (Company).
- Record (`record_id`, text, required): The record's Nutshell id (such as 12-leads), the number alone, or its address in Nutshell.
- Note (`body`, text, required): The note's text.

**Outputs**

- `body` (text): The note's text
- `created_at` (text): When it was added (ISO 8601, UTC)
- `id` (text): The note's Nutshell id
- `parent_id` (text): The id of the record it's on
- `parent_type` (text): What kind of record it's on
- `url` (text): Its page in Nutshell

**Example output**

```json
{
  "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**

- Lead (`lead_id`, text, required): The lead's Nutshell id (such as 12-leads), the number alone, or its address in Nutshell. Find one with 'List leads'.
- Outcome (`outcome_id`, text, required): How the lead ended. Pick one, or type its name, such as Won.

**Outputs**

- `account_ids` (list): The ids of the companies on the lead
- `closed_at` (text): When it was closed; empty while open
- `confidence` (number): How likely it is to close, as a percentage
- `contact_ids` (list): The ids of the people on the lead
- `created_at` (text): When it was created (ISO 8601, UTC)
- `currency` (text): The value's currency code, such as USD
- `description` (text): The lead's description
- `due_at` (text): When it is due to close; empty if not set
- `id` (text): The lead's Nutshell id, such as 12-leads
- `is_hot` (true/false): Whether the lead is marked hot
- `is_overdue` (true/false): Whether the lead is past its due date
- `name` (text): The lead's name
- `number` (number): The lead number shown in Nutshell (Lead-1001)
- `owner_id` (text): The id of the user it's assigned to
- `source_ids` (list): The ids of the lead's sources
- `status` (text): Open, won, lost or cancelled
- `url` (text): The lead's page in Nutshell
- `value_amount` (text): The lead's value as a number, such as 1500.00
- `value_formatted` (text): The value as Nutshell shows it, such as $1,500.00

**Example output**

```json
{
  "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**

- Name (`name`, text, required): The company's name.
- Email (`email`, text): The company's email address.
- Phone (`phone`, text): The company's phone number.
- Website (`website`, text): The company's website.
- Description (`description`, text): A line shown under its name.
- Owner (`owner_id`, text): The Nutshell user who owns it.
- Custom fields (`custom_fields`, object): Values for your Nutshell custom fields, by the field's name, such as {"Favorite Number": "12"}.

**Outputs**

- `account_type_id` (text): The id of its company type
- `contact_ids` (list): The ids of the people at the company
- `created_at` (text): When it was created (ISO 8601, UTC)
- `description` (text): The description shown under the name
- `email` (text): The primary email address
- `emails` (list): Every email address
- `id` (text): The company's Nutshell id, such as 3-accounts
- `industry_id` (text): The id of its industry
- `lead_ids` (list): The ids of the company's leads
- `name` (text): The full name
- `owner_id` (text): The id of the user who owns it
- `phone` (text): The primary phone number
- `phones` (list): Every phone number
- `url` (text): Its page in Nutshell
- `website` (text): The primary website

**Example output**

```json
{
  "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**

- Name (`name`, text, required): What the lead is called in Nutshell.
- Value (`value`, text): The lead's value, such as 1500. Leave empty to add up its products.
- People (`contact_ids`, text): The people on the lead: their ids (such as 3-contacts) separated by commas.
- Companies (`account_ids`, text): The companies on the lead: their ids (such as 5-accounts) separated by commas.
- Owner (`owner_id`, text): The user the lead is assigned to.
- Source (`source_id`, text): Where the lead came from.
- Custom fields (`custom_fields`, object): Values for your Nutshell custom fields, by the field's name, such as {"Favorite Number": "12"}.

**Outputs**

- `account_ids` (list): The ids of the companies on the lead
- `closed_at` (text): When it was closed; empty while open
- `confidence` (number): How likely it is to close, as a percentage
- `contact_ids` (list): The ids of the people on the lead
- `created_at` (text): When it was created (ISO 8601, UTC)
- `currency` (text): The value's currency code, such as USD
- `description` (text): The lead's description
- `due_at` (text): When it is due to close; empty if not set
- `id` (text): The lead's Nutshell id, such as 12-leads
- `is_hot` (true/false): Whether the lead is marked hot
- `is_overdue` (true/false): Whether the lead is past its due date
- `name` (text): The lead's name
- `number` (number): The lead number shown in Nutshell (Lead-1001)
- `owner_id` (text): The id of the user it's assigned to
- `source_ids` (list): The ids of the lead's sources
- `status` (text): Open, won, lost or cancelled
- `url` (text): The lead's page in Nutshell
- `value_amount` (text): The lead's value as a number, such as 1500.00
- `value_formatted` (text): The value as Nutshell shows it, such as $1,500.00

**Example output**

```json
{
  "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**

- Name (`name`, text, required): The person's full name.
- Email (`email`, text): Their email address.
- Phone (`phone`, text): Their phone number, with the country code if outside the US.
- Description (`description`, text): A line shown under their name, such as their role.
- Companies (`account_ids`, text): Their companies: ids (such as 5-accounts) separated by commas.
- Owner (`owner_id`, text): The Nutshell user who owns it.
- Custom fields (`custom_fields`, object): Values for your Nutshell custom fields, by the field's name, such as {"Favorite Number": "12"}.

**Outputs**

- `account_ids` (list): The ids of their companies
- `created_at` (text): When it was created (ISO 8601, UTC)
- `description` (text): The description shown under the name
- `email` (text): The primary email address
- `emails` (list): Every email address
- `first_name` (text): The given name
- `id` (text): The person's Nutshell id, such as 3-contacts
- `job_title` (text): Their role at their company
- `last_name` (text): The family name
- `lead_ids` (list): The ids of their leads
- `name` (text): The full name
- `owner_id` (text): The id of the user who owns it
- `phone` (text): The primary phone number
- `phones` (list): Every phone number
- `url` (text): Its page in Nutshell

**Example output**

```json
{
  "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**

- Title (`title`, text, required): What needs doing.
- Description (`description`, text): More detail.
- Due (`due_time`, date and time): When it's due.
- Assigned to (`assignee_id`, text): The user who should do it.
- About a (`related_type`, text): Whether it's about a lead, a person or a company. One of: `lead`, `contact` (Person), `account` (Company).
- About (`related_id`, text): The lead, person or company's Nutshell id, or its address in Nutshell.

**Outputs**

- `assignee_id` (text): The id of the user it's assigned to
- `description` (text): The task's description
- `due_at` (text): When it is due (ISO 8601, UTC); empty if not set
- `id` (text): The task's Nutshell id, such as 5-tasks
- `related_id` (text): The id of the lead, person or company it's about
- `title` (text): The task's title
- `url` (text): Its page in Nutshell

**Example output**

```json
{
  "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 type (`record_type`, text, required): What kind of record to delete. One of: `lead`, `contact` (Person), `account` (Company), `note`, `task`.
- Record (`record_id`, text, required): The record's Nutshell id (such as 12-leads), the number alone, or its address in Nutshell.

**Outputs**

- `deleted` (true/false): True once deleted
- `record_id` (text): The id deleted
- `record_type` (text): What kind of record

**Example output**

```json
{
  "deleted": true,
  "record_id": "1006-leads",
  "record_type": "lead"
}
```

### Get company

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

**Inputs**

- Company (`account_id`, text, required): 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_id` (text): The id of its company type
- `contact_ids` (list): The ids of the people at the company
- `created_at` (text): When it was created (ISO 8601, UTC)
- `description` (text): The description shown under the name
- `email` (text): The primary email address
- `emails` (list): Every email address
- `id` (text): The company's Nutshell id, such as 3-accounts
- `industry_id` (text): The id of its industry
- `lead_ids` (list): The ids of the company's leads
- `name` (text): The full name
- `owner_id` (text): The id of the user who owns it
- `phone` (text): The primary phone number
- `phones` (list): Every phone number
- `url` (text): Its page in Nutshell
- `website` (text): The primary website

**Example output**

```json
{
  "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**

- Lead (`lead_id`, text, required): The lead's Nutshell id (such as 12-leads), the number alone, or its address in Nutshell. Find one with 'List leads'.

**Outputs**

- `account_ids` (list): The ids of the companies on the lead
- `closed_at` (text): When it was closed; empty while open
- `confidence` (number): How likely it is to close, as a percentage
- `contact_ids` (list): The ids of the people on the lead
- `created_at` (text): When it was created (ISO 8601, UTC)
- `currency` (text): The value's currency code, such as USD
- `description` (text): The lead's description
- `due_at` (text): When it is due to close; empty if not set
- `id` (text): The lead's Nutshell id, such as 12-leads
- `is_hot` (true/false): Whether the lead is marked hot
- `is_overdue` (true/false): Whether the lead is past its due date
- `name` (text): The lead's name
- `number` (number): The lead number shown in Nutshell (Lead-1001)
- `owner_id` (text): The id of the user it's assigned to
- `source_ids` (list): The ids of the lead's sources
- `status` (text): Open, won, lost or cancelled
- `url` (text): The lead's page in Nutshell
- `value_amount` (text): The lead's value as a number, such as 1500.00
- `value_formatted` (text): The value as Nutshell shows it, such as $1,500.00

**Example output**

```json
{
  "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**

- Person (`contact_id`, text, required): The person's Nutshell id (such as 12-contacts), the number alone, or its address in Nutshell. Find one with 'List people'.

**Outputs**

- `account_ids` (list): The ids of their companies
- `created_at` (text): When it was created (ISO 8601, UTC)
- `description` (text): The description shown under the name
- `email` (text): The primary email address
- `emails` (list): Every email address
- `first_name` (text): The given name
- `id` (text): The person's Nutshell id, such as 3-contacts
- `job_title` (text): Their role at their company
- `last_name` (text): The family name
- `lead_ids` (list): The ids of their leads
- `name` (text): The full name
- `owner_id` (text): The id of the user who owns it
- `phone` (text): The primary phone number
- `phones` (list): Every phone number
- `url` (text): Its page in Nutshell

**Example output**

```json
{
  "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**

- Search (`query`, text): Words to look for in names, emails, places and more.
- Status (`status`, text): Only scheduled, logged or cancelled activities. One of: `scheduled`, `logged`, `cancelled`.
- Taking part (`participant_id`, text): Only activities with this person (such as 3-contacts) or user (such as 1-users).
- On or after (`from_date`, date): Only activities on or after this date.
- On or before (`to_date`, date): Only activities on or before this date.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 25. From 1 to 100.

**Outputs**

- `activities` (list): The activities
- `count` (number): How many on this page

**Example output**

```json
{
  "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**

- Search (`query`, text): Words to look for in names, emails, places and more.
- Email (`email`, text): Only records with this email address.
- Order (`sort`, text): 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).
- Page (`page`, number): Which page of results, from 1. At least 1.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 25. From 1 to 100.

**Outputs**

- `accounts` (list): The companies
- `count` (number): How many on this page
- `has_more` (true/false): Whether another page follows
- `page` (number): Which page this is, from 1

**Example output**

```json
{
  "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**

- Search (`query`, text): Words to look for in names, emails, places and more.
- Owner (`owner_id`, text): Only leads assigned to this user.
- Person (`contact_id`, text): The person's Nutshell id (such as 12-contacts), the number alone, or its address in Nutshell. Find one with 'List people'.
- Company (`account_id`, text): 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 after (`created_from`, date): Only leads created on or after this date.
- Created on or before (`created_to`, date): Only leads created on or before this date.
- Order (`sort`, text): 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).
- Page (`page`, number): Which page of results, from 1. At least 1.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 25. From 1 to 100.

**Outputs**

- `count` (number): How many on this page
- `has_more` (true/false): Whether another page follows
- `leads` (list): The leads
- `page` (number): Which page this is, from 1

**Example output**

```json
{
  "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**

- Search (`query`, text): Words to look for in names, emails, places and more.
- Email (`email`, text): Only records with this email address.
- Company (`account_id`, text): The company's Nutshell id (such as 12-accounts), the number alone, or its address in Nutshell. Find one with 'List companies'.
- Order (`sort`, text): 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).
- Page (`page`, number): Which page of results, from 1. At least 1.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 25. From 1 to 100.

**Outputs**

- `contacts` (list): The people
- `count` (number): How many on this page
- `has_more` (true/false): Whether another page follows
- `page` (number): Which page this is, from 1

**Example output**

```json
{
  "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**

- `count` (number): How many on this page
- `users` (list): The users

**Example output**

```json
{
  "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**

- Name (`name`, text, required): What the activity is called.
- Start (`start_time`, date and time, required): When it starts or started.
- End (`end_time`, date and time): When it ends. Defaults to 30 minutes after the start.
- Happened or coming up (`state`, text): 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`.
- Type (`activity_type_id`, text): The kind of activity, such as a phone call or meeting.
- Agenda (`agenda`, text): What it's about.
- Note (`note`, text): A note only your team sees.
- Location (`location`, text): Where it takes place.
- People (`contact_ids`, text): The people taking part: ids (such as 3-contacts) separated by commas.
- User (`participant_user_id`, text): A Nutshell user taking part.
- Leads (`lead_ids`, text): The leads it's about: ids separated by commas. Leave empty to relate it to every open lead of its people.
- Important (`flagged`, true/false): Mark the activity as important.

**Outputs**

- `activity_type_id` (text): The id of its type, such as a call or meeting
- `agenda` (text): What the activity is about
- `end_at` (text): When it ends (ISO 8601, UTC)
- `id` (text): The activity's Nutshell id, such as 7-activities
- `is_all_day` (true/false): Whether it lasts all day
- `is_cancelled` (true/false): Whether it was cancelled
- `is_flagged` (true/false): Whether it is marked important
- `is_logged` (true/false): Whether it has been logged as having happened
- `lead_ids` (list): The ids of the leads it's about
- `name` (text): The activity's name
- `participant_ids` (list): The ids of the people and users taking part
- `start_at` (text): When it starts (ISO 8601, UTC)
- `url` (text): Its page in Nutshell

**Example output**

```json
{
  "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**

- Lead (`lead_id`, text, required): The lead's Nutshell id (such as 12-leads), the number alone, or its address in Nutshell. Find one with 'List leads'.

**Outputs**

- `account_ids` (list): The ids of the companies on the lead
- `closed_at` (text): When it was closed; empty while open
- `confidence` (number): How likely it is to close, as a percentage
- `contact_ids` (list): The ids of the people on the lead
- `created_at` (text): When it was created (ISO 8601, UTC)
- `currency` (text): The value's currency code, such as USD
- `description` (text): The lead's description
- `due_at` (text): When it is due to close; empty if not set
- `id` (text): The lead's Nutshell id, such as 12-leads
- `is_hot` (true/false): Whether the lead is marked hot
- `is_overdue` (true/false): Whether the lead is past its due date
- `name` (text): The lead's name
- `number` (number): The lead number shown in Nutshell (Lead-1001)
- `owner_id` (text): The id of the user it's assigned to
- `source_ids` (list): The ids of the lead's sources
- `status` (text): Open, won, lost or cancelled
- `url` (text): The lead's page in Nutshell
- `value_amount` (text): The lead's value as a number, such as 1500.00
- `value_formatted` (text): The value as Nutshell shows it, such as $1,500.00

**Example output**

```json
{
  "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**

- Company (`account_id`, text, required): The company's Nutshell id (such as 12-accounts), the number alone, or its address in Nutshell. Find one with 'List companies'.
- Name (`name`, text): A new name. Leave empty to keep it.
- Description (`description`, text): A new description. Leave empty to keep it.
- Add email (`add_email`, text): An email address to add to the company's.
- Add phone (`add_phone`, text): A phone number to add to the company's.
- Owner (`owner_id`, text): A new owner. Leave empty to keep it.
- Custom fields (`custom_fields`, object): Values for your Nutshell custom fields, by the field's name, such as {"Favorite Number": "12"}.

**Outputs**

- `account_type_id` (text): The id of its company type
- `contact_ids` (list): The ids of the people at the company
- `created_at` (text): When it was created (ISO 8601, UTC)
- `description` (text): The description shown under the name
- `email` (text): The primary email address
- `emails` (list): Every email address
- `id` (text): The company's Nutshell id, such as 3-accounts
- `industry_id` (text): The id of its industry
- `lead_ids` (list): The ids of the company's leads
- `name` (text): The full name
- `owner_id` (text): The id of the user who owns it
- `phone` (text): The primary phone number
- `phones` (list): Every phone number
- `url` (text): Its page in Nutshell
- `website` (text): The primary website

**Example output**

```json
{
  "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**

- Lead (`lead_id`, text, required): The lead's Nutshell id (such as 12-leads), the number alone, or its address in Nutshell. Find one with 'List leads'.
- Name (`name`, text): A new name. Leave empty to keep it.
- Value (`value`, text): A new value, such as 1500. Leave empty to keep it.
- Owner (`owner_id`, text): A new owner. Leave empty to keep it.
- Add person (`add_contact_id`, text): The person's Nutshell id (such as 12-contacts), the number alone, or its address in Nutshell. Find one with 'List people'.
- Add company (`add_account_id`, text): The company's Nutshell id (such as 12-accounts), the number alone, or its address in Nutshell. Find one with 'List companies'.
- Custom fields (`custom_fields`, object): Values for your Nutshell custom fields, by the field's name, such as {"Favorite Number": "12"}.

**Outputs**

- `account_ids` (list): The ids of the companies on the lead
- `closed_at` (text): When it was closed; empty while open
- `confidence` (number): How likely it is to close, as a percentage
- `contact_ids` (list): The ids of the people on the lead
- `created_at` (text): When it was created (ISO 8601, UTC)
- `currency` (text): The value's currency code, such as USD
- `description` (text): The lead's description
- `due_at` (text): When it is due to close; empty if not set
- `id` (text): The lead's Nutshell id, such as 12-leads
- `is_hot` (true/false): Whether the lead is marked hot
- `is_overdue` (true/false): Whether the lead is past its due date
- `name` (text): The lead's name
- `number` (number): The lead number shown in Nutshell (Lead-1001)
- `owner_id` (text): The id of the user it's assigned to
- `source_ids` (list): The ids of the lead's sources
- `status` (text): Open, won, lost or cancelled
- `url` (text): The lead's page in Nutshell
- `value_amount` (text): The lead's value as a number, such as 1500.00
- `value_formatted` (text): The value as Nutshell shows it, such as $1,500.00

**Example output**

```json
{
  "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**

- Person (`contact_id`, text, required): The person's Nutshell id (such as 12-contacts), the number alone, or its address in Nutshell. Find one with 'List people'.
- Name (`name`, text): A new full name. Leave empty to keep it.
- Description (`description`, text): A new description. Leave empty to keep it.
- Add email (`add_email`, text): An email address to add to theirs.
- Add phone (`add_phone`, text): A phone number to add to theirs.
- Add company (`add_account_id`, text): The company's Nutshell id (such as 12-accounts), the number alone, or its address in Nutshell. Find one with 'List companies'.
- Owner (`owner_id`, text): A new owner. Leave empty to keep it.
- Custom fields (`custom_fields`, object): Values for your Nutshell custom fields, by the field's name, such as {"Favorite Number": "12"}.

**Outputs**

- `account_ids` (list): The ids of their companies
- `created_at` (text): When it was created (ISO 8601, UTC)
- `description` (text): The description shown under the name
- `email` (text): The primary email address
- `emails` (list): Every email address
- `first_name` (text): The given name
- `id` (text): The person's Nutshell id, such as 3-contacts
- `job_title` (text): Their role at their company
- `last_name` (text): The family name
- `lead_ids` (list): The ids of their leads
- `name` (text): The full name
- `owner_id` (text): The id of the user who owns it
- `phone` (text): The primary phone number
- `phones` (list): Every phone number
- `url` (text): Its page in Nutshell

**Example output**

```json
{
  "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"
}
```
