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

ActionWhat it does
Add commentAdd a comment to a record's history, such as a lead, contact, organization, deal or ticket.
Create contactCreate a contact in Vtiger.
Create dealCreate a deal in Vtiger.
Create leadCreate a lead in Vtiger.
Create organizationCreate a organization in Vtiger.
Create recordCreate a record in any module from a list of fields, for a module without its own create action.
Create taskCreate a task in Vtiger.
Create ticketCreate a ticket in Vtiger.
Delete recordDelete a record of any module.
Describe moduleList 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 userGet the Vtiger user the connection signs in as, and the version of Vtiger it runs.
Get recordGet one record of any module with all its fields.
List modulesList the modules that hold records in this Vtiger, including custom ones.
List recordsList 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 groupsList the users and groups a record can be assigned to, with the ids to give 'Assigned to'.
Run queryRun a read-only VtigerQL query, such as SELECT firstname, lastname FROM Contacts WHERE email LIKE '%acme%' LIMIT 0, 50.
Update contactChange a contact in Vtiger.
Update dealChange a deal in Vtiger.
Update leadChange a lead in Vtiger.
Update organizationChange a organization in Vtiger.
Update recordChange fields of a record in any module.
Update taskChange a task in Vtiger.
Update ticketChange a ticket in Vtiger.

Add comment

Add a comment to a record's history, such as a lead, contact, organization, deal or ticket.

Inputs

Recordrelated_totextRequired
The id of the record to comment on, such as 4x123, from an earlier step.
CommentcommenttextRequired
What to say.
Assigned toassigned_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 namelast_nametextRequired
The contact's last name.
First namefirst_nametext
The contact's first name.
Salutationsalutationtext
How to address the contact.One of: Mr., Ms., Mrs., Dr., Prof..
Emailemailtext
The contact's email address.
Phonephonetext
The contact's phone number.
Mobilemobiletext
The contact's mobile number.
Job titlejob_titletext
The contact's job title. Pick one, or type a title your instance uses.
Departmentdepartmenttext
The contact's department.
Organizationaccount_idtext
The organization the contact works for. Pick one, or give the id of an organization from an earlier step.
Lead sourcelead_sourcetext
Where the contact came from. Pick one, or type a source your instance uses.
Birthdaybirthdaydate
The contact's date of birth.
Streetstreettext
The mailing street address.
Citycitytext
The mailing city.
Statestatetext
The mailing state or region.
Postal codepostal_codetext
The mailing postal or ZIP code.
Countrycountrytext
The mailing country.
Descriptiondescriptiontext
Notes about the record.
Assigned toassigned_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 namenametextRequired
The deal's name.
Organizationrelated_totextRequired
The organization the deal is with. Pick one, or give the id of an organization or contact from an earlier step.
Expected close dateclosing_datedateRequired
When the deal is expected to close.
Sales stagesales_stagetextRequired
Where the deal is in your pipeline. Pick one, or type a stage your instance uses.
Amountamountnumber
The deal's value, as a number.
Probability (%)probabilitynumber
The chance of winning, from 0 to 100.From 0 to 100.
Lead sourcelead_sourcetext
Where the deal came from. Pick one, or type a source your instance uses.
Next stepnext_steptext
What happens next.
Descriptiondescriptiontext
Notes about the record.
Assigned toassigned_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 namelast_nametextRequired
The lead's last name.
First namefirst_nametext
The lead's first name.
Salutationsalutationtext
How to address the lead.One of: Mr., Ms., Mrs., Dr., Prof..
Companycompanytext
The company the lead works for.
Emailemailtext
The lead's email address.
Phonephonetext
The lead's phone number.
Mobilemobiletext
The lead's mobile number.
Job titlejob_titletext
The lead's job title. Pick one, or type a title your instance uses.
Websitewebsitetext
The lead's website.
Lead statuslead_statustext
Where the lead is in your process. Pick one, or type a status your instance uses.
Lead sourcelead_sourcetext
Where the lead came from. Pick one, or type a source your instance uses.
Industryindustrytext
The lead's industry. Pick one, or type an industry your instance uses.
Annual revenueannual_revenuenumber
The company's yearly revenue, as a number.
Number of employeesemployeesnumber
How many people work at the company.At least 0.
Streetstreettext
The street address.
Citycitytext
The city.
Statestatetext
The state or region.
Postal codepostal_codetext
The postal or ZIP code.
Countrycountrytext
The country.
Descriptiondescriptiontext
Notes about the record.
Assigned toassigned_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 namenametextRequired
The organization's name.
Websitewebsitetext
The organization's website.
Emailemailtext
The organization's main email address.
Phonephonetext
The organization's main phone number.
Industryindustrytext
The organization's industry. Pick one, or type an industry your instance uses.
Typeaccount_typetext
What kind of organization it is, such as Customer or Partner. Pick one, or type a type your instance uses.
Number of employeesemployeesnumber
How many people work there.At least 0.
Annual revenueannual_revenuenumber
The organization's yearly revenue, as a number.
Billing streetstreettext
The billing street address.
Billing citycitytext
The billing city.
Billing statestatetext
The billing state or region.
Billing postal codepostal_codetext
The billing postal or ZIP code.
Billing countrycountrytext
The billing country.
Descriptiondescriptiontext
Notes about the record.
Assigned toassigned_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

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

SubjectsubjecttextRequired
What needs doing.
Start datestart_datedateRequired
The day the task starts.
Start timestart_timetime
The time the task starts. Defaults to 09:00.
Due datedue_datedate
The day the task is due. Defaults to the start date.
Statusstatustext
Where the task is. Pick one, or type a status your instance uses. Defaults to Not Started.
Priorityprioritytext
How urgent the task is. Pick one, or type a priority your instance uses.
Related torelated_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.
Contactcontact_idtext
The id of the contact the task is about, from an earlier step.
Descriptiondescriptiontext
Notes about the task.
Assigned toassigned_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

TitletitletextRequired
A short summary of the problem.
Statusstatustext
Where the ticket is. Pick one, or type a status your instance uses. Defaults to Open.
Priorityprioritytext
How urgent the ticket is. Pick one, or type a priority your instance uses.
Organizationaccount_idtext
The organization the ticket is for. Pick one, or give the id of an organization or contact from an earlier step.
Contactcontact_idtext
The id of the contact who raised it, from an earlier step. Newer Vtiger versions require it.
Descriptiondescriptiontext
The details of the problem. Newer Vtiger versions require it.
Solutionsolutiontext
How the problem was solved. Not kept by newer Vtiger versions, which call tickets Cases.
Assigned toassigned_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 IDrecord_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

ModulemoduletextRequired
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 IDrecord_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

ModulemoduletextRequired
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 returnfieldslist
Only these fields. Leave empty for every field.
Filter fieldfilter_fieldtext
The field to filter on, such as email or leadstatus.
Filterfilter_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 valuefilter_valuetext
The value to compare with. Dates are YYYY-MM-DD.
Changed sincemodified_sincedate and time
Only records changed at or after this moment.
Created sincecreated_sincedate and time
Only records created at or after this moment.
Sort byorder_bytext
The field to sort by, such as createdtime. Defaults to Vtiger's order.
Sort orderorder_directiontext
Which end to start from when sorting. Defaults to smallest first.One of: asc (Smallest first (default)), desc (Largest first).
Page sizelimitnumber
How many records to return, 1 to 100. Defaults to 25.From 1 to 100.
Start atoffsetnumber
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

QueryquerytextRequired
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

Contactrecord_idtextRequired
The contact's id, such as 4x123, from 'Create contact', 'List records' or an earlier step.
Last namelast_nametext
The contact's last name.
First namefirst_nametext
The contact's first name.
Salutationsalutationtext
How to address the contact.One of: Mr., Ms., Mrs., Dr., Prof..
Emailemailtext
The contact's email address.
Phonephonetext
The contact's phone number.
Mobilemobiletext
The contact's mobile number.
Job titlejob_titletext
The contact's job title. Pick one, or type a title your instance uses.
Departmentdepartmenttext
The contact's department.
Organizationaccount_idtext
The organization the contact works for. Pick one, or give the id of an organization from an earlier step.
Lead sourcelead_sourcetext
Where the contact came from. Pick one, or type a source your instance uses.
Birthdaybirthdaydate
The contact's date of birth.
Streetstreettext
The mailing street address.
Citycitytext
The mailing city.
Statestatetext
The mailing state or region.
Postal codepostal_codetext
The mailing postal or ZIP code.
Countrycountrytext
The mailing country.
Descriptiondescriptiontext
Notes about the record.
Assigned toassigned_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

Dealrecord_idtextRequired
The deal's id, such as 4x123, from 'Create deal', 'List records' or an earlier step.
Deal namenametext
The deal's name.
Organizationrelated_totext
The organization the deal is with. Pick one, or give the id of an organization or contact from an earlier step.
Expected close dateclosing_datedate
When the deal is expected to close.
Sales stagesales_stagetext
Where the deal is in your pipeline. Pick one, or type a stage your instance uses.
Amountamountnumber
The deal's value, as a number.
Probability (%)probabilitynumber
The chance of winning, from 0 to 100.From 0 to 100.
Lead sourcelead_sourcetext
Where the deal came from. Pick one, or type a source your instance uses.
Next stepnext_steptext
What happens next.
Descriptiondescriptiontext
Notes about the record.
Assigned toassigned_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

Leadrecord_idtextRequired
The lead's id, such as 4x123, from 'Create lead', 'List records' or an earlier step.
Last namelast_nametext
The lead's last name.
First namefirst_nametext
The lead's first name.
Salutationsalutationtext
How to address the lead.One of: Mr., Ms., Mrs., Dr., Prof..
Companycompanytext
The company the lead works for.
Emailemailtext
The lead's email address.
Phonephonetext
The lead's phone number.
Mobilemobiletext
The lead's mobile number.
Job titlejob_titletext
The lead's job title. Pick one, or type a title your instance uses.
Websitewebsitetext
The lead's website.
Lead statuslead_statustext
Where the lead is in your process. Pick one, or type a status your instance uses.
Lead sourcelead_sourcetext
Where the lead came from. Pick one, or type a source your instance uses.
Industryindustrytext
The lead's industry. Pick one, or type an industry your instance uses.
Annual revenueannual_revenuenumber
The company's yearly revenue, as a number.
Number of employeesemployeesnumber
How many people work at the company.At least 0.
Streetstreettext
The street address.
Citycitytext
The city.
Statestatetext
The state or region.
Postal codepostal_codetext
The postal or ZIP code.
Countrycountrytext
The country.
Descriptiondescriptiontext
Notes about the record.
Assigned toassigned_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

Organizationrecord_idtextRequired
The organization's id, such as 4x123, from 'Create organization', 'List records' or an earlier step.
Organization namenametext
The organization's name.
Websitewebsitetext
The organization's website.
Emailemailtext
The organization's main email address.
Phonephonetext
The organization's main phone number.
Industryindustrytext
The organization's industry. Pick one, or type an industry your instance uses.
Typeaccount_typetext
What kind of organization it is, such as Customer or Partner. Pick one, or type a type your instance uses.
Number of employeesemployeesnumber
How many people work there.At least 0.
Annual revenueannual_revenuenumber
The organization's yearly revenue, as a number.
Billing streetstreettext
The billing street address.
Billing citycitytext
The billing city.
Billing statestatetext
The billing state or region.
Billing postal codepostal_codetext
The billing postal or ZIP code.
Billing countrycountrytext
The billing country.
Descriptiondescriptiontext
Notes about the record.
Assigned toassigned_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 IDrecord_idtextRequired
The record's id, such as 4x123, from 'List records' or the 'id' of an earlier step.
FieldsfieldsobjectRequired
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

Taskrecord_idtextRequired
The task's id, such as 4x123, from 'Create task', 'List records' or an earlier step.
Subjectsubjecttext
What needs doing.
Start datestart_datedate
The day the task starts.
Start timestart_timetime
The time the task starts. Defaults to 09:00.
Due datedue_datedate
The day the task is due. Defaults to the start date.
Statusstatustext
Where the task is. Pick one, or type a status your instance uses. Defaults to Not Started.
Priorityprioritytext
How urgent the task is. Pick one, or type a priority your instance uses.
Related torelated_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.
Contactcontact_idtext
The id of the contact the task is about, from an earlier step.
Descriptiondescriptiontext
Notes about the task.
Assigned toassigned_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

Ticketrecord_idtextRequired
The ticket's id, such as 4x123, from 'Create ticket', 'List records' or an earlier step.
Titletitletext
A short summary of the problem.
Statusstatustext
Where the ticket is. Pick one, or type a status your instance uses. Defaults to Open.
Priorityprioritytext
How urgent the ticket is. Pick one, or type a priority your instance uses.
Organizationaccount_idtext
The organization the ticket is for. Pick one, or give the id of an organization or contact from an earlier step.
Contactcontact_idtext
The id of the contact who raised it, from an earlier step. Newer Vtiger versions require it.
Descriptiondescriptiontext
The details of the problem. Newer Vtiger versions require it.
Solutionsolutiontext
How the problem was solved. Not kept by newer Vtiger versions, which call tickets Cases.
Assigned toassigned_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"
  }
}

On this page