Cmdlets for Zoho CRM

Build 24.0.9060

Leads

Create, update, delete, and query information regarding Leads.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert


INSERT INTO Leads(FirstName, LastName, Title) VALUES('Alert', 'Bat', 'Mr')
INSERT INTO LEADS(FirstName, LastName, Email, Trigger) VALUES('Enthusiastic', 'Panda', '[email protected]', 'workflow,approval,blueprint')

Required fields: LastName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Leads WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Leads SET Description = 'Changed from the API.' WHERE Id = '3152079000000488014'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier for this record.

LeadOwner_Id String False

The Id of the lead owner.

LeadOwner_FirstName String False

The First Name of the lead owner.

LeadOwner_LastName String False

The Last Name of the lead owner.

Company String False

The company of the lead.

FirstName String False

The first name of the lead.

LastName String False

The last name of the lead.

Title String False

The designation of the lead.

Email String False

The email of the lead.

Phone String False

The phone number of the lead.

Fax String False

The fax number of the lead.

Mobile String False

The mobile number of the lead.

Website String False

The website of the lead.

LeadSource String False

The source of the lead.

LeadStatus String False

The status of the lead.

Industry String False

The induystr in which the lead is in.

No_ofEmployees Int False

The number of employees in the lead's company.

AnnualRevenue Double False

The annual revenue of the lead.

Rating String False

The rating of the lead.

Tag String False

A list of tag related to the lead.

CreatedBy_Id String False

The Id of the User who created the record.

EmailOptOut Bool False

Whether the lead has opted out of emails or not.

SkypeID String False

The skype id of the lead.

ModifiedBy_Id String False

The Id of the User who modified the record.

ModifiedBy_FirstName String False

The First Name of the User who modified the record.

ModifiedBy_LastName String False

The Last Name of the User who modified the record.

CreatedTime Datetime False

The time when the record was created.

ModifiedTime Datetime False

The time when the record was modified.

FullName String False

The full name of the lead.

Salutation String False

The salutation that the lead likes to be referred to.

SecondaryEmail String False

The secondary email of the lead.

Twitter String False

The twitter handle of the lead.

LastActivityTime Datetime False

The last time the lead had any activity.

Street String False

The street where the lead resides in.

City String False

The city where the lead resides in.

State String False

The state where the lead resides in.

ZipCode String False

The zip code of the place where the lead resides in.

Country String False

The country where the lead resides in.

Description String False

A description of the lead.

MostRecentVisit Datetime False

The last time the lead visited.

FirstVisit Datetime False

The first time the lead visited.

Referrer String False

The referrer of the lead.

FirstPageVisited String False

The first URL that the lead has visited.

NumberOfChats Int False

The number of chats had with the lead.

AverageTimeSpent_Minutes_ String False

The average time the lead has spent in minutes.

DaysVisited Int False

The number of days the lead has visitied.

VisitorScore Long False

The visitor score calculated for this lead.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
DuplicateCheckFields String

The field/s to be used for checking in an upsert.

CustomViewId Long

The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Trigger String

To trigger the rule while inserting record into CRM account.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060