ByteChef LogoByteChef

VTiger

VTiger is a comprehensive customer relationship management (CRM) platform that offers sales, marketing, and support solutions to streamline business.

Categories: CRM

Type: vtiger/v1


Connections

Version: 1

Basic Auth

Properties

NameLabelTypeDescriptionRequired
usernameUsernameSTRINGEnter your username/email.true
passwordAccess KeySTRINGtrue
instance_urlVTiger Instance URLSTRINGFor the instance URL, add the url without the endpoint.true

Connection Setup

Find Access Key

  1. Navigate to VTiger dashboard.
  2. Click on your account icon.
  3. Click on My Preferences.
  4. Here you can see your credentials.
  5. Done 🚀.

Actions

Create Contact

Name: createContact

Creates a new contact.

Properties

NameLabelTypeDescriptionRequired
firstnameFirst NameSTRINGFirst name of the contact.true
lastnameLast NameSTRINGLast name of the contact.true
emailEmailSTRINGEmail address of the contact.true

Example JSON Structure

{
  "label" : "Create Contact",
  "name" : "createContact",
  "parameters" : {
    "firstname" : "",
    "lastname" : "",
    "email" : ""
  },
  "type" : "vtiger/v1/createContact"
}

Output

Type: OBJECT

Properties

NameTypeDescription
resultOBJECT
Properties {STRING(firstname), STRING(lastname), STRING(email), STRING(phone), STRING(assigned_user_id), STRING(id)}

Output Example

{
  "result" : {
    "firstname" : "",
    "lastname" : "",
    "email" : "",
    "phone" : "",
    "assigned_user_id" : "",
    "id" : ""
  }
}

Create Product

Name: createProduct

Creates a new product for your CRM.

Properties

NameLabelTypeDescriptionRequired
productnameProduct NameSTRINGName of the product.true
product_typeProduct TypeSTRING
Options Solo, Fixed Bundle
Type of the product.true

Example JSON Structure

{
  "label" : "Create Product",
  "name" : "createProduct",
  "parameters" : {
    "productname" : "",
    "product_type" : ""
  },
  "type" : "vtiger/v1/createProduct"
}

Output

Type: OBJECT

Properties

NameTypeDescription
resultsOBJECT
Properties {STRING(productname), STRING(product_type), STRING(assigned_user_id), STRING(id)}

Output Example

{
  "results" : {
    "productname" : "",
    "product_type" : "",
    "assigned_user_id" : "",
    "id" : ""
  }
}

Get Me

Name: getMe

Get more information about yourself.

Example JSON Structure

{
  "label" : "Get Me",
  "name" : "getMe",
  "type" : "vtiger/v1/getMe"
}

Output

Type: OBJECT

Properties

NameTypeDescription
resultOBJECT
Properties {STRING(id), STRING(user_name), STRING(user_type), STRING(email), STRING(phone_home), STRING(phone_work), STRING(phone_mobile), STRING(userlable), STRING(address_street), STRING(address_city), STRING(address_state), STRING(address_country), STRING(roleid), STRING(language), BOOLEAN(is_admin), BOOLEAN(is_owner), STRING(status)}

Output Example

{
  "result" : {
    "id" : "",
    "user_name" : "",
    "user_type" : "",
    "email" : "",
    "phone_home" : "",
    "phone_work" : "",
    "phone_mobile" : "",
    "userlable" : "",
    "address_street" : "",
    "address_city" : "",
    "address_state" : "",
    "address_country" : "",
    "roleid" : "",
    "language" : "",
    "is_admin" : false,
    "is_owner" : false,
    "status" : ""
  }
}

How is this guide?

Last updated on

On this page