Operations (sample payloads)

Main operations
Copy

Convert lead
Copy

Converts a lead.

Sample Input

1{
2    "record_id": "3000000012345",
3    "data": {
4        "overwrite": true,
5        "notify_lead_owner": true,
6        "notify_new_entity_owner": false,
7        "accounts": "4000000067890",
8        "contacts": "5000000054321",
9        "assign_to": "6000000098765",
10        "deals": {
11            "campaign_source": "Email Campaign Q2 2023",
12            "deal_name": "Enterprise Software Upgrade",
13            "closing_date": "2023-09-30",
14            "stage": "Negotiation",
15            "amount": 75000
16        }
17    }
18}

Sample Output

1{
2    "data": [
3        {
4            "Contacts": "5000000054321",
5            "Deals": "7000000123456",
6            "Accounts": "4000000067890"
7        }
8    ]
9}

Create specific record
Copy

Creates a new entity and inserts it into a module.

Sample Input

1{
2    "module_name": "Leads",
3    "record": [
4        {
5            "name": "Last Name",
6            "value": "Smith"
7        },
8        {
9            "name": "First Name",
10            "value": "John"
11        },
12        {
13            "name": "Email",
14            "value": "john.smith@example.com"
15        },
16        {
17            "name": "Company",
18            "value": "Acme Corp"
19        },
20        {
21            "name": "Phone",
22            "value": "+1 (555) 123-4567"
23        }
24    ],
25    "trigger": [
26        "workflow"
27    ]
28}

Sample Output

1{
2    "data": [
3        {
4            "code": "SUCCESS",
5            "details": {
6                "Modified_Time": "2023-05-15T14:30:45+0000",
7                "Modified_By": {
8                    "name": "John Doe",
9                    "id": "4567890"
10                },
11                "Created_Time": "2023-05-15T14:30:45+0000",
12                "id": "3000000456789",
13                "Created_By": {
14                    "name": "John Doe",
15                    "id": "4567890"
16                }
17            },
18            "message": "Record added successfully",
19            "status": "success"
20        }
21    ]
22}

Create/Update records
Copy

Creates new records or updates existing ones.

Sample Input

1{
2    "module_name": "Leads",
3    "records": [
4        [
5            {
6                "field": "Last_Name",
7                "value": "Smith"
8            },
9            {
10                "field": "First_Name",
11                "value": "John"
12            },
13            {
14                "field": "Email",
15                "value": "john.smith@example.com"
16            },
17            {
18                "field": "Company",
19                "value": "Acme Corp"
20            }
21        ],
22        [
23            {
24                "field": "Last_Name",
25                "value": "Doe"
26            },
27            {
28                "field": "First_Name",
29                "value": "Jane"
30            },
31            {
32                "field": "Email",
33                "value": "jane.doe@example.com"
34            },
35            {
36                "field": "Company",
37                "value": "XYZ Inc"
38            }
39        ]
40    ],
41    "check_duplicates": [
42        "Email"
43    ]
44}

Sample Output

1{
2    "data": [
3        {
4            "code": "SUCCESS",
5            "action": "insert",
6            "details": {
7                "Modified_Time": "2023-05-15T14:30:45+0000",
8                "Modified_By": {
9                    "name": "John Doe",
10                    "id": "4567890"
11                },
12                "Created_Time": "2023-05-15T14:30:45+0000",
13                "id": "3000000001234",
14                "Created_By": {
15                    "name": "John Doe",
16                    "id": "4567890"
17                }
18            },
19            "message": "Record added successfully",
20            "status": "success"
21        },
22        {
23            "code": "DUPLICATE_DATA",
24            "duplicate_field": "Email",
25            "action": "update",
26            "details": {
27                "Modified_Time": "2023-05-15T14:30:46+0000",
28                "Modified_By": {
29                    "name": "John Doe",
30                    "id": "4567890"
31                },
32                "Created_Time": "2023-05-10T09:15:30+0000",
33                "id": "3000000005678",
34                "Created_By": {
35                    "name": "Jane Smith",
36                    "id": "1234567"
37                }
38            },
39            "message": "Record updated successfully",
40            "status": "success"
41        }
42    ]
43}

Delete records
Copy

Deletes one or a list of records.

Sample Input

1{
2    "module_name": "Contacts",
3    "ids": [
4        "3000000001234",
5        "3000000005678",
6        "3000000009012"
7    ]
8}

Sample Output

1{
2    "data": [
3        {
4            "code": "SUCCESS",
5            "details": {
6                "id": "3000000001234"
7            },
8            "message": "record deleted",
9            "status": "success"
10        },
11        {
12            "code": "SUCCESS",
13            "details": {
14                "id": "3000000005678"
15            },
16            "message": "record deleted",
17            "status": "success"
18        },
19        {
20            "code": "INVALID_DATA",
21            "details": {
22                "id": "3000000009012"
23            },
24            "message": "Record does not exist",
25            "status": "error"
26        }
27    ]
28}

Get organization
Copy

Gets information about the current organization

Sample Input

1{}

Sample Output

1{
2    "org": [
3        {
4            "zia_portal_id": "12345",
5            "zip": "94105",
6            "mobile": "+1 (415) 555-1234",
7            "street": "123 Main St",
8            "license_details": {
9                "paid_expiry": false,
10                "users_license_purchased": 50,
11                "trial_type": "PROFESSIONAL",
12                "trial_expiry": false,
13                "paid": true,
14                "paid_type": "ANNUAL"
15            },
16            "currency_symbol": "$",
17            "iso_code": "USD",
18            "zgid": "67890",
19            "currency_locale": "en_US",
20            "photo_id": "abcdef123456",
21            "city": "San Francisco",
22            "company_name": "Acme Corporation",
23            "phone": "+1 (415) 555-5678",
24            "alias": "acme",
25            "currency": "USD",
26            "state": "CA",
27            "primary_zuid": "zuid123456",
28            "country_code": "US",
29            "country": "United States",
30            "privacy_settings": true,
31            "gapps_enabled": true,
32            "website": "https://www.acmecorp.com",
33            "id": "org123456",
34            "mc_status": true,
35            "description": "Leading provider of innovative solutions",
36            "fax": "+1 (415) 555-9876",
37            "employee_count": "1000-5000",
38            "time_zone": "America/Los_Angeles",
39            "primary_email": "info@acmecorp.com"
40        }
41    ]
42}

Get record
Copy

Returns information about a record.

Sample Input

1{
2    "module_name": "Leads",
3    "record_id": "3872984000000321001"
4}

Sample Output

1{
2    "data": [
3        {
4            "Mobile": null,
5            "$currency_symbol": "$",
6            "$process_flow": false,
7            "$converted_detail": {},
8            "Street": null,
9            "Modified_Time": "2023-05-15T14:30:00+0000",
10            "Created_Time": "2023-05-10T09:15:00+0000",
11            "Skype_ID": null,
12            "$approval": {
13                "delegate": false,
14                "approve": false,
15                "reject": false,
16                "resubmit": false
17            },
18            "$editable": true,
19            "Zip_Code": null,
20            "City": null,
21            "Modified_By": {
22                "name": "John Doe",
23                "id": "3872984000000185001"
24            },
25            "Created_By": {
26                "name": "Jane Smith",
27                "id": "3872984000000185002"
28            },
29            "Phone": null,
30            "$converted": false,
31            "State": null,
32            "Secondary_Email": null,
33            "Twitter": null,
34            "Owner": {
35                "name": "Jane Smith",
36                "id": "3872984000000185002"
37            },
38            "Last_Activity_Time": null,
39            "$followed": true,
40            "Last_Name": "Johnson",
41            "Lead_Status": null,
42            "Country": null,
43            "Designation": null,
44            "Salutation": null,
45            "First_Name": null,
46            "Tag": [],
47            "Website": null,
48            "No_of_Employees": 50,
49            "id": "3872984000000321001",
50            "Full_Name": "Johnson",
51            "$approved": true,
52            "Annual_Revenue": 1000000,
53            "Email": null,
54            "Description": null,
55            "Company": null,
56            "Rating": null,
57            "Fax": null,
58            "Industry": null,
59            "Lead_Source": null,
60            "Email_Opt_Out": false
61        }
62    ]
63}

Get user
Copy

Get a specific user using their ID

Sample Input

1{
2    "user_id": "3000000123456"
3}

Sample Output

1{
2    "users": [
3        {
4            "confirm": true,
5            "zip": "94105",
6            "mobile": "+1 (415) 555-1234",
7            "street": "123 Main St",
8            "Modified_Time": "2023-05-15T14:30:00-07:00",
9            "country_locale": "en_US",
10            "created_time": "2023-01-01T09:00:00-08:00",
11            "date_format": "MM/dd/yyyy",
12            "profile": {
13                "name": "Sales Representative",
14                "id": "4000000789012"
15            },
16            "time_format": "hh:mm a",
17            "city": "San Francisco",
18            "Modified_By": {
19                "name": "Admin User",
20                "id": "3000000987654"
21            },
22            "microsoft": false,
23            "created_by": {
24                "name": "System",
25                "id": "3000000000001"
26            },
27            "phone": "+1 (415) 555-5678",
28            "alias": "jsmith",
29            "state": "CA",
30            "status": "active",
31            "offset": -7,
32            "last_name": "Smith",
33            "role": {
34                "name": "Sales",
35                "id": "5000000123456"
36            },
37            "zuid": "12345678",
38            "country": "United States",
39            "dob": "1985-06-15",
40            "territories": [
41                "West Coast",
42                "Pacific Northwest"
43            ],
44            "language": "English",
45            "locale": "en_US",
46            "first_name": "John",
47            "website": "https://www.example.com",
48            "id": "3000000123456",
49            "full_name": "John Smith",
50            "email": "john.smith@example.com",
51            "Isonline": true,
52            "fax": "+1 (415) 555-9876",
53            "time_zone": "America/Los_Angeles"
54        }
55    ]
56}

List records
Copy

Returns the list available records from a module.

Sample Input

1{
2    "module_name": "Leads",
3    "fields": [
4        "First_Name",
5        "Last_Name",
6        "Email",
7        "Company",
8        "Phone"
9    ],
10    "sort_by": "Created_Time",
11    "sort_order": "desc",
12    "converted": "false",
13    "approved": "both",
14    "page": 1,
15    "per_page": 100
16}

Sample Output

1{
2    "data": [
3        {
4            "First_Name": "John",
5            "Last_Name": "Doe",
6            "Email": "john.doe@example.com",
7            "Company": "Acme Corp",
8            "Phone": "+1 (555) 123-4567",
9            "id": "3000000001234",
10            "Owner": {
11                "name": "Jane Smith",
12                "id": "3000000004321"
13            },
14            "Created_Time": "2023-04-15T10:30:00+0000",
15            "Modified_Time": "2023-04-15T10:30:00+0000",
16            "$currency_symbol": "$",
17            "$process_flow": false,
18            "$converted": false,
19            "$approved": true,
20            "$editable": true,
21            "$followed": false,
22            "Email_Opt_Out": false,
23            "Tag": []
24        },
25        {
26            "First_Name": "Alice",
27            "Last_Name": "Johnson",
28            "Email": "alice.johnson@example.com",
29            "Company": "Tech Innovations",
30            "Phone": "+1 (555) 987-6543",
31            "id": "3000000001235",
32            "Owner": {
33                "name": "Bob Williams",
34                "id": "3000000004322"
35            },
36            "Created_Time": "2023-04-14T15:45:00+0000",
37            "Modified_Time": "2023-04-14T15:45:00+0000",
38            "$currency_symbol": "$",
39            "$process_flow": false,
40            "$converted": false,
41            "$approved": true,
42            "$editable": true,
43            "$followed": true,
44            "Email_Opt_Out": false,
45            "Tag": [
46                "Potential",
47                "Follow-up"
48            ]
49        }
50    ],
51    "info": {
52        "per_page": 100,
53        "count": 2,
54        "page": 1,
55        "more_records": false
56    }
57}

List users
Copy

List / filter users found in Zoho account

Sample Input

1{
2    "user_type": "ActiveUsers",
3    "page": "1",
4    "per_page": "50"
5}

Sample Output

1{
2    "users": [
3        {
4            "confirm": true,
5            "zip": null,
6            "mobile": null,
7            "street": null,
8            "Modified_Time": "2023-05-15T10:30:00Z",
9            "country_locale": "en_US",
10            "created_time": "2023-01-01T09:00:00Z",
11            "date_format": "MM/dd/yyyy",
12            "profile": {
13                "name": "Sales Representative",
14                "id": "67890"
15            },
16            "time_format": "hh:mm a",
17            "theme": {
18                "normal_tab": {
19                    "font_color": "#000000",
20                    "background": "#FFFFFF"
21                },
22                "selected_tab": {
23                    "font_color": "#FFFFFF",
24                    "background": "#4A90E2"
25                },
26                "new_background": null,
27                "background": "#F2F2F2",
28                "screen": "normal",
29                "type": "custom"
30            },
31            "customize_info": {
32                "notes_desc": null,
33                "show_right_panel": null,
34                "bc_view": null,
35                "show_home": true,
36                "show_detail_view": true,
37                "unpin_recent_item": null
38            },
39            "name_format": "Salutation,First Name,Last Name",
40            "city": null,
41            "Modified_By": {
42                "name": "Admin User",
43                "id": "12345"
44            },
45            "microsoft": false,
46            "created_by": {
47                "name": "Admin User",
48                "id": "12345"
49            },
50            "phone": null,
51            "personal_account": false,
52            "alias": null,
53            "state": null,
54            "status": "active",
55            "offset": 5.5,
56            "last_name": "Smith",
57            "role": {
58                "name": "Sales",
59                "id": "54321"
60            },
61            "zuid": "51234567890",
62            "country": null,
63            "default_tab_group": "Leads",
64            "dob": null,
65            "decimal_separator": ".",
66            "signature": null,
67            "territories": [],
68            "language": "en_US",
69            "locale": "en_US",
70            "first_name": "John",
71            "website": null,
72            "id": "98765432",
73            "full_name": "John Smith",
74            "email": "john.smith@example.com",
75            "Isonline": true,
76            "fax": null,
77            "time_zone": "America/New_York"
78        }
79    ],
80    "info": {
81        "per_page": 50,
82        "count": 1,
83        "page": 1,
84        "more_records": false
85    }
86}

Search records
Copy

Returns a list of records matching the search criteria.

Sample Input

1{
2    "module_name": "Leads",
3    "query": {
4        "criteria_list": [
5            {
6                "field_name": "Email",
7                "field_value": "example.com",
8                "condition": "ends_with"
9            },
10            {
11                "field_name": "Annual_Revenue",
12                "field_value": "1000000",
13                "condition": "greater_than"
14            }
15        ]
16    },
17    "per_page": 50,
18    "page": 1
19}

Sample Output

1{
2    "data": [
3        {
4            "Mobile": null,
5            "$currency_symbol": "$",
6            "$process_flow": false,
7            "$converted_detail": {},
8            "Street": null,
9            "Modified_Time": "2023-05-15T14:30:22-07:00",
10            "Created_Time": "2023-05-10T09:15:43-07:00",
11            "Skype_ID": null,
12            "$approval": {
13                "delegate": false,
14                "approve": false,
15                "reject": false,
16                "resubmit": false
17            },
18            "$editable": true,
19            "Zip_Code": null,
20            "City": null,
21            "Modified_By": {
22                "name": "John Doe",
23                "id": "3000000000001"
24            },
25            "Created_By": {
26                "name": "Jane Smith",
27                "id": "3000000000002"
28            },
29            "Phone": null,
30            "$converted": false,
31            "State": null,
32            "Secondary_Email": null,
33            "Twitter": null,
34            "Owner": {
35                "name": "Alice Johnson",
36                "id": "3000000000003"
37            },
38            "Last_Activity_Time": null,
39            "$followed": true,
40            "Last_Name": "Brown",
41            "Lead_Status": null,
42            "Country": null,
43            "Designation": null,
44            "Salutation": null,
45            "First_Name": "Robert",
46            "Tag": [],
47            "Website": null,
48            "No_of_Employees": 500,
49            "id": "3000000000004",
50            "Full_Name": "Robert Brown",
51            "$approved": true,
52            "Annual_Revenue": 2500000,
53            "Email": "robert.brown@example.com",
54            "Description": null,
55            "Company": null,
56            "Rating": null,
57            "Fax": null,
58            "Industry": null,
59            "Lead_Source": null,
60            "Email_Opt_Out": false
61        }
62    ],
63    "info": {
64        "per_page": 50,
65        "count": 1,
66        "page": 1,
67        "more_records": false
68    }
69}

Update records
Copy

Updates existing record.

Sample Input

1{
2    "module_name": "Contacts",
3    "records": [
4        {
5            "record_id": "3890876000000410001",
6            "properties2": [
7                {
8                    "field": "Last_Name",
9                    "value": "Smith"
10                },
11                {
12                    "field": "Email",
13                    "value": "john.smith@example.com"
14                },
15                {
16                    "field": "Phone",
17                    "value": "+1 (555) 123-4567"
18                }
19            ]
20        },
21        {
22            "record_id": "3890876000000410002",
23            "properties2": [
24                {
25                    "field": "First_Name",
26                    "value": "Jane"
27                },
28                {
29                    "field": "Title",
30                    "value": "Marketing Manager"
31                }
32            ]
33        }
34    ],
35    "check_duplicates": [
36        "Email",
37        "Phone"
38    ]
39}

Sample Output

1{
2    "data": [
3        {
4            "code": "SUCCESS",
5            "details": {
6                "Modified_Time": "2023-05-15T14:30:45+0000",
7                "Modified_By": {
8                    "name": "John Doe",
9                    "id": "3890876000000410003"
10                },
11                "Created_Time": "2023-05-10T09:15:30+0000",
12                "id": "3890876000000410001",
13                "Created_By": {
14                    "name": "Jane Smith",
15                    "id": "3890876000000410004"
16                }
17            },
18            "message": "Record updated successfully",
19            "status": "success"
20        },
21        {
22            "code": "SUCCESS",
23            "details": {
24                "Modified_Time": "2023-05-15T14:30:46+0000",
25                "Modified_By": {
26                    "name": "John Doe",
27                    "id": "3890876000000410003"
28                },
29                "Created_Time": "2023-05-11T11:20:15+0000",
30                "id": "3890876000000410002",
31                "Created_By": {
32                    "name": "Jane Smith",
33                    "id": "3890876000000410004"
34                }
35            },
36            "message": "Record updated successfully",
37            "status": "success"
38        }
39    ]
40}

Update specific record
Copy

Updates information about a specific record.

Sample Input

1{
2    "module_name": "Contacts",
3    "record_id": "3000000001234",
4    "record": [
5        {
6            "name": "First Name",
7            "value": "John"
8        },
9        {
10            "name": "Last Name",
11            "value": "Doe"
12        },
13        {
14            "name": "Email",
15            "value": "johndoe@example.com"
16        },
17        {
18            "name": "Phone",
19            "value": "+1 (555) 123-4567"
20        }
21    ],
22    "trigger": [
23        "workflow"
24    ]
25}

Sample Output

1{
2    "data": [
3        {
4            "code": "SUCCESS",
5            "details": {
6                "Modified_Time": "2023-05-15T14:30:45+0000",
7                "Modified_By": {
8                    "name": "Jane Smith",
9                    "id": "3000000001235"
10                },
11                "Created_Time": "2023-05-10T09:15:30+0000",
12                "id": "3000000001234",
13                "Created_By": {
14                    "name": "John Doe",
15                    "id": "3000000001236"
16                }
17            },
18            "message": "Record updated successfully",
19            "status": "success"
20        }
21    ]
22}

DDL operations
Copy

List convertable modules (DDL)
Copy

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

1{}

Sample Output

1{
2    "convertable_modules": [
3        {
4            "module": "Leads",
5            "convertable": true
6        },
7        {
8            "module": "Contacts",
9            "convertable": false
10        },
11        {
12            "module": "Accounts",
13            "convertable": false
14        },
15        {
16            "module": "Deals",
17            "convertable": true
18        }
19    ]
20}

List creatable modules (DDL)
Copy

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

1{}

Sample Output

1{
2    "modules": [
3        {
4            "api_name": "Leads",
5            "singular_label": "Lead",
6            "plural_label": "Leads"
7        },
8        {
9            "api_name": "Contacts",
10            "singular_label": "Contact",
11            "plural_label": "Contacts"
12        },
13        {
14            "api_name": "Accounts",
15            "singular_label": "Account",
16            "plural_label": "Accounts"
17        },
18        {
19            "api_name": "Deals",
20            "singular_label": "Deal",
21            "plural_label": "Deals"
22        },
23        {
24            "api_name": "Tasks",
25            "singular_label": "Task",
26            "plural_label": "Tasks"
27        }
28    ]
29}

List deletable modules (DDL)
Copy

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

1{}

Sample Output

1{
2    "modules": [
3        {
4            "api_name": "Leads",
5            "plural_label": "Leads",
6            "singular_label": "Lead"
7        },
8        {
9            "api_name": "Contacts",
10            "plural_label": "Contacts",
11            "singular_label": "Contact"
12        },
13        {
14            "api_name": "Accounts",
15            "plural_label": "Accounts",
16            "singular_label": "Account"
17        },
18        {
19            "api_name": "Deals",
20            "plural_label": "Deals",
21            "singular_label": "Deal"
22        }
23    ]
24}

List fields (DDL)
Copy

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

1{
2    "module_name": "Contacts"
3}

Sample Output

1{
2    "fields": [
3        {
4            "api_name": "Last_Name",
5            "data_type": "string",
6            "length": 80,
7            "required": true,
8            "field_label": "Last Name",
9            "read_only": false
10        },
11        {
12            "api_name": "First_Name",
13            "data_type": "string",
14            "length": 40,
15            "required": false,
16            "field_label": "First Name",
17            "read_only": false
18        },
19        {
20            "api_name": "Email",
21            "data_type": "email",
22            "length": 100,
23            "required": false,
24            "field_label": "Email",
25            "read_only": false
26        },
27        {
28            "api_name": "Phone",
29            "data_type": "phone",
30            "length": 50,
31            "required": false,
32            "field_label": "Phone",
33            "read_only": false
34        },
35        {
36            "api_name": "Account_Name",
37            "data_type": "lookup",
38            "length": 120,
39            "required": false,
40            "field_label": "Account Name",
41            "read_only": false
42        }
43    ]
44}

List record IDs (DDL)
Copy

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

1{
2    "module_name": "Contacts"
3}

Sample Output

1{
2    "result": [
3        {
4            "text": "John Doe",
5            "value": "3890000000007001"
6        },
7        {
8            "text": "Jane Smith",
9            "value": "3890000000007002"
10        },
11        {
12            "text": "Mike Johnson",
13            "value": "3890000000007003"
14        }
15    ]
16}

List upsertable modules (DDL)
Copy

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

1{}

Sample Output

1{
2    "modules": [
3        {
4            "api_name": "Leads",
5            "plural_label": "Leads",
6            "singular_label": "Lead"
7        },
8        {
9            "api_name": "Contacts",
10            "plural_label": "Contacts",
11            "singular_label": "Contact"
12        },
13        {
14            "api_name": "Accounts",
15            "plural_label": "Accounts",
16            "singular_label": "Account"
17        },
18        {
19            "api_name": "Deals",
20            "plural_label": "Deals",
21            "singular_label": "Deal"
22        }
23    ]
24}

List viewable modules (DDL)
Copy

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

1{}

Sample Output

1{
2    "modules": [
3        {
4            "api_name": "Leads",
5            "singular_label": "Lead",
6            "plural_label": "Leads"
7        },
8        {
9            "api_name": "Contacts",
10            "singular_label": "Contact",
11            "plural_label": "Contacts"
12        },
13        {
14            "api_name": "Accounts",
15            "singular_label": "Account",
16            "plural_label": "Accounts"
17        },
18        {
19            "api_name": "Deals",
20            "singular_label": "Deal",
21            "plural_label": "Deals"
22        },
23        {
24            "api_name": "Tasks",
25            "singular_label": "Task",
26            "plural_label": "Tasks"
27        }
28    ]
29}

Operations (sample payloads)

Main operationsCopy

Convert leadCopy

Create specific recordCopy

Create/Update recordsCopy

Delete recordsCopy

Get organizationCopy

Get recordCopy

Get userCopy

List recordsCopy

List usersCopy

Search recordsCopy

Update recordsCopy

Update specific recordCopy

DDL operationsCopy

List convertable modules (DDL)Copy

List creatable modules (DDL)Copy

List deletable modules (DDL)Copy

List fields (DDL)Copy

List record IDs (DDL)Copy

List upsertable modules (DDL)Copy

List viewable modules (DDL)Copy

Overview

Operations

Main operations
Copy

Convert lead
Copy

Create specific record
Copy

Create/Update records
Copy

Delete records
Copy

Get organization
Copy

Get record
Copy

Get user
Copy

List records
Copy

List users
Copy

Search records
Copy

Update records
Copy

Update specific record
Copy

DDL operations
Copy

List convertable modules (DDL)
Copy

List creatable modules (DDL)
Copy

List deletable modules (DDL)
Copy

List fields (DDL)
Copy

List record IDs (DDL)
Copy

List upsertable modules (DDL)
Copy

List viewable modules (DDL)
Copy