# SuiteCRM

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

App · 29 actions. Web page: https://docs.lodol.com/docs/integrations/suitecrm

## Actions

### Add note

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

**Inputs**

- Related to (`related_to_type`, text): 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_to`, text, required): The ID of the account, contact, lead, opportunity or case it's about, or a link to it in SuiteCRM.
- Subject (`subject`, text, required): What the note is about.
- Text (`text`, text): What the note says.
- Contact (`contact`, text): The contact it's about's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.

**Outputs**

- `contact_id` (text): The contact it's about; empty if none
- `created_at` (text): When it was added (ISO 8601, UTC)
- `id` (text): The note's ID
- `link` (text): A link to it in SuiteCRM
- `related_id` (text): The ID of the record it's about; empty if none
- `related_name` (text): That record's name
- `related_type` (text): What it's about: account, contact, lead, opportunity or case
- `subject` (text): Its subject
- `text` (text): What it says

**Example output**

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

- Name (`name`, text, required): What the account is called.
- Email (`email`, text): Its email address.
- Office phone (`phone`, text): Its office phone number.
- Website (`website`, text): Its website, such as https://acme.com.
- Type (`account_type`, text): What it is to you, such as Customer or Partner.
- Industry (`industry`, text): Its industry, such as Technology.
- Street (`street`, text): Its billing street address.
- City (`city`, text): Its billing city.
- State (`state`, text): Its billing state or region.
- Postal code (`postal_code`, text): Its billing postal code or ZIP code.
- Country (`country`, text): Its billing country.
- Description (`description`, text): More about it, shown in SuiteCRM.
- Assigned user (`assigned_user`, text): The user the account is assigned to, or their full name or email.
- Other fields (`other_fields`, object): 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_type` (text): What it is to you, such as Customer
- `assigned_user_id` (text): The ID of the user it's assigned to; empty if none
- `assigned_user_name` (text): Their name
- `city` (text): Billing address: city
- `country` (text): Billing address: country
- `created_at` (text): When it was added to SuiteCRM (ISO 8601, UTC)
- `custom_fields` (object): Fields an administrator added in Studio (their names end in _c), as SuiteCRM gives them
- `description` (text): The account's description
- `email` (text): Its primary email
- `id` (text): The account's ID
- `industry` (text): Its industry
- `link` (text): A link to it in SuiteCRM
- `modified_at` (text): When it last changed (ISO 8601, UTC)
- `name` (text): Its name
- `phone` (text): Its office phone
- `postal_code` (text): Billing address: postal code or zip code
- `state` (text): Billing address: state or region
- `street` (text): Billing address: street
- `website` (text): Its website

**Example output**

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

- Subject (`name`, text, required): What the case is about.
- Description (`description`, text): The details, such as the customer's message.
- Account (`account`, text): The account's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
- Contact (`contact`, text): The contact to link to it's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
- Status (`status`, text): Where it stands. Leave blank for New.
- Priority (`priority`, text): How urgent it is: High, Medium or Low.
- Type (`case_type`, text): What kind of case it is, such as Product.
- Assigned user (`assigned_user`, text): The user the case is assigned to, or their full name or email.
- Other fields (`other_fields`, object): 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_id` (text): Its account's ID; empty if none
- `account_name` (text): Its account's name
- `assigned_user_id` (text): The ID of the user it's assigned to; empty if none
- `assigned_user_name` (text): Their name
- `case_type` (text): What kind of case it is, such as Product
- `created_at` (text): When it was added to SuiteCRM (ISO 8601, UTC)
- `custom_fields` (object): Fields an administrator added in Studio (their names end in _c), as SuiteCRM gives them
- `description` (text): The details
- `id` (text): The case's ID
- `link` (text): A link to it in SuiteCRM
- `modified_at` (text): When it last changed (ISO 8601, UTC)
- `name` (text): Its subject
- `number` (text): Its case number, such as 1042
- `priority` (text): P1 (High), P2 (Medium) or P3 (Low)
- `state` (text): Open or Closed
- `status` (text): Its status as SuiteCRM stores it, such as Open_New or Closed_Closed

**Example output**

```json
{
  "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 name (`first_name`, text): Their first name.
- Last name (`last_name`, text, required): Their last name. SuiteCRM needs one for a contact.
- Email (`email`, text): Their email address.
- Office phone (`phone`, text): Their office phone number.
- Mobile (`mobile`, text): Their mobile phone number.
- Title (`title`, text): Their job title, such as Head of Sales.
- Account (`account`, text): The account's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
- Source (`source`, text): Where they came from, such as Web Site.
- Street (`street`, text): Their street address.
- City (`city`, text): Their city.
- State (`state`, text): Their state or region.
- Postal code (`postal_code`, text): Their postal code or ZIP code.
- Country (`country`, text): Their country.
- Description (`description`, text): More about it, shown in SuiteCRM.
- Assigned user (`assigned_user`, text): The user the contact is assigned to, or their full name or email.
- Other fields (`other_fields`, object): 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_id` (text): Their account's ID; empty if none
- `account_name` (text): Their account's name
- `assigned_user_id` (text): The ID of the user it's assigned to; empty if none
- `assigned_user_name` (text): Their name
- `city` (text): City
- `country` (text): Country
- `created_at` (text): When it was added to SuiteCRM (ISO 8601, UTC)
- `custom_fields` (object): Fields an administrator added in Studio (their names end in _c), as SuiteCRM gives them
- `description` (text): The contact's description
- `email` (text): Their primary email
- `first_name` (text): Their first name
- `id` (text): The contact's ID
- `last_name` (text): Their last name
- `link` (text): A link to it in SuiteCRM
- `mobile` (text): Their mobile phone
- `modified_at` (text): When it last changed (ISO 8601, UTC)
- `name` (text): Their full name
- `phone` (text): Their office phone
- `postal_code` (text): Postal code or ZIP code
- `source` (text): Where they came from, such as Web Site
- `state` (text): State or region
- `street` (text): Street
- `title` (text): Their job title

**Example output**

```json
{
  "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 name (`first_name`, text): Their first name.
- Last name (`last_name`, text, required): Their last name. SuiteCRM needs one for a lead.
- Email (`email`, text): Their email address.
- Office phone (`phone`, text): Their office phone number.
- Mobile (`mobile`, text): Their mobile phone number.
- Title (`title`, text): Their job title, such as Head of Sales.
- Account name (`account_name`, text): The company or organisation they're with.
- Status (`status`, text): Where the lead stands, such as New or In Process.
- Source (`source`, text): Where they came from, such as Web Site.
- Website (`website`, text): Their website.
- Street (`street`, text): Their street address.
- City (`city`, text): Their city.
- State (`state`, text): Their state or region.
- Postal code (`postal_code`, text): Their postal code or ZIP code.
- Country (`country`, text): Their country.
- Description (`description`, text): More about it, shown in SuiteCRM.
- Assigned user (`assigned_user`, text): The user the lead is assigned to, or their full name or email.
- Other fields (`other_fields`, object): 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_name` (text): The company they work for, as typed on the lead
- `assigned_user_id` (text): The ID of the user it's assigned to; empty if none
- `assigned_user_name` (text): Their name
- `city` (text): City
- `converted` (true/false): Whether it has been converted into a contact
- `country` (text): Country
- `created_at` (text): When it was added to SuiteCRM (ISO 8601, UTC)
- `custom_fields` (object): Fields an administrator added in Studio (their names end in _c), as SuiteCRM gives them
- `description` (text): The lead's description
- `email` (text): Their primary email
- `first_name` (text): Their first name
- `id` (text): The lead's ID
- `last_name` (text): Their last name
- `link` (text): A link to it in SuiteCRM
- `mobile` (text): Their mobile phone
- `modified_at` (text): When it last changed (ISO 8601, UTC)
- `name` (text): Their full name
- `phone` (text): Their office phone
- `postal_code` (text): Postal code or ZIP code
- `source` (text): Where the lead came from, such as Web Site
- `state` (text): State or region
- `status` (text): Where the lead stands, such as New or In Process
- `street` (text): Street
- `title` (text): Their job title
- `website` (text): Their website

**Example output**

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

- Name (`name`, text, required): What the opportunity is called.
- Amount (`amount`, number, required): How much it's worth, in SuiteCRM's default currency, such as 12000. At least 0.
- Expected close date (`close_date`, date, required): When it's expected to close.
- Sales stage (`stage`, text): The stage it starts in. Leave blank for Prospecting.
- Probability (%) (`probability`, number): The chance it closes, from 0 to 100. From 0 to 100.
- Next step (`next_step`, text): What happens next, such as Send proposal.
- Account (`account`, text): The account's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
- Contact (`contact`, text): The contact to link to it's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
- Description (`description`, text): More about it, shown in SuiteCRM.
- Assigned user (`assigned_user`, text): The user the opportunity is assigned to, or their full name or email.
- Other fields (`other_fields`, object): 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_id` (text): Its account's ID; empty if none
- `account_name` (text): Its account's name
- `amount` (number): What it's worth
- `assigned_user_id` (text): The ID of the user it's assigned to; empty if none
- `assigned_user_name` (text): Their name
- `close_date` (text): When it's expected to close (YYYY-MM-DD)
- `created_at` (text): When it was added to SuiteCRM (ISO 8601, UTC)
- `currency` (text): The amount's currency, such as US Dollar
- `custom_fields` (object): Fields an administrator added in Studio (their names end in _c), as SuiteCRM gives them
- `description` (text): The opportunity's description
- `id` (text): The opportunity's ID
- `link` (text): A link to it in SuiteCRM
- `modified_at` (text): When it last changed (ISO 8601, UTC)
- `name` (text): Its name
- `next_step` (text): The next step
- `probability` (number): The chance it closes, in percent
- `stage` (text): Its sales stage, such as Prospecting or Closed Won

**Example output**

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

- Email (`email`, text, required): The email to match the contact on; one is added if none has it.
- First name (`first_name`, text): Their first name.
- Last name (`last_name`, text): Their last name. SuiteCRM needs one for a new contact; without one the email is used.
- Office phone (`phone`, text): Their office phone number.
- Mobile (`mobile`, text): Their mobile phone number.
- Title (`title`, text): Their job title, such as Head of Sales.
- Account (`account`, text): The account's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
- Source (`source`, text): Where they came from, such as Web Site.
- Street (`street`, text): Their street address.
- City (`city`, text): Their city.
- State (`state`, text): Their state or region.
- Postal code (`postal_code`, text): Their postal code or ZIP code.
- Country (`country`, text): Their country.
- Description (`description`, text): More about it, shown in SuiteCRM.
- Assigned user (`assigned_user`, text): The user the contact is assigned to, or their full name or email.
- Other fields (`other_fields`, object): 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_id` (text): Their account's ID; empty if none
- `account_name` (text): Their account's name
- `assigned_user_id` (text): The ID of the user it's assigned to; empty if none
- `assigned_user_name` (text): Their name
- `city` (text): City
- `country` (text): Country
- `created` (true/false): True if it was added, false if one was updated
- `created_at` (text): When it was added to SuiteCRM (ISO 8601, UTC)
- `custom_fields` (object): Fields an administrator added in Studio (their names end in _c), as SuiteCRM gives them
- `description` (text): The contact's description
- `email` (text): Their primary email
- `first_name` (text): Their first name
- `id` (text): The contact's ID
- `last_name` (text): Their last name
- `link` (text): A link to it in SuiteCRM
- `mobile` (text): Their mobile phone
- `modified_at` (text): When it last changed (ISO 8601, UTC)
- `name` (text): Their full name
- `phone` (text): Their office phone
- `postal_code` (text): Postal code or ZIP code
- `source` (text): Where they came from, such as Web Site
- `state` (text): State or region
- `street` (text): Street
- `title` (text): Their job title

**Example output**

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

- Email (`email`, text, required): The email to match the lead on; one is added if none has it.
- First name (`first_name`, text): Their first name.
- Last name (`last_name`, text): Their last name. SuiteCRM needs one for a new lead; without one the email is used.
- Office phone (`phone`, text): Their office phone number.
- Mobile (`mobile`, text): Their mobile phone number.
- Title (`title`, text): Their job title, such as Head of Sales.
- Account name (`account_name`, text): The company or organisation they're with.
- Status (`status`, text): Where the lead stands, such as New or In Process.
- Source (`source`, text): Where they came from, such as Web Site.
- Website (`website`, text): Their website.
- Street (`street`, text): Their street address.
- City (`city`, text): Their city.
- State (`state`, text): Their state or region.
- Postal code (`postal_code`, text): Their postal code or ZIP code.
- Country (`country`, text): Their country.
- Description (`description`, text): More about it, shown in SuiteCRM.
- Assigned user (`assigned_user`, text): The user the lead is assigned to, or their full name or email.
- Other fields (`other_fields`, object): 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_name` (text): The company they work for, as typed on the lead
- `assigned_user_id` (text): The ID of the user it's assigned to; empty if none
- `assigned_user_name` (text): Their name
- `city` (text): City
- `converted` (true/false): Whether it has been converted into a contact
- `country` (text): Country
- `created` (true/false): True if it was added, false if one was updated
- `created_at` (text): When it was added to SuiteCRM (ISO 8601, UTC)
- `custom_fields` (object): Fields an administrator added in Studio (their names end in _c), as SuiteCRM gives them
- `description` (text): The lead's description
- `email` (text): Their primary email
- `first_name` (text): Their first name
- `id` (text): The lead's ID
- `last_name` (text): Their last name
- `link` (text): A link to it in SuiteCRM
- `mobile` (text): Their mobile phone
- `modified_at` (text): When it last changed (ISO 8601, UTC)
- `name` (text): Their full name
- `phone` (text): Their office phone
- `postal_code` (text): Postal code or ZIP code
- `source` (text): Where the lead came from, such as Web Site
- `state` (text): State or region
- `status` (text): Where the lead stands, such as New or In Process
- `street` (text): Street
- `title` (text): Their job title
- `website` (text): Their website

**Example output**

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

- Subject (`name`, text, required): What needs doing.
- Due (`due_at`, date and time): When it's due.
- Status (`status`, text): Where it stands. Leave blank for Not Started. One of: `Not Started`, `In Progress`, `Completed`, `Pending Input`, `Deferred`.
- Priority (`priority`, text): How urgent it is. Leave blank for Medium. One of: `High`, `Medium`, `Low`.
- Description (`description`, text): More about it.
- Related to (`related_to_type`, text): 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_to`, text): The ID of the account, contact, lead, opportunity or case it's about, or a link to it in SuiteCRM.
- Contact (`contact`, text): The contact it's for's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
- Assigned user (`assigned_user`, text): The user the task is for, or their full name or email.

**Outputs**

- `assigned_user_id` (text): The ID of the user it's for
- `assigned_user_name` (text): Their name
- `contact_id` (text): The contact it's for; empty if none
- `created_at` (text): When it was added (ISO 8601, UTC)
- `description` (text): More about it
- `due_at` (text): When it's due (ISO 8601, UTC); empty if no date
- `id` (text): The task's ID
- `link` (text): A link to it in SuiteCRM
- `name` (text): What needs doing
- `priority` (text): High, Medium or Low
- `related_id` (text): The ID of the record it's about; empty if none
- `related_name` (text): That record's name
- `related_type` (text): What it's about: account, contact, lead, opportunity or case
- `status` (text): Where it stands, such as Not Started

**Example output**

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

- Type (`record_type`, text, required): What kind of record it is. One of: `lead`, `contact`, `account`, `opportunity`, `case`, `task`, `call`, `note`.
- Record (`record`, text, required): The record's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `id` (text): Its ID
- `record_type` (text): The kind of record deleted

**Example output**

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

- Name (`name`, text): Words in the account's name.
- Email (`email`, text): Its email address.
- Website (`website`, text): Its website, such as acme.com.
- Type (`account_type`, text): Only accounts of this type.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 100.

**Outputs**

- `accounts` (list): The accounts found
- `count` (number): How many are listed

**Example output**

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

- Subject (`name`, text): Words in the case's subject.
- Case number (`number`, number): The case's number, such as 1042. At least 1.
- Status (`status`, text): Only cases with this status.
- Account (`account`, text): The account's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 100.

**Outputs**

- `cases` (list): The cases found
- `count` (number): How many are listed

**Example output**

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

- Email (`email`, text): Their email address.
- Name (`name`, text): Their name, or part of it, such as Ada or Ada Lovelace.
- Account (`account`, text): The account's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 100.

**Outputs**

- `contacts` (list): The contacts found
- `count` (number): How many are listed

**Example output**

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

- Email (`email`, text): Their email address.
- Name (`name`, text): Their name, or part of it, such as Ada or Ada Lovelace.
- Status (`status`, text): Only leads with this status.
- Source (`source`, text): Only leads from this source.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 100.

**Outputs**

- `count` (number): How many are listed
- `leads` (list): The leads found

**Example output**

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

- Name (`name`, text): Words in the opportunity's name.
- Sales stage (`stage`, text): Only opportunities in this stage.
- Account (`account`, text): The account's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 100.

**Outputs**

- `count` (number): How many are listed
- `opportunities` (list): The opportunities found

**Example output**

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

- Account (`account`, text, required): The account's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.

**Outputs**

- `account_type` (text): What it is to you, such as Customer
- `assigned_user_id` (text): The ID of the user it's assigned to; empty if none
- `assigned_user_name` (text): Their name
- `city` (text): Billing address: city
- `country` (text): Billing address: country
- `created_at` (text): When it was added to SuiteCRM (ISO 8601, UTC)
- `custom_fields` (object): Fields an administrator added in Studio (their names end in _c), as SuiteCRM gives them
- `description` (text): The account's description
- `email` (text): Its primary email
- `id` (text): The account's ID
- `industry` (text): Its industry
- `link` (text): A link to it in SuiteCRM
- `modified_at` (text): When it last changed (ISO 8601, UTC)
- `name` (text): Its name
- `phone` (text): Its office phone
- `postal_code` (text): Billing address: postal code or zip code
- `state` (text): Billing address: state or region
- `street` (text): Billing address: street
- `website` (text): Its website

**Example output**

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

- Case (`case`, text, required): The case's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.

**Outputs**

- `account_id` (text): Its account's ID; empty if none
- `account_name` (text): Its account's name
- `assigned_user_id` (text): The ID of the user it's assigned to; empty if none
- `assigned_user_name` (text): Their name
- `case_type` (text): What kind of case it is, such as Product
- `created_at` (text): When it was added to SuiteCRM (ISO 8601, UTC)
- `custom_fields` (object): Fields an administrator added in Studio (their names end in _c), as SuiteCRM gives them
- `description` (text): The details
- `id` (text): The case's ID
- `link` (text): A link to it in SuiteCRM
- `modified_at` (text): When it last changed (ISO 8601, UTC)
- `name` (text): Its subject
- `number` (text): Its case number, such as 1042
- `priority` (text): P1 (High), P2 (Medium) or P3 (Low)
- `state` (text): Open or Closed
- `status` (text): Its status as SuiteCRM stores it, such as Open_New or Closed_Closed

**Example output**

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

- Contact (`contact`, text, required): The contact's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.

**Outputs**

- `account_id` (text): Their account's ID; empty if none
- `account_name` (text): Their account's name
- `assigned_user_id` (text): The ID of the user it's assigned to; empty if none
- `assigned_user_name` (text): Their name
- `city` (text): City
- `country` (text): Country
- `created_at` (text): When it was added to SuiteCRM (ISO 8601, UTC)
- `custom_fields` (object): Fields an administrator added in Studio (their names end in _c), as SuiteCRM gives them
- `description` (text): The contact's description
- `email` (text): Their primary email
- `first_name` (text): Their first name
- `id` (text): The contact's ID
- `last_name` (text): Their last name
- `link` (text): A link to it in SuiteCRM
- `mobile` (text): Their mobile phone
- `modified_at` (text): When it last changed (ISO 8601, UTC)
- `name` (text): Their full name
- `phone` (text): Their office phone
- `postal_code` (text): Postal code or ZIP code
- `source` (text): Where they came from, such as Web Site
- `state` (text): State or region
- `street` (text): Street
- `title` (text): Their job title

**Example output**

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

- Lead (`lead`, text, required): The lead's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.

**Outputs**

- `account_name` (text): The company they work for, as typed on the lead
- `assigned_user_id` (text): The ID of the user it's assigned to; empty if none
- `assigned_user_name` (text): Their name
- `city` (text): City
- `converted` (true/false): Whether it has been converted into a contact
- `country` (text): Country
- `created_at` (text): When it was added to SuiteCRM (ISO 8601, UTC)
- `custom_fields` (object): Fields an administrator added in Studio (their names end in _c), as SuiteCRM gives them
- `description` (text): The lead's description
- `email` (text): Their primary email
- `first_name` (text): Their first name
- `id` (text): The lead's ID
- `last_name` (text): Their last name
- `link` (text): A link to it in SuiteCRM
- `mobile` (text): Their mobile phone
- `modified_at` (text): When it last changed (ISO 8601, UTC)
- `name` (text): Their full name
- `phone` (text): Their office phone
- `postal_code` (text): Postal code or ZIP code
- `source` (text): Where the lead came from, such as Web Site
- `state` (text): State or region
- `status` (text): Where the lead stands, such as New or In Process
- `street` (text): Street
- `title` (text): Their job title
- `website` (text): Their website

**Example output**

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

- Opportunity (`opportunity`, text, required): The opportunity's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.

**Outputs**

- `account_id` (text): Its account's ID; empty if none
- `account_name` (text): Its account's name
- `amount` (number): What it's worth
- `assigned_user_id` (text): The ID of the user it's assigned to; empty if none
- `assigned_user_name` (text): Their name
- `close_date` (text): When it's expected to close (YYYY-MM-DD)
- `created_at` (text): When it was added to SuiteCRM (ISO 8601, UTC)
- `currency` (text): The amount's currency, such as US Dollar
- `custom_fields` (object): Fields an administrator added in Studio (their names end in _c), as SuiteCRM gives them
- `description` (text): The opportunity's description
- `id` (text): The opportunity's ID
- `link` (text): A link to it in SuiteCRM
- `modified_at` (text): When it last changed (ISO 8601, UTC)
- `name` (text): Its name
- `next_step` (text): The next step
- `probability` (number): The chance it closes, in percent
- `stage` (text): Its sales stage, such as Prospecting or Closed Won

**Example output**

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

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

**Inputs**

- Record type (`record_type`, text, required): The kind of the first record, such as Contact. One of: `account`, `contact`, `lead`, `opportunity`, `case`.
- Record (`record`, text, required): The first record's ID or link in SuiteCRM.
- Link to (`related_type`, text, required): The kind of record to link it to, such as Account. One of: `account`, `contact`, `lead`, `opportunity`, `case`.
- Related record (`related`, text, required): That record's ID or link in SuiteCRM.

**Outputs**

- `linked` (true/false): Always true once linked
- `record_id` (text): Its ID
- `record_type` (text): The first record's kind
- `related_id` (text): Its ID
- `related_type` (text): The other record's kind

**Example output**

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

- `count` (number): How many are listed
- `users` (list): The active users

**Example output**

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

- Subject (`name`, text, required): What the call was about.
- Started (`start_at`, date and time): When the call started. Leave blank for now.
- Minutes (`duration_minutes`, number): How long it lasted, in minutes. Leave blank for 15. At least 0.
- Direction (`direction`, text): Whether you called them or they called you. Leave blank for Outbound. One of: `Outbound`, `Inbound`.
- Status (`status`, text): Whether it happened. Leave blank for Held. One of: `Held`, `Planned`, `Not Held`.
- Description (`description`, text): Notes from the call.
- Related to (`related_to_type`, text): 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_to`, text): The ID of the account, contact, lead, opportunity or case it's about, or a link to it in SuiteCRM.
- Assigned user (`assigned_user`, text): The user who made or took the call, or their full name or email.

**Outputs**

- `assigned_user_id` (text): The ID of the user who made or took it
- `assigned_user_name` (text): Their name
- `created_at` (text): When it was logged (ISO 8601, UTC)
- `description` (text): Notes from the call
- `direction` (text): Outbound or Inbound
- `duration_minutes` (number): How long it lasted, in minutes
- `id` (text): The call's ID
- `link` (text): A link to it in SuiteCRM
- `name` (text): What it was about
- `related_id` (text): The ID of the record it's about; empty if none
- `related_name` (text): That record's name
- `related_type` (text): What it's about: account, contact, lead, opportunity or case
- `start_at` (text): When it started (ISO 8601, UTC)
- `status` (text): Held, Planned or Not Held

**Example output**

```json
{
  "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 type (`record_type`, text, required): The kind of record (module) to search, such as Accounts.
- Conditions (`conditions`, object): 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.
- Match (`match`, text): 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 by (`sort_by`, text): A field to sort by, with - before it for newest or largest first, such as -date_modified. Leave blank for newest added first.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 100.

**Outputs**

- `count` (number): How many are listed
- `records` (list): The records found, newest first unless sorted

**Example output**

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

- Account (`account`, text, required): The account's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
- Name (`name`, text): What the account is called. Leave blank to keep it.
- Email (`email`, text): Its email address.
- Office phone (`phone`, text): Its office phone number.
- Website (`website`, text): Its website, such as https://acme.com.
- Type (`account_type`, text): What it is to you, such as Customer or Partner.
- Industry (`industry`, text): Its industry, such as Technology.
- Street (`street`, text): Its billing street address.
- City (`city`, text): Its billing city.
- State (`state`, text): Its billing state or region.
- Postal code (`postal_code`, text): Its billing postal code or ZIP code.
- Country (`country`, text): Its billing country.
- Description (`description`, text): More about it, shown in SuiteCRM.
- Assigned user (`assigned_user`, text): The user the account is assigned to, or their full name or email.
- Other fields (`other_fields`, object): 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_type` (text): What it is to you, such as Customer
- `assigned_user_id` (text): The ID of the user it's assigned to; empty if none
- `assigned_user_name` (text): Their name
- `city` (text): Billing address: city
- `country` (text): Billing address: country
- `created_at` (text): When it was added to SuiteCRM (ISO 8601, UTC)
- `custom_fields` (object): Fields an administrator added in Studio (their names end in _c), as SuiteCRM gives them
- `description` (text): The account's description
- `email` (text): Its primary email
- `id` (text): The account's ID
- `industry` (text): Its industry
- `link` (text): A link to it in SuiteCRM
- `modified_at` (text): When it last changed (ISO 8601, UTC)
- `name` (text): Its name
- `phone` (text): Its office phone
- `postal_code` (text): Billing address: postal code or zip code
- `state` (text): Billing address: state or region
- `street` (text): Billing address: street
- `website` (text): Its website

**Example output**

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

- Case (`case`, text, required): The case's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
- Subject (`name`, text): What the case is about. Leave blank to keep it.
- Description (`description`, text): The details, such as the customer's message.
- Account (`account`, text): The account's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
- Status (`status`, text): Where it stands now, such as Pending Input or Closed. Leave blank to keep it.
- Priority (`priority`, text): How urgent it is: High, Medium or Low.
- Type (`case_type`, text): What kind of case it is, such as Product.
- Assigned user (`assigned_user`, text): The user the case is assigned to, or their full name or email.
- Other fields (`other_fields`, object): 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_id` (text): Its account's ID; empty if none
- `account_name` (text): Its account's name
- `assigned_user_id` (text): The ID of the user it's assigned to; empty if none
- `assigned_user_name` (text): Their name
- `case_type` (text): What kind of case it is, such as Product
- `created_at` (text): When it was added to SuiteCRM (ISO 8601, UTC)
- `custom_fields` (object): Fields an administrator added in Studio (their names end in _c), as SuiteCRM gives them
- `description` (text): The details
- `id` (text): The case's ID
- `link` (text): A link to it in SuiteCRM
- `modified_at` (text): When it last changed (ISO 8601, UTC)
- `name` (text): Its subject
- `number` (text): Its case number, such as 1042
- `priority` (text): P1 (High), P2 (Medium) or P3 (Low)
- `state` (text): Open or Closed
- `status` (text): Its status as SuiteCRM stores it, such as Open_New or Closed_Closed

**Example output**

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

- Contact (`contact`, text, required): The contact's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
- First name (`first_name`, text): Their first name.
- Last name (`last_name`, text): Their last name.
- Email (`email`, text): Their email address.
- Office phone (`phone`, text): Their office phone number.
- Mobile (`mobile`, text): Their mobile phone number.
- Title (`title`, text): Their job title, such as Head of Sales.
- Account (`account`, text): The account's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
- Source (`source`, text): Where they came from, such as Web Site.
- Street (`street`, text): Their street address.
- City (`city`, text): Their city.
- State (`state`, text): Their state or region.
- Postal code (`postal_code`, text): Their postal code or ZIP code.
- Country (`country`, text): Their country.
- Description (`description`, text): More about it, shown in SuiteCRM.
- Assigned user (`assigned_user`, text): The user the contact is assigned to, or their full name or email.
- Other fields (`other_fields`, object): 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_id` (text): Their account's ID; empty if none
- `account_name` (text): Their account's name
- `assigned_user_id` (text): The ID of the user it's assigned to; empty if none
- `assigned_user_name` (text): Their name
- `city` (text): City
- `country` (text): Country
- `created_at` (text): When it was added to SuiteCRM (ISO 8601, UTC)
- `custom_fields` (object): Fields an administrator added in Studio (their names end in _c), as SuiteCRM gives them
- `description` (text): The contact's description
- `email` (text): Their primary email
- `first_name` (text): Their first name
- `id` (text): The contact's ID
- `last_name` (text): Their last name
- `link` (text): A link to it in SuiteCRM
- `mobile` (text): Their mobile phone
- `modified_at` (text): When it last changed (ISO 8601, UTC)
- `name` (text): Their full name
- `phone` (text): Their office phone
- `postal_code` (text): Postal code or ZIP code
- `source` (text): Where they came from, such as Web Site
- `state` (text): State or region
- `street` (text): Street
- `title` (text): Their job title

**Example output**

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

- Lead (`lead`, text, required): The lead's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
- First name (`first_name`, text): Their first name.
- Last name (`last_name`, text): Their last name.
- Email (`email`, text): Their email address.
- Office phone (`phone`, text): Their office phone number.
- Mobile (`mobile`, text): Their mobile phone number.
- Title (`title`, text): Their job title, such as Head of Sales.
- Account name (`account_name`, text): The company or organisation they're with.
- Status (`status`, text): Where the lead stands, such as New or In Process.
- Source (`source`, text): Where they came from, such as Web Site.
- Website (`website`, text): Their website.
- Street (`street`, text): Their street address.
- City (`city`, text): Their city.
- State (`state`, text): Their state or region.
- Postal code (`postal_code`, text): Their postal code or ZIP code.
- Country (`country`, text): Their country.
- Description (`description`, text): More about it, shown in SuiteCRM.
- Assigned user (`assigned_user`, text): The user the lead is assigned to, or their full name or email.
- Other fields (`other_fields`, object): 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_name` (text): The company they work for, as typed on the lead
- `assigned_user_id` (text): The ID of the user it's assigned to; empty if none
- `assigned_user_name` (text): Their name
- `city` (text): City
- `converted` (true/false): Whether it has been converted into a contact
- `country` (text): Country
- `created_at` (text): When it was added to SuiteCRM (ISO 8601, UTC)
- `custom_fields` (object): Fields an administrator added in Studio (their names end in _c), as SuiteCRM gives them
- `description` (text): The lead's description
- `email` (text): Their primary email
- `first_name` (text): Their first name
- `id` (text): The lead's ID
- `last_name` (text): Their last name
- `link` (text): A link to it in SuiteCRM
- `mobile` (text): Their mobile phone
- `modified_at` (text): When it last changed (ISO 8601, UTC)
- `name` (text): Their full name
- `phone` (text): Their office phone
- `postal_code` (text): Postal code or ZIP code
- `source` (text): Where the lead came from, such as Web Site
- `state` (text): State or region
- `status` (text): Where the lead stands, such as New or In Process
- `street` (text): Street
- `title` (text): Their job title
- `website` (text): Their website

**Example output**

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

- Opportunity (`opportunity`, text, required): The opportunity's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
- Name (`name`, text): What the opportunity is called. Leave blank to keep it.
- Amount (`amount`, number): How much it's worth, in SuiteCRM's default currency, such as 12000. At least 0.
- Expected close date (`close_date`, date): When it's expected to close.
- Sales stage (`stage`, text): The stage to move it to, such as Closed Won. Leave blank to keep it where it is.
- Probability (%) (`probability`, number): The chance it closes, from 0 to 100. From 0 to 100.
- Next step (`next_step`, text): What happens next, such as Send proposal.
- Account (`account`, text): The account's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
- Contact (`contact`, text): The contact to link to it's ID, from another SuiteCRM step or the trigger, or a link to it in SuiteCRM.
- Description (`description`, text): More about it, shown in SuiteCRM.
- Assigned user (`assigned_user`, text): The user the opportunity is assigned to, or their full name or email.
- Other fields (`other_fields`, object): 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_id` (text): Its account's ID; empty if none
- `account_name` (text): Its account's name
- `amount` (number): What it's worth
- `assigned_user_id` (text): The ID of the user it's assigned to; empty if none
- `assigned_user_name` (text): Their name
- `close_date` (text): When it's expected to close (YYYY-MM-DD)
- `created_at` (text): When it was added to SuiteCRM (ISO 8601, UTC)
- `currency` (text): The amount's currency, such as US Dollar
- `custom_fields` (object): Fields an administrator added in Studio (their names end in _c), as SuiteCRM gives them
- `description` (text): The opportunity's description
- `id` (text): The opportunity's ID
- `link` (text): A link to it in SuiteCRM
- `modified_at` (text): When it last changed (ISO 8601, UTC)
- `name` (text): Its name
- `next_step` (text): The next step
- `probability` (number): The chance it closes, in percent
- `stage` (text): Its sales stage, such as Prospecting or Closed Won

**Example output**

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