Freshsales
App · 26 actions
Work with your Freshsales CRM: create, find, update and delete contacts, accounts and deals, add notes, manage tasks and search across your records.
Actions
| Action | What it does |
|---|---|
| Create account | Add a company to Freshsales. |
| Create contact | Add a person to Freshsales. |
| Create deal | Add a sales opportunity for an account. |
| Create note | Add a note to a contact, account or deal. |
| Create task | Add a to-do for a user, about a contact, account or deal. |
| Delete account | Delete an account. |
| Delete contact | Delete a contact. |
| Delete deal | Delete a deal. |
| Delete note | Delete a note. |
| Delete task | Delete a task. |
| Find contacts by email | Find the contacts whose email address matches exactly. |
| Get account | Get one account by its id. |
| Get contact | Get one contact by its id. |
| Get deal | Get one deal by its id. |
| Get task | Get one task by its id. |
| List accounts | List accounts a page at a time, from a saved view such as 'All Accounts'. |
| List contacts | List contacts a page at a time, from a saved view such as 'All Contacts'. |
| List deals | List deals a page at a time, from a saved view such as 'All Deals'. |
| List tasks | List tasks that are open, due today or tomorrow, overdue or completed. |
| List users | List the users in the Freshsales account with their ids, to assign records and tasks to. |
| Search records | Search contacts, accounts, deals and users by name or email. |
| Update account | Change an account. |
| Update contact | Change a contact. |
| Update deal | Change a deal, such as moving it to another stage. |
| Update note | Replace the text of a note. |
| Update task | Change a task, or mark it open or completed. |
Create account
Add a company to Freshsales.
Inputs
- Name
nametextRequired - The account's name.
- Address
addresstext - The account's street address.
- City
citytext - The account's city.
- State
statetext - The account's state or region.
- Postal code
zipcodetext - The account's postal code.
- Country
countrytext - The account's country.
- Website
websitetext - The account's website.
- Phone
phonetext - The account's phone number.
- Number of employees
number_of_employeesnumber - How many people work at the account.At least 0.
- Annual revenue
annual_revenuenumber - The account's yearly revenue, as a number.At least 0.
- Industry
industry_type_idtext - The account's industry.
- Business type
business_type_idtext - The account's business type.
- Owner
owner_idtext - The user the account is assigned to. Pick one, or give an id.
- Custom fields
custom_fieldobject - 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
accountobject- The account created
Example output
{
"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_nametext - The contact's first name.
- Last name
last_nametext - The contact's last name.
- Email
emailtext - The contact's email address. Give an email or a mobile number.
- Job title
job_titletext - The contact's job title.
- Work phone
work_numbertext - The contact's work phone number.
- Mobile phone
mobile_numbertext - The contact's mobile phone number.
- Address
addresstext - The contact's street address.
- City
citytext - The contact's city.
- State
statetext - The contact's state or region.
- Postal code
zipcodetext - The contact's postal code.
- Country
countrytext - The contact's country.
- Owner
owner_idtext - The user the contact is assigned to. Pick one, or give an id.
- Lead source
lead_source_idtext - Where the contact came from.
- Contact status
contact_status_idtext - The contact's status.
- Lifecycle stage
lifecycle_stage_idtext - The contact's lifecycle stage.
- Account
sales_account_idtext - The account the contact works at, set as their primary account.
- Custom fields
custom_fieldobject - 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
contactobject- The contact created
Example output
{
"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
nametextRequired - The deal's name.
- Amount
amountnumberRequired - The deal's value, as a number.At least 0.
- Account
sales_account_idtextRequired - The account the deal is for. Pick one, or give its id.
- Pipeline
deal_pipeline_idtext - The pipeline the deal is in. Leave empty for the default pipeline.
- Stage
deal_stage_idtext - The deal's stage. Stages are shown with their pipeline.
- Expected close date
expected_closedate - When the deal is expected to close.
- Probability
probabilitynumber - The chance of winning the deal, 0 to 100 percent.From 0 to 100.
- Owner
owner_idtext - The user the deal is assigned to. Pick one, or give an id.
- Deal type
deal_type_idtext - The deal's type.
- Lead source
lead_source_idtext - Where the deal came from.
- Custom fields
custom_fieldobject - 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
dealobject- The deal created
Example output
{
"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
descriptiontextRequired - The text of the note.
- About
target_typetextRequired - What the record is attached to.One of:
Contact,SalesAccount(Account),Deal. - Contact, account or deal ID
target_idtextRequired - The id of the contact, account or deal, from an earlier step.
Outputs
noteobject- The note created
Example output
{
"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
titletextRequired - What needs doing.
- Due
due_datedate and timeRequired - When the task is due.
- Assigned to
owner_idtextRequired - The user who does the task. Pick one, or give an id.
- About
target_typetextRequired - What the record is attached to.One of:
Contact,SalesAccount(Account),Deal. - Contact, account or deal ID
target_idtextRequired - The id of the contact, account or deal, from an earlier step.
- Details
descriptiontext - More about the task.
Outputs
taskobject- The task created
Example output
{
"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_idtextRequired - The account. Pick one, or give its id from an earlier step.
- Also delete its contacts and deals
delete_contacts_and_dealstrue/false - Delete the contacts and deals attached to the account.Default:
false.
Outputs
account_idtext- The id of the account deleted
deletedtrue/false- Always true once deleted
Example output
{
"account_id": "2001",
"deleted": true
}Delete contact
Delete a contact. Freshsales moves it to the recycle bin.
Inputs
- Contact ID
contact_idtextRequired - The contact's id, from an earlier step.
Outputs
contact_idtext- The id of the contact deleted
deletedtrue/false- Always true once deleted
Example output
{
"contact_id": "1001",
"deleted": true
}Delete deal
Delete a deal.
Inputs
- Deal ID
deal_idtextRequired - The deal's id, from an earlier step.
Outputs
deal_idtext- The id of the deal deleted
deletedtrue/false- Always true once deleted
Example output
{
"deal_id": "3001",
"deleted": true
}Delete note
Delete a note.
Inputs
- Note ID
note_idtextRequired - The note's id, from 'Create note'.
Outputs
deletedtrue/false- Always true once deleted
note_idtext- The id of the note deleted
Example output
{
"deleted": true,
"note_id": "7001"
}Delete task
Delete a task.
Inputs
- Task ID
task_idtextRequired - The task's id, from 'Create task'.
Outputs
deletedtrue/false- Always true once deleted
task_idtext- The id of the task deleted
Example output
{
"deleted": true,
"task_id": "8001"
}Find contacts by email
Find the contacts whose email address matches exactly.
Inputs
- Email
emailtextRequired - The email address to look for.
- Page size
per_pagenumber - How many to return per page, 1 to 100. Freshsales' default is 25.From 1 to 100.
Outputs
contactslist- The matching contacts
countnumber- How many records this page holds
has_moretrue/false- True when a later page has more records
pagenumber- The page number returned
totalnumber- How many records Freshsales reports in all
Example output
{
"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_idtextRequired - The account. Pick one, or give its id from an earlier step.
Outputs
accountobject- The account
Example output
{
"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_idtextRequired - The contact's id, from an earlier step.
Outputs
contactobject- The contact
Example output
{
"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_idtextRequired - The deal's id, from an earlier step.
Outputs
dealobject- The deal
Example output
{
"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_idtextRequired - The task's id, from 'Create task'.
Outputs
taskobject- The task
Example output
{
"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_idtext - The saved view to list Accounts from. Defaults to the 'All Accounts' view.
- Sort by
sorttext - Which field to sort by.One of:
created_at(Created),updated_at(Last updated). - Order
sort_typetext - Which way to sort. Defaults to descending.One of:
asc(Ascending),desc(Descending (default)). - Page
pagenumber - Which page of results to return, starting at 1.From 1 to 1000.
- Page size
per_pagenumber - How many to return per page, 1 to 100. Freshsales' default is 25.From 1 to 100.
Outputs
countnumber- How many records this page holds
has_moretrue/false- True when a later page has more records
pagenumber- The page number returned
sales_accountslist- The accounts
totalnumber- How many records Freshsales reports in all
view_idtext- The view listed
Example output
{
"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_idtext - The saved view to list Contacts from. Defaults to the 'All Contacts' view.
- Sort by
sorttext - 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_typetext - Which way to sort. Defaults to descending.One of:
asc(Ascending),desc(Descending (default)). - Page
pagenumber - Which page of results to return, starting at 1.From 1 to 1000.
- Page size
per_pagenumber - How many to return per page, 1 to 100. Freshsales' default is 25.From 1 to 100.
Outputs
contactslist- The contacts
countnumber- How many records this page holds
has_moretrue/false- True when a later page has more records
pagenumber- The page number returned
totalnumber- How many records Freshsales reports in all
view_idtext- The view listed
Example output
{
"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_idtext - The saved view to list Deals from. Defaults to the 'All Deals' view.
- Sort by
sorttext - Which field to sort by.One of:
created_at(Created),updated_at(Last updated). - Order
sort_typetext - Which way to sort. Defaults to descending.One of:
asc(Ascending),desc(Descending (default)). - Page
pagenumber - Which page of results to return, starting at 1.From 1 to 1000.
- Page size
per_pagenumber - How many to return per page, 1 to 100. Freshsales' default is 25.From 1 to 100.
Outputs
countnumber- How many records this page holds
dealslist- The deals
has_moretrue/false- True when a later page has more records
pagenumber- The page number returned
totalnumber- How many records Freshsales reports in all
view_idtext- The view listed
Example output
{
"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
filtertext - Which tasks to list. Defaults to open tasks.One of:
open(Open (default)),due_today(Due today),due_tomorrow(Due tomorrow),overdue,completed. - Page
pagenumber - Which page of results to return, starting at 1.From 1 to 1000.
- Page size
per_pagenumber - How many to return per page, 1 to 100. Freshsales' default is 25.From 1 to 100.
Outputs
countnumber- How many records this page holds
has_moretrue/false- True when a later page has more records
pagenumber- The page number returned
taskslist- The tasks
totalnumber- How many records Freshsales reports in all
Example output
{
"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
countnumber- How many users
userslist- The account's users
Example output
{
"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
querytextRequired - The name or email to look for.
- Look in
entitieslist - 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_pagenumber - How many to return per page, 1 to 100. Freshsales' default is 25.From 1 to 100.
Outputs
countnumber- How many matched
resultslist- The matching records
Example output
{
"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_idtextRequired - The account. Pick one, or give its id from an earlier step.
- Name
nametext - The account's new name.
- Address
addresstext - The account's street address.
- City
citytext - The account's city.
- State
statetext - The account's state or region.
- Postal code
zipcodetext - The account's postal code.
- Country
countrytext - The account's country.
- Website
websitetext - The account's website.
- Phone
phonetext - The account's phone number.
- Number of employees
number_of_employeesnumber - How many people work at the account.At least 0.
- Annual revenue
annual_revenuenumber - The account's yearly revenue, as a number.At least 0.
- Industry
industry_type_idtext - The account's industry.
- Business type
business_type_idtext - The account's business type.
- Owner
owner_idtext - The user the account is assigned to. Pick one, or give an id.
- Custom fields
custom_fieldobject - 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
accountobject- The account, as updated
Example output
{
"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_idtextRequired - The contact's id, from an earlier step.
- First name
first_nametext - The contact's first name.
- Last name
last_nametext - The contact's last name.
- Email
emailtext - The contact's email address.
- Job title
job_titletext - The contact's job title.
- Work phone
work_numbertext - The contact's work phone number.
- Mobile phone
mobile_numbertext - The contact's mobile phone number.
- Address
addresstext - The contact's street address.
- City
citytext - The contact's city.
- State
statetext - The contact's state or region.
- Postal code
zipcodetext - The contact's postal code.
- Country
countrytext - The contact's country.
- Owner
owner_idtext - The user the contact is assigned to. Pick one, or give an id.
- Lead source
lead_source_idtext - Where the contact came from.
- Contact status
contact_status_idtext - The contact's status.
- Lifecycle stage
lifecycle_stage_idtext - The contact's lifecycle stage.
- Account
sales_account_idtext - The account the contact works at, set as their primary account.
- Custom fields
custom_fieldobject - 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
contactobject- The contact, as updated
Example output
{
"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_idtextRequired - The deal's id, from an earlier step.
- Name
nametext - The deal's new name.
- Amount
amountnumber - The deal's value, as a number.At least 0.
- Account
sales_account_idtext - The account the deal is for. Pick one, or give its id.
- Pipeline
deal_pipeline_idtext - The pipeline the deal is in. Leave empty for the default pipeline.
- Stage
deal_stage_idtext - The deal's stage. Stages are shown with their pipeline.
- Expected close date
expected_closedate - When the deal is expected to close.
- Probability
probabilitynumber - The chance of winning the deal, 0 to 100 percent.From 0 to 100.
- Owner
owner_idtext - The user the deal is assigned to. Pick one, or give an id.
- Deal type
deal_type_idtext - The deal's type.
- Lead source
lead_source_idtext - Where the deal came from.
- Custom fields
custom_fieldobject - 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
dealobject- The deal, as updated
Example output
{
"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_idtextRequired - The note's id, from 'Create note'.
- Note
descriptiontextRequired - The new text of the note.
Outputs
noteobject- The note, as updated
Example output
{
"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_idtextRequired - The task's id, from 'Create task'.
- Title
titletext - The task's new title.
- Due
due_datedate and time - The task's new due time.
- Assigned to
owner_idtext - The user who does the task. Pick one, or give an id.
- Details
descriptiontext - The task's new details.
- Status
statustext - Mark the task open or completed.One of:
open,completed.
Outputs
taskobject- The task, as updated
Example output
{
"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"
}
}