# Freshsales

> Work with your Freshsales CRM: create, find, update and delete contacts, accounts and deals, add notes, manage tasks and search across your records.

App · 26 actions. Web page: https://docs.lodol.com/docs/integrations/freshsales

## Actions

### Create account

Add a company to Freshsales.

**Inputs**

- Name (`name`, text, required): The account's name.
- Address (`address`, text): The account's street address.
- City (`city`, text): The account's city.
- State (`state`, text): The account's state or region.
- Postal code (`zipcode`, text): The account's postal code.
- Country (`country`, text): The account's country.
- Website (`website`, text): The account's website.
- Phone (`phone`, text): The account's phone number.
- Number of employees (`number_of_employees`, number): How many people work at the account. At least 0.
- Annual revenue (`annual_revenue`, number): The account's yearly revenue, as a number. At least 0.
- Industry (`industry_type_id`, text): The account's industry.
- Business type (`business_type_id`, text): The account's business type.
- Owner (`owner_id`, text): The user the account is assigned to. Pick one, or give an id.
- Custom fields (`custom_field`, object): Values for custom fields, keyed by the field's internal name, for example {"cf_plan": "Pro"}. Find the names under Admin settings > Fields in Freshsales.

**Outputs**

- `account` (object): The account created

**Example output**

```json
{
  "account": {
    "address": "1 Main Street",
    "annual_revenue": "1000000.0",
    "city": "Springfield",
    "country": "USA",
    "created_at": "2026-10-01T09:00:00Z",
    "custom_field": {},
    "id": 2001,
    "name": "Acme Inc",
    "number_of_employees": 51,
    "owner_id": 5001,
    "phone": "555 0100",
    "state": "IL",
    "updated_at": "2026-10-02T09:00:00Z",
    "website": "https://acme.example.com",
    "zipcode": "62701"
  }
}
```

### Create contact

Add a person to Freshsales. Give at least an email or a mobile number.

**Inputs**

- First name (`first_name`, text): The contact's first name.
- Last name (`last_name`, text): The contact's last name.
- Email (`email`, text): The contact's email address. Give an email or a mobile number.
- Job title (`job_title`, text): The contact's job title.
- Work phone (`work_number`, text): The contact's work phone number.
- Mobile phone (`mobile_number`, text): The contact's mobile phone number.
- Address (`address`, text): The contact's street address.
- City (`city`, text): The contact's city.
- State (`state`, text): The contact's state or region.
- Postal code (`zipcode`, text): The contact's postal code.
- Country (`country`, text): The contact's country.
- Owner (`owner_id`, text): The user the contact is assigned to. Pick one, or give an id.
- Lead source (`lead_source_id`, text): Where the contact came from.
- Contact status (`contact_status_id`, text): The contact's status.
- Lifecycle stage (`lifecycle_stage_id`, text): The contact's lifecycle stage.
- Account (`sales_account_id`, text): The account the contact works at, set as their primary account.
- Custom fields (`custom_field`, object): Values for custom fields, keyed by the field's internal name, for example {"cf_plan": "Pro"}. Find the names under Admin settings > Fields in Freshsales.

**Outputs**

- `contact` (object): The contact created

**Example output**

```json
{
  "contact": {
    "address": "1 Main Street",
    "city": "Springfield",
    "country": "USA",
    "created_at": "2026-10-01T09:00:00Z",
    "custom_field": {},
    "display_name": "Jo Bloggs",
    "email": "jo@example.com",
    "first_name": "Jo",
    "id": 1001,
    "job_title": "Buyer",
    "last_contacted": "2026-10-01T09:00:00Z",
    "last_name": "Bloggs",
    "lead_score": 12,
    "mobile_number": "555 0101",
    "open_deals_amount": "0.0",
    "owner_id": 5001,
    "state": "IL",
    "updated_at": "2026-10-02T09:00:00Z",
    "work_number": "555 0100",
    "zipcode": "62701"
  }
}
```

### Create deal

Add a sales opportunity for an account.

**Inputs**

- Name (`name`, text, required): The deal's name.
- Amount (`amount`, number, required): The deal's value, as a number. At least 0.
- Account (`sales_account_id`, text, required): The account the deal is for. Pick one, or give its id.
- Pipeline (`deal_pipeline_id`, text): The pipeline the deal is in. Leave empty for the default pipeline.
- Stage (`deal_stage_id`, text): The deal's stage. Stages are shown with their pipeline.
- Expected close date (`expected_close`, date): When the deal is expected to close.
- Probability (`probability`, number): The chance of winning the deal, 0 to 100 percent. From 0 to 100.
- Owner (`owner_id`, text): The user the deal is assigned to. Pick one, or give an id.
- Deal type (`deal_type_id`, text): The deal's type.
- Lead source (`lead_source_id`, text): Where the deal came from.
- Custom fields (`custom_field`, object): Values for custom fields, keyed by the field's internal name, for example {"cf_plan": "Pro"}. Find the names under Admin settings > Fields in Freshsales.

**Outputs**

- `deal` (object): The deal created

**Example output**

```json
{
  "deal": {
    "amount": "12000.0",
    "base_currency_amount": "12000.0",
    "closed_date": "2026-12-31",
    "created_at": "2026-10-01T09:00:00Z",
    "custom_field": {},
    "deal_pipeline_id": 6001,
    "deal_stage_id": 4001,
    "expected_close": "2026-12-31",
    "id": 3001,
    "name": "Acme renewal",
    "owner_id": 5001,
    "probability": 60,
    "sales_account_id": 2001,
    "updated_at": "2026-10-02T09:00:00Z"
  }
}
```

### Create note

Add a note to a contact, account or deal.

**Inputs**

- Note (`description`, text, required): The text of the note.
- About (`target_type`, text, required): What the record is attached to. One of: `Contact`, `SalesAccount` (Account), `Deal`.
- Contact, account or deal ID (`target_id`, text, required): The id of the contact, account or deal, from an earlier step.

**Outputs**

- `note` (object): The note created

**Example output**

```json
{
  "note": {
    "created_at": "2026-10-01T09:00:00Z",
    "description": "Called about the renewal.",
    "id": 7001,
    "updated_at": "2026-10-01T09:00:00Z"
  }
}
```

### Create task

Add a to-do for a user, about a contact, account or deal.

**Inputs**

- Title (`title`, text, required): What needs doing.
- Due (`due_date`, date and time, required): When the task is due.
- Assigned to (`owner_id`, text, required): The user who does the task. Pick one, or give an id.
- About (`target_type`, text, required): What the record is attached to. One of: `Contact`, `SalesAccount` (Account), `Deal`.
- Contact, account or deal ID (`target_id`, text, required): The id of the contact, account or deal, from an earlier step.
- Details (`description`, text): More about the task.

**Outputs**

- `task` (object): The task created

**Example output**

```json
{
  "task": {
    "created_at": "2026-10-01T09:00:00Z",
    "creater_id": 5001,
    "description": "Follow up after the call.",
    "due_date": "2026-10-20T14:00:00Z",
    "id": 8001,
    "owner_id": 5001,
    "status": 0,
    "title": "Send the proposal",
    "updated_at": "2026-10-01T09:00:00Z"
  }
}
```

### Delete account

Delete an account. Its contacts and deals are kept unless you ask for them to be deleted too.

**Inputs**

- Account (`account_id`, text, required): The account. Pick one, or give its id from an earlier step.
- Also delete its contacts and deals (`delete_contacts_and_deals`, true/false): Delete the contacts and deals attached to the account. Default: `false`.

**Outputs**

- `account_id` (text): The id of the account deleted
- `deleted` (true/false): Always true once deleted

**Example output**

```json
{
  "account_id": "2001",
  "deleted": true
}
```

### Delete contact

Delete a contact. Freshsales moves it to the recycle bin.

**Inputs**

- Contact ID (`contact_id`, text, required): The contact's id, from an earlier step.

**Outputs**

- `contact_id` (text): The id of the contact deleted
- `deleted` (true/false): Always true once deleted

**Example output**

```json
{
  "contact_id": "1001",
  "deleted": true
}
```

### Delete deal

Delete a deal.

**Inputs**

- Deal ID (`deal_id`, text, required): The deal's id, from an earlier step.

**Outputs**

- `deal_id` (text): The id of the deal deleted
- `deleted` (true/false): Always true once deleted

**Example output**

```json
{
  "deal_id": "3001",
  "deleted": true
}
```

### Delete note

Delete a note.

**Inputs**

- Note ID (`note_id`, text, required): The note's id, from 'Create note'.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `note_id` (text): The id of the note deleted

**Example output**

```json
{
  "deleted": true,
  "note_id": "7001"
}
```

### Delete task

Delete a task.

**Inputs**

- Task ID (`task_id`, text, required): The task's id, from 'Create task'.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `task_id` (text): The id of the task deleted

**Example output**

```json
{
  "deleted": true,
  "task_id": "8001"
}
```

### Find contacts by email

Find the contacts whose email address matches exactly.

**Inputs**

- Email (`email`, text, required): The email address to look for.
- Page size (`per_page`, number): How many to return per page, 1 to 100. Freshsales' default is 25. From 1 to 100.

**Outputs**

- `contacts` (list): The matching contacts
- `count` (number): How many records this page holds
- `has_more` (true/false): True when a later page has more records
- `page` (number): The page number returned
- `total` (number): How many records Freshsales reports in all

**Example output**

```json
{
  "contacts": [
    {
      "address": "1 Main Street",
      "city": "Springfield",
      "country": "USA",
      "created_at": "2026-10-01T09:00:00Z",
      "custom_field": {},
      "display_name": "Jo Bloggs",
      "email": "jo@example.com",
      "first_name": "Jo",
      "id": 1001,
      "job_title": "Buyer",
      "last_contacted": "2026-10-01T09:00:00Z",
      "last_name": "Bloggs",
      "lead_score": 12,
      "mobile_number": "555 0101",
      "open_deals_amount": "0.0",
      "owner_id": 5001,
      "state": "IL",
      "updated_at": "2026-10-02T09:00:00Z",
      "work_number": "555 0100",
      "zipcode": "62701"
    }
  ],
  "count": 1,
  "has_more": false,
  "page": 1,
  "total": 1
}
```

### Get account

Get one account by its id.

**Inputs**

- Account (`account_id`, text, required): The account. Pick one, or give its id from an earlier step.

**Outputs**

- `account` (object): The account

**Example output**

```json
{
  "account": {
    "address": "1 Main Street",
    "annual_revenue": "1000000.0",
    "city": "Springfield",
    "country": "USA",
    "created_at": "2026-10-01T09:00:00Z",
    "custom_field": {},
    "id": 2001,
    "name": "Acme Inc",
    "number_of_employees": 51,
    "owner_id": 5001,
    "phone": "555 0100",
    "state": "IL",
    "updated_at": "2026-10-02T09:00:00Z",
    "website": "https://acme.example.com",
    "zipcode": "62701"
  }
}
```

### Get contact

Get one contact by its id.

**Inputs**

- Contact ID (`contact_id`, text, required): The contact's id, from an earlier step.

**Outputs**

- `contact` (object): The contact

**Example output**

```json
{
  "contact": {
    "address": "1 Main Street",
    "city": "Springfield",
    "country": "USA",
    "created_at": "2026-10-01T09:00:00Z",
    "custom_field": {},
    "display_name": "Jo Bloggs",
    "email": "jo@example.com",
    "first_name": "Jo",
    "id": 1001,
    "job_title": "Buyer",
    "last_contacted": "2026-10-01T09:00:00Z",
    "last_name": "Bloggs",
    "lead_score": 12,
    "mobile_number": "555 0101",
    "open_deals_amount": "0.0",
    "owner_id": 5001,
    "state": "IL",
    "updated_at": "2026-10-02T09:00:00Z",
    "work_number": "555 0100",
    "zipcode": "62701"
  }
}
```

### Get deal

Get one deal by its id.

**Inputs**

- Deal ID (`deal_id`, text, required): The deal's id, from an earlier step.

**Outputs**

- `deal` (object): The deal

**Example output**

```json
{
  "deal": {
    "amount": "12000.0",
    "base_currency_amount": "12000.0",
    "closed_date": "2026-12-31",
    "created_at": "2026-10-01T09:00:00Z",
    "custom_field": {},
    "deal_pipeline_id": 6001,
    "deal_stage_id": 4001,
    "expected_close": "2026-12-31",
    "id": 3001,
    "name": "Acme renewal",
    "owner_id": 5001,
    "probability": 60,
    "sales_account_id": 2001,
    "updated_at": "2026-10-02T09:00:00Z"
  }
}
```

### Get task

Get one task by its id.

**Inputs**

- Task ID (`task_id`, text, required): The task's id, from 'Create task'.

**Outputs**

- `task` (object): The task

**Example output**

```json
{
  "task": {
    "created_at": "2026-10-01T09:00:00Z",
    "creater_id": 5001,
    "description": "Follow up after the call.",
    "due_date": "2026-10-20T14:00:00Z",
    "id": 8001,
    "owner_id": 5001,
    "status": 0,
    "title": "Send the proposal",
    "updated_at": "2026-10-01T09:00:00Z"
  }
}
```

### List accounts

List accounts a page at a time, from a saved view such as 'All Accounts'.

**Inputs**

- View (`view_id`, text): The saved view to list Accounts from. Defaults to the 'All Accounts' view.
- Sort by (`sort`, text): Which field to sort by. One of: `created_at` (Created), `updated_at` (Last updated).
- Order (`sort_type`, text): Which way to sort. Defaults to descending. One of: `asc` (Ascending), `desc` (Descending (default)).
- Page (`page`, number): Which page of results to return, starting at 1. From 1 to 1000.
- Page size (`per_page`, number): How many to return per page, 1 to 100. Freshsales' default is 25. From 1 to 100.

**Outputs**

- `count` (number): How many records this page holds
- `has_more` (true/false): True when a later page has more records
- `page` (number): The page number returned
- `sales_accounts` (list): The accounts
- `total` (number): How many records Freshsales reports in all
- `view_id` (text): The view listed

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "page": 1,
  "sales_accounts": [
    {
      "address": "1 Main Street",
      "annual_revenue": "1000000.0",
      "city": "Springfield",
      "country": "USA",
      "created_at": "2026-10-01T09:00:00Z",
      "custom_field": {},
      "id": 2001,
      "name": "Acme Inc",
      "number_of_employees": 51,
      "owner_id": 5001,
      "phone": "555 0100",
      "state": "IL",
      "updated_at": "2026-10-02T09:00:00Z",
      "website": "https://acme.example.com",
      "zipcode": "62701"
    }
  ],
  "total": 1,
  "view_id": "9002"
}
```

### List contacts

List contacts a page at a time, from a saved view such as 'All Contacts'.

**Inputs**

- View (`view_id`, text): The saved view to list Contacts from. Defaults to the 'All Contacts' view.
- Sort by (`sort`, text): Which field to sort by. One of: `created_at` (Created), `updated_at` (Last updated), `lead_score` (Lead score), `open_deals_amount` (Open deals amount), `last_contacted` (Last contacted).
- Order (`sort_type`, text): Which way to sort. Defaults to descending. One of: `asc` (Ascending), `desc` (Descending (default)).
- Page (`page`, number): Which page of results to return, starting at 1. From 1 to 1000.
- Page size (`per_page`, number): How many to return per page, 1 to 100. Freshsales' default is 25. From 1 to 100.

**Outputs**

- `contacts` (list): The contacts
- `count` (number): How many records this page holds
- `has_more` (true/false): True when a later page has more records
- `page` (number): The page number returned
- `total` (number): How many records Freshsales reports in all
- `view_id` (text): The view listed

**Example output**

```json
{
  "contacts": [
    {
      "address": "1 Main Street",
      "city": "Springfield",
      "country": "USA",
      "created_at": "2026-10-01T09:00:00Z",
      "custom_field": {},
      "display_name": "Jo Bloggs",
      "email": "jo@example.com",
      "first_name": "Jo",
      "id": 1001,
      "job_title": "Buyer",
      "last_contacted": "2026-10-01T09:00:00Z",
      "last_name": "Bloggs",
      "lead_score": 12,
      "mobile_number": "555 0101",
      "open_deals_amount": "0.0",
      "owner_id": 5001,
      "state": "IL",
      "updated_at": "2026-10-02T09:00:00Z",
      "work_number": "555 0100",
      "zipcode": "62701"
    }
  ],
  "count": 1,
  "has_more": false,
  "page": 1,
  "total": 1,
  "view_id": "9001"
}
```

### List deals

List deals a page at a time, from a saved view such as 'All Deals'.

**Inputs**

- View (`view_id`, text): The saved view to list Deals from. Defaults to the 'All Deals' view.
- Sort by (`sort`, text): Which field to sort by. One of: `created_at` (Created), `updated_at` (Last updated).
- Order (`sort_type`, text): Which way to sort. Defaults to descending. One of: `asc` (Ascending), `desc` (Descending (default)).
- Page (`page`, number): Which page of results to return, starting at 1. From 1 to 1000.
- Page size (`per_page`, number): How many to return per page, 1 to 100. Freshsales' default is 25. From 1 to 100.

**Outputs**

- `count` (number): How many records this page holds
- `deals` (list): The deals
- `has_more` (true/false): True when a later page has more records
- `page` (number): The page number returned
- `total` (number): How many records Freshsales reports in all
- `view_id` (text): The view listed

**Example output**

```json
{
  "count": 1,
  "deals": [
    {
      "amount": "12000.0",
      "base_currency_amount": "12000.0",
      "closed_date": "2026-12-31",
      "created_at": "2026-10-01T09:00:00Z",
      "custom_field": {},
      "deal_pipeline_id": 6001,
      "deal_stage_id": 4001,
      "expected_close": "2026-12-31",
      "id": 3001,
      "name": "Acme renewal",
      "owner_id": 5001,
      "probability": 60,
      "sales_account_id": 2001,
      "updated_at": "2026-10-02T09:00:00Z"
    }
  ],
  "has_more": false,
  "page": 1,
  "total": 1,
  "view_id": "9003"
}
```

### List tasks

List tasks that are open, due today or tomorrow, overdue or completed.

**Inputs**

- Which tasks (`filter`, text): Which tasks to list. Defaults to open tasks. One of: `open` (Open (default)), `due_today` (Due today), `due_tomorrow` (Due tomorrow), `overdue`, `completed`.
- Page (`page`, number): Which page of results to return, starting at 1. From 1 to 1000.
- Page size (`per_page`, number): How many to return per page, 1 to 100. Freshsales' default is 25. From 1 to 100.

**Outputs**

- `count` (number): How many records this page holds
- `has_more` (true/false): True when a later page has more records
- `page` (number): The page number returned
- `tasks` (list): The tasks
- `total` (number): How many records Freshsales reports in all

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "page": 1,
  "tasks": [
    {
      "created_at": "2026-10-01T09:00:00Z",
      "creater_id": 5001,
      "description": "Follow up after the call.",
      "due_date": "2026-10-20T14:00:00Z",
      "id": 8001,
      "owner_id": 5001,
      "status": 0,
      "title": "Send the proposal",
      "updated_at": "2026-10-01T09:00:00Z"
    }
  ],
  "total": 1
}
```

### List users

List the users in the Freshsales account with their ids, to assign records and tasks to.

**Inputs**: None.

**Outputs**

- `count` (number): How many users
- `users` (list): The account's users

**Example output**

```json
{
  "count": 1,
  "users": [
    {
      "email": "sam@example.com",
      "id": 5001,
      "name": "Sam Seller"
    }
  ]
}
```

### Search records

Search contacts, accounts, deals and users by name or email. Each result says what kind of record it is.

**Inputs**

- Search for (`query`, text, required): The name or email to look for.
- Look in (`entities`, list): Which kinds of record to search. Defaults to contacts, accounts and deals. One or more of: `contact` (Contacts), `sales_account` (Accounts), `deal` (Deals), `user` (Users).
- Page size (`per_page`, number): How many to return per page, 1 to 100. Freshsales' default is 25. From 1 to 100.

**Outputs**

- `count` (number): How many matched
- `results` (list): The matching records

**Example output**

```json
{
  "count": 1,
  "results": [
    {
      "email": "jo@example.com",
      "id": "1001",
      "name": "Jo Bloggs",
      "type": "contact"
    }
  ]
}
```

### Update account

Change an account. Only the fields you fill in are changed; empty fields are left as they are.

**Inputs**

- Account (`account_id`, text, required): The account. Pick one, or give its id from an earlier step.
- Name (`name`, text): The account's new name.
- Address (`address`, text): The account's street address.
- City (`city`, text): The account's city.
- State (`state`, text): The account's state or region.
- Postal code (`zipcode`, text): The account's postal code.
- Country (`country`, text): The account's country.
- Website (`website`, text): The account's website.
- Phone (`phone`, text): The account's phone number.
- Number of employees (`number_of_employees`, number): How many people work at the account. At least 0.
- Annual revenue (`annual_revenue`, number): The account's yearly revenue, as a number. At least 0.
- Industry (`industry_type_id`, text): The account's industry.
- Business type (`business_type_id`, text): The account's business type.
- Owner (`owner_id`, text): The user the account is assigned to. Pick one, or give an id.
- Custom fields (`custom_field`, object): Values for custom fields, keyed by the field's internal name, for example {"cf_plan": "Pro"}. Find the names under Admin settings > Fields in Freshsales.

**Outputs**

- `account` (object): The account, as updated

**Example output**

```json
{
  "account": {
    "address": "1 Main Street",
    "annual_revenue": "1000000.0",
    "city": "Springfield",
    "country": "USA",
    "created_at": "2026-10-01T09:00:00Z",
    "custom_field": {},
    "id": 2001,
    "name": "Acme Inc",
    "number_of_employees": 51,
    "owner_id": 5001,
    "phone": "555 0100",
    "state": "IL",
    "updated_at": "2026-10-02T09:00:00Z",
    "website": "https://acme.example.com",
    "zipcode": "62701"
  }
}
```

### Update contact

Change a contact. Only the fields you fill in are changed; empty fields are left as they are.

**Inputs**

- Contact ID (`contact_id`, text, required): The contact's id, from an earlier step.
- First name (`first_name`, text): The contact's first name.
- Last name (`last_name`, text): The contact's last name.
- Email (`email`, text): The contact's email address.
- Job title (`job_title`, text): The contact's job title.
- Work phone (`work_number`, text): The contact's work phone number.
- Mobile phone (`mobile_number`, text): The contact's mobile phone number.
- Address (`address`, text): The contact's street address.
- City (`city`, text): The contact's city.
- State (`state`, text): The contact's state or region.
- Postal code (`zipcode`, text): The contact's postal code.
- Country (`country`, text): The contact's country.
- Owner (`owner_id`, text): The user the contact is assigned to. Pick one, or give an id.
- Lead source (`lead_source_id`, text): Where the contact came from.
- Contact status (`contact_status_id`, text): The contact's status.
- Lifecycle stage (`lifecycle_stage_id`, text): The contact's lifecycle stage.
- Account (`sales_account_id`, text): The account the contact works at, set as their primary account.
- Custom fields (`custom_field`, object): Values for custom fields, keyed by the field's internal name, for example {"cf_plan": "Pro"}. Find the names under Admin settings > Fields in Freshsales.

**Outputs**

- `contact` (object): The contact, as updated

**Example output**

```json
{
  "contact": {
    "address": "1 Main Street",
    "city": "Springfield",
    "country": "USA",
    "created_at": "2026-10-01T09:00:00Z",
    "custom_field": {},
    "display_name": "Jo Bloggs",
    "email": "jo@example.com",
    "first_name": "Jo",
    "id": 1001,
    "job_title": "Buyer",
    "last_contacted": "2026-10-01T09:00:00Z",
    "last_name": "Bloggs",
    "lead_score": 12,
    "mobile_number": "555 0101",
    "open_deals_amount": "0.0",
    "owner_id": 5001,
    "state": "IL",
    "updated_at": "2026-10-02T09:00:00Z",
    "work_number": "555 0100",
    "zipcode": "62701"
  }
}
```

### Update deal

Change a deal, such as moving it to another stage. Only the fields you fill in are changed; empty fields are left as they are.

**Inputs**

- Deal ID (`deal_id`, text, required): The deal's id, from an earlier step.
- Name (`name`, text): The deal's new name.
- Amount (`amount`, number): The deal's value, as a number. At least 0.
- Account (`sales_account_id`, text): The account the deal is for. Pick one, or give its id.
- Pipeline (`deal_pipeline_id`, text): The pipeline the deal is in. Leave empty for the default pipeline.
- Stage (`deal_stage_id`, text): The deal's stage. Stages are shown with their pipeline.
- Expected close date (`expected_close`, date): When the deal is expected to close.
- Probability (`probability`, number): The chance of winning the deal, 0 to 100 percent. From 0 to 100.
- Owner (`owner_id`, text): The user the deal is assigned to. Pick one, or give an id.
- Deal type (`deal_type_id`, text): The deal's type.
- Lead source (`lead_source_id`, text): Where the deal came from.
- Custom fields (`custom_field`, object): Values for custom fields, keyed by the field's internal name, for example {"cf_plan": "Pro"}. Find the names under Admin settings > Fields in Freshsales.

**Outputs**

- `deal` (object): The deal, as updated

**Example output**

```json
{
  "deal": {
    "amount": "12000.0",
    "base_currency_amount": "12000.0",
    "closed_date": "2026-12-31",
    "created_at": "2026-10-01T09:00:00Z",
    "custom_field": {},
    "deal_pipeline_id": 6001,
    "deal_stage_id": 4001,
    "expected_close": "2026-12-31",
    "id": 3001,
    "name": "Acme renewal",
    "owner_id": 5001,
    "probability": 60,
    "sales_account_id": 2001,
    "updated_at": "2026-10-02T09:00:00Z"
  }
}
```

### Update note

Replace the text of a note.

**Inputs**

- Note ID (`note_id`, text, required): The note's id, from 'Create note'.
- Note (`description`, text, required): The new text of the note.

**Outputs**

- `note` (object): The note, as updated

**Example output**

```json
{
  "note": {
    "created_at": "2026-10-01T09:00:00Z",
    "description": "Called about the renewal.",
    "id": 7001,
    "updated_at": "2026-10-01T09:00:00Z"
  }
}
```

### Update task

Change a task, or mark it open or completed. Only the fields you fill in are changed.

**Inputs**

- Task ID (`task_id`, text, required): The task's id, from 'Create task'.
- Title (`title`, text): The task's new title.
- Due (`due_date`, date and time): The task's new due time.
- Assigned to (`owner_id`, text): The user who does the task. Pick one, or give an id.
- Details (`description`, text): The task's new details.
- Status (`status`, text): Mark the task open or completed. One of: `open`, `completed`.

**Outputs**

- `task` (object): The task, as updated

**Example output**

```json
{
  "task": {
    "created_at": "2026-10-01T09:00:00Z",
    "creater_id": 5001,
    "description": "Follow up after the call.",
    "due_date": "2026-10-20T14:00:00Z",
    "id": 8001,
    "owner_id": 5001,
    "status": 0,
    "title": "Send the proposal",
    "updated_at": "2026-10-01T09:00:00Z"
  }
}
```
