Operations (sample payloads)
Main operations
Convert lead
Converts a lead. Sample Input Sample Output
Create specific record
Creates a new entity and inserts it into a module. Sample Input Sample Output
Create/Update records
Creates new records or updates existing ones. Sample Input Sample Output
Delete records
Deletes one or a list of records. Sample Input
\{
"module_name": "Contacts",
"ids": [
"3000000001234",
"3000000005678",
"3000000009012"
]
\}
Sample Output
{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "3000000001234"
},
"message": "record deleted",
"status": "success"
},
{
"code": "SUCCESS",
"details": {
"id": "3000000005678"
},
"message": "record deleted",
"status": "success"
},
{
"code": "INVALID_DATA",
"details": {
"id": "3000000009012"
},
"message": "Record does not exist",
"status": "error"
}
]
}
Get organization
Gets information about the current organization Sample Input Sample Output
{
"org": [
{
"zia_portal_id": "12345",
"zip": "94105",
"mobile": "+1 (415) 555-1234",
"street": "123 Main St",
"license_details": \{
"paid_expiry": false,
"users_license_purchased": 50,
"trial_type": "PROFESSIONAL",
"trial_expiry": false,
"paid": true,
"paid_type": "ANNUAL"
\},
"currency_symbol": "$",
"iso_code": "USD",
"zgid": "67890",
"currency_locale": "en_US",
"photo_id": "abcdef123456",
"city": "San Francisco",
"company_name": "Acme Corporation",
"phone": "+1 (415) 555-5678",
"alias": "acme",
"currency": "USD",
"state": "CA",
"primary_zuid": "zuid123456",
"country_code": "US",
"country": "United States",
"privacy_settings": true,
"gapps_enabled": true,
"website": "https://www.acmecorp.com",
"id": "org123456",
"mc_status": true,
"description": "Leading provider of innovative solutions",
"fax": "+1 (415) 555-9876",
"employee_count": "1000-5000",
"time_zone": "America/Los_Angeles",
"primary_email": "info@acmecorp.com"
}
]
}
Get record
Returns information about a record. Sample Input Sample Output
{
"data": [
{
"Mobile": null,
"$currency_symbol": "$",
"$process_flow": false,
"$converted_detail": {},
"Street": null,
"Modified_Time": "2023-05-15T14:30:00+0000",
"Created_Time": "2023-05-10T09:15:00+0000",
"Skype_ID": null,
"$approval": \{
"delegate": false,
"approve": false,
"reject": false,
"resubmit": false
\},
"$editable": true,
"Zip_Code": null,
"City": null,
"Modified_By": \{
"name": "John Doe",
"id": "3872984000000185001"
\},
"Created_By": \{
"name": "Jane Smith",
"id": "3872984000000185002"
\},
"Phone": null,
"$converted": false,
"State": null,
"Secondary_Email": null,
"Twitter": null,
"Owner": \{
"name": "Jane Smith",
"id": "3872984000000185002"
\},
"Last_Activity_Time": null,
"$followed": true,
"Last_Name": "Johnson",
"Lead_Status": null,
"Country": null,
"Designation": null,
"Salutation": null,
"First_Name": null,
"Tag": [],
"Website": null,
"No_of_Employees": 50,
"id": "3872984000000321001",
"Full_Name": "Johnson",
"$approved": true,
"Annual_Revenue": 1000000,
"Email": null,
"Description": null,
"Company": null,
"Rating": null,
"Fax": null,
"Industry": null,
"Lead_Source": null,
"Email_Opt_Out": false
}
]
}
Get user
Get a specific user using their ID Sample Input Sample Output
{
"users": [
{
"confirm": true,
"zip": "94105",
"mobile": "+1 (415) 555-1234",
"street": "123 Main St",
"Modified_Time": "2023-05-15T14:30:00-07:00",
"country_locale": "en_US",
"created_time": "2023-01-01T09:00:00-08:00",
"date_format": "MM/dd/yyyy",
"profile": \{
"name": "Sales Representative",
"id": "4000000789012"
\},
"time_format": "hh:mm a",
"city": "San Francisco",
"Modified_By": \{
"name": "Admin User",
"id": "3000000987654"
\},
"microsoft": false,
"created_by": \{
"name": "System",
"id": "3000000000001"
\},
"phone": "+1 (415) 555-5678",
"alias": "jsmith",
"state": "CA",
"status": "active",
"offset": -7,
"last_name": "Smith",
"role": \{
"name": "Sales",
"id": "5000000123456"
\},
"zuid": "12345678",
"country": "United States",
"dob": "1985-06-15",
"territories": [
"West Coast",
"Pacific Northwest"
],
"language": "English",
"locale": "en_US",
"first_name": "John",
"website": "https://www.example.com",
"id": "3000000123456",
"full_name": "John Smith",
"email": "john.smith@example.com",
"Isonline": true,
"fax": "+1 (415) 555-9876",
"time_zone": "America/Los_Angeles"
}
]
}
List records
Returns the list available records from a module. Sample Input Sample Output
{
"data": [
{
"First_Name": "John",
"Last_Name": "Doe",
"Email": "john.doe@example.com",
"Company": "Acme Corp",
"Phone": "+1 (555) 123-4567",
"id": "3000000001234",
"Owner": \{
"name": "Jane Smith",
"id": "3000000004321"
\},
"Created_Time": "2023-04-15T10:30:00+0000",
"Modified_Time": "2023-04-15T10:30:00+0000",
"$currency_symbol": "$",
"$process_flow": false,
"$converted": false,
"$approved": true,
"$editable": true,
"$followed": false,
"Email_Opt_Out": false,
"Tag": []
},
{
"First_Name": "Alice",
"Last_Name": "Johnson",
"Email": "alice.johnson@example.com",
"Company": "Tech Innovations",
"Phone": "+1 (555) 987-6543",
"id": "3000000001235",
"Owner": \{
"name": "Bob Williams",
"id": "3000000004322"
\},
"Created_Time": "2023-04-14T15:45:00+0000",
"Modified_Time": "2023-04-14T15:45:00+0000",
"$currency_symbol": "$",
"$process_flow": false,
"$converted": false,
"$approved": true,
"$editable": true,
"$followed": true,
"Email_Opt_Out": false,
"Tag": [
"Potential",
"Follow-up"
]
}
],
"info": \{
"per_page": 100,
"count": 2,
"page": 1,
"more_records": false
\}
}
List users
List / filter users found in Zoho account Sample Input
\{
"user_type": "ActiveUsers",
"page": "1",
"per_page": "50"
\}
Sample Output
{
"users": [
{
"confirm": true,
"zip": null,
"mobile": null,
"street": null,
"Modified_Time": "2023-05-15T10:30:00Z",
"country_locale": "en_US",
"created_time": "2023-01-01T09:00:00Z",
"date_format": "MM/dd/yyyy",
"profile": \{
"name": "Sales Representative",
"id": "67890"
\},
"time_format": "hh:mm a",
"theme": {
"normal_tab": \{
"font_color": "#000000",
"background": "#FFFFFF"
\},
"selected_tab": \{
"font_color": "#FFFFFF",
"background": "#4A90E2"
\},
"new_background": null,
"background": "#F2F2F2",
"screen": "normal",
"type": "custom"
},
"customize_info": \{
"notes_desc": null,
"show_right_panel": null,
"bc_view": null,
"show_home": true,
"show_detail_view": true,
"unpin_recent_item": null
\},
"name_format": "Salutation,First Name,Last Name",
"city": null,
"Modified_By": \{
"name": "Admin User",
"id": "12345"
\},
"microsoft": false,
"created_by": \{
"name": "Admin User",
"id": "12345"
\},
"phone": null,
"personal_account": false,
"alias": null,
"state": null,
"status": "active",
"offset": 5.5,
"last_name": "Smith",
"role": \{
"name": "Sales",
"id": "54321"
\},
"zuid": "51234567890",
"country": null,
"default_tab_group": "Leads",
"dob": null,
"decimal_separator": ".",
"signature": null,
"territories": [],
"language": "en_US",
"locale": "en_US",
"first_name": "John",
"website": null,
"id": "98765432",
"full_name": "John Smith",
"email": "john.smith@example.com",
"Isonline": true,
"fax": null,
"time_zone": "America/New_York"
}
],
"info": \{
"per_page": 50,
"count": 1,
"page": 1,
"more_records": false
\}
}
Search records
Returns a list of records matching the search criteria. Sample Input
{
"module_name": "Leads",
"query": {
"criteria_list": [
\{
"field_name": "Email",
"field_value": "example.com",
"condition": "ends_with"
\},
\{
"field_name": "Annual_Revenue",
"field_value": "1000000",
"condition": "greater_than"
\}
]
},
"per_page": 50,
"page": 1
}
Sample Output
Update records
Updates existing record. Sample Input
{
"module_name": "Contacts",
"records": [
{
"record_id": "3890876000000410001",
"properties2": [
\{
"field": "Last_Name",
"value": "Smith"
\},
\{
"field": "Email",
"value": "john.smith@example.com"
\},
\{
"field": "Phone",
"value": "+1 (555) 123-4567"
\}
]
},
{
"record_id": "3890876000000410002",
"properties2": [
\{
"field": "First_Name",
"value": "Jane"
\},
\{
"field": "Title",
"value": "Marketing Manager"
\}
]
}
],
"check_duplicates": [
"Email",
"Phone"
]
}
Sample Output
{
"data": [
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2023-05-15T14:30:45+0000",
"Modified_By": \{
"name": "John Doe",
"id": "3890876000000410003"
\},
"Created_Time": "2023-05-10T09:15:30+0000",
"id": "3890876000000410001",
"Created_By": \{
"name": "Jane Smith",
"id": "3890876000000410004"
\}
},
"message": "Record updated successfully",
"status": "success"
},
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2023-05-15T14:30:46+0000",
"Modified_By": \{
"name": "John Doe",
"id": "3890876000000410003"
\},
"Created_Time": "2023-05-11T11:20:15+0000",
"id": "3890876000000410002",
"Created_By": \{
"name": "Jane Smith",
"id": "3890876000000410004"
\}
},
"message": "Record updated successfully",
"status": "success"
}
]
}
Update specific record
Updates information about a specific record. Sample Input
{
"module_name": "Contacts",
"record_id": "3000000001234",
"record": [
\{
"name": "First Name",
"value": "John"
\},
\{
"name": "Last Name",
"value": "Doe"
\},
\{
"name": "Email",
"value": "johndoe@example.com"
\},
\{
"name": "Phone",
"value": "+1 (555) 123-4567"
\}
],
"trigger": [
"workflow"
]
}
Sample Output
{
"data": [
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2023-05-15T14:30:45+0000",
"Modified_By": \{
"name": "Jane Smith",
"id": "3000000001235"
\},
"Created_Time": "2023-05-10T09:15:30+0000",
"id": "3000000001234",
"Created_By": \{
"name": "John Doe",
"id": "3000000001236"
\}
},
"message": "Record updated successfully",
"status": "success"
}
]
}
DDL operations
List convertable modules (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Checks if the user can convert a record in the current module. Sample Input
{}
Sample Output
{
"convertable_modules": [
\{
"module": "Leads",
"convertable": true
\},
\{
"module": "Contacts",
"convertable": false
\},
\{
"module": "Accounts",
"convertable": false
\},
\{
"module": "Deals",
"convertable": true
\}
]
}
List creatable modules (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Checks if the user can create a record in the current module. Sample Input Sample Output
{
"modules": [
\{
"api_name": "Leads",
"singular_label": "Lead",
"plural_label": "Leads"
\},
\{
"api_name": "Contacts",
"singular_label": "Contact",
"plural_label": "Contacts"
\},
\{
"api_name": "Accounts",
"singular_label": "Account",
"plural_label": "Accounts"
\},
\{
"api_name": "Deals",
"singular_label": "Deal",
"plural_label": "Deals"
\},
\{
"api_name": "Tasks",
"singular_label": "Task",
"plural_label": "Tasks"
\}
]
}
List deletable modules (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Checks if the user can delete a record in the current module. Sample Input
{}
Sample Output
{
"modules": [
\{
"api_name": "Leads",
"plural_label": "Leads",
"singular_label": "Lead"
\},
\{
"api_name": "Contacts",
"plural_label": "Contacts",
"singular_label": "Contact"
\},
\{
"api_name": "Accounts",
"plural_label": "Accounts",
"singular_label": "Account"
\},
\{
"api_name": "Deals",
"plural_label": "Deals",
"singular_label": "Deal"
\}
]
}
List fields (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Retrieves the field meta data for the specified module. The fields displayed are from all layouts for the module and the response does not contain layout-specific fields like mandatory fields or picklist values. Sample Input
{
"module_name": "Contacts"
}
Sample Output
{
"fields": [
\{
"api_name": "Last_Name",
"data_type": "string",
"length": 80,
"required": true,
"field_label": "Last Name",
"read_only": false
\},
\{
"api_name": "First_Name",
"data_type": "string",
"length": 40,
"required": false,
"field_label": "First Name",
"read_only": false
\},
\{
"api_name": "Email",
"data_type": "email",
"length": 100,
"required": false,
"field_label": "Email",
"read_only": false
\},
\{
"api_name": "Phone",
"data_type": "phone",
"length": 50,
"required": false,
"field_label": "Phone",
"read_only": false
\},
\{
"api_name": "Account_Name",
"data_type": "lookup",
"length": 120,
"required": false,
"field_label": "Account Name",
"read_only": false
\}
]
}
List record IDs (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
A DDL for selecting individual records. Sample Input
{
"module_name": "Contacts"
}
Sample Output
{
"result": [
\{
"text": "John Doe",
"value": "3890000000007001"
\},
\{
"text": "Jane Smith",
"value": "3890000000007002"
\},
\{
"text": "Mike Johnson",
"value": "3890000000007003"
\}
]
}
List upsertable modules (DDL)
Checks if the user can create a record in the current module. Sample Input
{}
Sample Output
List viewable modules (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Checks if the user can view a record in the current module. Sample Input
{}
Sample Output
{
"modules": [
\{
"api_name": "Leads",
"singular_label": "Lead",
"plural_label": "Leads"
\},
\{
"api_name": "Contacts",
"singular_label": "Contact",
"plural_label": "Contacts"
\},
\{
"api_name": "Accounts",
"singular_label": "Account",
"plural_label": "Accounts"
\},
\{
"api_name": "Deals",
"singular_label": "Deal",
"plural_label": "Deals"
\},
\{
"api_name": "Tasks",
"singular_label": "Task",
"plural_label": "Tasks"
\}
]
}