EspoCRM
App · 25 actions
Keep EspoCRM, the open-source CRM, up to date: add and update leads and contacts from forms and sign-ups, convert leads, move opportunities through the pipeline, log calls, add tasks and notes, and open cases. Start a workflow when a lead, contact, opportunity or case is added, or a deal changes stage.
Actions
| Action | What it does |
|---|---|
| Add note | Post a note to the stream of an account, contact, lead, opportunity or case, where everyone following it sees it. |
| Convert lead | Turn a qualified lead into a contact, an account (if the lead has an account name) and, if you name one, an opportunity, as EspoCRM's Convert button does. |
| Create account | Add an account: a company or organisation you work with. |
| Create case | Open a support case for an account or contact, such as from a form or an email. |
| Create contact | Add a contact to EspoCRM, even if one with the same name or email exists; use 'Create or update contact' to avoid that. |
| Create lead | Add a lead to EspoCRM, even if one with the same name or email exists; use 'Create or update lead' for forms and sign-ups. |
| Create opportunity | Add an opportunity (a deal) to the pipeline, with its amount, close date, stage, account and contact. |
| Create or update contact | Update the contact with this email, or add one if none has it. |
| Create or update lead | Update the lead with this email, or add one if none has it, such as for a form or sign-up. |
| Create task | Add a task for someone, with a due date, about an account, contact, lead, opportunity or case. |
| Delete record | Delete a lead, contact, account, opportunity, case, task or call. |
| Find accounts | Find accounts by name, website or email, newest first. |
| Find contacts | Find contacts by email, name or account, newest first. |
| Find leads | Find leads by email, name, status or source, newest first. |
| Find opportunities | Find opportunities by name, stage or account, newest first. |
| Get account | Get an account's details. |
| Get contact | Get a contact's details, with their account's name. |
| Get lead | Get a lead's details, and what it was converted into. |
| Get opportunity | Get an opportunity's details, with its stage, account and contact. |
| List users | List the active users records can be assigned to, with their user names and emails. |
| Log call | Record a call someone made or took, about an account, contact, lead, opportunity or case. |
| Update account | Change an account's details. |
| Update contact | Change a contact's details. |
| Update lead | Change a lead, such as its status. |
| Update opportunity | Change an opportunity, such as moving it to another stage. |
Add note
Post a note to the stream of an account, contact, lead, opportunity or case, where everyone following it sees it.
Inputs
- Related to
related_to_typetext - What kind of record it's about. Not needed when Record is a link to it.One of:
account,contact,lead,opportunity,case. - Record
related_totextRequired - The ID of the account, contact, lead, opportunity or case it's about, or a link to it in EspoCRM.
- Text
texttextRequired - What the note says. Markdown, such as **bold**, is kept.
Outputs
created_attext- When it was posted (ISO 8601, UTC)
idtext- The note's ID
linktext- A link to the record it's on, in EspoCRM
related_idtext- The ID of the record it's about
related_nametext- That record's name
related_typetext- What it's about: account, contact, lead, opportunity or case; empty if none
texttext- What it says
Example output
{
"created_at": "2026-11-05T09:40:00Z",
"id": "6aeca609ce0728cd5",
"link": "https://crm.example.com/#Opportunity/view/6aeca65cbcda4c086",
"related_id": "6aeca65cbcda4c086",
"related_name": "Analytical Engines renewal",
"related_type": "opportunity",
"text": "Wants a quote for 40 seats by Friday."
}Convert lead
Turn a qualified lead into a contact, an account (if the lead has an account name) and, if you name one, an opportunity, as EspoCRM's Convert button does.
Inputs
- Lead
leadtextRequired - The lead's ID, from another EspoCRM step or the trigger, or a link to it in EspoCRM.
- Opportunity name
opportunity_nametext - Name an opportunity to add one too. Leave blank for none.
- Opportunity amount
opportunity_amountnumber - What the opportunity is worth. Leave blank for the lead's Opportunity Amount.At least 0.
- Close date
close_datedate - When the opportunity is expected to close.
Outputs
account_idtext- The account it became; empty if the lead had no account name
account_linktext- A link to the account; empty if none
contact_idtext- The contact it became
contact_linktext- A link to the contact in EspoCRM
lead_idtext- The lead's ID
opportunity_idtext- The opportunity it became; empty if none was asked for
opportunity_linktext- A link to the opportunity; empty if none
statustext- The lead's status now: Converted
Example output
{
"account_id": "6aeca65caff8e7fcc",
"account_link": "https://crm.example.com/#Account/view/6aeca65caff8e7fcc",
"contact_id": "6aeca65cb55c304f8",
"contact_link": "https://crm.example.com/#Contact/view/6aeca65cb55c304f8",
"lead_id": "6aeca603c5e5ee841",
"opportunity_id": "6aeca65cbcda4c086",
"opportunity_link": "https://crm.example.com/#Opportunity/view/6aeca65cbcda4c086",
"status": "Converted"
}Create account
Add an account: a company or organisation you work with.
Inputs
- Name
nametextRequired - What the account is called.
- Website
websitetext - Its website, such as https://acme.com.
- Email
emailtext - Its email address.
- Phone
phonetext - Its phone number with its country code.
- Type
account_typetext - What it is to you.One of:
Customer,Investor,Partner,Reseller. - Street
streettext - Its billing street address.
- City
citytext - Its billing city.
- State
statetext - Its billing state or region.
- Postal code
postal_codetext - Its billing postal code or ZIP code.
- Country
countrytext - Its billing country.
- Description
descriptiontext - More about it, shown in EspoCRM.
- Assigned user
assigned_usertext - The user the account is assigned to, or their user name or email.
- Team
teamtext - A team to add it to, which decides who else can see it in EspoCRM.
- Other fields
custom_fieldsobject - Any other fields by their name in EspoCRM, such as {"industry": "Software"}. Fields an administrator added start with c, such as {"cLeadScore": 80}; their names are under Administration > Entity Manager > Fields.
Outputs
assigned_user_idtext- The ID of the user it's assigned to; empty if none
assigned_user_nametext- Their name
citytext- City
countrytext- Country
created_attext- When it was added to EspoCRM (ISO 8601, UTC)
custom_fieldsobject- Fields an administrator added, by their API name, as EspoCRM gives them
descriptiontext- The account's description
emailtext- Its primary email
idtext- The account's ID
industrytext- Its industry
linktext- A link to it in EspoCRM
modified_attext- When it last changed (ISO 8601, UTC)
nametext- Its name
phonetext- Its primary phone number
postal_codetext- Postal code or ZIP code
statetext- State or region
streettext- Street
typetext- What it is to you, such as Customer or Partner
websitetext- Its website
Example output
{
"assigned_user_id": "6aeca42d024294e09",
"assigned_user_name": "Grace Hopper",
"city": "London",
"country": "United Kingdom",
"created_at": "2026-11-05T09:00:00Z",
"custom_fields": {},
"description": "",
"email": "hello@analytical.example.com",
"id": "6aeca65caff8e7fcc",
"industry": "Software",
"link": "https://crm.example.com/#Account/view/6aeca65caff8e7fcc",
"modified_at": "2026-11-05T09:00:00Z",
"name": "Analytical Engines",
"phone": "+442079460000",
"postal_code": "NW1 5LR",
"state": "",
"street": "12 Marylebone Road",
"type": "Customer",
"website": "https://analytical.example.com"
}Create case
Open a support case for an account or contact, such as from a form or an email.
Inputs
- Name
nametextRequired - What the case is about.
- Description
descriptiontext - The details, such as the customer's message.
- Account
accounttext - The account's ID, from another EspoCRM step or the trigger, or a link to it in EspoCRM.
- Contact
contacttext - The contact's ID, from another EspoCRM step or the trigger, or a link to it in EspoCRM.
- Status
statustext - Where it stands. Leave blank for New.One of:
New,Assigned,Pending,Closed,Rejected,Duplicate. - Priority
prioritytext - How urgent it is. Leave blank for Normal.One of:
Low,Normal,High,Urgent. - Type
case_typetext - What kind of case it is.One of:
Question,Incident,Problem. - Assigned user
assigned_usertext - The user the case is assigned to, or their user name or email.
- Team
teamtext - A team to add it to, which decides who else can see it in EspoCRM.
- Other fields
custom_fieldsobject - Any other fields by their name in EspoCRM, such as {"industry": "Software"}. Fields an administrator added start with c, such as {"cLeadScore": 80}; their names are under Administration > Entity Manager > Fields.
Outputs
account_idtext- The account's ID; empty if none
account_nametext- The account's name
assigned_user_idtext- The ID of the user it's assigned to; empty if none
assigned_user_nametext- Their name
contact_idtext- The contact's ID; empty if none
contact_nametext- The contact's name
created_attext- When it was added to EspoCRM (ISO 8601, UTC)
custom_fieldsobject- Fields an administrator added, by their API name, as EspoCRM gives them
descriptiontext- The case's description
idtext- The case's ID
linktext- A link to it in EspoCRM
modified_attext- When it last changed (ISO 8601, UTC)
nametext- What it's about
numbernumber- The case's number, as EspoCRM shows it
prioritytext- Low, Normal, High or Urgent
statustext- Where it stands, such as New or Pending
typetext- Question, Incident or Problem; empty if not set
Example output
{
"account_id": "6aeca65caff8e7fcc",
"account_name": "Analytical Engines",
"assigned_user_id": "6aeca42d024294e09",
"assigned_user_name": "Grace Hopper",
"contact_id": "6aeca65cb55c304f8",
"contact_name": "Ada Lovelace",
"created_at": "2026-11-05T09:00:00Z",
"custom_fields": {},
"description": "The sign-in page says the password is wrong.",
"id": "6aeca7a1d2c9e1f0b",
"link": "https://crm.example.com/#Case/view/6aeca7a1d2c9e1f0b",
"modified_at": "2026-11-05T09:00:00Z",
"name": "Can't sign in",
"number": 42,
"priority": "High",
"status": "New",
"type": "Incident"
}Create contact
Add a contact to EspoCRM, even if one with the same name or email exists; use 'Create or update contact' to avoid that.
Inputs
- First name
first_nametext - Their first name.
- Last name
last_nametextRequired - Their last name. EspoCRM needs one for a new contact.
- Email
emailtext - Their email address.
- Phone
phonetext - Their phone number with its country code, such as +1 415 555 0134.
- Title
titletext - Their job title, such as Head of Sales.
- Account
accounttext - The account's ID, from another EspoCRM step or the trigger, or a link to it in EspoCRM.
- Street
streettext - Their street address.
- City
citytext - Their city.
- State
statetext - Their state or region.
- Postal code
postal_codetext - Their postal code or ZIP code.
- Country
countrytext - Their country.
- Description
descriptiontext - More about it, shown in EspoCRM.
- Assigned user
assigned_usertext - The user the contact is assigned to, or their user name or email.
- Team
teamtext - A team to add it to, which decides who else can see it in EspoCRM.
- Other fields
custom_fieldsobject - Any other fields by their name in EspoCRM, such as {"industry": "Software"}. Fields an administrator added start with c, such as {"cLeadScore": 80}; their names are under Administration > Entity Manager > Fields.
Outputs
account_idtext- Their account's ID; empty if none
account_nametext- Their account's name
assigned_user_idtext- The ID of the user it's assigned to; empty if none
assigned_user_nametext- Their name
citytext- City
countrytext- Country
created_attext- When it was added to EspoCRM (ISO 8601, UTC)
custom_fieldsobject- Fields an administrator added, by their API name, as EspoCRM gives them
descriptiontext- The contact's description
emailtext- Their primary email
first_nametext- Their first name
idtext- The contact's ID
last_nametext- Their last name
linktext- A link to it in EspoCRM
modified_attext- When it last changed (ISO 8601, UTC)
nametext- Their full name
phonetext- Their primary phone number
postal_codetext- Postal code or ZIP code
statetext- State or region
streettext- Street
titletext- Their job title
Example output
{
"account_id": "6aeca65caff8e7fcc",
"account_name": "Analytical Engines",
"assigned_user_id": "6aeca42d024294e09",
"assigned_user_name": "Grace Hopper",
"city": "London",
"country": "United Kingdom",
"created_at": "2026-11-05T09:00:00Z",
"custom_fields": {},
"description": "",
"email": "ada@analytical.example.com",
"first_name": "Ada",
"id": "6aeca65cb55c304f8",
"last_name": "Lovelace",
"link": "https://crm.example.com/#Contact/view/6aeca65cb55c304f8",
"modified_at": "2026-11-05T09:00:00Z",
"name": "Ada Lovelace",
"phone": "+14155550134",
"postal_code": "NW1 5LR",
"state": "",
"street": "12 Marylebone Road",
"title": "Head of Engineering"
}Create lead
Add a lead to EspoCRM, even if one with the same name or email exists; use 'Create or update lead' for forms and sign-ups.
Inputs
- First name
first_nametext - Their first name.
- Last name
last_nametext - Their last name.
- Email
emailtext - Their email address.
- Phone
phonetext - Their phone number with its country code, such as +1 415 555 0134.
- Title
titletext - Their job title, such as Head of Sales.
- Account name
account_nametext - The company or organisation they're with.
- Status
statustext - Where the lead stands, such as New or In Process.
- Source
sourcetext - Where the lead came from, such as Web Site.
- Website
websitetext - Their website.
- Street
streettext - Their street address.
- City
citytext - Their city.
- State
statetext - Their state or region.
- Postal code
postal_codetext - Their postal code or ZIP code.
- Country
countrytext - Their country.
- Description
descriptiontext - More about it, shown in EspoCRM.
- Assigned user
assigned_usertext - The user the lead is assigned to, or their user name or email.
- Team
teamtext - A team to add it to, which decides who else can see it in EspoCRM.
- Other fields
custom_fieldsobject - Any other fields by their name in EspoCRM, such as {"industry": "Software"}. Fields an administrator added start with c, such as {"cLeadScore": 80}; their names are under Administration > Entity Manager > Fields.
Outputs
account_nametext- The company they work for, as typed on the lead
assigned_user_idtext- The ID of the user it's assigned to; empty if none
assigned_user_nametext- Their name
citytext- City
converted_account_idtext- The account it became; empty if none
converted_contact_idtext- The contact it became; empty until converted
converted_opportunity_idtext- The opportunity it became; empty if none
countrytext- Country
created_attext- When it was added to EspoCRM (ISO 8601, UTC)
custom_fieldsobject- Fields an administrator added, by their API name, as EspoCRM gives them
descriptiontext- The lead's description
emailtext- Their primary email
first_nametext- Their first name
idtext- The lead's ID
last_nametext- Their last name
linktext- A link to it in EspoCRM
modified_attext- When it last changed (ISO 8601, UTC)
nametext- Their full name
phonetext- Their primary phone number
postal_codetext- Postal code or ZIP code
sourcetext- Where the lead came from, such as Web Site
statetext- State or region
statustext- Where the lead stands, such as New or In Process
streettext- Street
titletext- Their job title
websitetext- Their website
Example output
{
"account_name": "Analytical Engines",
"assigned_user_id": "6aeca42d024294e09",
"assigned_user_name": "Grace Hopper",
"city": "London",
"converted_account_id": "",
"converted_contact_id": "",
"converted_opportunity_id": "",
"country": "United Kingdom",
"created_at": "2026-11-05T09:00:00Z",
"custom_fields": {},
"description": "Asked for a demo on the website.",
"email": "ada@analytical.example.com",
"first_name": "Ada",
"id": "6aeca603c5e5ee841",
"last_name": "Lovelace",
"link": "https://crm.example.com/#Lead/view/6aeca603c5e5ee841",
"modified_at": "2026-11-05T09:00:00Z",
"name": "Ada Lovelace",
"phone": "+14155550134",
"postal_code": "NW1 5LR",
"source": "Web Site",
"state": "",
"status": "New",
"street": "12 Marylebone Road",
"title": "Head of Engineering",
"website": "https://analytical.example.com"
}Create opportunity
Add an opportunity (a deal) to the pipeline, with its amount, close date, stage, account and contact.
Inputs
- Name
nametextRequired - What the opportunity is called.
- Amount
amountnumberRequired - How much it's worth, such as 12000.At least 0.
- Close date
close_datedateRequired - When it's expected to close.
- Currency
currencytext - The amount's three-letter currency code, such as EUR. Defaults to EspoCRM's default currency.
- Stage
stagetext - The stage it starts in. Leave blank for the first stage.
- Account
accounttext - The account's ID, from another EspoCRM step or the trigger, or a link to it in EspoCRM.
- Contact
contacttext - The primary contact's ID, from another EspoCRM step or the trigger, or a link to it in EspoCRM.
- Description
descriptiontext - More about it, shown in EspoCRM.
- Assigned user
assigned_usertext - The user the opportunity is assigned to, or their user name or email.
- Team
teamtext - A team to add it to, which decides who else can see it in EspoCRM.
- Other fields
custom_fieldsobject - Any other fields by their name in EspoCRM, such as {"industry": "Software"}. Fields an administrator added start with c, such as {"cLeadScore": 80}; their names are under Administration > Entity Manager > Fields.
Outputs
account_idtext- The account's ID; empty if none
account_nametext- The account's name
amountnumber- How much it's worth
assigned_user_idtext- The ID of the user it's assigned to; empty if none
assigned_user_nametext- Their name
close_datetext- When it's expected to close (YYYY-MM-DD)
contact_idtext- The primary contact's ID; empty if none
contact_nametext- The primary contact's name
created_attext- When it was added to EspoCRM (ISO 8601, UTC)
currencytext- The amount's currency, such as USD
custom_fieldsobject- Fields an administrator added, by their API name, as EspoCRM gives them
descriptiontext- The opportunity's description
idtext- The opportunity's ID
lead_sourcetext- Where it came from, such as Web Site
linktext- A link to it in EspoCRM
modified_attext- When it last changed (ISO 8601, UTC)
nametext- Its name
probabilitynumber- How likely it is to close, in percent
stagetext- Its stage, such as Proposal
Example output
{
"account_id": "6aeca65caff8e7fcc",
"account_name": "Analytical Engines",
"amount": 12000,
"assigned_user_id": "6aeca42d024294e09",
"assigned_user_name": "Grace Hopper",
"close_date": "2026-12-15",
"contact_id": "6aeca65cb55c304f8",
"contact_name": "Ada Lovelace",
"created_at": "2026-11-05T09:00:00Z",
"currency": "USD",
"custom_fields": {},
"description": "",
"id": "6aeca65cbcda4c086",
"lead_source": "Web Site",
"link": "https://crm.example.com/#Opportunity/view/6aeca65cbcda4c086",
"modified_at": "2026-11-05T09:00:00Z",
"name": "Analytical Engines renewal",
"probability": 50,
"stage": "Proposal"
}Create or update contact
Update the contact with this email, or add one if none has it. Fields left blank keep what they have.
Inputs
- Email
emailtextRequired - The email to match the contact on; one is added if none has it.
- First name
first_nametext - Their first name.
- Last name
last_nametext - Their last name. EspoCRM needs one for a new contact.
- Phone
phonetext - Their phone number with its country code, such as +1 415 555 0134.
- Title
titletext - Their job title, such as Head of Sales.
- Account
accounttext - The account's ID, from another EspoCRM step or the trigger, or a link to it in EspoCRM.
- Street
streettext - Their street address.
- City
citytext - Their city.
- State
statetext - Their state or region.
- Postal code
postal_codetext - Their postal code or ZIP code.
- Country
countrytext - Their country.
- Description
descriptiontext - More about it, shown in EspoCRM.
- Assigned user
assigned_usertext - The user the contact is assigned to, or their user name or email.
- Team
teamtext - A team to add it to, which decides who else can see it in EspoCRM.
- Other fields
custom_fieldsobject - Any other fields by their name in EspoCRM, such as {"industry": "Software"}. Fields an administrator added start with c, such as {"cLeadScore": 80}; their names are under Administration > Entity Manager > Fields.
Outputs
account_idtext- Their account's ID; empty if none
account_nametext- Their account's name
assigned_user_idtext- The ID of the user it's assigned to; empty if none
assigned_user_nametext- Their name
citytext- City
countrytext- Country
createdtrue/false- True if it was added, false if it was updated
created_attext- When it was added to EspoCRM (ISO 8601, UTC)
custom_fieldsobject- Fields an administrator added, by their API name, as EspoCRM gives them
descriptiontext- The contact's description
emailtext- Their primary email
first_nametext- Their first name
idtext- The contact's ID
last_nametext- Their last name
linktext- A link to it in EspoCRM
modified_attext- When it last changed (ISO 8601, UTC)
nametext- Their full name
phonetext- Their primary phone number
postal_codetext- Postal code or ZIP code
statetext- State or region
streettext- Street
titletext- Their job title
Example output
{
"account_id": "6aeca65caff8e7fcc",
"account_name": "Analytical Engines",
"assigned_user_id": "6aeca42d024294e09",
"assigned_user_name": "Grace Hopper",
"city": "London",
"country": "United Kingdom",
"created": true,
"created_at": "2026-11-05T09:00:00Z",
"custom_fields": {},
"description": "",
"email": "ada@analytical.example.com",
"first_name": "Ada",
"id": "6aeca65cb55c304f8",
"last_name": "Lovelace",
"link": "https://crm.example.com/#Contact/view/6aeca65cb55c304f8",
"modified_at": "2026-11-05T09:00:00Z",
"name": "Ada Lovelace",
"phone": "+14155550134",
"postal_code": "NW1 5LR",
"state": "",
"street": "12 Marylebone Road",
"title": "Head of Engineering"
}Create or update lead
Update the lead with this email, or add one if none has it, such as for a form or sign-up. Fields left blank keep what they have.
Inputs
- Email
emailtextRequired - The email to match the lead on; one is added if none has it.
- First name
first_nametext - Their first name.
- Last name
last_nametext - Their last name.
- Phone
phonetext - Their phone number with its country code, such as +1 415 555 0134.
- Title
titletext - Their job title, such as Head of Sales.
- Account name
account_nametext - The company or organisation they're with.
- Status
statustext - Where the lead stands, such as New or In Process.
- Source
sourcetext - Where the lead came from, such as Web Site.
- Website
websitetext - Their website.
- Street
streettext - Their street address.
- City
citytext - Their city.
- State
statetext - Their state or region.
- Postal code
postal_codetext - Their postal code or ZIP code.
- Country
countrytext - Their country.
- Description
descriptiontext - More about it, shown in EspoCRM.
- Assigned user
assigned_usertext - The user the lead is assigned to, or their user name or email.
- Team
teamtext - A team to add it to, which decides who else can see it in EspoCRM.
- Other fields
custom_fieldsobject - Any other fields by their name in EspoCRM, such as {"industry": "Software"}. Fields an administrator added start with c, such as {"cLeadScore": 80}; their names are under Administration > Entity Manager > Fields.
Outputs
account_nametext- The company they work for, as typed on the lead
assigned_user_idtext- The ID of the user it's assigned to; empty if none
assigned_user_nametext- Their name
citytext- City
converted_account_idtext- The account it became; empty if none
converted_contact_idtext- The contact it became; empty until converted
converted_opportunity_idtext- The opportunity it became; empty if none
countrytext- Country
createdtrue/false- True if it was added, false if it was updated
created_attext- When it was added to EspoCRM (ISO 8601, UTC)
custom_fieldsobject- Fields an administrator added, by their API name, as EspoCRM gives them
descriptiontext- The lead's description
emailtext- Their primary email
first_nametext- Their first name
idtext- The lead's ID
last_nametext- Their last name
linktext- A link to it in EspoCRM
modified_attext- When it last changed (ISO 8601, UTC)
nametext- Their full name
phonetext- Their primary phone number
postal_codetext- Postal code or ZIP code
sourcetext- Where the lead came from, such as Web Site
statetext- State or region
statustext- Where the lead stands, such as New or In Process
streettext- Street
titletext- Their job title
websitetext- Their website
Example output
{
"account_name": "Analytical Engines",
"assigned_user_id": "6aeca42d024294e09",
"assigned_user_name": "Grace Hopper",
"city": "London",
"converted_account_id": "",
"converted_contact_id": "",
"converted_opportunity_id": "",
"country": "United Kingdom",
"created": true,
"created_at": "2026-11-05T09:00:00Z",
"custom_fields": {},
"description": "Asked for a demo on the website.",
"email": "ada@analytical.example.com",
"first_name": "Ada",
"id": "6aeca603c5e5ee841",
"last_name": "Lovelace",
"link": "https://crm.example.com/#Lead/view/6aeca603c5e5ee841",
"modified_at": "2026-11-05T09:00:00Z",
"name": "Ada Lovelace",
"phone": "+14155550134",
"postal_code": "NW1 5LR",
"source": "Web Site",
"state": "",
"status": "New",
"street": "12 Marylebone Road",
"title": "Head of Engineering",
"website": "https://analytical.example.com"
}Create task
Add a task for someone, with a due date, about an account, contact, lead, opportunity or case.
Inputs
- Name
nametextRequired - What needs doing.
- Assigned user
assigned_usertextRequired - The user the task is for, or their user name or email.
- Due
due_atdate and time - When it's due.
- Description
descriptiontext - More about it.
- Status
statustext - Where it stands. Leave blank for Not Started.One of:
Not Started,Started,Completed,Canceled,Deferred. - Priority
prioritytext - How urgent it is. Leave blank for Normal.One of:
Low,Normal,High,Urgent. - Related to
related_to_typetext - What kind of record it's about. Not needed when Record is a link to it.One of:
account,contact,lead,opportunity,case. - Record
related_totext - The ID of the account, contact, lead, opportunity or case it's about, or a link to it in EspoCRM.
- Team
teamtext - A team to add it to, which decides who else can see it in EspoCRM.
Outputs
assigned_user_idtext- The ID of the user it's for
assigned_user_nametext- Their name
created_attext- When it was added (ISO 8601, UTC)
descriptiontext- More about it
due_attext- When it's due (ISO 8601, UTC); empty if not set
idtext- The task's ID
linktext- A link to it in EspoCRM
nametext- What needs doing
prioritytext- Low, Normal, High or Urgent
related_idtext- The ID of the record it's about
related_nametext- That record's name
related_typetext- What it's about: account, contact, lead, opportunity or case; empty if none
statustext- Where it stands, such as Not Started
Example output
{
"assigned_user_id": "6aeca42d024294e09",
"assigned_user_name": "Grace Hopper",
"created_at": "2026-11-05T09:41:00Z",
"description": "40 seats, annual.",
"due_at": "2026-11-07T17:00:00Z",
"id": "6aeca64c56ad927a8",
"link": "https://crm.example.com/#Task/view/6aeca64c56ad927a8",
"name": "Send Ada the quote",
"priority": "Normal",
"related_id": "6aeca65cbcda4c086",
"related_name": "Analytical Engines renewal",
"related_type": "opportunity",
"status": "Not Started"
}Delete record
Delete a lead, contact, account, opportunity, case, task or call.
Inputs
- Type
record_typetextRequired - What kind of record it is.One of:
lead,contact,account,opportunity,case,task,call. - Record
recordtextRequired - The record's ID, from another EspoCRM step or the trigger, or a link to it in EspoCRM.
Outputs
deletedtrue/false- True once deleted
idtext- The record's ID
record_typetext- lead, contact, account, opportunity, case, task or call
Example output
{
"deleted": true,
"id": "6aeca603c5e5ee841",
"record_type": "lead"
}Find accounts
Find accounts by name, website or email, newest first. Leave every field blank to list the newest.
Inputs
- Name
nametext - Words in the account's name.
- Website
websitetext - Its website, such as acme.com.
- Email
emailtext - Its email address.
- How many
limitnumber - The most to list, newest first. Defaults to 25.From 1 to 200.
Outputs
accountslist- The accounts found
countnumber- How many are listed
totalnumber- How many match in all
Example output
{
"accounts": [
{
"assigned_user_id": "6aeca42d024294e09",
"assigned_user_name": "Grace Hopper",
"city": "London",
"country": "United Kingdom",
"created_at": "2026-11-05T09:00:00Z",
"custom_fields": {},
"description": "",
"email": "hello@analytical.example.com",
"id": "6aeca65caff8e7fcc",
"industry": "Software",
"link": "https://crm.example.com/#Account/view/6aeca65caff8e7fcc",
"modified_at": "2026-11-05T09:00:00Z",
"name": "Analytical Engines",
"phone": "+442079460000",
"postal_code": "NW1 5LR",
"state": "",
"street": "12 Marylebone Road",
"type": "Customer",
"website": "https://analytical.example.com"
}
],
"count": 1,
"total": 1
}Find contacts
Find contacts by email, name or account, newest first. Leave every field blank to list the newest.
Inputs
- Email
emailtext - Their email address.
- Name
nametext - Words in their name, such as Ada or Ada Lovelace.
- Account
accounttext - The account's ID, from another EspoCRM step or the trigger, or a link to it in EspoCRM.
- How many
limitnumber - The most to list, newest first. Defaults to 25.From 1 to 200.
Outputs
contactslist- The contacts found
countnumber- How many are listed
totalnumber- How many match in all
Example output
{
"contacts": [
{
"account_id": "6aeca65caff8e7fcc",
"account_name": "Analytical Engines",
"assigned_user_id": "6aeca42d024294e09",
"assigned_user_name": "Grace Hopper",
"city": "London",
"country": "United Kingdom",
"created_at": "2026-11-05T09:00:00Z",
"custom_fields": {},
"description": "",
"email": "ada@analytical.example.com",
"first_name": "Ada",
"id": "6aeca65cb55c304f8",
"last_name": "Lovelace",
"link": "https://crm.example.com/#Contact/view/6aeca65cb55c304f8",
"modified_at": "2026-11-05T09:00:00Z",
"name": "Ada Lovelace",
"phone": "+14155550134",
"postal_code": "NW1 5LR",
"state": "",
"street": "12 Marylebone Road",
"title": "Head of Engineering"
}
],
"count": 1,
"total": 1
}Find leads
Find leads by email, name, status or source, newest first. Leave every field blank to list the newest.
Inputs
- Email
emailtext - Their email address.
- Name
nametext - Words in their name, such as Ada or Ada Lovelace.
- Status
statustext - Only leads with this status.
- Source
sourcetext - Only leads from this source.
- How many
limitnumber - The most to list, newest first. Defaults to 25.From 1 to 200.
Outputs
countnumber- How many are listed
leadslist- The leads found
totalnumber- How many match in all
Example output
{
"count": 1,
"leads": [
{
"account_name": "Analytical Engines",
"assigned_user_id": "6aeca42d024294e09",
"assigned_user_name": "Grace Hopper",
"city": "London",
"converted_account_id": "",
"converted_contact_id": "",
"converted_opportunity_id": "",
"country": "United Kingdom",
"created_at": "2026-11-05T09:00:00Z",
"custom_fields": {},
"description": "Asked for a demo on the website.",
"email": "ada@analytical.example.com",
"first_name": "Ada",
"id": "6aeca603c5e5ee841",
"last_name": "Lovelace",
"link": "https://crm.example.com/#Lead/view/6aeca603c5e5ee841",
"modified_at": "2026-11-05T09:00:00Z",
"name": "Ada Lovelace",
"phone": "+14155550134",
"postal_code": "NW1 5LR",
"source": "Web Site",
"state": "",
"status": "New",
"street": "12 Marylebone Road",
"title": "Head of Engineering",
"website": "https://analytical.example.com"
}
],
"total": 1
}Find opportunities
Find opportunities by name, stage or account, newest first. Leave every field blank to list the newest.
Inputs
- Name
nametext - Words in the opportunity's name.
- Stage
stagetext - Only opportunities in this stage.
- Account
accounttext - The account's ID, from another EspoCRM step or the trigger, or a link to it in EspoCRM.
- How many
limitnumber - The most to list, newest first. Defaults to 25.From 1 to 200.
Outputs
countnumber- How many are listed
opportunitieslist- The opportunities found
totalnumber- How many match in all
Example output
{
"count": 1,
"opportunities": [
{
"account_id": "6aeca65caff8e7fcc",
"account_name": "Analytical Engines",
"amount": 12000,
"assigned_user_id": "6aeca42d024294e09",
"assigned_user_name": "Grace Hopper",
"close_date": "2026-12-15",
"contact_id": "6aeca65cb55c304f8",
"contact_name": "Ada Lovelace",
"created_at": "2026-11-05T09:00:00Z",
"currency": "USD",
"custom_fields": {},
"description": "",
"id": "6aeca65cbcda4c086",
"lead_source": "Web Site",
"link": "https://crm.example.com/#Opportunity/view/6aeca65cbcda4c086",
"modified_at": "2026-11-05T09:00:00Z",
"name": "Analytical Engines renewal",
"probability": 50,
"stage": "Proposal"
}
],
"total": 1
}Get account
Get an account's details.
Inputs
- Account
accounttextRequired - The account's ID, from another EspoCRM step or the trigger, or a link to it in EspoCRM.
Outputs
assigned_user_idtext- The ID of the user it's assigned to; empty if none
assigned_user_nametext- Their name
citytext- City
countrytext- Country
created_attext- When it was added to EspoCRM (ISO 8601, UTC)
custom_fieldsobject- Fields an administrator added, by their API name, as EspoCRM gives them
descriptiontext- The account's description
emailtext- Its primary email
idtext- The account's ID
industrytext- Its industry
linktext- A link to it in EspoCRM
modified_attext- When it last changed (ISO 8601, UTC)
nametext- Its name
phonetext- Its primary phone number
postal_codetext- Postal code or ZIP code
statetext- State or region
streettext- Street
typetext- What it is to you, such as Customer or Partner
websitetext- Its website
Example output
{
"assigned_user_id": "6aeca42d024294e09",
"assigned_user_name": "Grace Hopper",
"city": "London",
"country": "United Kingdom",
"created_at": "2026-11-05T09:00:00Z",
"custom_fields": {},
"description": "",
"email": "hello@analytical.example.com",
"id": "6aeca65caff8e7fcc",
"industry": "Software",
"link": "https://crm.example.com/#Account/view/6aeca65caff8e7fcc",
"modified_at": "2026-11-05T09:00:00Z",
"name": "Analytical Engines",
"phone": "+442079460000",
"postal_code": "NW1 5LR",
"state": "",
"street": "12 Marylebone Road",
"type": "Customer",
"website": "https://analytical.example.com"
}Get contact
Get a contact's details, with their account's name.
Inputs
- Contact
contacttextRequired - The contact's ID, from another EspoCRM step or the trigger, or a link to it in EspoCRM.
Outputs
account_idtext- Their account's ID; empty if none
account_nametext- Their account's name
assigned_user_idtext- The ID of the user it's assigned to; empty if none
assigned_user_nametext- Their name
citytext- City
countrytext- Country
created_attext- When it was added to EspoCRM (ISO 8601, UTC)
custom_fieldsobject- Fields an administrator added, by their API name, as EspoCRM gives them
descriptiontext- The contact's description
emailtext- Their primary email
first_nametext- Their first name
idtext- The contact's ID
last_nametext- Their last name
linktext- A link to it in EspoCRM
modified_attext- When it last changed (ISO 8601, UTC)
nametext- Their full name
phonetext- Their primary phone number
postal_codetext- Postal code or ZIP code
statetext- State or region
streettext- Street
titletext- Their job title
Example output
{
"account_id": "6aeca65caff8e7fcc",
"account_name": "Analytical Engines",
"assigned_user_id": "6aeca42d024294e09",
"assigned_user_name": "Grace Hopper",
"city": "London",
"country": "United Kingdom",
"created_at": "2026-11-05T09:00:00Z",
"custom_fields": {},
"description": "",
"email": "ada@analytical.example.com",
"first_name": "Ada",
"id": "6aeca65cb55c304f8",
"last_name": "Lovelace",
"link": "https://crm.example.com/#Contact/view/6aeca65cb55c304f8",
"modified_at": "2026-11-05T09:00:00Z",
"name": "Ada Lovelace",
"phone": "+14155550134",
"postal_code": "NW1 5LR",
"state": "",
"street": "12 Marylebone Road",
"title": "Head of Engineering"
}Get lead
Get a lead's details, and what it was converted into.
Inputs
- Lead
leadtextRequired - The lead's ID, from another EspoCRM step or the trigger, or a link to it in EspoCRM.
Outputs
account_nametext- The company they work for, as typed on the lead
assigned_user_idtext- The ID of the user it's assigned to; empty if none
assigned_user_nametext- Their name
citytext- City
converted_account_idtext- The account it became; empty if none
converted_contact_idtext- The contact it became; empty until converted
converted_opportunity_idtext- The opportunity it became; empty if none
countrytext- Country
created_attext- When it was added to EspoCRM (ISO 8601, UTC)
custom_fieldsobject- Fields an administrator added, by their API name, as EspoCRM gives them
descriptiontext- The lead's description
emailtext- Their primary email
first_nametext- Their first name
idtext- The lead's ID
last_nametext- Their last name
linktext- A link to it in EspoCRM
modified_attext- When it last changed (ISO 8601, UTC)
nametext- Their full name
phonetext- Their primary phone number
postal_codetext- Postal code or ZIP code
sourcetext- Where the lead came from, such as Web Site
statetext- State or region
statustext- Where the lead stands, such as New or In Process
streettext- Street
titletext- Their job title
websitetext- Their website
Example output
{
"account_name": "Analytical Engines",
"assigned_user_id": "6aeca42d024294e09",
"assigned_user_name": "Grace Hopper",
"city": "London",
"converted_account_id": "",
"converted_contact_id": "",
"converted_opportunity_id": "",
"country": "United Kingdom",
"created_at": "2026-11-05T09:00:00Z",
"custom_fields": {},
"description": "Asked for a demo on the website.",
"email": "ada@analytical.example.com",
"first_name": "Ada",
"id": "6aeca603c5e5ee841",
"last_name": "Lovelace",
"link": "https://crm.example.com/#Lead/view/6aeca603c5e5ee841",
"modified_at": "2026-11-05T09:00:00Z",
"name": "Ada Lovelace",
"phone": "+14155550134",
"postal_code": "NW1 5LR",
"source": "Web Site",
"state": "",
"status": "New",
"street": "12 Marylebone Road",
"title": "Head of Engineering",
"website": "https://analytical.example.com"
}Get opportunity
Get an opportunity's details, with its stage, account and contact.
Inputs
- Opportunity
opportunitytextRequired - The opportunity's ID, from another EspoCRM step or the trigger, or a link to it in EspoCRM.
Outputs
account_idtext- The account's ID; empty if none
account_nametext- The account's name
amountnumber- How much it's worth
assigned_user_idtext- The ID of the user it's assigned to; empty if none
assigned_user_nametext- Their name
close_datetext- When it's expected to close (YYYY-MM-DD)
contact_idtext- The primary contact's ID; empty if none
contact_nametext- The primary contact's name
created_attext- When it was added to EspoCRM (ISO 8601, UTC)
currencytext- The amount's currency, such as USD
custom_fieldsobject- Fields an administrator added, by their API name, as EspoCRM gives them
descriptiontext- The opportunity's description
idtext- The opportunity's ID
lead_sourcetext- Where it came from, such as Web Site
linktext- A link to it in EspoCRM
modified_attext- When it last changed (ISO 8601, UTC)
nametext- Its name
probabilitynumber- How likely it is to close, in percent
stagetext- Its stage, such as Proposal
Example output
{
"account_id": "6aeca65caff8e7fcc",
"account_name": "Analytical Engines",
"amount": 12000,
"assigned_user_id": "6aeca42d024294e09",
"assigned_user_name": "Grace Hopper",
"close_date": "2026-12-15",
"contact_id": "6aeca65cb55c304f8",
"contact_name": "Ada Lovelace",
"created_at": "2026-11-05T09:00:00Z",
"currency": "USD",
"custom_fields": {},
"description": "",
"id": "6aeca65cbcda4c086",
"lead_source": "Web Site",
"link": "https://crm.example.com/#Opportunity/view/6aeca65cbcda4c086",
"modified_at": "2026-11-05T09:00:00Z",
"name": "Analytical Engines renewal",
"probability": 50,
"stage": "Proposal"
}List users
List the active users records can be assigned to, with their user names and emails.
Inputs
None.
Outputs
countnumber- How many
userslist- The active users
Example output
{
"count": 1,
"users": [
{
"email": "grace@example.com",
"id": "6aeca42d024294e09",
"name": "Grace Hopper",
"user_name": "grace"
}
]
}Log call
Record a call someone made or took, about an account, contact, lead, opportunity or case.
Inputs
- Name
nametextRequired - What the call was about.
- Assigned user
assigned_usertextRequired - The user who made or took the call, or their user name or email.
- Started
start_atdate and time - When the call started. Leave blank for now.
- Minutes
duration_minutesnumber - How long it lasted, in minutes. Leave blank for 5.At least 0.
- Direction
directiontext - Whether you called them or they called you. Leave blank for Outbound.One of:
Outbound,Inbound. - Status
statustext - Whether it happened. Leave blank for Held.One of:
Held,Planned,Not Held. - Description
descriptiontext - Notes from the call.
- Related to
related_to_typetext - What kind of record it's about. Not needed when Record is a link to it.One of:
account,contact,lead,opportunity,case. - Record
related_totext - The ID of the account, contact, lead, opportunity or case it's about, or a link to it in EspoCRM.
- Team
teamtext - A team to add it to, which decides who else can see it in EspoCRM.
Outputs
assigned_user_idtext- The ID of the user who made or took it
assigned_user_nametext- Their name
created_attext- When it was logged (ISO 8601, UTC)
descriptiontext- Notes from the call
directiontext- Outbound or Inbound
duration_minutesnumber- How long it lasted, in minutes
end_attext- When it ended (ISO 8601, UTC)
idtext- The call's ID
linktext- A link to it in EspoCRM
nametext- What it was about
related_idtext- The ID of the record it's about
related_nametext- That record's name
related_typetext- What it's about: account, contact, lead, opportunity or case; empty if none
start_attext- When it started (ISO 8601, UTC)
statustext- Held, Planned or Not Held
Example output
{
"assigned_user_id": "6aeca42d024294e09",
"assigned_user_name": "Grace Hopper",
"created_at": "2026-11-05T10:16:00Z",
"description": "Wants a quote for 40 seats.",
"direction": "Outbound",
"duration_minutes": 15,
"end_at": "2026-11-05T10:15:00Z",
"id": "6aeca64c637675f4c",
"link": "https://crm.example.com/#Call/view/6aeca64c637675f4c",
"name": "Discovery call with Ada",
"related_id": "6aeca65cbcda4c086",
"related_name": "Analytical Engines renewal",
"related_type": "opportunity",
"start_at": "2026-11-05T10:00:00Z",
"status": "Held"
}Update account
Change an account's details. Fields left blank keep what it has.
Inputs
- Account
accounttextRequired - The account's ID, from another EspoCRM step or the trigger, or a link to it in EspoCRM.
- Name
nametext - What the account is called. Leave blank to keep it.
- Website
websitetext - Its website, such as https://acme.com.
- Email
emailtext - Its email address.
- Phone
phonetext - Its phone number with its country code.
- Type
account_typetext - What it is to you.One of:
Customer,Investor,Partner,Reseller. - Street
streettext - Its billing street address.
- City
citytext - Its billing city.
- State
statetext - Its billing state or region.
- Postal code
postal_codetext - Its billing postal code or ZIP code.
- Country
countrytext - Its billing country.
- Description
descriptiontext - More about it, shown in EspoCRM.
- Assigned user
assigned_usertext - The user the account is assigned to, or their user name or email.
- Team
teamtext - A team to add it to, which decides who else can see it in EspoCRM.
- Other fields
custom_fieldsobject - Any other fields by their name in EspoCRM, such as {"industry": "Software"}. Fields an administrator added start with c, such as {"cLeadScore": 80}; their names are under Administration > Entity Manager > Fields.
Outputs
assigned_user_idtext- The ID of the user it's assigned to; empty if none
assigned_user_nametext- Their name
citytext- City
countrytext- Country
created_attext- When it was added to EspoCRM (ISO 8601, UTC)
custom_fieldsobject- Fields an administrator added, by their API name, as EspoCRM gives them
descriptiontext- The account's description
emailtext- Its primary email
idtext- The account's ID
industrytext- Its industry
linktext- A link to it in EspoCRM
modified_attext- When it last changed (ISO 8601, UTC)
nametext- Its name
phonetext- Its primary phone number
postal_codetext- Postal code or ZIP code
statetext- State or region
streettext- Street
typetext- What it is to you, such as Customer or Partner
websitetext- Its website
Example output
{
"assigned_user_id": "6aeca42d024294e09",
"assigned_user_name": "Grace Hopper",
"city": "London",
"country": "United Kingdom",
"created_at": "2026-11-05T09:00:00Z",
"custom_fields": {},
"description": "",
"email": "hello@analytical.example.com",
"id": "6aeca65caff8e7fcc",
"industry": "Software",
"link": "https://crm.example.com/#Account/view/6aeca65caff8e7fcc",
"modified_at": "2026-11-05T09:00:00Z",
"name": "Analytical Engines",
"phone": "+442079460000",
"postal_code": "NW1 5LR",
"state": "",
"street": "12 Marylebone Road",
"type": "Customer",
"website": "https://analytical.example.com"
}Update contact
Change a contact's details. Fields left blank keep what they have.
Inputs
- Contact
contacttextRequired - The contact's ID, from another EspoCRM step or the trigger, or a link to it in EspoCRM.
- First name
first_nametext - Their first name.
- Last name
last_nametext - Their last name. EspoCRM needs one for a new contact.
- Email
emailtext - Their email address.
- Phone
phonetext - Their phone number with its country code, such as +1 415 555 0134.
- Title
titletext - Their job title, such as Head of Sales.
- Account
accounttext - The account's ID, from another EspoCRM step or the trigger, or a link to it in EspoCRM.
- Street
streettext - Their street address.
- City
citytext - Their city.
- State
statetext - Their state or region.
- Postal code
postal_codetext - Their postal code or ZIP code.
- Country
countrytext - Their country.
- Description
descriptiontext - More about it, shown in EspoCRM.
- Assigned user
assigned_usertext - The user the contact is assigned to, or their user name or email.
- Team
teamtext - A team to add it to, which decides who else can see it in EspoCRM.
- Other fields
custom_fieldsobject - Any other fields by their name in EspoCRM, such as {"industry": "Software"}. Fields an administrator added start with c, such as {"cLeadScore": 80}; their names are under Administration > Entity Manager > Fields.
Outputs
account_idtext- Their account's ID; empty if none
account_nametext- Their account's name
assigned_user_idtext- The ID of the user it's assigned to; empty if none
assigned_user_nametext- Their name
citytext- City
countrytext- Country
created_attext- When it was added to EspoCRM (ISO 8601, UTC)
custom_fieldsobject- Fields an administrator added, by their API name, as EspoCRM gives them
descriptiontext- The contact's description
emailtext- Their primary email
first_nametext- Their first name
idtext- The contact's ID
last_nametext- Their last name
linktext- A link to it in EspoCRM
modified_attext- When it last changed (ISO 8601, UTC)
nametext- Their full name
phonetext- Their primary phone number
postal_codetext- Postal code or ZIP code
statetext- State or region
streettext- Street
titletext- Their job title
Example output
{
"account_id": "6aeca65caff8e7fcc",
"account_name": "Analytical Engines",
"assigned_user_id": "6aeca42d024294e09",
"assigned_user_name": "Grace Hopper",
"city": "London",
"country": "United Kingdom",
"created_at": "2026-11-05T09:00:00Z",
"custom_fields": {},
"description": "",
"email": "ada@analytical.example.com",
"first_name": "Ada",
"id": "6aeca65cb55c304f8",
"last_name": "Lovelace",
"link": "https://crm.example.com/#Contact/view/6aeca65cb55c304f8",
"modified_at": "2026-11-05T09:00:00Z",
"name": "Ada Lovelace",
"phone": "+14155550134",
"postal_code": "NW1 5LR",
"state": "",
"street": "12 Marylebone Road",
"title": "Head of Engineering"
}Update lead
Change a lead, such as its status. Fields left blank keep what they have.
Inputs
- Lead
leadtextRequired - The lead's ID, from another EspoCRM step or the trigger, or a link to it in EspoCRM.
- First name
first_nametext - Their first name.
- Last name
last_nametext - Their last name.
- Email
emailtext - Their email address.
- Phone
phonetext - Their phone number with its country code, such as +1 415 555 0134.
- Title
titletext - Their job title, such as Head of Sales.
- Account name
account_nametext - The company or organisation they're with.
- Status
statustext - Where the lead stands, such as New or In Process.
- Source
sourcetext - Where the lead came from, such as Web Site.
- Website
websitetext - Their website.
- Street
streettext - Their street address.
- City
citytext - Their city.
- State
statetext - Their state or region.
- Postal code
postal_codetext - Their postal code or ZIP code.
- Country
countrytext - Their country.
- Description
descriptiontext - More about it, shown in EspoCRM.
- Assigned user
assigned_usertext - The user the lead is assigned to, or their user name or email.
- Team
teamtext - A team to add it to, which decides who else can see it in EspoCRM.
- Other fields
custom_fieldsobject - Any other fields by their name in EspoCRM, such as {"industry": "Software"}. Fields an administrator added start with c, such as {"cLeadScore": 80}; their names are under Administration > Entity Manager > Fields.
Outputs
account_nametext- The company they work for, as typed on the lead
assigned_user_idtext- The ID of the user it's assigned to; empty if none
assigned_user_nametext- Their name
citytext- City
converted_account_idtext- The account it became; empty if none
converted_contact_idtext- The contact it became; empty until converted
converted_opportunity_idtext- The opportunity it became; empty if none
countrytext- Country
created_attext- When it was added to EspoCRM (ISO 8601, UTC)
custom_fieldsobject- Fields an administrator added, by their API name, as EspoCRM gives them
descriptiontext- The lead's description
emailtext- Their primary email
first_nametext- Their first name
idtext- The lead's ID
last_nametext- Their last name
linktext- A link to it in EspoCRM
modified_attext- When it last changed (ISO 8601, UTC)
nametext- Their full name
phonetext- Their primary phone number
postal_codetext- Postal code or ZIP code
sourcetext- Where the lead came from, such as Web Site
statetext- State or region
statustext- Where the lead stands, such as New or In Process
streettext- Street
titletext- Their job title
websitetext- Their website
Example output
{
"account_name": "Analytical Engines",
"assigned_user_id": "6aeca42d024294e09",
"assigned_user_name": "Grace Hopper",
"city": "London",
"converted_account_id": "",
"converted_contact_id": "",
"converted_opportunity_id": "",
"country": "United Kingdom",
"created_at": "2026-11-05T09:00:00Z",
"custom_fields": {},
"description": "Asked for a demo on the website.",
"email": "ada@analytical.example.com",
"first_name": "Ada",
"id": "6aeca603c5e5ee841",
"last_name": "Lovelace",
"link": "https://crm.example.com/#Lead/view/6aeca603c5e5ee841",
"modified_at": "2026-11-05T09:00:00Z",
"name": "Ada Lovelace",
"phone": "+14155550134",
"postal_code": "NW1 5LR",
"source": "Web Site",
"state": "",
"status": "New",
"street": "12 Marylebone Road",
"title": "Head of Engineering",
"website": "https://analytical.example.com"
}Update opportunity
Change an opportunity, such as moving it to another stage. Fields left blank keep what it has.
Inputs
- Opportunity
opportunitytextRequired - The opportunity's ID, from another EspoCRM step or the trigger, or a link to it in EspoCRM.
- Name
nametext - What the opportunity is called. Leave blank to keep it.
- Amount
amountnumber - How much it's worth, such as 12000.At least 0.
- Close date
close_datedate - When it's expected to close.
- Currency
currencytext - The amount's three-letter currency code, such as EUR. Defaults to EspoCRM's default currency.
- Stage
stagetext - The stage to move it to. Leave blank to keep it where it is.
- Account
accounttext - The account's ID, from another EspoCRM step or the trigger, or a link to it in EspoCRM.
- Contact
contacttext - The primary contact's ID, from another EspoCRM step or the trigger, or a link to it in EspoCRM.
- Description
descriptiontext - More about it, shown in EspoCRM.
- Assigned user
assigned_usertext - The user the opportunity is assigned to, or their user name or email.
- Team
teamtext - A team to add it to, which decides who else can see it in EspoCRM.
- Other fields
custom_fieldsobject - Any other fields by their name in EspoCRM, such as {"industry": "Software"}. Fields an administrator added start with c, such as {"cLeadScore": 80}; their names are under Administration > Entity Manager > Fields.
Outputs
account_idtext- The account's ID; empty if none
account_nametext- The account's name
amountnumber- How much it's worth
assigned_user_idtext- The ID of the user it's assigned to; empty if none
assigned_user_nametext- Their name
close_datetext- When it's expected to close (YYYY-MM-DD)
contact_idtext- The primary contact's ID; empty if none
contact_nametext- The primary contact's name
created_attext- When it was added to EspoCRM (ISO 8601, UTC)
currencytext- The amount's currency, such as USD
custom_fieldsobject- Fields an administrator added, by their API name, as EspoCRM gives them
descriptiontext- The opportunity's description
idtext- The opportunity's ID
lead_sourcetext- Where it came from, such as Web Site
linktext- A link to it in EspoCRM
modified_attext- When it last changed (ISO 8601, UTC)
nametext- Its name
probabilitynumber- How likely it is to close, in percent
stagetext- Its stage, such as Proposal
Example output
{
"account_id": "6aeca65caff8e7fcc",
"account_name": "Analytical Engines",
"amount": 12000,
"assigned_user_id": "6aeca42d024294e09",
"assigned_user_name": "Grace Hopper",
"close_date": "2026-12-15",
"contact_id": "6aeca65cb55c304f8",
"contact_name": "Ada Lovelace",
"created_at": "2026-11-05T09:00:00Z",
"currency": "USD",
"custom_fields": {},
"description": "",
"id": "6aeca65cbcda4c086",
"lead_source": "Web Site",
"link": "https://crm.example.com/#Opportunity/view/6aeca65cbcda4c086",
"modified_at": "2026-11-05T09:00:00Z",
"name": "Analytical Engines renewal",
"probability": 50,
"stage": "Proposal"
}