Vtiger CRM
App · 23 actions
Work with your Vtiger CRM: create, find, update and delete leads, contacts, organizations, deals, tickets and tasks, read or change records of any other module, run queries, and add comments to a record's history.
Actions
| Action | What it does |
|---|---|
| Add comment | Add a comment to a record's history, such as a lead, contact, organization, deal or ticket. |
| Create contact | Create a contact in Vtiger. |
| Create deal | Create a deal in Vtiger. |
| Create lead | Create a lead in Vtiger. |
| Create organization | Create a organization in Vtiger. |
| Create record | Create a record in any module from a list of fields, for a module without its own create action. |
| Create task | Create a task in Vtiger. |
| Create ticket | Create a ticket in Vtiger. |
| Delete record | Delete a record of any module. |
| Describe module | List a module's fields: the names to use in 'Create record' and 'List records', their types, which are required, and the values of picklists. |
| Get current user | Get the Vtiger user the connection signs in as, and the version of Vtiger it runs. |
| Get record | Get one record of any module with all its fields. |
| List modules | List the modules that hold records in this Vtiger, including custom ones. |
| List records | List records of any module, one page at a time, optionally filtered on a field or to those changed or created since a moment. |
| List users and groups | List the users and groups a record can be assigned to, with the ids to give 'Assigned to'. |
| Run query | Run a read-only VtigerQL query, such as SELECT firstname, lastname FROM Contacts WHERE email LIKE '%acme%' LIMIT 0, 50. |
| Update contact | Change a contact in Vtiger. |
| Update deal | Change a deal in Vtiger. |
| Update lead | Change a lead in Vtiger. |
| Update organization | Change a organization in Vtiger. |
| Update record | Change fields of a record in any module. |
| Update task | Change a task in Vtiger. |
| Update ticket | Change a ticket in Vtiger. |
Add comment
Add a comment to a record's history, such as a lead, contact, organization, deal or ticket.
Inputs
- Record
related_totextRequired - The id of the record to comment on, such as 4x123, from an earlier step.
- Comment
commenttextRequired - What to say.
- Assigned to
assigned_totext - The user or group that owns the record. Pick one, or give an id from 'List users and groups'. Defaults to the connected user.
Outputs
commentobject- The comment added
Example output
{
"comment": {
"assigned_user_id": "19x1",
"commentcontent": "Spoke to Alex; sending a quote.",
"createdtime": "2026-10-20 09:15:00",
"id": "10x42",
"modifiedtime": "2026-10-21 14:02:10",
"related_to": "3x12"
}
}Create contact
Create a contact in Vtiger. Fill in what you know; it is assigned to the connected user unless you choose someone else.
Inputs
- Last name
last_nametextRequired - The contact's last name.
- First name
first_nametext - The contact's first name.
- Salutation
salutationtext - How to address the contact.One of:
Mr.,Ms.,Mrs.,Dr.,Prof.. - Email
emailtext - The contact's email address.
- Phone
phonetext - The contact's phone number.
- Mobile
mobiletext - The contact's mobile number.
- Job title
job_titletext - The contact's job title. Pick one, or type a title your instance uses.
- Department
departmenttext - The contact's department.
- Organization
account_idtext - The organization the contact works for. Pick one, or give the id of an organization from an earlier step.
- Lead source
lead_sourcetext - Where the contact came from. Pick one, or type a source your instance uses.
- Birthday
birthdaydate - The contact's date of birth.
- Street
streettext - The mailing street address.
- City
citytext - The mailing city.
- State
statetext - The mailing state or region.
- Postal code
postal_codetext - The mailing postal or ZIP code.
- Country
countrytext - The mailing country.
- Description
descriptiontext - Notes about the record.
- Assigned to
assigned_totext - The user or group that owns the record. Pick one, or give an id from 'List users and groups'. Defaults to the connected user.
Outputs
contactobject- The contact
Example output
{
"contact": {
"account_id": "3x12",
"assigned_user_id": "19x1",
"createdtime": "2026-10-20 09:15:00",
"email": "alex.smith@example.com",
"firstname": "Alex",
"id": "10x42",
"lastname": "Smith",
"modifiedtime": "2026-10-21 14:02:10",
"phone": "+1 555 0100",
"title": "Head of Operations"
}
}Create deal
Create a deal in Vtiger. Fill in what you know; it is assigned to the connected user unless you choose someone else.
Inputs
- Deal name
nametextRequired - The deal's name.
- Organization
related_totextRequired - The organization the deal is with. Pick one, or give the id of an organization or contact from an earlier step.
- Expected close date
closing_datedateRequired - When the deal is expected to close.
- Sales stage
sales_stagetextRequired - Where the deal is in your pipeline. Pick one, or type a stage your instance uses.
- Amount
amountnumber - The deal's value, as a number.
- Probability (%)
probabilitynumber - The chance of winning, from 0 to 100.From 0 to 100.
- Lead source
lead_sourcetext - Where the deal came from. Pick one, or type a source your instance uses.
- Next step
next_steptext - What happens next.
- Description
descriptiontext - Notes about the record.
- Assigned to
assigned_totext - The user or group that owns the record. Pick one, or give an id from 'List users and groups'. Defaults to the connected user.
Outputs
dealobject- The deal
Example output
{
"deal": {
"amount": "15000.00",
"assigned_user_id": "19x1",
"closingdate": "2026-12-31",
"createdtime": "2026-10-20 09:15:00",
"id": "10x42",
"modifiedtime": "2026-10-21 14:02:10",
"potentialname": "Acme renewal",
"probability": "40",
"related_to": "3x12",
"sales_stage": "Prospecting"
}
}Create lead
Create a lead in Vtiger. Fill in what you know; it is assigned to the connected user unless you choose someone else.
Inputs
- Last name
last_nametextRequired - The lead's last name.
- First name
first_nametext - The lead's first name.
- Salutation
salutationtext - How to address the lead.One of:
Mr.,Ms.,Mrs.,Dr.,Prof.. - Company
companytext - The company the lead works for.
- Email
emailtext - The lead's email address.
- Phone
phonetext - The lead's phone number.
- Mobile
mobiletext - The lead's mobile number.
- Job title
job_titletext - The lead's job title. Pick one, or type a title your instance uses.
- Website
websitetext - The lead's website.
- Lead status
lead_statustext - Where the lead is in your process. Pick one, or type a status your instance uses.
- Lead source
lead_sourcetext - Where the lead came from. Pick one, or type a source your instance uses.
- Industry
industrytext - The lead's industry. Pick one, or type an industry your instance uses.
- Annual revenue
annual_revenuenumber - The company's yearly revenue, as a number.
- Number of employees
employeesnumber - How many people work at the company.At least 0.
- Street
streettext - The street address.
- City
citytext - The city.
- State
statetext - The state or region.
- Postal code
postal_codetext - The postal or ZIP code.
- Country
countrytext - The country.
- Description
descriptiontext - Notes about the record.
- Assigned to
assigned_totext - The user or group that owns the record. Pick one, or give an id from 'List users and groups'. Defaults to the connected user.
Outputs
leadobject- The lead
Example output
{
"lead": {
"assigned_user_id": "19x1",
"company": "Acme Ltd",
"createdtime": "2026-10-20 09:15:00",
"email": "alex.smith@example.com",
"firstname": "Alex",
"id": "10x42",
"lastname": "Smith",
"leadstatus": "Contacted",
"modifiedtime": "2026-10-21 14:02:10",
"phone": "+1 555 0100"
}
}Create organization
Create a organization in Vtiger. Fill in what you know; it is assigned to the connected user unless you choose someone else.
Inputs
- Organization name
nametextRequired - The organization's name.
- Website
websitetext - The organization's website.
- Email
emailtext - The organization's main email address.
- Phone
phonetext - The organization's main phone number.
- Industry
industrytext - The organization's industry. Pick one, or type an industry your instance uses.
- Type
account_typetext - What kind of organization it is, such as Customer or Partner. Pick one, or type a type your instance uses.
- Number of employees
employeesnumber - How many people work there.At least 0.
- Annual revenue
annual_revenuenumber - The organization's yearly revenue, as a number.
- Billing street
streettext - The billing street address.
- Billing city
citytext - The billing city.
- Billing state
statetext - The billing state or region.
- Billing postal code
postal_codetext - The billing postal or ZIP code.
- Billing country
countrytext - The billing country.
- Description
descriptiontext - Notes about the record.
- Assigned to
assigned_totext - The user or group that owns the record. Pick one, or give an id from 'List users and groups'. Defaults to the connected user.
Outputs
organizationobject- The organization
Example output
{
"organization": {
"accountname": "Acme Ltd",
"assigned_user_id": "19x1",
"createdtime": "2026-10-20 09:15:00",
"email1": "info@acme.example.com",
"id": "10x42",
"industry": "Technology",
"modifiedtime": "2026-10-21 14:02:10",
"phone": "+1 555 0100",
"website": "https://acme.example.com"
}
}Create record
Create a record in any module from a list of fields, for a module without its own create action. It is assigned to the connected user unless 'assigned_user_id' is given.
Inputs
- Module
moduletextRequired - The kind of record, such as Leads, Contacts, Accounts (organizations), Potentials (deals), HelpDesk (tickets) or Calendar (tasks). Pick one, or type a module's name.
- Fields
fieldsobjectRequired - The fields to set, each a field name and its value, such as lastname and Smith. 'Describe module' lists a module's field names; dates are YYYY-MM-DD and yes/no fields are true or false.
Outputs
recordobject- The record created
Example output
{
"record": {
"assigned_user_id": "19x1",
"createdtime": "2026-10-20 09:15:00",
"id": "10x42",
"modifiedtime": "2026-10-21 14:02:10"
}
}Create task
Create a task in Vtiger. Fill in what you know; it is assigned to the connected user unless you choose someone else.
Inputs
- Subject
subjecttextRequired - What needs doing.
- Start date
start_datedateRequired - The day the task starts.
- Start time
start_timetime - The time the task starts. Defaults to 09:00.
- Due date
due_datedate - The day the task is due. Defaults to the start date.
- Status
statustext - Where the task is. Pick one, or type a status your instance uses. Defaults to Not Started.
- Priority
prioritytext - How urgent the task is. Pick one, or type a priority your instance uses.
- Related to
related_totext - The id of the lead, deal or ticket the task is about, from an earlier step. Older Vtiger versions also accept an organization; newer ones do not.
- Contact
contact_idtext - The id of the contact the task is about, from an earlier step.
- Description
descriptiontext - Notes about the task.
- Assigned to
assigned_totext - The user or group that owns the record. Pick one, or give an id from 'List users and groups'. Defaults to the connected user.
Outputs
taskobject- The task
Example output
{
"task": {
"assigned_user_id": "19x1",
"createdtime": "2026-10-20 09:15:00",
"date_start": "2026-11-02",
"due_date": "2026-11-02",
"id": "10x42",
"modifiedtime": "2026-10-21 14:02:10",
"subject": "Call Alex about the renewal",
"taskpriority": "Medium",
"taskstatus": "Not Started",
"time_start": "09:00:00"
}
}Create ticket
Create a ticket in Vtiger. Fill in what you know; it is assigned to the connected user unless you choose someone else.
Inputs
- Title
titletextRequired - A short summary of the problem.
- Status
statustext - Where the ticket is. Pick one, or type a status your instance uses. Defaults to Open.
- Priority
prioritytext - How urgent the ticket is. Pick one, or type a priority your instance uses.
- Organization
account_idtext - The organization the ticket is for. Pick one, or give the id of an organization or contact from an earlier step.
- Contact
contact_idtext - The id of the contact who raised it, from an earlier step. Newer Vtiger versions require it.
- Description
descriptiontext - The details of the problem. Newer Vtiger versions require it.
- Solution
solutiontext - How the problem was solved. Not kept by newer Vtiger versions, which call tickets Cases.
- Assigned to
assigned_totext - The user or group that owns the record. Pick one, or give an id from 'List users and groups'. Defaults to the connected user.
Outputs
ticketobject- The ticket
Example output
{
"ticket": {
"assigned_user_id": "19x1",
"createdtime": "2026-10-20 09:15:00",
"id": "10x42",
"modifiedtime": "2026-10-21 14:02:10",
"ticket_no": "TT12",
"ticket_title": "Cannot sign in",
"ticketpriorities": "Normal",
"ticketstatus": "Open"
}
}Delete record
Delete a record of any module. Vtiger moves it to its Recycle Bin, from where it can be restored.
Inputs
- Record ID
record_idtextRequired - The record's id, such as 4x123, from 'List records' or the 'id' of an earlier step.
Outputs
deletedtrue/false- Always true once deleted
record_idtext- The record deleted
Example output
{
"deleted": true,
"record_id": "10x42"
}Describe module
List a module's fields: the names to use in 'Create record' and 'List records', their types, which are required, and the values of picklists.
Inputs
- Module
moduletextRequired - The kind of record, such as Leads, Contacts, Accounts (organizations), Potentials (deals), HelpDesk (tickets) or Calendar (tasks). Pick one, or type a module's name.
Outputs
can_createtrue/false- Whether you can create records
can_deletetrue/false- Whether you can delete records
can_updatetrue/false- Whether you can change records
field_countnumber- How many fields
fieldslist- The fields
id_prefixtext- The number its record ids start with
labeltext- The name people see
nametext- The module's name
Example output
{
"can_create": true,
"can_delete": true,
"can_update": true,
"field_count": 1,
"fields": [
{
"editable": true,
"label": "Last Name",
"mandatory": true,
"name": "lastname",
"picklist_values": [],
"type": "string"
}
],
"id_prefix": "10",
"label": "Leads",
"name": "Leads"
}Get current user
Get the Vtiger user the connection signs in as, and the version of Vtiger it runs.
Inputs
None.
Outputs
userobject- The connected user
vtiger_versiontext- The Vtiger version, such as 7.5.0
webservice_versiontext- The web service version, such as 0.22
Example output
{
"user": {
"email1": "alex.smith@example.com",
"first_name": "Alex",
"id": "19x1",
"last_name": "Smith",
"status": "Active",
"user_name": "admin"
},
"vtiger_version": "7.5.0",
"webservice_version": "0.22"
}Get record
Get one record of any module with all its fields.
Inputs
- Record ID
record_idtextRequired - The record's id, such as 4x123, from 'List records' or the 'id' of an earlier step.
Outputs
recordobject- The record
Example output
{
"record": {
"assigned_user_id": "19x1",
"createdtime": "2026-10-20 09:15:00",
"id": "10x42",
"modifiedtime": "2026-10-21 14:02:10"
}
}List modules
List the modules that hold records in this Vtiger, including custom ones.
Inputs
None.
Outputs
countnumber- How many modules
moduleslist- The modules
Example output
{
"count": 1,
"modules": [
{
"is_entity": true,
"label": "Leads",
"name": "Leads",
"singular_label": "Lead"
}
]
}List records
List records of any module, one page at a time, optionally filtered on a field or to those changed or created since a moment.
Inputs
- Module
moduletextRequired - The kind of record, such as Leads, Contacts, Accounts (organizations), Potentials (deals), HelpDesk (tickets) or Calendar (tasks). Pick one, or type a module's name.
- Fields to return
fieldslist - Only these fields. Leave empty for every field.
- Filter field
filter_fieldtext - The field to filter on, such as email or leadstatus.
- Filter
filter_operatortext - How to compare the field with the value. Defaults to equals.One of:
equals(Equals (default)),not_equals(Does not equal),contains,starts_with(Starts with),greater_than(Greater than),greater_or_equal(Greater than or equal to),less_than(Less than),less_or_equal(Less than or equal to). - Filter value
filter_valuetext - The value to compare with. Dates are YYYY-MM-DD.
- Changed since
modified_sincedate and time - Only records changed at or after this moment.
- Created since
created_sincedate and time - Only records created at or after this moment.
- Sort by
order_bytext - The field to sort by, such as createdtime. Defaults to Vtiger's order.
- Sort order
order_directiontext - Which end to start from when sorting. Defaults to smallest first.One of:
asc(Smallest first (default)),desc(Largest first). - Page size
limitnumber - How many records to return, 1 to 100. Defaults to 25.From 1 to 100.
- Start at
offsetnumber - How many records to skip: the 'next_offset' of an earlier page.At least 0.
Outputs
countnumber- How many records this page holds
has_moretrue/false- Whether another page follows
moduletext- The module listed
next_offsetnumber- The 'Start at' for the next page, or 0 when there is none
recordslist- The records
Example output
{
"count": 1,
"has_more": false,
"module": "Leads",
"next_offset": 0,
"records": [
{
"assigned_user_id": "19x1",
"createdtime": "2026-10-20 09:15:00",
"id": "10x42",
"modifiedtime": "2026-10-21 14:02:10"
}
]
}List users and groups
List the users and groups a record can be assigned to, with the ids to give 'Assigned to'.
Inputs
None.
Outputs
group_countnumber- How many groups
groupslist- The groups
user_countnumber- How many users
userslist- The users
Example output
{
"group_count": 1,
"groups": [
{
"id": "20x3",
"name": "Support"
}
],
"user_count": 1,
"users": [
{
"email": "alex.smith@example.com",
"id": "19x1",
"is_admin": true,
"name": "Alex Smith",
"status": "Active",
"user_name": "admin"
}
]
}Run query
Run a read-only VtigerQL query, such as SELECT firstname, lastname FROM Contacts WHERE email LIKE '%acme%' LIMIT 0, 50. Vtiger returns at most 100 rows.
Inputs
- Query
querytextRequired - A single SELECT in VtigerQL, Vtiger's SQL-like language. It cannot join modules.
Outputs
countnumber- How many rows came back
recordslist- The rows
Example output
{
"count": 1,
"records": [
{
"assigned_user_id": "19x1",
"createdtime": "2026-10-20 09:15:00",
"id": "10x42",
"modifiedtime": "2026-10-21 14:02:10"
}
]
}Update contact
Change a contact in Vtiger. Only the fields you fill in change; the rest stay as they are.
Inputs
- Contact
record_idtextRequired - The contact's id, such as 4x123, from 'Create contact', 'List records' or an earlier step.
- Last name
last_nametext - The contact's last name.
- First name
first_nametext - The contact's first name.
- Salutation
salutationtext - How to address the contact.One of:
Mr.,Ms.,Mrs.,Dr.,Prof.. - Email
emailtext - The contact's email address.
- Phone
phonetext - The contact's phone number.
- Mobile
mobiletext - The contact's mobile number.
- Job title
job_titletext - The contact's job title. Pick one, or type a title your instance uses.
- Department
departmenttext - The contact's department.
- Organization
account_idtext - The organization the contact works for. Pick one, or give the id of an organization from an earlier step.
- Lead source
lead_sourcetext - Where the contact came from. Pick one, or type a source your instance uses.
- Birthday
birthdaydate - The contact's date of birth.
- Street
streettext - The mailing street address.
- City
citytext - The mailing city.
- State
statetext - The mailing state or region.
- Postal code
postal_codetext - The mailing postal or ZIP code.
- Country
countrytext - The mailing country.
- Description
descriptiontext - Notes about the record.
- Assigned to
assigned_totext - The user or group that owns the record. Pick one, or give an id from 'List users and groups'. Defaults to the connected user.
Outputs
contactobject- The contact
Example output
{
"contact": {
"account_id": "3x12",
"assigned_user_id": "19x1",
"createdtime": "2026-10-20 09:15:00",
"email": "alex.smith@example.com",
"firstname": "Alex",
"id": "10x42",
"lastname": "Smith",
"modifiedtime": "2026-10-21 14:02:10",
"phone": "+1 555 0100",
"title": "Head of Operations"
}
}Update deal
Change a deal in Vtiger. Only the fields you fill in change; the rest stay as they are.
Inputs
- Deal
record_idtextRequired - The deal's id, such as 4x123, from 'Create deal', 'List records' or an earlier step.
- Deal name
nametext - The deal's name.
- Organization
related_totext - The organization the deal is with. Pick one, or give the id of an organization or contact from an earlier step.
- Expected close date
closing_datedate - When the deal is expected to close.
- Sales stage
sales_stagetext - Where the deal is in your pipeline. Pick one, or type a stage your instance uses.
- Amount
amountnumber - The deal's value, as a number.
- Probability (%)
probabilitynumber - The chance of winning, from 0 to 100.From 0 to 100.
- Lead source
lead_sourcetext - Where the deal came from. Pick one, or type a source your instance uses.
- Next step
next_steptext - What happens next.
- Description
descriptiontext - Notes about the record.
- Assigned to
assigned_totext - The user or group that owns the record. Pick one, or give an id from 'List users and groups'. Defaults to the connected user.
Outputs
dealobject- The deal
Example output
{
"deal": {
"amount": "15000.00",
"assigned_user_id": "19x1",
"closingdate": "2026-12-31",
"createdtime": "2026-10-20 09:15:00",
"id": "10x42",
"modifiedtime": "2026-10-21 14:02:10",
"potentialname": "Acme renewal",
"probability": "40",
"related_to": "3x12",
"sales_stage": "Prospecting"
}
}Update lead
Change a lead in Vtiger. Only the fields you fill in change; the rest stay as they are.
Inputs
- Lead
record_idtextRequired - The lead's id, such as 4x123, from 'Create lead', 'List records' or an earlier step.
- Last name
last_nametext - The lead's last name.
- First name
first_nametext - The lead's first name.
- Salutation
salutationtext - How to address the lead.One of:
Mr.,Ms.,Mrs.,Dr.,Prof.. - Company
companytext - The company the lead works for.
- Email
emailtext - The lead's email address.
- Phone
phonetext - The lead's phone number.
- Mobile
mobiletext - The lead's mobile number.
- Job title
job_titletext - The lead's job title. Pick one, or type a title your instance uses.
- Website
websitetext - The lead's website.
- Lead status
lead_statustext - Where the lead is in your process. Pick one, or type a status your instance uses.
- Lead source
lead_sourcetext - Where the lead came from. Pick one, or type a source your instance uses.
- Industry
industrytext - The lead's industry. Pick one, or type an industry your instance uses.
- Annual revenue
annual_revenuenumber - The company's yearly revenue, as a number.
- Number of employees
employeesnumber - How many people work at the company.At least 0.
- Street
streettext - The street address.
- City
citytext - The city.
- State
statetext - The state or region.
- Postal code
postal_codetext - The postal or ZIP code.
- Country
countrytext - The country.
- Description
descriptiontext - Notes about the record.
- Assigned to
assigned_totext - The user or group that owns the record. Pick one, or give an id from 'List users and groups'. Defaults to the connected user.
Outputs
leadobject- The lead
Example output
{
"lead": {
"assigned_user_id": "19x1",
"company": "Acme Ltd",
"createdtime": "2026-10-20 09:15:00",
"email": "alex.smith@example.com",
"firstname": "Alex",
"id": "10x42",
"lastname": "Smith",
"leadstatus": "Contacted",
"modifiedtime": "2026-10-21 14:02:10",
"phone": "+1 555 0100"
}
}Update organization
Change a organization in Vtiger. Only the fields you fill in change; the rest stay as they are.
Inputs
- Organization
record_idtextRequired - The organization's id, such as 4x123, from 'Create organization', 'List records' or an earlier step.
- Organization name
nametext - The organization's name.
- Website
websitetext - The organization's website.
- Email
emailtext - The organization's main email address.
- Phone
phonetext - The organization's main phone number.
- Industry
industrytext - The organization's industry. Pick one, or type an industry your instance uses.
- Type
account_typetext - What kind of organization it is, such as Customer or Partner. Pick one, or type a type your instance uses.
- Number of employees
employeesnumber - How many people work there.At least 0.
- Annual revenue
annual_revenuenumber - The organization's yearly revenue, as a number.
- Billing street
streettext - The billing street address.
- Billing city
citytext - The billing city.
- Billing state
statetext - The billing state or region.
- Billing postal code
postal_codetext - The billing postal or ZIP code.
- Billing country
countrytext - The billing country.
- Description
descriptiontext - Notes about the record.
- Assigned to
assigned_totext - The user or group that owns the record. Pick one, or give an id from 'List users and groups'. Defaults to the connected user.
Outputs
organizationobject- The organization
Example output
{
"organization": {
"accountname": "Acme Ltd",
"assigned_user_id": "19x1",
"createdtime": "2026-10-20 09:15:00",
"email1": "info@acme.example.com",
"id": "10x42",
"industry": "Technology",
"modifiedtime": "2026-10-21 14:02:10",
"phone": "+1 555 0100",
"website": "https://acme.example.com"
}
}Update record
Change fields of a record in any module. Only the fields you list change; the rest stay as they are.
Inputs
- Record ID
record_idtextRequired - The record's id, such as 4x123, from 'List records' or the 'id' of an earlier step.
- Fields
fieldsobjectRequired - The fields to set, each a field name and its value, such as lastname and Smith. 'Describe module' lists a module's field names; dates are YYYY-MM-DD and yes/no fields are true or false.
Outputs
recordobject- The record, changed
Example output
{
"record": {
"assigned_user_id": "19x1",
"createdtime": "2026-10-20 09:15:00",
"id": "10x42",
"modifiedtime": "2026-10-21 14:02:10"
}
}Update task
Change a task in Vtiger. Only the fields you fill in change; the rest stay as they are.
Inputs
- Task
record_idtextRequired - The task's id, such as 4x123, from 'Create task', 'List records' or an earlier step.
- Subject
subjecttext - What needs doing.
- Start date
start_datedate - The day the task starts.
- Start time
start_timetime - The time the task starts. Defaults to 09:00.
- Due date
due_datedate - The day the task is due. Defaults to the start date.
- Status
statustext - Where the task is. Pick one, or type a status your instance uses. Defaults to Not Started.
- Priority
prioritytext - How urgent the task is. Pick one, or type a priority your instance uses.
- Related to
related_totext - The id of the lead, deal or ticket the task is about, from an earlier step. Older Vtiger versions also accept an organization; newer ones do not.
- Contact
contact_idtext - The id of the contact the task is about, from an earlier step.
- Description
descriptiontext - Notes about the task.
- Assigned to
assigned_totext - The user or group that owns the record. Pick one, or give an id from 'List users and groups'. Defaults to the connected user.
Outputs
taskobject- The task
Example output
{
"task": {
"assigned_user_id": "19x1",
"createdtime": "2026-10-20 09:15:00",
"date_start": "2026-11-02",
"due_date": "2026-11-02",
"id": "10x42",
"modifiedtime": "2026-10-21 14:02:10",
"subject": "Call Alex about the renewal",
"taskpriority": "Medium",
"taskstatus": "Not Started",
"time_start": "09:00:00"
}
}Update ticket
Change a ticket in Vtiger. Only the fields you fill in change; the rest stay as they are.
Inputs
- Ticket
record_idtextRequired - The ticket's id, such as 4x123, from 'Create ticket', 'List records' or an earlier step.
- Title
titletext - A short summary of the problem.
- Status
statustext - Where the ticket is. Pick one, or type a status your instance uses. Defaults to Open.
- Priority
prioritytext - How urgent the ticket is. Pick one, or type a priority your instance uses.
- Organization
account_idtext - The organization the ticket is for. Pick one, or give the id of an organization or contact from an earlier step.
- Contact
contact_idtext - The id of the contact who raised it, from an earlier step. Newer Vtiger versions require it.
- Description
descriptiontext - The details of the problem. Newer Vtiger versions require it.
- Solution
solutiontext - How the problem was solved. Not kept by newer Vtiger versions, which call tickets Cases.
- Assigned to
assigned_totext - The user or group that owns the record. Pick one, or give an id from 'List users and groups'. Defaults to the connected user.
Outputs
ticketobject- The ticket
Example output
{
"ticket": {
"assigned_user_id": "19x1",
"createdtime": "2026-10-20 09:15:00",
"id": "10x42",
"modifiedtime": "2026-10-21 14:02:10",
"ticket_no": "TT12",
"ticket_title": "Cannot sign in",
"ticketpriorities": "Normal",
"ticketstatus": "Open"
}
}