SuiteCRM

App · 29 actions

Keep SuiteCRM, the open-source CRM, up to date: add and update leads and contacts from forms and sign-ups, manage accounts, move opportunities through the pipeline, open and close support cases, and add notes, tasks and calls. Start a workflow when a lead, contact, opportunity or case is added, or a deal changes stage.

Actions

ActionWhat it does
Add noteAdd a note to an account, contact, lead, opportunity or case, shown in its History.
Create accountAdd an account: a company or organisation you work with.
Create caseOpen a support case for an account or contact, such as from a form or an email.
Create contactAdd a contact to SuiteCRM, even if one with the same email exists; use 'Create or update contact' to avoid that.
Create leadAdd a lead to SuiteCRM, even if one with the same email exists; use 'Create or update lead' for forms and sign-ups.
Create opportunityAdd an opportunity (a deal) to the pipeline, with its amount, close date, sales stage, account and contact.
Create or update contactUpdate the contact with this email, or add one if none has it.
Create or update leadUpdate the lead with this email, or add one if none has it, such as for a form or sign-up.
Create taskAdd a task, with a due date, about an account, contact, lead, opportunity or case.
Delete recordDelete a lead, contact, account, opportunity, case, task, call or note.
Find accountsFind accounts by name, email, website or type, newest first.
Find casesFind cases by subject, number, status or account, newest first.
Find contactsFind contacts by email, name or account, newest first.
Find leadsFind leads by email, name, status or source, newest first.
Find opportunitiesFind opportunities by name, sales stage or account, newest first.
Get accountGet an account's details.
Get caseGet a case's details, with its number, status and account.
Get contactGet a contact's details, with their account's name.
Get leadGet a lead's details.
Get opportunityGet an opportunity's details, with its sales stage and account.
Link recordsLink two related records, such as a contact to an account or an opportunity, so each shows under the other in SuiteCRM.
List usersList the active users records can be assigned to, with their emails.
Log callRecord a call someone made or took, about an account, contact, lead, opportunity or case.
Search recordsFind records of any kind (module) with a filter on their fields, such as cases with priority P1 or accounts in one city.
Update accountChange an account's details.
Update caseChange a case, such as its status, priority or who it's assigned to; a Closed, Rejected or Duplicate status closes it.
Update contactChange a contact's details.
Update leadChange a lead, such as its status.
Update opportunityChange an opportunity, such as moving it to another sales stage or marking it Closed Won.

Add note

Add a note to an account, contact, lead, opportunity or case, shown in its History.

Inputs

Related torelated_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.
Recordrelated_totextRequired
The ID of the account, contact, lead, opportunity or case it's about, or a link to it in SuiteCRM.
SubjectsubjecttextRequired
What the note is about.
Texttexttext
What the note says.
Contactcontacttext
The contact it's about's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.

Outputs

contact_idtext
The contact it's about; empty if none
created_attext
When it was added (ISO 8601, UTC)
idtext
The note's ID
linktext
A link to it in SuiteCRM
related_idtext
The ID of the record it's about; empty if none
related_nametext
That record's name
related_typetext
What it's about: account, contact, lead, opportunity or case
subjecttext
Its subject
texttext
What it says
Example output
{
  "contact_id": "",
  "created_at": "2026-11-05T09:00:00Z",
  "id": "cc5614e9-3fa7-4ef0-832e-5f9234048f02",
  "link": "https://crm.example.com/#/notes/record/cc5614e9-3fa7-4ef0-832e-5f9234048f02",
  "related_id": "84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
  "related_name": "Analytical Engines",
  "related_type": "account",
  "subject": "Called back",
  "text": "Wants a quote for three engines."
}

Create account

Add an account: a company or organisation you work with.

Inputs

NamenametextRequired
What the account is called.
Emailemailtext
Its email address.
Office phonephonetext
Its office phone number.
Websitewebsitetext
Its website, such as https://acme.com.
Typeaccount_typetext
What it is to you, such as Customer or Partner.
Industryindustrytext
Its industry, such as Technology.
Streetstreettext
Its billing street address.
Citycitytext
Its billing city.
Statestatetext
Its billing state or region.
Postal codepostal_codetext
Its billing postal code or ZIP code.
Countrycountrytext
Its billing country.
Descriptiondescriptiontext
More about it, shown in SuiteCRM.
Assigned userassigned_usertext
The user the account is assigned to, or their full name or email.
Other fieldsother_fieldsobject
Any other fields by their name in SuiteCRM, such as {"department": "Sales"}. Fields an administrator added in Studio end in _c, such as {"lead_score_c": 80}; their names are under Admin > Studio.

Outputs

account_typetext
What it is to you, such as Customer
assigned_user_idtext
The ID of the user it's assigned to; empty if none
assigned_user_nametext
Their name
citytext
Billing address: city
countrytext
Billing address: country
created_attext
When it was added to SuiteCRM (ISO 8601, UTC)
custom_fieldsobject
Fields an administrator added in Studio (their names end in _c), as SuiteCRM 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 SuiteCRM
modified_attext
When it last changed (ISO 8601, UTC)
nametext
Its name
phonetext
Its office phone
postal_codetext
Billing address: postal code or zip code
statetext
Billing address: state or region
streettext
Billing address: street
websitetext
Its website
Example output
{
  "account_type": "Customer",
  "assigned_user_id": "47a89d91-2b58-4d2d-b13e-5c38f168859e",
  "assigned_user_name": "Sally Sales",
  "city": "London",
  "country": "United Kingdom",
  "created_at": "2026-11-05T09:00:00Z",
  "custom_fields": {},
  "description": "",
  "email": "hello@analytical.example.com",
  "id": "84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
  "industry": "Technology",
  "link": "https://crm.example.com/#/accounts/record/84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
  "modified_at": "2026-11-05T09:00:00Z",
  "name": "Analytical Engines",
  "phone": "+44 20 7946 0100",
  "postal_code": "NW1 5LR",
  "state": "",
  "street": "12 Marylebone Road",
  "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

SubjectnametextRequired
What the case is about.
Descriptiondescriptiontext
The details, such as the customer's message.
Accountaccounttext
The account's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
Contactcontacttext
The contact to link to it's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
Statusstatustext
Where it stands. Leave blank for New.
Priorityprioritytext
How urgent it is: High, Medium or Low.
Typecase_typetext
What kind of case it is, such as Product.
Assigned userassigned_usertext
The user the case is assigned to, or their full name or email.
Other fieldsother_fieldsobject
Any other fields by their name in SuiteCRM, such as {"department": "Sales"}. Fields an administrator added in Studio end in _c, such as {"lead_score_c": 80}; their names are under Admin > Studio.

Outputs

account_idtext
Its account's ID; empty if none
account_nametext
Its account's name
assigned_user_idtext
The ID of the user it's assigned to; empty if none
assigned_user_nametext
Their name
case_typetext
What kind of case it is, such as Product
created_attext
When it was added to SuiteCRM (ISO 8601, UTC)
custom_fieldsobject
Fields an administrator added in Studio (their names end in _c), as SuiteCRM gives them
descriptiontext
The details
idtext
The case's ID
linktext
A link to it in SuiteCRM
modified_attext
When it last changed (ISO 8601, UTC)
nametext
Its subject
numbertext
Its case number, such as 1042
prioritytext
P1 (High), P2 (Medium) or P3 (Low)
statetext
Open or Closed
statustext
Its status as SuiteCRM stores it, such as Open_New or Closed_Closed
Example output
{
  "account_id": "84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
  "account_name": "Analytical Engines",
  "assigned_user_id": "47a89d91-2b58-4d2d-b13e-5c38f168859e",
  "assigned_user_name": "Sally Sales",
  "case_type": "Product",
  "created_at": "2026-11-05T09:00:00Z",
  "custom_fields": {},
  "description": "Reported by phone.",
  "id": "f9960530-68bc-45df-a957-fc71dd546524",
  "link": "https://crm.example.com/#/cases/record/f9960530-68bc-45df-a957-fc71dd546524",
  "modified_at": "2026-11-05T09:00:00Z",
  "name": "The engine jams on gear 4",
  "number": "1042",
  "priority": "P1",
  "state": "Open",
  "status": "Open_New"
}

Create contact

Add a contact to SuiteCRM, even if one with the same email exists; use 'Create or update contact' to avoid that.

Inputs

First namefirst_nametext
Their first name.
Last namelast_nametextRequired
Their last name. SuiteCRM needs one for a contact.
Emailemailtext
Their email address.
Office phonephonetext
Their office phone number.
Mobilemobiletext
Their mobile phone number.
Titletitletext
Their job title, such as Head of Sales.
Accountaccounttext
The account's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
Sourcesourcetext
Where they came from, such as Web Site.
Streetstreettext
Their street address.
Citycitytext
Their city.
Statestatetext
Their state or region.
Postal codepostal_codetext
Their postal code or ZIP code.
Countrycountrytext
Their country.
Descriptiondescriptiontext
More about it, shown in SuiteCRM.
Assigned userassigned_usertext
The user the contact is assigned to, or their full name or email.
Other fieldsother_fieldsobject
Any other fields by their name in SuiteCRM, such as {"department": "Sales"}. Fields an administrator added in Studio end in _c, such as {"lead_score_c": 80}; their names are under Admin > Studio.

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 SuiteCRM (ISO 8601, UTC)
custom_fieldsobject
Fields an administrator added in Studio (their names end in _c), as SuiteCRM 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 SuiteCRM
mobiletext
Their mobile phone
modified_attext
When it last changed (ISO 8601, UTC)
nametext
Their full name
phonetext
Their office phone
postal_codetext
Postal code or ZIP code
sourcetext
Where they came from, such as Web Site
statetext
State or region
streettext
Street
titletext
Their job title
Example output
{
  "account_id": "84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
  "account_name": "Analytical Engines",
  "assigned_user_id": "47a89d91-2b58-4d2d-b13e-5c38f168859e",
  "assigned_user_name": "Sally Sales",
  "city": "London",
  "country": "United Kingdom",
  "created_at": "2026-11-05T09:00:00Z",
  "custom_fields": {},
  "description": "",
  "email": "grace@analytical.example.com",
  "first_name": "Grace",
  "id": "97efe5ad-1983-4315-aac5-14ca4b681fc1",
  "last_name": "Hopper",
  "link": "https://crm.example.com/#/contacts/record/97efe5ad-1983-4315-aac5-14ca4b681fc1",
  "mobile": "",
  "modified_at": "2026-11-05T09:00:00Z",
  "name": "Grace Hopper",
  "phone": "+44 20 7946 0135",
  "postal_code": "NW1 5LR",
  "source": "",
  "state": "",
  "street": "12 Marylebone Road",
  "title": "Chief Engineer"
}

Create lead

Add a lead to SuiteCRM, even if one with the same email exists; use 'Create or update lead' for forms and sign-ups.

Inputs

First namefirst_nametext
Their first name.
Last namelast_nametextRequired
Their last name. SuiteCRM needs one for a lead.
Emailemailtext
Their email address.
Office phonephonetext
Their office phone number.
Mobilemobiletext
Their mobile phone number.
Titletitletext
Their job title, such as Head of Sales.
Account nameaccount_nametext
The company or organisation they're with.
Statusstatustext
Where the lead stands, such as New or In Process.
Sourcesourcetext
Where they came from, such as Web Site.
Websitewebsitetext
Their website.
Streetstreettext
Their street address.
Citycitytext
Their city.
Statestatetext
Their state or region.
Postal codepostal_codetext
Their postal code or ZIP code.
Countrycountrytext
Their country.
Descriptiondescriptiontext
More about it, shown in SuiteCRM.
Assigned userassigned_usertext
The user the lead is assigned to, or their full name or email.
Other fieldsother_fieldsobject
Any other fields by their name in SuiteCRM, such as {"department": "Sales"}. Fields an administrator added in Studio end in _c, such as {"lead_score_c": 80}; their names are under Admin > Studio.

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
convertedtrue/false
Whether it has been converted into a contact
countrytext
Country
created_attext
When it was added to SuiteCRM (ISO 8601, UTC)
custom_fieldsobject
Fields an administrator added in Studio (their names end in _c), as SuiteCRM 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 SuiteCRM
mobiletext
Their mobile phone
modified_attext
When it last changed (ISO 8601, UTC)
nametext
Their full name
phonetext
Their office phone
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": "47a89d91-2b58-4d2d-b13e-5c38f168859e",
  "assigned_user_name": "Sally Sales",
  "city": "London",
  "converted": false,
  "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": "c2b5020d-38e0-4644-8195-1c11b32af713",
  "last_name": "Lovelace",
  "link": "https://crm.example.com/#/leads/record/c2b5020d-38e0-4644-8195-1c11b32af713",
  "mobile": "",
  "modified_at": "2026-11-05T09:00:00Z",
  "name": "Ada Lovelace",
  "phone": "+44 20 7946 0134",
  "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, sales stage, account and contact.

Inputs

NamenametextRequired
What the opportunity is called.
AmountamountnumberRequired
How much it's worth, in SuiteCRM's default currency, such as 12000.At least 0.
Expected close dateclose_datedateRequired
When it's expected to close.
Sales stagestagetext
The stage it starts in. Leave blank for Prospecting.
Probability (%)probabilitynumber
The chance it closes, from 0 to 100.From 0 to 100.
Next stepnext_steptext
What happens next, such as Send proposal.
Accountaccounttext
The account's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
Contactcontacttext
The contact to link to it's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
Descriptiondescriptiontext
More about it, shown in SuiteCRM.
Assigned userassigned_usertext
The user the opportunity is assigned to, or their full name or email.
Other fieldsother_fieldsobject
Any other fields by their name in SuiteCRM, such as {"department": "Sales"}. Fields an administrator added in Studio end in _c, such as {"lead_score_c": 80}; their names are under Admin > Studio.

Outputs

account_idtext
Its account's ID; empty if none
account_nametext
Its account's name
amountnumber
What 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)
created_attext
When it was added to SuiteCRM (ISO 8601, UTC)
currencytext
The amount's currency, such as US Dollar
custom_fieldsobject
Fields an administrator added in Studio (their names end in _c), as SuiteCRM gives them
descriptiontext
The opportunity's description
idtext
The opportunity's ID
linktext
A link to it in SuiteCRM
modified_attext
When it last changed (ISO 8601, UTC)
nametext
Its name
next_steptext
The next step
probabilitynumber
The chance it closes, in percent
stagetext
Its sales stage, such as Prospecting or Closed Won
Example output
{
  "account_id": "84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
  "account_name": "Analytical Engines",
  "amount": 12000.0,
  "assigned_user_id": "47a89d91-2b58-4d2d-b13e-5c38f168859e",
  "assigned_user_name": "Sally Sales",
  "close_date": "2026-12-31",
  "created_at": "2026-11-05T09:00:00Z",
  "currency": "US Dollar",
  "custom_fields": {},
  "description": "",
  "id": "25f8d9ae-d320-4fb7-acdb-a689de1cd59a",
  "link": "https://crm.example.com/#/opportunities/record/25f8d9ae-d320-4fb7-acdb-a689de1cd59a",
  "modified_at": "2026-11-05T09:00:00Z",
  "name": "Analytical Engines renewal",
  "next_step": "Send the proposal",
  "probability": 10.0,
  "stage": "Prospecting"
}

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

EmailemailtextRequired
The email to match the contact on; one is added if none has it.
First namefirst_nametext
Their first name.
Last namelast_nametext
Their last name. SuiteCRM needs one for a new contact; without one the email is used.
Office phonephonetext
Their office phone number.
Mobilemobiletext
Their mobile phone number.
Titletitletext
Their job title, such as Head of Sales.
Accountaccounttext
The account's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
Sourcesourcetext
Where they came from, such as Web Site.
Streetstreettext
Their street address.
Citycitytext
Their city.
Statestatetext
Their state or region.
Postal codepostal_codetext
Their postal code or ZIP code.
Countrycountrytext
Their country.
Descriptiondescriptiontext
More about it, shown in SuiteCRM.
Assigned userassigned_usertext
The user the contact is assigned to, or their full name or email.
Other fieldsother_fieldsobject
Any other fields by their name in SuiteCRM, such as {"department": "Sales"}. Fields an administrator added in Studio end in _c, such as {"lead_score_c": 80}; their names are under Admin > Studio.

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 one was updated
created_attext
When it was added to SuiteCRM (ISO 8601, UTC)
custom_fieldsobject
Fields an administrator added in Studio (their names end in _c), as SuiteCRM 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 SuiteCRM
mobiletext
Their mobile phone
modified_attext
When it last changed (ISO 8601, UTC)
nametext
Their full name
phonetext
Their office phone
postal_codetext
Postal code or ZIP code
sourcetext
Where they came from, such as Web Site
statetext
State or region
streettext
Street
titletext
Their job title
Example output
{
  "account_id": "84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
  "account_name": "Analytical Engines",
  "assigned_user_id": "47a89d91-2b58-4d2d-b13e-5c38f168859e",
  "assigned_user_name": "Sally Sales",
  "city": "London",
  "country": "United Kingdom",
  "created": true,
  "created_at": "2026-11-05T09:00:00Z",
  "custom_fields": {},
  "description": "",
  "email": "grace@analytical.example.com",
  "first_name": "Grace",
  "id": "97efe5ad-1983-4315-aac5-14ca4b681fc1",
  "last_name": "Hopper",
  "link": "https://crm.example.com/#/contacts/record/97efe5ad-1983-4315-aac5-14ca4b681fc1",
  "mobile": "",
  "modified_at": "2026-11-05T09:00:00Z",
  "name": "Grace Hopper",
  "phone": "+44 20 7946 0135",
  "postal_code": "NW1 5LR",
  "source": "",
  "state": "",
  "street": "12 Marylebone Road",
  "title": "Chief Engineer"
}

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

EmailemailtextRequired
The email to match the lead on; one is added if none has it.
First namefirst_nametext
Their first name.
Last namelast_nametext
Their last name. SuiteCRM needs one for a new lead; without one the email is used.
Office phonephonetext
Their office phone number.
Mobilemobiletext
Their mobile phone number.
Titletitletext
Their job title, such as Head of Sales.
Account nameaccount_nametext
The company or organisation they're with.
Statusstatustext
Where the lead stands, such as New or In Process.
Sourcesourcetext
Where they came from, such as Web Site.
Websitewebsitetext
Their website.
Streetstreettext
Their street address.
Citycitytext
Their city.
Statestatetext
Their state or region.
Postal codepostal_codetext
Their postal code or ZIP code.
Countrycountrytext
Their country.
Descriptiondescriptiontext
More about it, shown in SuiteCRM.
Assigned userassigned_usertext
The user the lead is assigned to, or their full name or email.
Other fieldsother_fieldsobject
Any other fields by their name in SuiteCRM, such as {"department": "Sales"}. Fields an administrator added in Studio end in _c, such as {"lead_score_c": 80}; their names are under Admin > Studio.

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
convertedtrue/false
Whether it has been converted into a contact
countrytext
Country
createdtrue/false
True if it was added, false if one was updated
created_attext
When it was added to SuiteCRM (ISO 8601, UTC)
custom_fieldsobject
Fields an administrator added in Studio (their names end in _c), as SuiteCRM 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 SuiteCRM
mobiletext
Their mobile phone
modified_attext
When it last changed (ISO 8601, UTC)
nametext
Their full name
phonetext
Their office phone
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": "47a89d91-2b58-4d2d-b13e-5c38f168859e",
  "assigned_user_name": "Sally Sales",
  "city": "London",
  "converted": false,
  "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": "c2b5020d-38e0-4644-8195-1c11b32af713",
  "last_name": "Lovelace",
  "link": "https://crm.example.com/#/leads/record/c2b5020d-38e0-4644-8195-1c11b32af713",
  "mobile": "",
  "modified_at": "2026-11-05T09:00:00Z",
  "name": "Ada Lovelace",
  "phone": "+44 20 7946 0134",
  "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, with a due date, about an account, contact, lead, opportunity or case.

Inputs

SubjectnametextRequired
What needs doing.
Duedue_atdate and time
When it's due.
Statusstatustext
Where it stands. Leave blank for Not Started.One of: Not Started, In Progress, Completed, Pending Input, Deferred.
Priorityprioritytext
How urgent it is. Leave blank for Medium.One of: High, Medium, Low.
Descriptiondescriptiontext
More about it.
Related torelated_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.
Recordrelated_totext
The ID of the account, contact, lead, opportunity or case it's about, or a link to it in SuiteCRM.
Contactcontacttext
The contact it's for's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
Assigned userassigned_usertext
The user the task is for, or their full name or email.

Outputs

assigned_user_idtext
The ID of the user it's for
assigned_user_nametext
Their name
contact_idtext
The contact it's for; empty if none
created_attext
When it was added (ISO 8601, UTC)
descriptiontext
More about it
due_attext
When it's due (ISO 8601, UTC); empty if no date
idtext
The task's ID
linktext
A link to it in SuiteCRM
nametext
What needs doing
prioritytext
High, Medium or Low
related_idtext
The ID of the record it's about; empty if none
related_nametext
That record's name
related_typetext
What it's about: account, contact, lead, opportunity or case
statustext
Where it stands, such as Not Started
Example output
{
  "assigned_user_id": "47a89d91-2b58-4d2d-b13e-5c38f168859e",
  "assigned_user_name": "Sally Sales",
  "contact_id": "",
  "created_at": "2026-11-05T09:00:00Z",
  "description": "",
  "due_at": "2026-11-20T15:00:00Z",
  "id": "4580dc28-80e0-4461-8435-eccf42fab1a7",
  "link": "https://crm.example.com/#/tasks/record/4580dc28-80e0-4461-8435-eccf42fab1a7",
  "name": "Send the quote",
  "priority": "High",
  "related_id": "84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
  "related_name": "Analytical Engines",
  "related_type": "account",
  "status": "Not Started"
}

Delete record

Delete a lead, contact, account, opportunity, case, task, call or note.

Inputs

Typerecord_typetextRequired
What kind of record it is.One of: lead, contact, account, opportunity, case, task, call, note.
RecordrecordtextRequired
The record's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.

Outputs

deletedtrue/false
Always true once deleted
idtext
Its ID
record_typetext
The kind of record deleted
Example output
{
  "deleted": true,
  "id": "c2b5020d-38e0-4644-8195-1c11b32af713",
  "record_type": "lead"
}

Find accounts

Find accounts by name, email, website or type, newest first. Leave every field blank to list the newest.

Inputs

Namenametext
Words in the account's name.
Emailemailtext
Its email address.
Websitewebsitetext
Its website, such as acme.com.
Typeaccount_typetext
Only accounts of this type.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

accountslist
The accounts found
countnumber
How many are listed
Example output
{
  "accounts": [
    {
      "account_type": "Customer",
      "assigned_user_id": "47a89d91-2b58-4d2d-b13e-5c38f168859e",
      "assigned_user_name": "Sally Sales",
      "city": "London",
      "country": "United Kingdom",
      "created_at": "2026-11-05T09:00:00Z",
      "custom_fields": {},
      "description": "",
      "email": "hello@analytical.example.com",
      "id": "84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
      "industry": "Technology",
      "link": "https://crm.example.com/#/accounts/record/84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
      "modified_at": "2026-11-05T09:00:00Z",
      "name": "Analytical Engines",
      "phone": "+44 20 7946 0100",
      "postal_code": "NW1 5LR",
      "state": "",
      "street": "12 Marylebone Road",
      "website": "https://analytical.example.com"
    }
  ],
  "count": 1
}

Find cases

Find cases by subject, number, status or account, newest first. Leave every field blank to list the newest.

Inputs

Subjectnametext
Words in the case's subject.
Case numbernumbernumber
The case's number, such as 1042.At least 1.
Statusstatustext
Only cases with this status.
Accountaccounttext
The account's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

caseslist
The cases found
countnumber
How many are listed
Example output
{
  "cases": [
    {
      "account_id": "84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
      "account_name": "Analytical Engines",
      "assigned_user_id": "47a89d91-2b58-4d2d-b13e-5c38f168859e",
      "assigned_user_name": "Sally Sales",
      "case_type": "Product",
      "created_at": "2026-11-05T09:00:00Z",
      "custom_fields": {},
      "description": "Reported by phone.",
      "id": "f9960530-68bc-45df-a957-fc71dd546524",
      "link": "https://crm.example.com/#/cases/record/f9960530-68bc-45df-a957-fc71dd546524",
      "modified_at": "2026-11-05T09:00:00Z",
      "name": "The engine jams on gear 4",
      "number": "1042",
      "priority": "P1",
      "state": "Open",
      "status": "Open_New"
    }
  ],
  "count": 1
}

Find contacts

Find contacts by email, name or account, newest first. Leave every field blank to list the newest.

Inputs

Emailemailtext
Their email address.
Namenametext
Their name, or part of it, such as Ada or Ada Lovelace.
Accountaccounttext
The account's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

contactslist
The contacts found
countnumber
How many are listed
Example output
{
  "contacts": [
    {
      "account_id": "84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
      "account_name": "Analytical Engines",
      "assigned_user_id": "47a89d91-2b58-4d2d-b13e-5c38f168859e",
      "assigned_user_name": "Sally Sales",
      "city": "London",
      "country": "United Kingdom",
      "created_at": "2026-11-05T09:00:00Z",
      "custom_fields": {},
      "description": "",
      "email": "grace@analytical.example.com",
      "first_name": "Grace",
      "id": "97efe5ad-1983-4315-aac5-14ca4b681fc1",
      "last_name": "Hopper",
      "link": "https://crm.example.com/#/contacts/record/97efe5ad-1983-4315-aac5-14ca4b681fc1",
      "mobile": "",
      "modified_at": "2026-11-05T09:00:00Z",
      "name": "Grace Hopper",
      "phone": "+44 20 7946 0135",
      "postal_code": "NW1 5LR",
      "source": "",
      "state": "",
      "street": "12 Marylebone Road",
      "title": "Chief Engineer"
    }
  ],
  "count": 1
}

Find leads

Find leads by email, name, status or source, newest first. Leave every field blank to list the newest.

Inputs

Emailemailtext
Their email address.
Namenametext
Their name, or part of it, such as Ada or Ada Lovelace.
Statusstatustext
Only leads with this status.
Sourcesourcetext
Only leads from this source.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
leadslist
The leads found
Example output
{
  "count": 1,
  "leads": [
    {
      "account_name": "Analytical Engines",
      "assigned_user_id": "47a89d91-2b58-4d2d-b13e-5c38f168859e",
      "assigned_user_name": "Sally Sales",
      "city": "London",
      "converted": false,
      "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": "c2b5020d-38e0-4644-8195-1c11b32af713",
      "last_name": "Lovelace",
      "link": "https://crm.example.com/#/leads/record/c2b5020d-38e0-4644-8195-1c11b32af713",
      "mobile": "",
      "modified_at": "2026-11-05T09:00:00Z",
      "name": "Ada Lovelace",
      "phone": "+44 20 7946 0134",
      "postal_code": "NW1 5LR",
      "source": "Web Site",
      "state": "",
      "status": "New",
      "street": "12 Marylebone Road",
      "title": "Head of Engineering",
      "website": "https://analytical.example.com"
    }
  ]
}

Find opportunities

Find opportunities by name, sales stage or account, newest first. Leave every field blank to list the newest.

Inputs

Namenametext
Words in the opportunity's name.
Sales stagestagetext
Only opportunities in this stage.
Accountaccounttext
The account's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
opportunitieslist
The opportunities found
Example output
{
  "count": 1,
  "opportunities": [
    {
      "account_id": "84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
      "account_name": "Analytical Engines",
      "amount": 12000.0,
      "assigned_user_id": "47a89d91-2b58-4d2d-b13e-5c38f168859e",
      "assigned_user_name": "Sally Sales",
      "close_date": "2026-12-31",
      "created_at": "2026-11-05T09:00:00Z",
      "currency": "US Dollar",
      "custom_fields": {},
      "description": "",
      "id": "25f8d9ae-d320-4fb7-acdb-a689de1cd59a",
      "link": "https://crm.example.com/#/opportunities/record/25f8d9ae-d320-4fb7-acdb-a689de1cd59a",
      "modified_at": "2026-11-05T09:00:00Z",
      "name": "Analytical Engines renewal",
      "next_step": "Send the proposal",
      "probability": 10.0,
      "stage": "Prospecting"
    }
  ]
}

Get account

Get an account's details.

Inputs

AccountaccounttextRequired
The account's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.

Outputs

account_typetext
What it is to you, such as Customer
assigned_user_idtext
The ID of the user it's assigned to; empty if none
assigned_user_nametext
Their name
citytext
Billing address: city
countrytext
Billing address: country
created_attext
When it was added to SuiteCRM (ISO 8601, UTC)
custom_fieldsobject
Fields an administrator added in Studio (their names end in _c), as SuiteCRM 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 SuiteCRM
modified_attext
When it last changed (ISO 8601, UTC)
nametext
Its name
phonetext
Its office phone
postal_codetext
Billing address: postal code or zip code
statetext
Billing address: state or region
streettext
Billing address: street
websitetext
Its website
Example output
{
  "account_type": "Customer",
  "assigned_user_id": "47a89d91-2b58-4d2d-b13e-5c38f168859e",
  "assigned_user_name": "Sally Sales",
  "city": "London",
  "country": "United Kingdom",
  "created_at": "2026-11-05T09:00:00Z",
  "custom_fields": {},
  "description": "",
  "email": "hello@analytical.example.com",
  "id": "84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
  "industry": "Technology",
  "link": "https://crm.example.com/#/accounts/record/84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
  "modified_at": "2026-11-05T09:00:00Z",
  "name": "Analytical Engines",
  "phone": "+44 20 7946 0100",
  "postal_code": "NW1 5LR",
  "state": "",
  "street": "12 Marylebone Road",
  "website": "https://analytical.example.com"
}

Get case

Get a case's details, with its number, status and account.

Inputs

CasecasetextRequired
The case's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.

Outputs

account_idtext
Its account's ID; empty if none
account_nametext
Its account's name
assigned_user_idtext
The ID of the user it's assigned to; empty if none
assigned_user_nametext
Their name
case_typetext
What kind of case it is, such as Product
created_attext
When it was added to SuiteCRM (ISO 8601, UTC)
custom_fieldsobject
Fields an administrator added in Studio (their names end in _c), as SuiteCRM gives them
descriptiontext
The details
idtext
The case's ID
linktext
A link to it in SuiteCRM
modified_attext
When it last changed (ISO 8601, UTC)
nametext
Its subject
numbertext
Its case number, such as 1042
prioritytext
P1 (High), P2 (Medium) or P3 (Low)
statetext
Open or Closed
statustext
Its status as SuiteCRM stores it, such as Open_New or Closed_Closed
Example output
{
  "account_id": "84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
  "account_name": "Analytical Engines",
  "assigned_user_id": "47a89d91-2b58-4d2d-b13e-5c38f168859e",
  "assigned_user_name": "Sally Sales",
  "case_type": "Product",
  "created_at": "2026-11-05T09:00:00Z",
  "custom_fields": {},
  "description": "Reported by phone.",
  "id": "f9960530-68bc-45df-a957-fc71dd546524",
  "link": "https://crm.example.com/#/cases/record/f9960530-68bc-45df-a957-fc71dd546524",
  "modified_at": "2026-11-05T09:00:00Z",
  "name": "The engine jams on gear 4",
  "number": "1042",
  "priority": "P1",
  "state": "Open",
  "status": "Open_New"
}

Get contact

Get a contact's details, with their account's name.

Inputs

ContactcontacttextRequired
The contact's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.

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 SuiteCRM (ISO 8601, UTC)
custom_fieldsobject
Fields an administrator added in Studio (their names end in _c), as SuiteCRM 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 SuiteCRM
mobiletext
Their mobile phone
modified_attext
When it last changed (ISO 8601, UTC)
nametext
Their full name
phonetext
Their office phone
postal_codetext
Postal code or ZIP code
sourcetext
Where they came from, such as Web Site
statetext
State or region
streettext
Street
titletext
Their job title
Example output
{
  "account_id": "84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
  "account_name": "Analytical Engines",
  "assigned_user_id": "47a89d91-2b58-4d2d-b13e-5c38f168859e",
  "assigned_user_name": "Sally Sales",
  "city": "London",
  "country": "United Kingdom",
  "created_at": "2026-11-05T09:00:00Z",
  "custom_fields": {},
  "description": "",
  "email": "grace@analytical.example.com",
  "first_name": "Grace",
  "id": "97efe5ad-1983-4315-aac5-14ca4b681fc1",
  "last_name": "Hopper",
  "link": "https://crm.example.com/#/contacts/record/97efe5ad-1983-4315-aac5-14ca4b681fc1",
  "mobile": "",
  "modified_at": "2026-11-05T09:00:00Z",
  "name": "Grace Hopper",
  "phone": "+44 20 7946 0135",
  "postal_code": "NW1 5LR",
  "source": "",
  "state": "",
  "street": "12 Marylebone Road",
  "title": "Chief Engineer"
}

Get lead

Get a lead's details.

Inputs

LeadleadtextRequired
The lead's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.

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
convertedtrue/false
Whether it has been converted into a contact
countrytext
Country
created_attext
When it was added to SuiteCRM (ISO 8601, UTC)
custom_fieldsobject
Fields an administrator added in Studio (their names end in _c), as SuiteCRM 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 SuiteCRM
mobiletext
Their mobile phone
modified_attext
When it last changed (ISO 8601, UTC)
nametext
Their full name
phonetext
Their office phone
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": "47a89d91-2b58-4d2d-b13e-5c38f168859e",
  "assigned_user_name": "Sally Sales",
  "city": "London",
  "converted": false,
  "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": "c2b5020d-38e0-4644-8195-1c11b32af713",
  "last_name": "Lovelace",
  "link": "https://crm.example.com/#/leads/record/c2b5020d-38e0-4644-8195-1c11b32af713",
  "mobile": "",
  "modified_at": "2026-11-05T09:00:00Z",
  "name": "Ada Lovelace",
  "phone": "+44 20 7946 0134",
  "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 sales stage and account.

Inputs

OpportunityopportunitytextRequired
The opportunity's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.

Outputs

account_idtext
Its account's ID; empty if none
account_nametext
Its account's name
amountnumber
What 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)
created_attext
When it was added to SuiteCRM (ISO 8601, UTC)
currencytext
The amount's currency, such as US Dollar
custom_fieldsobject
Fields an administrator added in Studio (their names end in _c), as SuiteCRM gives them
descriptiontext
The opportunity's description
idtext
The opportunity's ID
linktext
A link to it in SuiteCRM
modified_attext
When it last changed (ISO 8601, UTC)
nametext
Its name
next_steptext
The next step
probabilitynumber
The chance it closes, in percent
stagetext
Its sales stage, such as Prospecting or Closed Won
Example output
{
  "account_id": "84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
  "account_name": "Analytical Engines",
  "amount": 12000.0,
  "assigned_user_id": "47a89d91-2b58-4d2d-b13e-5c38f168859e",
  "assigned_user_name": "Sally Sales",
  "close_date": "2026-12-31",
  "created_at": "2026-11-05T09:00:00Z",
  "currency": "US Dollar",
  "custom_fields": {},
  "description": "",
  "id": "25f8d9ae-d320-4fb7-acdb-a689de1cd59a",
  "link": "https://crm.example.com/#/opportunities/record/25f8d9ae-d320-4fb7-acdb-a689de1cd59a",
  "modified_at": "2026-11-05T09:00:00Z",
  "name": "Analytical Engines renewal",
  "next_step": "Send the proposal",
  "probability": 10.0,
  "stage": "Prospecting"
}

Link two related records, such as a contact to an account or an opportunity, so each shows under the other in SuiteCRM.

Inputs

Record typerecord_typetextRequired
The kind of the first record, such as Contact.One of: account, contact, lead, opportunity, case.
RecordrecordtextRequired
The first record's ID or link in SuiteCRM.
Link torelated_typetextRequired
The kind of record to link it to, such as Account.One of: account, contact, lead, opportunity, case.
Related recordrelatedtextRequired
That record's ID or link in SuiteCRM.

Outputs

linkedtrue/false
Always true once linked
record_idtext
Its ID
record_typetext
The first record's kind
related_idtext
Its ID
related_typetext
The other record's kind
Example output
{
  "linked": true,
  "record_id": "97efe5ad-1983-4315-aac5-14ca4b681fc1",
  "record_type": "contact",
  "related_id": "84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
  "related_type": "account"
}

List users

List the active users records can be assigned to, with their emails.

Inputs

None.

Outputs

countnumber
How many are listed
userslist
The active users
Example output
{
  "count": 1,
  "users": [
    {
      "email": "sally@example.com",
      "id": "47a89d91-2b58-4d2d-b13e-5c38f168859e",
      "name": "Sally Sales",
      "title": "Account Executive"
    }
  ]
}

Log call

Record a call someone made or took, about an account, contact, lead, opportunity or case.

Inputs

SubjectnametextRequired
What the call was about.
Startedstart_atdate and time
When the call started. Leave blank for now.
Minutesduration_minutesnumber
How long it lasted, in minutes. Leave blank for 15.At least 0.
Directiondirectiontext
Whether you called them or they called you. Leave blank for Outbound.One of: Outbound, Inbound.
Statusstatustext
Whether it happened. Leave blank for Held.One of: Held, Planned, Not Held.
Descriptiondescriptiontext
Notes from the call.
Related torelated_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.
Recordrelated_totext
The ID of the account, contact, lead, opportunity or case it's about, or a link to it in SuiteCRM.
Assigned userassigned_usertext
The user who made or took the call, or their full name or email.

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
idtext
The call's ID
linktext
A link to it in SuiteCRM
nametext
What it was about
related_idtext
The ID of the record it's about; empty if none
related_nametext
That record's name
related_typetext
What it's about: account, contact, lead, opportunity or case
start_attext
When it started (ISO 8601, UTC)
statustext
Held, Planned or Not Held
Example output
{
  "assigned_user_id": "47a89d91-2b58-4d2d-b13e-5c38f168859e",
  "assigned_user_name": "Sally Sales",
  "created_at": "2026-11-05T09:16:00Z",
  "description": "Wants a demo next week.",
  "direction": "Outbound",
  "duration_minutes": 15,
  "id": "a32a20d8-72ad-4f32-970f-b6bbd748b23e",
  "link": "https://crm.example.com/#/calls/record/a32a20d8-72ad-4f32-970f-b6bbd748b23e",
  "name": "Intro call",
  "related_id": "84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
  "related_name": "Analytical Engines",
  "related_type": "account",
  "start_at": "2026-11-05T09:00:00Z",
  "status": "Held"
}

Search records

Find records of any kind (module) with a filter on their fields, such as cases with priority P1 or accounts in one city.

Inputs

Record typerecord_typetextRequired
The kind of record (module) to search, such as Accounts.
Conditionsconditionsobject
Field names and the values they must have, such as {"billing_address_city": "London"}. For other comparisons give an operator: {"amount": {"gte": 10000}}, or like with % for any text: {"name": {"like": "Acme%"}}. Operators: eq, neq, gt, gte, lt, lte, like. Times are UTC.
Matchmatchtext
Whether a record must meet all the conditions or any of them. Leave blank for all.One of: all (All conditions), any (Any condition).
Sort bysort_bytext
A field to sort by, with - before it for newest or largest first, such as -date_modified. Leave blank for newest added first.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
recordslist
The records found, newest first unless sorted
Example output
{
  "count": 1,
  "records": [
    {
      "fields": {
        "account_type": "Customer",
        "name": "Analytical Engines"
      },
      "id": "84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
      "link": "https://crm.example.com/#/accounts/record/84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
      "name": "Analytical Engines",
      "record_type": "Accounts"
    }
  ]
}

Update account

Change an account's details. Fields left blank keep what it has.

Inputs

AccountaccounttextRequired
The account's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
Namenametext
What the account is called. Leave blank to keep it.
Emailemailtext
Its email address.
Office phonephonetext
Its office phone number.
Websitewebsitetext
Its website, such as https://acme.com.
Typeaccount_typetext
What it is to you, such as Customer or Partner.
Industryindustrytext
Its industry, such as Technology.
Streetstreettext
Its billing street address.
Citycitytext
Its billing city.
Statestatetext
Its billing state or region.
Postal codepostal_codetext
Its billing postal code or ZIP code.
Countrycountrytext
Its billing country.
Descriptiondescriptiontext
More about it, shown in SuiteCRM.
Assigned userassigned_usertext
The user the account is assigned to, or their full name or email.
Other fieldsother_fieldsobject
Any other fields by their name in SuiteCRM, such as {"department": "Sales"}. Fields an administrator added in Studio end in _c, such as {"lead_score_c": 80}; their names are under Admin > Studio.

Outputs

account_typetext
What it is to you, such as Customer
assigned_user_idtext
The ID of the user it's assigned to; empty if none
assigned_user_nametext
Their name
citytext
Billing address: city
countrytext
Billing address: country
created_attext
When it was added to SuiteCRM (ISO 8601, UTC)
custom_fieldsobject
Fields an administrator added in Studio (their names end in _c), as SuiteCRM 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 SuiteCRM
modified_attext
When it last changed (ISO 8601, UTC)
nametext
Its name
phonetext
Its office phone
postal_codetext
Billing address: postal code or zip code
statetext
Billing address: state or region
streettext
Billing address: street
websitetext
Its website
Example output
{
  "account_type": "Customer",
  "assigned_user_id": "47a89d91-2b58-4d2d-b13e-5c38f168859e",
  "assigned_user_name": "Sally Sales",
  "city": "London",
  "country": "United Kingdom",
  "created_at": "2026-11-05T09:00:00Z",
  "custom_fields": {},
  "description": "",
  "email": "hello@analytical.example.com",
  "id": "84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
  "industry": "Technology",
  "link": "https://crm.example.com/#/accounts/record/84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
  "modified_at": "2026-11-05T09:00:00Z",
  "name": "Analytical Engines",
  "phone": "+44 20 7946 0100",
  "postal_code": "NW1 5LR",
  "state": "",
  "street": "12 Marylebone Road",
  "website": "https://analytical.example.com"
}

Update case

Change a case, such as its status, priority or who it's assigned to; a Closed, Rejected or Duplicate status closes it. Fields left blank keep what it has.

Inputs

CasecasetextRequired
The case's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
Subjectnametext
What the case is about. Leave blank to keep it.
Descriptiondescriptiontext
The details, such as the customer's message.
Accountaccounttext
The account's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
Statusstatustext
Where it stands now, such as Pending Input or Closed. Leave blank to keep it.
Priorityprioritytext
How urgent it is: High, Medium or Low.
Typecase_typetext
What kind of case it is, such as Product.
Assigned userassigned_usertext
The user the case is assigned to, or their full name or email.
Other fieldsother_fieldsobject
Any other fields by their name in SuiteCRM, such as {"department": "Sales"}. Fields an administrator added in Studio end in _c, such as {"lead_score_c": 80}; their names are under Admin > Studio.

Outputs

account_idtext
Its account's ID; empty if none
account_nametext
Its account's name
assigned_user_idtext
The ID of the user it's assigned to; empty if none
assigned_user_nametext
Their name
case_typetext
What kind of case it is, such as Product
created_attext
When it was added to SuiteCRM (ISO 8601, UTC)
custom_fieldsobject
Fields an administrator added in Studio (their names end in _c), as SuiteCRM gives them
descriptiontext
The details
idtext
The case's ID
linktext
A link to it in SuiteCRM
modified_attext
When it last changed (ISO 8601, UTC)
nametext
Its subject
numbertext
Its case number, such as 1042
prioritytext
P1 (High), P2 (Medium) or P3 (Low)
statetext
Open or Closed
statustext
Its status as SuiteCRM stores it, such as Open_New or Closed_Closed
Example output
{
  "account_id": "84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
  "account_name": "Analytical Engines",
  "assigned_user_id": "47a89d91-2b58-4d2d-b13e-5c38f168859e",
  "assigned_user_name": "Sally Sales",
  "case_type": "Product",
  "created_at": "2026-11-05T09:00:00Z",
  "custom_fields": {},
  "description": "Reported by phone.",
  "id": "f9960530-68bc-45df-a957-fc71dd546524",
  "link": "https://crm.example.com/#/cases/record/f9960530-68bc-45df-a957-fc71dd546524",
  "modified_at": "2026-11-05T09:00:00Z",
  "name": "The engine jams on gear 4",
  "number": "1042",
  "priority": "P1",
  "state": "Open",
  "status": "Open_New"
}

Update contact

Change a contact's details. Fields left blank keep what they have.

Inputs

ContactcontacttextRequired
The contact's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
First namefirst_nametext
Their first name.
Last namelast_nametext
Their last name.
Emailemailtext
Their email address.
Office phonephonetext
Their office phone number.
Mobilemobiletext
Their mobile phone number.
Titletitletext
Their job title, such as Head of Sales.
Accountaccounttext
The account's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
Sourcesourcetext
Where they came from, such as Web Site.
Streetstreettext
Their street address.
Citycitytext
Their city.
Statestatetext
Their state or region.
Postal codepostal_codetext
Their postal code or ZIP code.
Countrycountrytext
Their country.
Descriptiondescriptiontext
More about it, shown in SuiteCRM.
Assigned userassigned_usertext
The user the contact is assigned to, or their full name or email.
Other fieldsother_fieldsobject
Any other fields by their name in SuiteCRM, such as {"department": "Sales"}. Fields an administrator added in Studio end in _c, such as {"lead_score_c": 80}; their names are under Admin > Studio.

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 SuiteCRM (ISO 8601, UTC)
custom_fieldsobject
Fields an administrator added in Studio (their names end in _c), as SuiteCRM 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 SuiteCRM
mobiletext
Their mobile phone
modified_attext
When it last changed (ISO 8601, UTC)
nametext
Their full name
phonetext
Their office phone
postal_codetext
Postal code or ZIP code
sourcetext
Where they came from, such as Web Site
statetext
State or region
streettext
Street
titletext
Their job title
Example output
{
  "account_id": "84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
  "account_name": "Analytical Engines",
  "assigned_user_id": "47a89d91-2b58-4d2d-b13e-5c38f168859e",
  "assigned_user_name": "Sally Sales",
  "city": "London",
  "country": "United Kingdom",
  "created_at": "2026-11-05T09:00:00Z",
  "custom_fields": {},
  "description": "",
  "email": "grace@analytical.example.com",
  "first_name": "Grace",
  "id": "97efe5ad-1983-4315-aac5-14ca4b681fc1",
  "last_name": "Hopper",
  "link": "https://crm.example.com/#/contacts/record/97efe5ad-1983-4315-aac5-14ca4b681fc1",
  "mobile": "",
  "modified_at": "2026-11-05T09:00:00Z",
  "name": "Grace Hopper",
  "phone": "+44 20 7946 0135",
  "postal_code": "NW1 5LR",
  "source": "",
  "state": "",
  "street": "12 Marylebone Road",
  "title": "Chief Engineer"
}

Update lead

Change a lead, such as its status. Fields left blank keep what they have.

Inputs

LeadleadtextRequired
The lead's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
First namefirst_nametext
Their first name.
Last namelast_nametext
Their last name.
Emailemailtext
Their email address.
Office phonephonetext
Their office phone number.
Mobilemobiletext
Their mobile phone number.
Titletitletext
Their job title, such as Head of Sales.
Account nameaccount_nametext
The company or organisation they're with.
Statusstatustext
Where the lead stands, such as New or In Process.
Sourcesourcetext
Where they came from, such as Web Site.
Websitewebsitetext
Their website.
Streetstreettext
Their street address.
Citycitytext
Their city.
Statestatetext
Their state or region.
Postal codepostal_codetext
Their postal code or ZIP code.
Countrycountrytext
Their country.
Descriptiondescriptiontext
More about it, shown in SuiteCRM.
Assigned userassigned_usertext
The user the lead is assigned to, or their full name or email.
Other fieldsother_fieldsobject
Any other fields by their name in SuiteCRM, such as {"department": "Sales"}. Fields an administrator added in Studio end in _c, such as {"lead_score_c": 80}; their names are under Admin > Studio.

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
convertedtrue/false
Whether it has been converted into a contact
countrytext
Country
created_attext
When it was added to SuiteCRM (ISO 8601, UTC)
custom_fieldsobject
Fields an administrator added in Studio (their names end in _c), as SuiteCRM 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 SuiteCRM
mobiletext
Their mobile phone
modified_attext
When it last changed (ISO 8601, UTC)
nametext
Their full name
phonetext
Their office phone
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": "47a89d91-2b58-4d2d-b13e-5c38f168859e",
  "assigned_user_name": "Sally Sales",
  "city": "London",
  "converted": false,
  "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": "c2b5020d-38e0-4644-8195-1c11b32af713",
  "last_name": "Lovelace",
  "link": "https://crm.example.com/#/leads/record/c2b5020d-38e0-4644-8195-1c11b32af713",
  "mobile": "",
  "modified_at": "2026-11-05T09:00:00Z",
  "name": "Ada Lovelace",
  "phone": "+44 20 7946 0134",
  "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 sales stage or marking it Closed Won. Fields left blank keep what it has.

Inputs

OpportunityopportunitytextRequired
The opportunity's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
Namenametext
What the opportunity is called. Leave blank to keep it.
Amountamountnumber
How much it's worth, in SuiteCRM's default currency, such as 12000.At least 0.
Expected close dateclose_datedate
When it's expected to close.
Sales stagestagetext
The stage to move it to, such as Closed Won. Leave blank to keep it where it is.
Probability (%)probabilitynumber
The chance it closes, from 0 to 100.From 0 to 100.
Next stepnext_steptext
What happens next, such as Send proposal.
Accountaccounttext
The account's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
Contactcontacttext
The contact to link to it's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
Descriptiondescriptiontext
More about it, shown in SuiteCRM.
Assigned userassigned_usertext
The user the opportunity is assigned to, or their full name or email.
Other fieldsother_fieldsobject
Any other fields by their name in SuiteCRM, such as {"department": "Sales"}. Fields an administrator added in Studio end in _c, such as {"lead_score_c": 80}; their names are under Admin > Studio.

Outputs

account_idtext
Its account's ID; empty if none
account_nametext
Its account's name
amountnumber
What 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)
created_attext
When it was added to SuiteCRM (ISO 8601, UTC)
currencytext
The amount's currency, such as US Dollar
custom_fieldsobject
Fields an administrator added in Studio (their names end in _c), as SuiteCRM gives them
descriptiontext
The opportunity's description
idtext
The opportunity's ID
linktext
A link to it in SuiteCRM
modified_attext
When it last changed (ISO 8601, UTC)
nametext
Its name
next_steptext
The next step
probabilitynumber
The chance it closes, in percent
stagetext
Its sales stage, such as Prospecting or Closed Won
Example output
{
  "account_id": "84c7cde2-e30a-4591-b9c3-0ab13fc8610e",
  "account_name": "Analytical Engines",
  "amount": 12000.0,
  "assigned_user_id": "47a89d91-2b58-4d2d-b13e-5c38f168859e",
  "assigned_user_name": "Sally Sales",
  "close_date": "2026-12-31",
  "created_at": "2026-11-05T09:00:00Z",
  "currency": "US Dollar",
  "custom_fields": {},
  "description": "",
  "id": "25f8d9ae-d320-4fb7-acdb-a689de1cd59a",
  "link": "https://crm.example.com/#/opportunities/record/25f8d9ae-d320-4fb7-acdb-a689de1cd59a",
  "modified_at": "2026-11-05T09:00:00Z",
  "name": "Analytical Engines renewal",
  "next_step": "Send the proposal",
  "probability": 10.0,
  "stage": "Prospecting"
}

On this page