Zoho Creator API
Tools that enable LLMs to interact directly with the Zoho Creator API.
Available tools(19)
| Tool name | Description | Secrets | |
|---|---|---|---|
Add multiple records to a Zoho Creator form efficiently.
Use this tool to add up to 200 records at once to a specified form within your Zoho Creator application. Each JSON object in the input represents a record to be added, subject to validation. Suitable for situations needing bulk data import or batch entry creation.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path, query parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path, query parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| 1 | ||
Initiate a bulk read job to export records.
Use this tool to create a bulk read job in Zoho, which allows you to export records from a specified report. This is useful for managing large datasets efficiently.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| 1 | ||
Delete records from a specified Zoho Creator report.
Use this tool to delete up to 200 records from a specified report in your Zoho Creator application. This action will adhere to any custom validations configured for the target form.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path, query parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path, query parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| 1 | ||
Delete a specific record in Zoho Creator by ID.
This tool deletes a specific record in Zoho Creator using its ID. It is used when a user wants to remove a record that appears in a report. The deletion follows custom validations set for the form.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| 1 | ||
Fetches detailed view data of a record by ID.
Use this tool to fetch detailed information of a specific record identified by its ID in a Zoho app. It does not include related data blocks. | 1 | ||
Fetch meta information of applications in a workspace.
Use this tool to retrieve the meta information for applications hosted in a specific workspace you have access to. Useful for gaining insights into application details. | 1 | ||
Fetch details of sections and components in Zoho Creator apps.
Use this tool to retrieve information about the sections, forms, reports, and pages of a Zoho Creator application's web form factor. | 1 | ||
Fetches meta information of pages in a Zoho Creator app.
This tool retrieves the meta information of all the pages present in a specified Zoho Creator application. Use it to gather detailed metadata about the app's pages, which can aid in app management and analysis. | 1 | ||
Fetches metadata of fields in a Zoho Creator form.
Use this tool to obtain meta information about all the fields within a specified form in a Zoho Creator application. It should be called when you need to understand the structure or details of the form fields such as field types, names, etc. | 1 | ||
Fetch meta information of Zoho Creator app forms.
This tool retrieves the meta information of all forms in a specified Zoho Creator application. Use it to obtain details about the forms within the application. | 1 | ||
Fetches detailed view data of a Zoho record by ID.
Use this tool to fetch the detailed information of a specific record in Zoho, identified by its record ID. This tool does not retrieve related records, only the detailed view of the specific identified record. | 1 | ||
Fetch records from a Zoho Creator report.
Use this tool to retrieve up to 200 records from the quick view fields of a specified Zoho Creator report. | 1 | ||
Fetch records displayed by a Zoho Creator report.
Use this tool to retrieve up to 200 records from a Zoho Creator report. It accesses the data in the fields shown in the report's quick view. | 1 | ||
Fetches meta information of reports in Zoho Creator.
This tool retrieves the meta information for all reports within a specified Zoho Creator application. Use it to gain insights into the report configurations and structures available in a particular app. | 1 | ||
Fetches meta information of accessible applications.
Use this tool to retrieve the meta information of all applications you have access to in Zoho. | 1 | ||
Retrieve details of a completed bulk read job in Zoho Creator.
This tool retrieves information about a bulk read job that was executed previously in Zoho Creator. It is useful when you need to check the status or outcome of a specific bulk read job. | 1 | ||
Add records to a form in Zoho Creator.
Use this tool to add one or more records to a specified form in your Zoho Creator application. It allows up to 200 records per request, subject to validation.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| 1 | ||
Update records in a Zoho Creator report.
Use this tool to update up to 200 records in a specific report of a Zoho Creator application, ensuring compliance with data validation.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path, query parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path, query parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| 1 | ||
Update a specific record in Zoho Creator by ID.
Use this tool to update a specific record within a Zoho Creator application. This tool is useful when modifications are needed on existing entries identified by their record ID, and respects the data validations configured for the form.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| 1 |
Selected tools
No tools selected.
Click "Show all tools" to add tools.
Requirements
Select tools to see requirements
ZohoCreatorApi.AddRecordsToZohoForm
Add multiple records to a Zoho Creator form efficiently. Use this tool to add up to 200 records at once to a specified form within your Zoho Creator application. Each JSON object in the input represents a record to be added, subject to validation. Suitable for situations needing bulk data import or batch entry creation. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
form_private_link | string | Optional | The unique identifier for accessing a specific form in Zoho Creator securely. Required for access control. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
zoho_account_owner_name | string | Optional | The account owner's name associated with the Zoho Creator application. This is needed to authenticate and route the records correctly. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
application_link_name | string | Optional | The unique identifier for the Zoho application where the form resides. Required to locate the specific application. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
zoho_form_link_name | string | Optional | The unique link name of the form in Zoho Creator where records will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint ''.No code example available for this tool.
ZohoCreatorApi.CreateBulkReadJob
Initiate a bulk read job to export records. Use this tool to create a bulk read job in Zoho, which allows you to export records from a specified report. This is useful for managing large datasets efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
account_owner_name | string | Optional | The name of the account owner in Zoho for whom the bulk read job is being created. This should match the official account details. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
application_link_name | string | Optional | The name of the application within Zoho to export records from. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
report_reference_name | string | Optional | Specifies the unique link or name of the report from which records will be exported in Zoho. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint ''.No code example available for this tool.
ZohoCreatorApi.DeleteReportRecords
Delete records from a specified Zoho Creator report. Use this tool to delete up to 200 records from a specified report in your Zoho Creator application. This action will adhere to any custom validations configured for the target form. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
account_owner_name | string | Optional | The name of the Zoho account owner. It identifies whose account the deletion should occur under. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
application_link_name | string | Optional | The unique identifier for the application within Zoho Creator. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
report_identifier | string | Optional | The name of the report from which records should be deleted. Must match the link name configured in Zoho Creator. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
process_records_up_to_limit | boolean | Optional | Boolean to enable processing records up to the 200-record limit per request. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint ''.No code example available for this tool.
ZohoCreatorApi.DeleteZohoRecord
Delete a specific record in Zoho Creator by ID. This tool deletes a specific record in Zoho Creator using its ID. It is used when a user wants to remove a record that appears in a report. The deletion follows custom validations set for the form. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
zoho_account_owner_name | string | Optional | The account owner's name in Zoho. Required to specify which user's account to access. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
application_link_name | string | Optional | The unique identifier for the Zoho Creator application. Provide this to specify which application contains the record to delete. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
report_link_name | string | Optional | The unique name of the report in Zoho where the record is listed. This identifies which report contains the record to be deleted. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
record_id | string | Optional | The unique ID of the record to be deleted from Zoho Creator. This must match the ID displayed in the relevant Zoho report. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint ''.No code example available for this tool.
ZohoCreatorApi.FetchRecordDetail
Fetches detailed view data of a record by ID. Use this tool to fetch detailed information of a specific record identified by its ID in a Zoho app. It does not include related data blocks.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
application_private_link | string | Required | The private link identifier of the Zoho application, necessary for accessing the specific record's detail view. |
account_owner_name | string | Required | The name of the account owner in Zoho. This specifies the owner of the account to which the app belongs. |
application_link_name | string | Required | The unique identifier or slug for the specific Zoho app to query. This determines which app's data is accessed. |
report_link_name | string | Required | The link name of the report from which to fetch the record detail. It identifies the specific report in the Zoho app. |
record_id | string | Required | The unique identifier of the record to fetch detailed information for. It should be a string corresponding to the record's ID in the Zoho app. |
Requirements
Output
json— Response from the API endpoint ''.No code example available for this tool.
ZohoCreatorApi.FetchWorkspaceAppMeta
Fetch meta information of applications in a workspace. Use this tool to retrieve the meta information for applications hosted in a specific workspace you have access to. Useful for gaining insights into application details.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
workspace_account_owner_name | string | Required | The name of the account owner for the workspace you want to fetch application meta information from. |
Requirements
Output
json— Response from the API endpoint ''.No code example available for this tool.
ZohoCreatorApi.FetchZohoAppSections
Fetch details of sections and components in Zoho Creator apps. Use this tool to retrieve information about the sections, forms, reports, and pages of a Zoho Creator application's web form factor.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
zoho_account_owner_name | string | Required | The account owner's username in Zoho. Required to fetch data for the specified application. |
zoho_application_link_name | string | Required | The unique link name of the Zoho Creator application whose sections and components you want to fetch. |
Requirements
Output
json— Response from the API endpoint ''.No code example available for this tool.
ZohoCreatorApi.FetchZohoCreatorPagesMeta
Fetches meta information of pages in a Zoho Creator app. This tool retrieves the meta information of all the pages present in a specified Zoho Creator application. Use it to gather detailed metadata about the app's pages, which can aid in app management and analysis.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_owner_name | string | Required | The name of the account owner in Zoho. This identifies the owner of the application for which the page metadata is fetched. |
zoho_app_link_name | string | Required | The unique identifier for the Zoho Creator application to fetch page metadata. |
Requirements
Output
json— Response from the API endpoint ''.No code example available for this tool.
ZohoCreatorApi.FetchZohoFormFieldsMetadata
Fetches metadata of fields in a Zoho Creator form. Use this tool to obtain meta information about all the fields within a specified form in a Zoho Creator application. It should be called when you need to understand the structure or details of the form fields such as field types, names, etc.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_owner_name | string | Required | The Zoho account owner's username. Required to identify the specific account that owns the application. |
application_link_name | string | Required | The unique link name of the Zoho Creator application. It identifies which application's form metadata to fetch. |
form_identifier | string | Required | The unique identifier or link name of the Zoho Creator form to fetch metadata for. |
Requirements
Output
json— Response from the API endpoint ''.No code example available for this tool.
ZohoCreatorApi.FetchZohoFormMetaInformation
Fetch meta information of Zoho Creator app forms. This tool retrieves the meta information of all forms in a specified Zoho Creator application. Use it to obtain details about the forms within the application.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
zoho_account_owner_name | string | Required | The name of the account owner for the Zoho Creator application. Required for authentication and identifying the account context. |
zoho_app_link_name | string | Required | The unique link name of the Zoho Creator application. This identifies the app whose form meta information is to be fetched. |
Requirements
Output
json— Response from the API endpoint ''.No code example available for this tool.
ZohoCreatorApi.FetchZohoRecordDetail
Fetches detailed view data of a Zoho record by ID. Use this tool to fetch the detailed information of a specific record in Zoho, identified by its record ID. This tool does not retrieve related records, only the detailed view of the specific identified record.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_owner_name | string | Required | The name of the account owner in Zoho to fetch the record for. This identifies the specific account under which the record exists. |
application_identifier | string | Required | The name of the application in Zoho used to uniquely identify which app's record details are to be fetched. |
report_link_name | string | Required | The specific name of the report in Zoho from which the data will be fetched. |
record_id | string | Required | The unique ID of the Zoho record to fetch its detailed information. |
Requirements
Output
json— Response from the API endpoint ''.No code example available for this tool.
ZohoCreatorApi.FetchZohoRecords
Fetch records from a Zoho Creator report. Use this tool to retrieve up to 200 records from the quick view fields of a specified Zoho Creator report.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_owner_identifier | string | Required | The unique identifier for the Zoho account owner. Required to fetch the report data. |
application_link_name | string | Required | The unique identifier for the Zoho Creator application. It specifies which app's report to fetch. |
report_link_name | string | Required | The unique link name of the Zoho Creator report to fetch records from. |
start_record_index | integer | Optional | The starting index of records to retrieve from the report. Must be an integer. |
record_limit | integer | Optional | The maximum number of records to retrieve, up to 200. |
filter_criteria | string | Optional | Specify conditions to filter records. Use Zoho Creator query format for filtering. |
Requirements
Output
json— Response from the API endpoint ''.No code example available for this tool.
ZohoCreatorApi.FetchZohoReportRecords
Fetch records displayed by a Zoho Creator report. Use this tool to retrieve up to 200 records from a Zoho Creator report. It accesses the data in the fields shown in the report's quick view.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
zoho_private_link | string | Required | The private link URL or identifier for accessing a specific Zoho Creator report. |
account_owner_name | string | Required | The username of the Zoho account owner. Required to identify the correct account for fetching report records. |
zoho_application_link_name | string | Required | The unique link name of the Zoho Creator application from which to fetch report records. |
report_link_name | string | Required | The unique link name of the Zoho report to fetch records from. It's required to specify which report to access. |
record_fetch_start_index | integer | Optional | Specify the starting index for records to be fetched. Use an integer value. |
record_limit | integer | Optional | Specify the maximum number of records to fetch, up to 200. |
filter_criteria | string | Optional | A string to filter records based on specific conditions, formatted as 'Field_Name Operator Value'. |
Requirements
Output
json— Response from the API endpoint ''.No code example available for this tool.
ZohoCreatorApi.FetchZohoReportsMeta
Fetches meta information of reports in Zoho Creator. This tool retrieves the meta information for all reports within a specified Zoho Creator application. Use it to gain insights into the report configurations and structures available in a particular app.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
zoho_account_owner_name | string | Required | The name of the account owner in Zoho. Used to identify which account's report metadata to fetch. |
zoho_app_link_name | string | Required | The unique link name of the Zoho Creator application to fetch report metadata from. This identifies the specific app within your Zoho account. |
Requirements
Output
json— Response from the API endpoint ''.No code example available for this tool.
ZohoCreatorApi.GetApplicationMetaInfo
Fetches meta information of accessible applications. Use this tool to retrieve the meta information of all applications you have access to in Zoho.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint ''.No code example available for this tool.
ZohoCreatorApi.GetBulkReadJobDetails
Retrieve details of a completed bulk read job in Zoho Creator. This tool retrieves information about a bulk read job that was executed previously in Zoho Creator. It is useful when you need to check the status or outcome of a specific bulk read job.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_owner_name | string | Required | The name of the account owner in Zoho. Required for identifying the correct account. |
application_link_name | string | Required | The name of the Zoho Creator application. Used to identify which application's bulk read job details are being retrieved. |
report_link_name | string | Required | The link name of the report for which the bulk read job details are requested. This is required to specify the report in Zoho Creator. |
job_id | string | Required | The unique identifier for the bulk read job to retrieve details for. This should be a string value. |
Requirements
Output
json— Response from the API endpoint ''.No code example available for this tool.
ZohoCreatorApi.InsertRecordsInZohoForm
Add records to a form in Zoho Creator. Use this tool to add one or more records to a specified form in your Zoho Creator application. It allows up to 200 records per request, subject to validation. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
zoho_account_owner_name | string | Optional | The name of the account owner in Zoho. This is required to identify which account the records should be added to. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
application_link_name | string | Optional | The unique identifier of the application in which the form is located. This is necessary to specify the target Zoho Creator application. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
form_link_name | string | Optional | The unique link name of the form in Zoho Creator where records will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint ''.No code example available for this tool.
ZohoCreatorApi.UpdateZohoCreatorReportRecords
Update records in a Zoho Creator report. Use this tool to update up to 200 records in a specific report of a Zoho Creator application, ensuring compliance with data validation. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
account_owner_name | string | Optional | The username of the owner of the Zoho account associated with the application. Required for determining access and permissions. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
application_link_name | string | Optional | The unique identifier (link name) of the Zoho Creator application. Required to specify the target app for updating records. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
report_link_name | string | Optional | The name or identifier of the report in Zoho Creator whose records you want to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
process_until_limit_enabled | boolean | Optional | Set to true to process records until reaching a limit of 200. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint ''.No code example available for this tool.
ZohoCreatorApi.UpdateZohoRecord
Update a specific record in Zoho Creator by ID. Use this tool to update a specific record within a Zoho Creator application. This tool is useful when modifications are needed on existing entries identified by their record ID, and respects the data validations configured for the form. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
zoho_account_owner_name | string | Optional | The account owner's name in Zoho. Used to identify the correct Zoho Creator account for the update operation. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
application_link_name | string | Optional | The unique name of the Zoho Creator application where the record resides. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
report_link_name | string | Optional | The string identifier of the report in Zoho Creator where the record is located. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
record_id | string | Optional | The unique identifier for the record to be updated in Zoho Creator. This ID specifies which record in the report will be modified. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint ''.No code example available for this tool.