Skip to main content
Zoho Projects logo
  • Category: project management
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 542
  • Triggers: 0
  • Slug: ZOHO_PROJECTS
  • Version: 00000000_00

Tools

Slug: ZOHO_PROJECTS_ACTIVATE_CLIENT_USERRestore a deactivated client user’s portal access.

Input Parameters

boolean
required
Whether to notify the client user about activation.
string
required
Portal ID returned by List Portals.
string
required
Client user ID returned by List Portal Users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ACTIVATE_USERRestore a deactivated user’s portal access.

Input Parameters

string ("true" | "false")
required
Whether to notify the user about activation.
string
required
User ID returned by List Portal Users.
string
required
Portal ID returned by List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_BUG_RESOLUTION_V3Add a resolution through the V3 bug_id contract. This variant supports V3 custom-field and WorkDrive thirdparty_id inputs and returns no content; use Add Issue Resolution (V3.1) for the V3.1 issue response.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
string
Enter the value for a character-type custom field. The field name must follow the UDF_NCHAR naming convention.
string
Enter the user ID for a user-type custom field. The field name must follow the UDF_NUSER naming convention. You can obtain it from the Get Project Users API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the status ID. You can obtain it from the Get Global Statuses API .
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Enter the resolution details describing how the issue was resolved.
array
Enter the WorkDrive resource IDs of the files to associate. The WorkDrive resource ID is different from the attachment ID in Zoho Projects. Up to 50 IDs can be passed in a single request. To retrieve the resource ID, refer to the ( WorkDrive Upload Large File API ). Users without upload permission to the folder or team folder can upload files up to 20 MB only.
array
Enter the IDs of attachments to include with the resolution. Maximum 100 attachments allowed. You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_CATEGORYAdd a new category for forums in a specific project. Use this API to create a forum category to organize discussions within a project.

Input Parameters

string
required
Enter the name of the category
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_CLIENT_USERInvite one or more client users to a portal and assign projects and rates.

Input Parameters

boolean
Whether to force adding eligible client users.
string
required
Portal ID returned by List Portals.
array
required
Client users and assignments to add.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_CURRENCYAdd a new currency to the organisation. Use this API to configure the currency code, symbol, format, and exchange rate for budget and financial tracking across projects.

Input Parameters

string ("###,##0" | "###.##0" | "### ##0" | "#,##,##0" | "###,##0.00" | "###.##0,00" | "### ##0,00" | "#,##,##0.00" | "###,##0.000" | "###.##0,000" | "### ##0,000" | "#,##,##0.000")
required
Enter the display format for the currency amount. Accepted values: No decimals: ###,##0, ###.##0, ### ##0, or #,##,##0 2 decimals: ###,##0.00, ###.##0,00, ### ##0,00, or #,##,##0.00 3 decimals: ###,##0.000, ###.##0,000, ### ##0,000, or #,##,##0.000
string
required
Enter the display symbol for the currency. For example, $, €, or AED.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Enter the currency code. For example, USD, EUR, or AED.
number
Enter the exchange rate relative to the base currency. For example, 3.67 means 1 base unit equals 3.67 of this currency.
string ("0" | "2" | "3")
required
Enter the number of decimal places for the currency. Accepted values: 0, 2, or 3.
string ("1" | "2")
Enter the conversion type to determine how the exchange rate is updated. Accepted values: 1 (manual) or 2 (live).
boolean
Specify whether to set this as the base currency. Accepted values: true or false.
string
Enter the exchange rate data as a JSON string. Used for live conversion scenarios.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_CUSTOM_DOMAINAdd a custom domain for the portal.

Input Parameters

string
required
Enter the custom domain name. The domain record is stored and the SSL certificate availability is checked. If SSL is not available, an SSL certificate is purchased automatically. SSL certificate provisioning may take up to 7 days.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_CUSTOM_MODULE_RECORD_COMMENTAdd a comment to a record. Use this API to post a new comment, with optional attachments.

Input Parameters

string
required
Enter the comment.
string
required
Identifier of an entity. Obtained from the Get Entities API - the “id” field in the response corresponds to entity_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
array
Enter the attachment details.
array
Enter the WorkDrive resource IDs of the files to associate. The WorkDrive resource ID is different from the attachment ID in Zoho Projects. Up to 50 IDs can be passed in a single request. To retrieve the resource ID, refer to the ( WorkDrive Upload Large File API ). Users without upload permission to the folder or team folder can upload files up to 20 MB only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_EVENTAdd a new event to a specific project. Use this API to create and schedule an event within a project.

Input Parameters

string
required
Enter the title of the event.
string
required
Enter the end date and time in the ISO8601 format.
string
Specify the Location of the event.
array
required
Specify the attendees for the event.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Enter the start date and time in the ISO8601 format.
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Specify the reminder duration before the event.
array
Enter the WorkDrive resource IDs of the files to associate. The WorkDrive resource ID is different from the attachment ID in Zoho Projects. Up to 50 IDs can be passed in a single request. To retrieve the resource ID, refer to the ( WorkDrive Upload Large File API ). Users without upload permission to the folder or team folder can upload files up to 20 MB only.
array
Enter Attachment IDs for the event. You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).
integer
Specify the recurrence count for the event.
string
Specify the recurrence frequency of the event.Available recurrence types : only once, every day, every week, every month, every year.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_EVENT_COMMENTAdd a comment to a specific event in a project. Use this API to post a comment on an event within a project.

Input Parameters

string
required
Content for the event comment.
string
required
Identifier of an event. Obtained from the Get Project Events API - the “id” field in the response corresponds to event_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
Enter the WorkDrive resource IDs of the files to associate. The WorkDrive resource ID is different from the attachment ID in Zoho Projects. Up to 50 IDs can be passed in a single request. To retrieve the resource ID, refer to the ( WorkDrive Upload Large File API ). Users without upload permission to the folder or team folder can upload files up to 20 MB only.
array
Array of attachment IDs associated with the comment. You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_FORUMAdd a new forum to a specific project. Use this API to create a forum for discussions within a project.

Input Parameters

string ("internal" | "external")
Mark the forum as internal (visible only to project users) or external (visible to both project and client users) Accepted values: internal , external
array
Enter the tags to add to the forum post
string ("normal" | "question")
Enter the forum type Accepted values: normal , question
string
required
Enter the forum title
array
Enter the ZPUID of the users to notify You can obtain it from the Get Project Users API (the “id” field in the response).
string
required
Enter the forum content
boolean
Specify whether to mark the post as sticky Accepted values: true , false
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Enter the project category ID You can obtain it from the Get Forum Categories API (the “id” field in the response).
array
Enter the WorkDrive resource IDs of the files to associate. The WorkDrive resource ID is different from the attachment ID in Zoho Projects. Up to 50 IDs can be passed in a single request. To retrieve the resource ID, refer to the ( WorkDrive Upload Large File API ). Users without upload permission to the folder or team folder can upload files up to 20 MB only.
array
Enter the attachment IDs You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).
boolean
Specify whether to mark the post as announcement Accepted values: true , false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_FORUM_COMMENTAdd a comment to a specific forum in a project. Use this API to post a comment on a forum within a project.

Input Parameters

string ("question" | "answer" | "normal")
Enter the comment type. Accepted values: question , answer , normal
array
Enter the ZPUID of the users to notify You can obtain it from the Get Project Users API (the “id” field in the response).
string
required
Enter the comment
string
Enter the ID of the root comment
string
required
Identifier of a forum. Obtained from the Get Forums API - the “id” field in the response corresponds to forum_id.
string
Enter the ID of the parent comment
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
Enter the WorkDrive resource IDs of the files to associate. The WorkDrive resource ID is different from the attachment ID in Zoho Projects. Up to 50 IDs can be passed in a single request. To retrieve the resource ID, refer to the ( WorkDrive Upload Large File API ). Users without upload permission to the folder or team folder can upload files up to 20 MB only.
array
Enter the attachment IDs You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_ISSUE_COMMENTAdd a comment to an issue.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
string
required
Enter the content of the comment to post on this issue.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
Enter the ZUIDs of the users to be notified
array
Enter the WorkDrive resource IDs of the files to associate. The WorkDrive resource ID is different from the attachment ID in Zoho Projects. Up to 50 IDs can be passed in a single request. To retrieve the resource ID, refer to the ( WorkDrive Upload Large File API ). Users without upload permission to the folder or team folder can upload files up to 20 MB only.
array
Enter IDs of the attachments to be associated You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).
string
Enter IDs of the SalesIO chat to be associated This identifier is owned by Zoho SalesIQ; obtain it from the Zoho SalesIQ API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_ISSUE_FOLLOWERSReceive updates or notifications about the issue in a project.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
required
Zoho account user IDs (ZUIDs) of followers. Use the “zuid” field returned by a project-user action, not its ZPUID “id” field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_ISSUE_RESOLUTION_V3_1Add a resolution through the V3.1 issue_id contract and return the created resolution list. Use Add Bug Resolution (V3) when V3 custom-field or WorkDrive thirdparty_id inputs are required.

Input Parameters

string
required
Identifier of an issue. Obtained from the Get Issues API - the “id” field in the response corresponds to issue_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the status ID. You can obtain it from the Get Global Statuses API .
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Enter the resolution content.
array
Enter the attachment IDs. You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_LEAVESCreate a leave in the Zoho Projects portal. A maximum of 100 leaves can be added in a request. Multiple user leaves cannot be added with a single request.

Input Parameters

string
required
Enter the Leave type. A maximum of 100 characters can be added.
object
required
Enter the ZPUID of the user in JSONObject.
string
Enter the reason for the leave. A maximum of 250 characters can be added.
string
required
Enter the end date of the leave. E.g. 2024-07-02T10:00:00Z
string
required
Enter the start date of the leave. E.g. 2024-07-02T10:00:00Z
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the reference ID. A maximum of 250 characters can be added.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_OR_UPDATE_TASK_FOLLOWERSAPI to add or update followers to a given task.

Input Parameters

string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
array
required
Array of Users ZPUID’s to be add or remove as followers
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_PHASE_COMMENTAdd a comment to a phase with optional notifications and attachments.

Input Parameters

array
Project user IDs to notify (up to 100).
string
required
Comment content.
string
required
Portal ID returned by List Portals.
string
required
Project ID returned by List Projects.
string
required
Milestone ID returned by a phase listing action.
array
WorkDrive resource IDs to associate (up to 49).
array
Zoho Projects attachment IDs to associate (up to 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_PHASE_FOLLOWERSAdd users as followers of a phase.

Input Parameters

array
required
Zoho Projects user IDs to add as followers (up to 100).
string
required
Portal ID returned by List Portals.
string
required
Project ID returned by List Projects.
string
required
Milestone ID returned by a phase listing action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_PORTAL_CUSTOMERSAdd customers to the Zoho Projects portal.

Input Parameters

string
Enter the city.
string
Enter the customer name.
string
Enter the state.
string
Enter the country.
string
Enter the ZIP code.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the web address.
string
Enter address line 1.
integer ("1" | "2")
Enter the customer type. Accepted values: 1 (Business), 2 (Individual).
string
Enter address line 2.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_PROJECT_CLIENT_USERGrant one or more client users access to a project.

Input Parameters

boolean
Whether to notify added client users.
string
required
Portal ID returned by List Portals.
string
required
Project ID returned by List Projects.
array
Client users and project-specific rates to add.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_PROJECT_COMMENTAdd a comment to a project. Use this API to associate attachments if required.

Input Parameters

string
required
Enter the comment.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
Enter the WorkDrive resource IDs of the files to associate. The WorkDrive resource ID is different from the attachment ID in Zoho Projects. Up to 50 IDs can be passed in a single request. To retrieve the resource ID, refer to the ( WorkDrive Upload Large File API ). Users without upload permission to the folder or team folder can upload files up to 20 MB only.
array
Specify the attachment Id’s. You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_PROJECT_CUSTOMERSCreate new customer within a project in the Zoho Projects portal.

Input Parameters

string
Enter the city.
string
Enter the customer name.
string
Enter the state.
string
Enter the country.
string
Enter the ZIP code.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Enter the web address.
string
Enter address line 1.
integer ("1" | "2")
Enter the customer type. Accepted values: 1 (Business), 2 (Individual).
string
Enter address line 2.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_PROJECT_USERGrant one or more portal users access to a project.

Input Parameters

boolean
Whether to notify added users.
string
required
Portal ID returned by List Portals.
string
required
Project ID returned by List Projects.
array
Users and project-specific rates to add.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_TASK_COMMENTAdd a new comment to a task. Use this API to post remarks, feedback, or updates on a task to keep collaborators informed.

Input Parameters

string
required
Enter the comment.
string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
Enter the attachment IDs. You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).
array
Enter the WorkDrive resource IDs of the files to associate. The WorkDrive resource ID is different from the attachment ID in Zoho Projects. Up to 50 IDs can be passed in a single request. This identifier is owned by Zoho WorkDrive; obtain it from the Zoho WorkDrive API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_TASK_DEPENDENCYCreate a dependency between two tasks in a project.

Input Parameters

object
Enter the lag details to apply between the predecessor and successor tasks.
Specify the dependency link type. Accepted values: 0 for Hard Link, 1 for Soft Link
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
object
required
Enter the details of the successor task.
string ("FS" | "FF" | "SF" | "SS" | "AutoSet")
Specify the type of dependency between the tasks. Accepted values: FS , FF , SF , SS , AutoSet
object
required
Enter the details of the predecessor task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_TASK_FOLLOWERSAdd followers to a task.

Input Parameters

string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
array
required
Enter the follower details.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_TASK_LIST_COMMENTAdd a comment to a task list.

Input Parameters

string
required
Enter the comment.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
Enter the attachment IDs. You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).
string
required
Identifier of a tasklist. Obtained from the Get Tasklists API - the “id” field in the response corresponds to tasklist_id.
array
Enter the WorkDrive resource IDs of the files to associate. The WorkDrive resource ID is different from the attachment ID in Zoho Projects. Up to 50 IDs can be passed in a single request. To retrieve the resource ID, refer to the ( WorkDrive Upload Large File API ). Users without upload permission to the folder or team folder can upload files up to 20 MB only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_TIME_LOGAdd a time log to a project. Use this API to record time spent on tasks or issues within a project.

Input Parameters

string
required
Enter the date to add Log.
string
Enter the log hours.
string
Enter the additional information for the log.
object
required
Enter the details of the module.
string ("Approved" | "Unapproved" | "Rejected")
Enter the approval status of the time log. Accepted values: Approved, Unapproved, Rejected
string
Enter the ZPUID of the approver. You can obtain it from the Get Project Users API (the “id” field in the response).
string
Enter the end time of the time log. Accepted values: 12-hour (with AM/PM), 12-hour (without AM/PM), or 24-hour formats. Example: 11:59 PM
string
Enter the log name.
boolean
Specify whether the time log is added from a timer. Accepted values: true or false
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Enter the start time of the time log. Accepted values: 12-hour (with AM/PM), 12-hour (without AM/PM), or 24-hour formats. Example: 11:59 PM
string ("Billable" | "Non Billable")
required
Enter the billing status of the time log. Accepted values: Billable, Non Billable
string
Enter the ZPUID of the owner. You can obtain it from the Get Project Users API (the “id” field in the response).
object
Enter the details of the custom fields.
string
Enter Zoho Sprints Log ID. This identifier is owned by Zoho Sprints; obtain it from the Zoho Sprints API.
number
Enter the Cost Per Hour.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ADD_USERInvite one or more users to a portal with roles, profiles, projects, and rates.

Input Parameters

string
required
Portal ID returned by List Portals.
array
required
Users and assignments to add to the portal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_APPLY_BLUEPRINT_TRANSITIONExecute transition in a blueprint.

Input Parameters

string
required
Enter the entity ID
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of a blueprint. Obtained from the Get Blueprints API - the “id” field in the response corresponds to blueprint_id.
array
Enter the field values to update during the transition.
string
required
Identifier of a transition. Obtained from the Get Next Available Transitions API - the “id” field in the response corresponds to transition_id.
boolean
Specify whether to skip issue validation during transition execution. By default, a transition cannot be executed while the associated task has open issues. Accepted values: true or false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ASSOCIATE_BUGS_TO_TASK_V3Use the V3 /tasks/{task_id}/bugs contract to associate bugs with a task. This variant permits bug_ids to be omitted; use Associate Issues to Task (V3 Required IDs) when supplying a required bug ID list.

Input Parameters

array
ID of the bugs to be associated You can obtain it from the Get Bugs API (the “id” field in the response).
string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ASSOCIATE_CUSTOMERS_TO_PROJECTAssociate customers to a project.

Input Parameters

string
required
Enter the Customer IDs You can obtain it from the Get Project Customers API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
boolean
Specify whether the customer is a primary customer. Accepted values : True or False.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ASSOCIATE_ENTITY_ATTACHMENTNote: Users can upload files up to 20 MB by default. For larger files, use the upload server and the user must be a member of the selected folder. Files larger than 20 MB must be uploaded using the WorkDrive Large File Upload API .

Input Parameters

string
required
Enter the module ID.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Enter the module name.
array
Enter the attachment IDs to associate. You can obtain it from the Get Task Attachments API (the “attachment_id” field in the response).
array
required
Enter the WorkDrive resource IDs of the files to associate. The WorkDrive resource ID is different from the attachment ID in Zoho Projects. Up to 50 IDs can be passed in a single request. To retrieve the resource ID, refer to the WorkDrive Upload Large File API . Users without upload permission to the folder or team folder can upload files up to 20 MB only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ASSOCIATE_FORUMSLink one or more forums to a task. Use this API to connect relevant forum discussions to a task.

Input Parameters

array
Enter the IDs of the forums You can obtain it from the Get Forums API (the “id” field in the response).
string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ASSOCIATE_ISSUE_ATTACHMENTSAssociate attachments with an issue.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
Enter the IDs of the attachments to be associated You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ASSOCIATE_ISSUES_TO_TASK_V3Use the V3 /tasks/{task_id}/associate-bugs contract to associate a required list of bug IDs with a task. Use Associate Bugs to Task (V3 Optional IDs) only for the separate contract where bug_ids may be omitted.

Input Parameters

array
required
ID of the bugs to be associated You can obtain it from the Get Bugs API (the “id” field in the response).
string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ASSOCIATE_MULTIPLE_ATTACHMENTSAssociate Multiple attachments for all entities

Input Parameters

string
required
Entity Id
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Name of the Enity
array
Unique Id’s of the attachment You can obtain it from the Get Task Attachments API (the “attachment_id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ASSOCIATE_PROJECT_ATTACHMENTAssociate attachments for all entities

Input Parameters

string
required
Entity Id
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Name of the entity Available entities: project_comment , status , status_comment , milestone_comment , tasklist_comment , task , task_comment , bug , bug_resolution , bug_comment , event , event_comment , forum , forum_comment , announcement_comment , zoho_meeting_comment
string
required
Identifier of an attachment. Obtained from the Get Attachments API - the “id” field in the response corresponds to attachment_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ASSOCIATE_PROJECT_CONTACTSAssociate existing contacts with a project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
array
Enter the contact IDs. You can obtain it from the Get Project Contacts API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ASSOCIATE_PROJECT_FOLDERSAssociate folder(s) to a project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
required
Enter the permission details for the folder.To get the default folder permission, use the Get Project Team Folder Details
array
Id’s of the folder

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ASSOCIATE_PROJECT_TEAM_FOLDERSAssociate an existing team folder to a project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
required
Enter the permission details for the team folder.To get the default team folder permission, use the Get Project Team Folder Details
array
Id’s of the folder This identifier is owned by Zoho WorkDrive; obtain it from the Zoho WorkDrive API.
array
required
Enter team folder ID.To get team folder details, use the Get Project Team Folder Settings This identifier is owned by Zoho WorkDrive; obtain it from the Zoho WorkDrive API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ASSOCIATE_PROJECT_TEAMSAdd an existing team to a specific project. Use this API to associate a portal team with a project to grant its members access.

Input Parameters

boolean
Specify whether to notify the users. Accepted values : true , false
array
required
Enter the team IDs to add. You can obtain it from the Get Project Teams API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ASSOCIATE_TAGS_TO_ENTITYAssociate tags with a module in a project. Note: This API will replace the current associated tags with the new tag IDs if the previous tag IDs are not included in the request.

Input Parameters

string
required
Enter the tag ID. You can obtain it from the Get Project Tags API (the “id” field in the response).
string
required
Enter the module ID.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
integer ("2" | "3" | "4" | "5" | "6" | "7" | "8")
required
Module type: 2 (project), 3 (milestone), 4 (task list), 5 (task), 6 (issue), 7 (forum), or 8 (status).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ASSOCIATE_TASK_ATTACHMENTSAssociate attachments to a task.

Input Parameters

string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
Id of the files to be associated with the task You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_ASSOCIATE_TASKSAssociate tasks with a specific issue.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
array
required
Enter the task IDs to associate with the issue You can obtain it from the Get Tasks API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_BULK_ADD_TIME_LOGSAdd multiple time log entries to a specific portal. Use this API to submit multiple time log entries in a single request.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
array
required
Enter the list of time log entries to add in bulk.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_BULK_ASSOCIATE_TASKSAssociate multiple tasks with multiple issues in a project.

Input Parameters

array
required
Enter the task IDs to associate with the issues You can obtain it from the Get Tasks API (the “id” field in the response).
array
required
Enter the IDs of the issues You can obtain it from the Get Issues API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_BULK_CREATE_TASKSCreate multiple tasks in a project in one request.

Input Parameters

array
Enter associated task data
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
boolean
Skip any mandatory fields. Accepted values: true or false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_BULK_DELETE_TIME_LOGSRemove multiple time log entries from a specific portal.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
array
required
Enter the details of the time logs to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_BULK_UPDATE_PORTAL_USERSModify profiles, roles, reporting lines, business hours, or rates for portal users.

Input Parameters

array
required
Portal users and fields to update.
string
required
Portal ID returned by List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_BULK_UPDATE_RESOURCE_SKILL_LEVELSUpdate the proficiency level of up to 100 resources for a skill.

Input Parameters

string ("beginner" | "intermediate" | "advanced")
required
New proficiency level for all resources.
string
required
Skill ID returned by List Skills.
string
required
Portal ID returned by List Portals.
array
required
Resources whose proficiency level should change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_BULK_UPDATE_TASKSModify multiple tasks at once in the Zoho Projects portal.Note: A maximum of 100 tasks across 5 unique projects can be updated per request.

Input Parameters

array
required
Enter the task details to update.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_BULK_UPDATE_TIME_LOGSUpdate multiple time log entries in the Zoho Projects portal. Use this API to modify multiple time log entries in a single request.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
array
required
Enter the details of the time logs to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_BULK_UPDATE_USER_SKILL_LEVELSUpdate the proficiency level of up to 100 portal users for a skill.

Input Parameters

string ("beginner" | "intermediate" | "advanced")
required
New proficiency level for all users.
array
required
Users whose proficiency level should change.
string
required
Skill ID returned by List Skills.
string
required
Portal ID returned by List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CHECK_CUSTOM_MODULE_RECORD_FOLLOWERVerify whether the user is a follower.

Input Parameters

string
required
Identifier of an entity. Obtained from the Get Entities API - the “id” field in the response corresponds to entity_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CLONE_ISSUEClone an issue in a project. Use this API to create a duplicate of an existing issue.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CLONE_PHASEClone a phase and its configuration within a project.

Input Parameters

string
required
Portal ID returned by List Portals.
string
required
Project ID returned by List Projects.
string
required
Milestone ID returned by a phase listing action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CLONE_TASKClone a task to create multiple instances within the project.

Input Parameters

string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
integer
required
Enter the number of instances to be created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CLONE_TASK_LISTCreate a task list in the specified project by cloning an existing task list from a project, project template, or task template.

Input Parameters

string
Specify the task list flag.
array
Specify tags to add or remove during task list creation.
object
Specify the destination phase.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Enter the date shift configuration in ISO 8601 format to adjust task dates when copying the task list.
array
Specify the mapping between source task list statuses and destination project statuses when the source statuses are not available in the destination project layout. If mapping to the existing status: Enter the ID in both old_status and new_status. If creating and mapping new status: Enter the ID in old_status, and specify name, color, and type in new_status.
object
Specify the task list that should be copied.
boolean
Specify whether dependent task lists should also be copied along with the source task list. Accepted values: true or false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CLOSE_TASK_LISTModify status of the task list as closed in a project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of a tasklist. Obtained from the Get Tasklists API - the “id” field in the response corresponds to tasklist_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CONVERT_CONTACT_TO_CLIENT_USERConvert contact to a client user in the Zoho Projects portal.

Input Parameters

string
Enter the email ID.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the profile ID. You can obtain it from the Get Profiles API (the “id” field in the response).
string
required
Identifier of a contact. Obtained from the Get Contacts API - the “id” field in the response corresponds to contact_id.
boolean
Specify whether to select all projects. Accepted values: true or false.
string
Enter the invoice rate of the user. E.g. $30 per hour.
array
Enter the project IDs. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CONVERT_TASK_LIST_TO_TEMPLATEConvert a task list into a template in a project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of a tasklist. Obtained from the Get Tasklists API - the “id” field in the response corresponds to tasklist_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CONVERT_TASK_TO_TASK_LISTto make the parent task as Tasklist.

Input Parameters

string ("internal" | "external")
Set the task list flag. Accepted values: internal , external .
string
required
Enter the name of the task list
array
Enter the tag details.
string
Enter the status of the task list.
string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
object
Enter the associated milestone ID.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CONVERT_TO_SUBTASKConvert a task into a subtask under a specified parent task in the project. Note: Parent task : The task directly above a subtask in the hierarchy. The converted task will be nested one level below this task. A parent task may or may not be a root task. Root task : A task at the topmost level of a task hierarchy. It has no parent above it. A root task can become a parent task if subtasks are added to it, but a parent task is not always a root task.

Input Parameters

string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
string
required
Enter the ID of the parent task under which the task will be nested as a subtask.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
object
Specify the placement of the converted subtask among the parent task’s existing subtasks. If omitted, the task is placed at the end of the parent task’s subtask list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CONVERT_TO_TASKConvert a subtask into a root task in the project. Note: Parent task : The task directly above a subtask in the hierarchy. The converted task will be nested one level below this task. A parent task may or may not be a root task. Root task : A task at the topmost level of a task hierarchy. It has no parent above it. A root task can become a parent task if subtasks are added to it, but a parent task is not always a root task.

Input Parameters

string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
object
Specify the placement of the converted root task within the task list. If omitted, the task is placed at the end of the task list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_COUNT_CUSTOM_MODULE_RECORD_ATTACHMENTSRetrieve the count of attachments from a record.

Input Parameters

string
required
Identifier of an entity. Obtained from the Get Entities API - the “id” field in the response corresponds to entity_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_COUNT_CUSTOM_MODULE_RECORD_COMMENTSRetrieve the total number of comments for a record.

Input Parameters

string
required
Identifier of an entity. Obtained from the Get Entities API - the “id” field in the response corresponds to entity_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_COUNT_CUSTOM_MODULE_RECORD_EDITSRetrieve the total number of edits made to a record within a module.

Input Parameters

string
required
Identifier of an entity. Obtained from the Get Entities API - the “id” field in the response corresponds to entity_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_COUNT_CUSTOM_MODULE_RECORDSRetrieve the count of records from a module.

Input Parameters

object
Enter the filter criteria.
string
Enter the custom view ID.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the project ID. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_BASELINECreate a baseline based on the current schedules in a project. Use this API to capture a snapshot of the project schedule for progress tracking and comparison.

Input Parameters

string
required
Enter the name of the baseline.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_BULK_OPTIONSCreate options for a custom-module field in bulk.

Input Parameters

string
required
Field ID from Get Custom Module Fields.
array
Roles to create as options.
array
Users to create as options.
string
required
Module API name or ID from List Modules.
object
Option position in the layout.
array
Statuses to create as options.
string
Layout ID from List Layouts.
string
required
Unique portal ID from List Portals.
array
Custom options to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_BULK_READ_JOBCreate a bulk read job to export records of a module from the Zoho Projects portal. The job is asynchronous: Zoho POSTs completion status and a one-day CSV ZIP download URL to follow_url.

Input Parameters

string
Comma-separated field keys to include.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
HTTP POST callback URL that receives completion status and download_url.
string ("initialfetch" | "syncfetch" | "deleted")
required
Export mode. syncfetch supports time_period.
string ("projects" | "projects_comments" | "projects_status_timeline" | "milestones" | "tasks" | "timesheets" | "timelog_groups" | "bugs" | "users" | "teams" | "tags" | "milestone_invoice" | "portal_users" | "project_groups" | "portal_clients" | "project_clients" | "task_workhrs" | "project_group_users" | "task_status_timeline" | "custom_status" | "task_invoice" | "issue_comments" | "milestone_comments" | "issue_status_timeline" | "milestone_status_timeline")
required
Module to export.
array
Project IDs whose records should be exported.
string
ISO 8601 starting time for a syncfetch export.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_BUSINESS_HOURSCreate a business calendar in the Zoho Projects portal.

Input Parameters

string
required
Enter the business hours’ name.
object
required
Enter the holiday list details to associate.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
array
required
Enter the work hour details.
string ("all_day" | "same_hours" | "different_hours")
required
Enter the work hours type. Accepted values : all_day , same_hours , different_hours

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_CONTACTSCreate new contacts in the Zoho Projects portal.

Input Parameters

string
Enter the customer ID. You can obtain it from the Get Customers API (the “id” field in the response).
array
Enter the contact details.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the project ID. You can obtain it from the Get Projects API (the “id” field in the response).
string
Enter the customer name.
boolean
Specify whether to select all projects. Accepted values: true or false.
object
Enter the project details
array
Enter the project IDs. You can obtain it from the Get Projects API (the “id” field in the response).
string
Provider-documented currency code value.
integer ("1" | "2")
Enter the customer type. Accepted values: 1 (Business), 2 (Individual).
string ("yes" | "no")
Specify whether the client is a primary client. Accepted values : yes or no.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_CUSTOM_MODULE_EXPORTPass project_id to scope the export to a single project. Omit it to export across the whole portal.

Input Parameters

object
Enter the custom view details.
object
Enter the filter criteria for the export.
string
Enter the export ID. Pass it to reuse the configuration of an existing export instead of defining one from scratch.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the project ID to scope the export to a single project. Omit it to export across the portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Enter the access code. It protects the exported file and must be at least 6 characters.
string ("csv" | "xlsx" | "pdf")
Enter the export file format. Accepted values: csv, xlsx, or pdf
string ("active" | "archived" | "both")
Enter the project type. Accepted values : active, archived, or both
object
Enter the schedule details for the export. Pass this to create a recurring export instead of a one-time one.
array
Specify the fields to include in the export. Pass the API name of each field.
boolean
Specify whether the scheduled export is active or inactive. Accepted values : true or false
boolean
Specify whether to include export details. Accepted values : true or false
boolean
Specify whether to export all project items in a single sheet. Accepted values : true or false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_CUSTOM_MODULE_IMPORTInitiate an import operation for a module by uploading a file.

Input Parameters

string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the Project ID.
object
required
Attach the file to be imported. One file allowed; maximum size 128000 KB.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_CUSTOM_MODULE_RECORDCreate a record in a custom module. Use this API to add a record with basic details such as name, status, layout, and project.

Input Parameters

string
required
Enter the record name.
object
Enter the layout details of the record. To get the layout details, use the Get Layouts API .
object
Enter the status details of the record. To get the status details, use the Get Global Statuses API .
object
Enter the project details of the entity.
boolean
Specify whether the record is closed. Accepted values : true or false
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the record description.
boolean
Specify whether the record is external. Accepted values : true or false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_DEFAULT_TASK_LISTCreate Default tasklist for a Project.

Input Parameters

string ("internal" | "external")
required
Set the task list flag. Accepted values: internal , external .
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_EXTENSION_PROPERTYStore all the entity or app properties of the extension.

Input Parameters

string
required
Enter the property key.
string ("entity" | "app")
required
Enter the extension type. Accepted values: entity or app.
integer
Enter the number of occurrences.
string
required
Enter the value to store.
object
Enter the entity details if the type is entity.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of an extension. Obtained from the Get Extension Configuration API - the “id” field in the response corresponds to extension_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_HOLIDAY_LISTCreate a holiday list in the Zoho Projects portal.

Input Parameters

string
required
Enter the holiday list name.
array
Specify the holidays in the list.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
array
Enter the business hours’ details to associate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_INVITATION_TEMPLATECreate a portal invitation email template.

Input Parameters

string
Template name.
string
Invitation email content.
string
Invitation email subject.
string
required
Portal ID returned by List Portals.
boolean
Whether to make this the default template.
string ("Users" | "Clients")
Module that uses the template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_ISSUECreate an issue in a project. Use this API to add a new issue with required and optional fields.

Input Parameters

string ("Internal" | "External")
Specify the flag type of the issue. Accepted values: Internal or External
string
required
Enter the name of the issue
array
Enter the IDs of the tags to associate You can obtain it from the Get Project Tags API (the “id” field in the response).
object
Specify the module of the project that this issue is related to.
object
Enter the status of the issue
object
Specify the assignee of the issue
string
Enter the due date for the issue in ISO 8601 format. Example: 2025-12-31T00:00:00+05:30
object
Configure a reminder for this issue to alert assignees or followers before or on the due date.
object
Specify the severity level of the issue. Example: Critical, Major, or Minor.
array
Enter the IDs of the users to follow the issue You can obtain it from the Get Project Users API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
object
Specify the reporter of the issue
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
Enter the IDs of attachments to associate You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).
string
Enter the description of the issue
object
Enter integration related details
number
Enter the billing rate per hour for the assignee working on this issue.
array
Enter the WorkDrive resource IDs of the files to associate. The WorkDrive resource ID is different from the attachment ID in Zoho Projects. You can pass up to 50 IDs. To get the thirdPartyId, refer to the WorkDrive API User who does not have upload permission to the folder/team folder can upload file upto 20 MB only.
object
Specify the classification of the issue
object
Specify the team associated with the issue
object
Specify the Release Milestone of the issue
object
Specify the Affected Milestone of the issue
number
Enter the internal cost per hour for the assignee working on this issue.
object
Specify how consistently this issue can be reproduced. Example: Always, Sometimes, or Rarely.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_LAYOUTCreate or clone a layout in a module.

Input Parameters

string
required
Layout name.
string
Layout type.
string
required
Module API name or ID from List Modules.
string
required
Unique portal ID from List Portals.
object
Layout to clone.
array
Entities to associate with the layout.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_MODULECreate a custom module in the portal.

Input Parameters

array
Project associations.
string
required
Unique portal ID from List Portals.
string
Module icon class.
string
Plural module display name.
string
Singular module display name.
boolean
Whether the module appears in all projects.
boolean
Whether the module is global.
boolean
Whether the module appears in overview.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_OR_UPDATE_FIELDCreate a field or update an existing field in a module layout.

Input Parameters

string
Existing field ID when updating; omit to create.
string
required
Module API name or ID from List Modules.
object
Field position in the layout section.
string
Field data type.
string
Layout ID from List Layouts.
string
required
Unique portal ID from List Portals.
string
Field type, such as singleline or picklist.
string
Section ID from Get Layout Details.
string
Field display name.
object
Field behavior and type properties.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_OR_UPDATE_SECTIONAdd or update a layout section.

Input Parameters

string
Existing section ID when updating.
string
required
Section name.
string
required
Module API name or ID from List Modules.
object
Section position in the layout.
string
required
Layout ID from List Layouts.
string
required
Unique portal ID from List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_PHASECreate a phase with owner, status, dates, tags, position, template settings, and budget details.

Input Parameters

string ("Internal" | "External")
Whether the phase is internal or external.
string
required
Phase name.
array
Tag IDs to associate with the phase.
string
Hex color for the phase’s Gantt bar.
object
Phase owner.
object
Phase status.
string
End date in YYYY-MM-DD format.
object
Placement of the phase.
string
required
Portal ID returned by List Portals.
string
required
Project ID returned by List Projects.
string
Start date in YYYY-MM-DD format.
object
Phase budget details when budgeting is enabled.
object
Settings used when the project is a template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_PROFILECreate or clone a profile in a portal.

Input Parameters

string
required
Profile name.
string ("normal" | "client")
Profile type.
string
required
Portal ID returned by List Portals.
string
Existing profile ID to clone.
boolean
Whether to make this the default profile.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_PROJECTCreate a new project in the Zoho Projects portal.

Input Parameters

string
required
Enter the project name.
array
Enter the tags for the project.
object
Enter the project owner.
object
Enter the project layout details.
object
Enter the status of the project.
string
Enter the end date of the project (YYYY-MM-DD).
string ("web" | "api")
Enter the source from which the project is added. Accepted values : web , api
string
Enter the template ID or existing project ID that this new project should be copied from. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the start date of the project (YYYY-MM-DD).
object
Enter the project budget details.
string
Enter the project description.
string ("active" | "template")
Enter the project type. Accepted values : active , template
object
Custom field values keyed by each field’s snake_case API name from the module field metadata. Values must match that field’s documented type.
object
Enter the project group details.
string
Enter the business hours ID. You can obtain it from the Get Business Hours API (the “id” field in the response).
boolean
Specify whether the project is public. Accepted values : true or false
boolean
Specify whether the project is roll-up project. Accepted values : true or false
object
Specify the sub-module settings, to declare sub-module related configurations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_PROJECT_EXPORTCreate a project export in the Zoho Projects portal.

Input Parameters

object
Enter the custom view details
object
Enter the filter criteria for the export.
string ("users" | "date" | "client" | "project")
Enter the grouping criteria. Accepted values : users , date , client , project
string
Enter the export ID
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
object
Enter the extension configuration details
string
Enter the access code
string ("csv" | "xlsx")
Enter the export file format. Accepted values: csv , xlsx
string ("active" | "archived" | "both")
Enter the project type. Accepted values : active , archived , both
object
Enter the schedule details for the export
array
Specify mandatory fields to include in the export.
array
Specify the fields to include in the export
boolean
Specify whether the scheduled export is active or inactive
boolean
Specify whether to include export details. Accepted values : true , false
boolean
Specify whether export extension is enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_PROJECT_FOLDERCreate a folder under a project team folder or folder.

Input Parameters

string
required
Name of the Folder
string
required
Enter the team folder or folder ID. To get the folder IDs, use the Get Project Team Folder Details
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
required
Enter the permission details for the folder. To get the default folder permission, use the Get Project Team Folder Details

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_PROJECT_GROUPAdd a new project group in the Zoho Projects portal.

Input Parameters

string
Enter the project group name.
string ("public" | "private")
Enter the project group type. Accepted values: public or private.
string
Enter a prefix of the project group.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_PROJECT_TEAM_FOLDERCreate a team folder in a project.

Input Parameters

string
required
Name of the Folder
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Description Content
array
required
Enter the permission details for the team folder.To get the default team folder permission, use the Get Project Team Folder Details

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_ROLECreate a role in a portal.

Input Parameters

string
required
Role name.
integer
Sequence number for the role.
string
required
Portal ID returned by List Portals.
boolean
Whether to make this the default role.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_SKILLCreate a skill in a Zoho Projects portal.

Input Parameters

string
required
Unique skill name within the portal.
string
required
Portal ID returned by List Portals.
string
Skill description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_TAGSCreate new tags in the Zoho Projects portal.

Input Parameters

array
required
Enter the tag information.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_TASKAdd a task to the project.

Input Parameters

string
required
Enter the task name
array
Enter the tags for the task
array
Add or remove teams associated with the task
object
Enter the task status details if not provided default open will be taken
object
Enter the duration of the task
string
Enter the end date of the task in ISO 8601 format. Use yyyy-MM-dd’T’HH:mm:ss’Z’ for UTC or yyyy-MM-dd’T’HH:mm:ss[+|-]HH:mm for other time zones.
string ("none" | "low" | "medium" | "high")
Enter the task priority Possible values are none , low , medium , high
object
Enter the Reminder details of the task
object
Enter the task list details. Uses the general task list when task list details are not provided; the project must have a general task list or an exception is thrown. To create one, use the Create Default Task List
object
Enter the milestone details to associate with the task.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
object
Enter recurrence details of the task
string
Enter the start date of the task in ISO 8601 format. Use yyyy-MM-dd’T’HH:mm:ss’Z’ for UTC or yyyy-MM-dd’T’HH:mm:ss[+|-]HH:mm for other time zones.
array
Enter the IDs of files to be uploaded You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).
object
Enter the Budget details of the task
string
Enter the task description
object
Enter the start after of the task
string ("none" | "billable" | "non_billable")
Enter the billing type for the task Possible values are none , billable , non_billable
object
Custom field values keyed by each field’s snake_case API name from the module field metadata. Values must match that field’s documented type.
object
Enter parent task details if sub task is need to be created
array
Enter the WorkDrive resource IDs of the files to associate. The WorkDrive resource ID is different from the attachment ID in Zoho Projects. You can pass up to 50 IDs. To get the thirdPartyId, refer to the WorkDrive API User who does not have upload permission to the folder/team folder can upload file upto 20 MB only.
object
Enter the task owner name and work details
integer
Enter the task completion percentage

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_TASK_LISTAdd a Task list to the project.

Input Parameters

string ("internal" | "external")
Set the task list flag. Accepted values: internal , external .
string
required
Enter the name of the task list
array
Specify the tags to associate with this task list. Use add to attach new tags or remove to detach existing ones.
string ("active" | "completed")
Specify the status of the task list. Accepted values: active or completed .
object
Enter the associated milestone ID.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_CREATE_TEAMCreate a new team in a specific portal. Use this API to set up a team and group users for collaborative work within a portal.

Input Parameters

string
required
ZPUID of the team lead.
string
required
Team name.
string
Team email address.
boolean
Whether to notify affected users.
object
required
Portal-user IDs to add to or remove from the team.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
object
Optional third-party record details.
object
required
Project IDs to associate with or dissociate from the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DEACTIVATE_CLIENT_USERRevoke a client user’s portal access without deleting the account.

Input Parameters

boolean
required
Whether to notify the client user about deactivation.
string
required
Portal ID returned by List Portals.
string
required
Client user ID returned by List Portal Users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DEACTIVATE_USERRevoke a user’s portal access without deleting the account.

Input Parameters

boolean
required
Whether to notify the user about deactivation.
string
required
User ID returned by List Portal Users.
string
required
Portal ID returned by List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_BUG_RESOLUTION_V3Remove a resolution through the V3 bug_id contract. This operation uses the documented bugs.UPDATE grant; use Delete Issue Resolution (V3.1) for the issue_id contract with bugs.DELETE.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_BUSINESS_HOURSRemove a business calendar from the Zoho Projects portal.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of a business hour. Obtained from the Get Business Hours API - the “id” field in the response corresponds to business-hour_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_CATEGORYDelete a forum category from a specific project. Use this API to permanently remove a forum category within a project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of a category. Obtained from the Get Categories API - the “id” field in the response corresponds to category_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_CLIENT_USERRemove a client user from the Zoho Projects portal.

Input Parameters

boolean
Specify whether to notify the user. Accepted values : True or False
string
required
Identifier of an user. Obtained from the Get Users API - the “id” field in the response corresponds to user_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_CLIENT_USER_FROM_PROJECTRemove a client user from the project.

Input Parameters

boolean
Specify whether to notify the user. Accepted values : True or False
string
required
Identifier of an user. Obtained from the Get Users API - the “id” field in the response corresponds to user_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_CONTACTRemove a contact from the Zoho Projects portal.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of a contact. Obtained from the Get Contacts API - the “id” field in the response corresponds to contact_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_CURRENCYRemove a currency configured for the Zoho Projects portal.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Enter the currency ID. You can obtain it from the Get Currency Setting (the “id” field in the response in currency list).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_CUSTOM_DOMAINRemove the custom domain configuration from the Zoho Projects portal. The portal will use the default Zoho Projects domain once removed.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_CUSTOMERRemove the client company from the Zoho Projects portal.

Input Parameters

boolean
Specify whether to notify the user. Accepted values : True or False
string
required
Identifier of a client. Obtained from the Get Clients API - the “id” field in the response corresponds to client_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_CUSTOMER_FROM_PROJECTRemove a customer from the project.

Input Parameters

boolean
Specify whether to notify the user. Accepted values : True or False
string
required
Identifier of a client. Obtained from the Get Clients API - the “id” field in the response corresponds to client_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_CUSTOM_MODULE_EXPORTRemove a portal-level Custom Module export. Deleting a scheduled export also cancels its remaining runs.

Input Parameters

string
required
Identifier of a record export. Obtained from the Get Portal Exports API - the “id” field in the response corresponds to export_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the project ID to retrieve its export form metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_CUSTOM_MODULE_IMPORTRemove an import entry from the table.

Input Parameters

string
required
Identifier of an import job. Obtained from the Initiate Import API - the “id” field in the response corresponds to import_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_CUSTOM_MODULE_RECORDRemove a record permanently from the recycle bin. Use this API to remove a record completely.

Input Parameters

string
required
Identifier of an entity. Obtained from the Get Entities API - the “id” field in the response corresponds to entity_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_CUSTOM_MODULE_RECORD_COMMENTRemove a comment from a record. Use this API to remove a comment permanently.

Input Parameters

string
required
Identifier of an entity. Obtained from the Get Entities API - the “id” field in the response corresponds to entity_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the comment within the specified record. You can obtain it from the Get All Comments API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_CUSTOM_VIEWRemove a task custom view from the Zoho Projects portal.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of a customview. Obtained from the Get Custom Views (Project) API - the “id” field in the response corresponds to customview_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_DEPENDENCYRemove a task dependency between tasks in a project.

Input Parameters

object
Enter the lag details.
Specify the dependency link type. Accepted values: 0 - Hard Link or 1 - Soft Link.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
object
required
Enter the successor task details.
string ("FS" | "FF" | "SF" | "SS")
Specify the dependency type. Accepted values: FS, FF, SF or SS.
object
required
Enter the predecessor task details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_EVENTRemove a specific event from a project. Use this API to permanently remove an event from a project.

Input Parameters

string
required
Identifier of an event. Obtained from the Get Project Events API - the “id” field in the response corresponds to event_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_EVENT_COMMENTDelete a comment associated with an event in a project within the Zoho Projects portal.

Input Parameters

string
required
Identifier of an event. Obtained from the Get Project Events API - the “id” field in the response corresponds to event_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the comment within the specified event. You can obtain it from the Get Event Comments API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_EXTENSION_PROPERTYRemove the entity or app property from the extension.

Input Parameters

string
required
Enter the property ID.
string ("entity" | "app")
required
Enter the property type. Accepted values: entity or app.
object
Enter entity details if the type is entity.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of an extension. Obtained from the Get Extension Configuration API - the “id” field in the response corresponds to extension_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_FIELDRemove a field from a custom module.

Input Parameters

string
required
Module API name or ID from List Modules.
string
required
Field ID from Get Custom Module Fields.
string
required
Unique portal ID from List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_FOLDERDelete a Folder.

Input Parameters

string
required
Identifier of a folder. Obtained from the Get Folders Details API - the “id” field in the response corresponds to folder_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_FORUMDelete a forum from a specific project. Use this API to permanently remove a forum and its content from a project.

Input Parameters

string
required
Identifier of a forum. Obtained from the Get Forums API - the “id” field in the response corresponds to forum_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_FORUM_COMMENTDelete a comment from a specific forum in a project. Use this API to permanently remove a comment from a forum within a project.

Input Parameters

string
required
Identifier of a forum. Obtained from the Get Forums API - the “id” field in the response corresponds to forum_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the comment within the specified forum post. You can obtain it from the Get Comments API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_HOLIDAY_LISTRemove a holiday list from the Zoho Projects portal.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of a holiday list. Obtained from the Get Holiday List API - the “id” field in the response corresponds to holiday-list_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_INVITATION_TEMPLATEDelete a portal invitation email template.

Input Parameters

string
required
Portal ID returned by List Portals.
string
required
Template ID returned by List Invitation Templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_ISSUERemove an issue from a project. Use this API to permanently remove an issue using its ID.

Input Parameters

string
required
Identifier of an issue. Obtained from the Get Issues API - the “id” field in the response corresponds to issue_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_ISSUE_COMMENTRemove a comment from an issue. Use this API to remove a comment using its ID.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the comment within the specified issue. You can obtain it from the Get Comments API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_ISSUE_RESOLUTION_V3_1Remove a resolution through the V3.1 issue_id contract with the documented bugs.DELETE grant. Use Delete Bug Resolution (V3) for the bug_id contract with bugs.UPDATE.

Input Parameters

string
required
Identifier of an issue. Obtained from the Get Issues API - the “id” field in the response corresponds to issue_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_LAYOUTRemove a layout from a module.

Input Parameters

string
required
Module API name or ID from List Modules.
string
required
Layout ID from List Layouts.
string
required
Unique portal ID from List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_LEAVERemove a leave from the Zoho Projects portal.

Input Parameters

string
required
Identifier of a leave. Obtained from the Get Leave API - the “id” field in the response corresponds to leave_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_MODULEPermanently remove a module from trash.

Input Parameters

string
required
Deleted module ID in the recycle bin.
string
required
Unique portal ID from List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_OR_DISASSOCIATE_FIELD_OPTIONSRemove or disassociate options from a field.

Input Parameters

string
required
Field ID from Get Custom Module Fields.
array
Role options to remove.
array
User options to remove.
string
required
Module API name or ID from List Modules.
array
Status options to remove.
string
Layout ID from List Layouts.
string
required
Unique portal ID from List Portals.
array
Custom options to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_PHASE_COMMENTRemove a comment from a phase.

Input Parameters

string
required
Portal ID returned by List Portals.
string
required
Comment ID returned by List Phase Comments.
string
required
Project ID returned by List Projects.
string
required
Milestone ID returned by a phase listing action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_PROFILEDelete a profile and migrate affected users.

Input Parameters

string
required
Portal ID returned by List Portals.
string
required
Profile ID returned by List Profiles.
string
Replacement profile ID for affected users; omit to use the default profile.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_PROJECTPermanently delete a project that has already been moved to the trash. Use Trash Project first for an active project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_PROJECT_COMMENTDelete Comment in a Project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the comment within the specified project. You can obtain it from the Get Comments API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_PROJECT_CONTACTSRemove contacts from a project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
array
Enter the contact IDs. You can obtain it from the Get Project Contacts API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_PROJECT_EXPORTRemove a project export from the Zoho Projects portal.

Input Parameters

string
required
Identifier of a project export. Obtained from the Get Project Exports Details API - the “id” field in the response corresponds to export_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_PROJECT_GROUPRemove a project group from the Zoho Projects portal.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of a project group. Obtained from the Get User’s Project Groups API - the “id” field in the response corresponds to project-group_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_PROJECT_USERRemove a user’s access to a project.

Input Parameters

string ("true" | "false")
required
Whether to notify the removed user.
string
required
User ID returned by List Project Users.
string
required
Portal ID returned by List Portals.
string
required
Project ID returned by List Projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_RECORDSPermanently remove selected records from the recycle bin.

Input Parameters

array
Record IDs to permanently delete (up to 100).
string ("phases" | "tasklists" | "tasks" | "issues")
required
Module containing the records: phases, tasklists, tasks, or issues.
string
required
Portal ID returned by List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_ROLEDelete a role and migrate affected users.

Input Parameters

string
required
Role ID returned by List Roles.
string
required
Portal ID returned by List Portals.
string
Replacement role ID for affected users; omit to use the default role.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_SECTIONRemove a section from a layout.

Input Parameters

string
required
Module API name or ID from List Modules.
string
required
Layout ID from List Layouts.
string
required
Unique portal ID from List Portals.
string
required
Section ID from Get Layout Details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_SKILLPermanently delete a skill from a Zoho Projects portal.

Input Parameters

string
required
Skill ID returned by List Skills.
string
required
Portal ID returned by List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_TAGRemove a tag from the Zoho Projects portal.

Input Parameters

string
required
Identifier of a tag. Obtained from the Get Tags API - the “id” field in the response corresponds to tag_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_TASKRemove a task from the project.

Input Parameters

string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_TASK_COMMENTRemove a comment from a task.

Input Parameters

string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the comment within the specified task. You can obtain it from the Get Comments API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_TASK_LISTRemove a task list from the project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of a tasklist. Obtained from the Get Tasklists API - the “id” field in the response corresponds to tasklist_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_TASK_LIST_COMMENTRemove a comment from a task list.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the comment within the specified task. You can obtain it from the Get Multiple Comments API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of a tasklist. Obtained from the Get Tasklists API - the “id” field in the response corresponds to tasklist_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_TEAMRemove a specific team from a portal. Use this API to permanently remove a team and its associations within a portal.

Input Parameters

string
required
Identifier of a team. Obtained from the Get Project Teams API - the “id” field in the response corresponds to team_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_TEAM_FOLDERRemove a team folder from a project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of a teamfolder. Obtained from the Get Project Team Folder Details API - the “id” field in the response corresponds to teamfolder_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_TIME_LOGRemove the time log from a project.

Input Parameters

string
required
Identifier of a log. Obtained from the Get Project Time Logs API - the “id” field in the response corresponds to log_id.
string ("task" | "issue" | "general")
required
Enter the module type. Accepted values: task, issue, general
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_TIMERRemove a timer entry from the Zoho Projects portal. Use this API to delete a timer that is no longer needed.

Input Parameters

string
required
Identifier of a timer. Obtained from the Get Running Timers API - the “id” field in the response corresponds to timer_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DELETE_USERPermanently remove a user from a portal.

Input Parameters

string ("true" | "false")
required
Whether to notify the removed user.
string
required
User ID returned by List Portal Users.
string
required
Portal ID returned by List Portals.
string
Replacement reporting manager user identifier.
string
Reporting manager identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DISASSOCIATE_ATTACHMENTDissociate an attachment from an issue.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of an attachment. Obtained from the Get Attachments API - the “id” field in the response corresponds to attachment_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DISASSOCIATE_FIELDRemove a field from a layout.

Input Parameters

string
required
Module API name or ID from List Modules.
string
required
Field ID from Get Custom Module Fields.
string
required
Layout ID from List Layouts.
string
required
Unique portal ID from List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DISASSOCIATE_FORUMSDisassociate multiple forums from a task.

Input Parameters

array
Enter the IDs of the forums You can obtain it from the Get Forums API (the “id” field in the response).
string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DISASSOCIATE_ISSUEDisassociate bug from a task.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DISASSOCIATE_MULTIPLE_ATTACHMENTSDisassociate Multiple attachments for all entities

Input Parameters

string
required
Entity Id
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Name of the Enity
array
Unique Id’s of the attachment You can obtain it from the Get Task Attachments API (the “attachment_id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DISASSOCIATE_PROJECT_ATTACHMENTDisassociate for all entities

Input Parameters

string
required
Entity Id
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Enter the module name. Available entities: project_comment , status , status_comment , milestone_comment , tasklist_comment , task , task_comment , bug , bug_resolution , bug_comment , event , event_comment , forum , forum_comment , announcement_comment , zoho_meeting_comment . For custom modules, use the Get List of Modules API with the filter is_customized = ‘true’ and use the returned api_name value as the entity_type. For comments under a custom module, use the format ‘api_name’_cm_comment .
string
required
Identifier of an attachment. Obtained from the Get Attachments API - the “id” field in the response corresponds to attachment_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DISASSOCIATE_PROJECT_CONTACTDisassociate a contact from a project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of a contact. Obtained from the Get Contacts API - the “id” field in the response corresponds to contact_id.
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DISASSOCIATE_PROJECT_FOLDERSDisassociate folder(s) from a project.

Input Parameters

string
required
Identifier of a folder. Obtained from the Get Folders Details API - the “id” field in the response corresponds to folder_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DISASSOCIATE_PROJECT_TEAMRemove a specific team from a project. Use this API to dissociate a team from a project and revoke its members’ project access.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of a dissociate team. You can obtain it from the Get Teams API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DISASSOCIATE_TAGS_FROM_ENTITYRemove associated tags from a module in a project.

Input Parameters

string
required
Enter the tag ID. You can obtain it from the Get Project Tags API (the “id” field in the response).
string
required
Enter the module ID.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
integer ("2" | "3" | "4" | "5" | "6" | "7" | "8")
required
Module type: 2 (project), 3 (milestone), 4 (task list), 5 (task), 6 (issue), 7 (forum), or 8 (status).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DISASSOCIATE_TASKRemove task association from an issue. Use this API to unlink a task from an issue.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_DISASSOCIATE_TEAM_FOLDERDisassociate team folder(s) from a project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of a teamfolder. Obtained from the Get Project Team Folder Details API - the “id” field in the response corresponds to teamfolder_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_EMPTY_RECYCLE_BINPermanently delete all records from a portal’s recycle bin. This cannot be reversed.

Input Parameters

string
required
Portal ID returned by List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_EXPORT_CUSTOM_MODULE_RECORD_STATUS_TIMELINEExports status timeline of a record.

Input Parameters

string
required
Identifier of an entity. Obtained from the Get Entities API - the “id” field in the response corresponds to entity_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_EXPORT_PORTAL_USERSStart an asynchronous export of portal users.

Input Parameters

string ("portal_users" | "all_project_users" | "portal_clientusers" | "all_project_clientusers" | "portal_clients" | "all_project_clients" | "portal_contacts" | "all_project_contacts" | "portal_allclients")
required
Portal user export type.
string ("csv" | "xlsx")
required
Export file format.
string
required
Portal ID returned by List Portals.
string
Optional password used to encrypt the export.
array
required
Zoho Projects field API names to include in the export.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_EXPORT_PROJECT_USERSStart an asynchronous export of project users.

Input Parameters

string ("project_users" | "project_clientusers" | "project_clients" | "project_contacts" | "project_allclients")
required
Project user export type.
string ("csv" | "xlsx")
required
Export file format.
string
required
Portal ID returned by List Portals.
string
required
Project ID returned by List Projects.
string
Optional password used to encrypt the export.
array
required
Zoho Projects field API names to include in the export.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_EXPORT_STATUS_TIMELINEExport the status timeline of tasks from a portal. Use this API to download a report of task status changes.

Input Parameters

string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_EXPORT_TASK_STATUS_TIMELINECreate an export of task status timeline data across the portal.

Input Parameters

string
required
Id of the Task You can obtain it from the Get Tasks by Portal API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Id of the project You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_FOLLOW_CUSTOM_MODULE_RECORDAdd a follower to the record.

Input Parameters

string
required
Identifier of an entity. Obtained from the Get Entities API - the “id” field in the response corresponds to entity_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_FOLLOW_FORUMFollow a specific forum in a project to receive notifications. Use this API to subscribe a user to forum updates within a project.

Input Parameters

string
required
Identifier of a forum. Obtained from the Get Forums API - the “id” field in the response corresponds to forum_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_FOLLOW_ISSUEAdd or update followers to an issue in a project.

Input Parameters

string
required
Identifier of an issue. Obtained from the Get Issues API - the “id” field in the response corresponds to issue_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
Enter the follower IDs. You can obtain it from the Get Project Users API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_FOLLOW_TASKFollow a task in a project.

Input Parameters

string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_FOLLOW_TASK_LISTFollow a task list to receive updates and notifications. Use this API to subscribe a user to activity on a specific task list within a project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of a tasklist. Obtained from the Get Tasklists API - the “id” field in the response corresponds to tasklist_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_ATTACHMENTRetrieve attachments of a comment. Use this API to fetch files associated with a specific comment.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the comment ID You can obtain it from the Get Comments API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_ATTACHMENT_DETAILSGet attachments details by attachment id

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of an attachment. Obtained from the Get Attachments API - the “id” field in the response corresponds to attachment_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_BLUEPRINT_TRANSITION_FIELDSRetrieve data of the action that is set to execute during the transition.

Input Parameters

string
required
Enter the entity ID.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of a blueprint. Obtained from the Get Blueprints API - the “id” field in the response corresponds to blueprint_id.
string
required
Identifier of a transition. Obtained from the Get Next Available Transitions API - the “id” field in the response corresponds to transition_id.
boolean
Specify whether to skip issue validation during transition execution. By default, a transition cannot be executed while the associated task has open issues. Accepted values: true or false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_BUG_RESOLUTION_V3Retrieve a bug resolution through the V3 bug_id contract. The response uses the V3 status_code/response wrapper; use Get Issue Resolution (V3.1) for the direct V3.1 issue response.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_BUG_STATUS_TRANSITIONS_V3Retrieve status-transition history through the V3 bug_id contract. The result uses the V3 status_code/response wrapper; use Get Issue Status Timeline (V3.1) for a direct timeline list.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_BUSINESS_HOUR_DETAILSRetrieve details of the business hours using its ID.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of a business hour. Obtained from the Get Business Hours API - the “id” field in the response corresponds to business-hour_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_COMMENT_DETAILSFetch Single Comment Detail.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the comment within the specified project. You can obtain it from the Get Comments API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_CONTACT_DETAILSRetrieve details of a contact from the Zoho Projects portal.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of a contact. Obtained from the Get Contacts API - the “id” field in the response corresponds to contact_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_CUSTOM_DOMAINRetrieve custom domain details for the portal.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_CUSTOM_MODULE_EXPORTRetrieve the details of a specific portal-level Custom Module export, including its file format, selected fields, filter criteria, schedule and notified users.

Input Parameters

string
required
Identifier of a record export. Obtained from the Get Portal Exports API - the “id” field in the response corresponds to export_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the project ID to retrieve its export form metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_CUSTOM_MODULE_FIELDSRetrieve fields and metadata available in a custom module.

Input Parameters

string
required
Module ID from List Modules.
string
required
Unique portal ID from List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_CUSTOM_MODULE_IMPORTRetrieve the details of an import operation.

Input Parameters

string
required
Identifier of an import job. Obtained from the Initiate Import API - the “id” field in the response corresponds to import_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_CUSTOM_MODULE_IMPORT_ERRORSRetrieve the error details of the import operation.

Input Parameters

integer
Enter the index of the import error record detail.
integer
Enter the range of the import error record detail.
integer
Enter the number of entries to be displayed per page.
string
required
Identifier of an import job. Obtained from the Initiate Import API - the “id” field in the response corresponds to import_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_CUSTOM_MODULE_IMPORT_FILERetrieve the details of the uploaded files for mapping in import operation.

Input Parameters

string
required
Identifier of an import job. Obtained from the Initiate Import API - the “id” field in the response corresponds to import_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_CUSTOM_MODULE_RECORDRetrieve details of a specific record. Use this API to fetch complete information of a record using its ID.

Input Parameters

string
required
Identifier of an entity. Obtained from the Get Entities API - the “id” field in the response corresponds to entity_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_CUSTOM_MODULE_RECORD_COMMENTRetrieve the details of a specific comment from a record. Use this API to fetch a single comment using its ID.

Input Parameters

string
required
Identifier of an entity. Obtained from the Get Entities API - the “id” field in the response corresponds to entity_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the comment within the specified record. You can obtain it from the Get All Comments API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_CUSTOM_MODULE_RECORD_EDITRetrieve edits made to a record using a specific audit ID.

Input Parameters

string
required
Identifier of an edit. Obtained from the Get All Edits of a Record API - the “id” field in the response corresponds to edit_id.
string
required
Identifier of an entity. Obtained from the Get Entities API - the “id” field in the response corresponds to entity_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_CUSTOM_MODULE_RECORD_STATUS_TIMELINERetrieve the status timeline of a record.

Input Parameters

string
required
Identifier of an entity. Obtained from the Get Entities API - the “id” field in the response corresponds to entity_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_CUSTOM_MODULE_RECORD_VIEWGet detail of the custom view.

Input Parameters

string
required
Enter the module API name or ID. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Identifier of the custom view. You can obtain it from the Get Custom View API .
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the project ID. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_CUSTOM_VIEW_DETAILSRetrieve the details of a project custom view, along with its associated fields.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string ("active" | "archive" | "template")
required
Specify the project type. Accepted values : active , archive , template
string
required
Identifier of a customview. Obtained from the Get Custom View List API - the “id” field in the response corresponds to customview_id.
boolean
Specify whether to show all fields. Accepted values: true or false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_CUSTOM_VIEW_DETAILS_FROM_PROJECTRetrieve the details of a custom view along with its fields.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of a customview. Obtained from the Get Custom Views API - the “id” field in the response corresponds to customview_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_DATA_BACKUP_STATUSCheck whether a portal backup is in progress or completed and return its download URL when ready.

Input Parameters

string
required
Portal ID returned by List Portals.
string
required
Export ID returned by Schedule Data Backup.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_DEFAULT_APPROVERRetrieve the default approver of the user in a project.

Input Parameters

string
Identifier of the user. You can obtain it from the Get Project Users API (the “id” field in the response).
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_DEFAULT_LAYOUTRetrieve the default layout configured for a module.

Input Parameters

string
required
Module API name or ID from List Modules.
string
required
Unique portal ID from List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_EVENT_COMMENT_BY_IDRetrieve the details of a specific event comment using its comment ID. Use this API to access an event comment without requiring the event ID.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of an eventcomment. Obtained from the Get Event Comment by ID API - the “id” field in the response corresponds to eventcomment_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_EVENT_DETAILSRetrieve the details of a specific event in a project. Use this API to access the full information of an event within a project.

Input Parameters

string
required
Identifier of an event. Obtained from the Get Project Events API - the “id” field in the response corresponds to event_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_EXTENSION_CONFIGURATIONRetrieve the configuration of the extension.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of an extension. Obtained from the Get Extension Configuration API - the “id” field in the response corresponds to extension_id.
string ("user" | "organization")
Specify the configuration level. Accepted values: user or organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_EXTENSION_PROPERTYRetrieve one page of entity or app properties from an extension.

Input Parameters

string
required
Enter the property key.
string ("entity" | "app")
required
Enter the property type. Accepted values: entity or app.
object
Enter the entity details if the type is entity.
integer
Provider-documented per page value.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
string
required
Identifier of an extension. Obtained from the Get Extension Configuration API - the “id” field in the response corresponds to extension_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_FIELD_CONFIGURATIONRetrieve supported field types and field limits for a module.

Input Parameters

string
required
Module API name or ID from List Modules.
string
required
Unique portal ID from List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_FIELD_INFO_FOR_CUSTOM_MODULERetrieve fields and metadata for a custom module, one page at a time.

Input Parameters

object
Structured field filter.
string
required
Module API name or ID from List Modules.
integer
Maximum fields on this page.
string
required
Unique portal ID from List Portals.
string
Continuation cursor from the previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_FORUM_COMMENTRetrieve a specific comment from a forum in a project. Use this API to access the details of a particular comment within a forum.

Input Parameters

string
required
Identifier of a forum. Obtained from the Get Forums API - the “id” field in the response corresponds to forum_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the comment within the specified forum post. You can obtain it from the Get Comments API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_FORUM_COMMENT_BY_IDRetrieve the details of a specific forum comment using its comment ID. Use this API to access a forum comment without requiring the forum ID.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of the forum comment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_FORUM_DETAILSRetrieve the details of a specific forum in a project. Use this API to access the full information of a forum within a project.

Input Parameters

string
required
Identifier of a forum. Obtained from the Get Forums API - the “id” field in the response corresponds to forum_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_HOLIDAY_LIST_DETAILSRetrieve holiday list details using its ID.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of a holiday list. Obtained from the Get Holiday List API - the “id” field in the response corresponds to holiday-list_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_INVITATION_TEMPLATERetrieve one portal invitation email template.

Input Parameters

string
required
Portal ID returned by List Portals.
string
required
Template ID returned by List Invitation Templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_ISSUE_COMMENTRetrieve a specific comment on an issue.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the comment within the specified issue. You can obtain it from the Get Comments API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_ISSUE_DESCRIPTIONRetrieve the description of the issue in a project.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_ISSUE_DETAILSRetrieve details of an issue in a project. Use this API to fetch complete information of an issue using its ID.

Input Parameters

string
required
Identifier of an issue. Obtained from the Get Issues API - the “id” field in the response corresponds to issue_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_ISSUE_RESOLUTION_V3_1Retrieve an issue resolution through the V3.1 issue_id contract, which returns the resolution list directly. Use Get Bug Resolution (V3) for the wrapped V3 bug_id response.

Input Parameters

string
required
Identifier of an issue. Obtained from the Get Issues API - the “id” field in the response corresponds to issue_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_ISSUE_STATUS_TIMELINE_V3_1Retrieve status-transition history through the V3.1 issue_id contract as a direct timeline list. Use Get Bug Status Transitions (V3) for the wrapped V3 response.

Input Parameters

string
required
Identifier of an issue. Obtained from the Get Issues API - the “id” field in the response corresponds to issue_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_LAYOUT_DETAILSRetrieve complete layout details, including its sections.

Input Parameters

string
required
Module API name or ID from List Modules.
string
required
Layout ID from List Layouts.
string
required
Unique portal ID from List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_LEAVE_DETAILSRetrieve specific leave details from the Zoho Projects portal.

Input Parameters

string
required
Identifier of a leave. Obtained from the Get Leave API - the “id” field in the response corresponds to leave_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_MODULERetrieve one module’s configuration.

Input Parameters

string
required
Module ID or API name from List Modules.
string
required
Unique portal ID from List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_MY_PORTAL_PERMISSIONSRetrieve the current user’s record-level or field-level portal permissions.

Input Parameters

string
Module name; required for fields and bugfields.
string
required
Portal ID returned by List Portals.
string
required
Record category or field category fields, bugfields, or flp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_MY_PROJECT_PERMISSIONSRetrieve the current user’s record-level or field-level project permissions.

Input Parameters

string
Module name; required for fields and bugfields.
string
required
Portal ID returned by List Portals.
string
required
Project ID returned by List Projects.
string
required
Record category or field category fields, bugfields, or flp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_OWNER_ALLOCATED_WORKRetrieve allocated work details of an existing user or resource from the Zoho Projects portal.

Input Parameters

object
Enter the filter criteria to narrow down results.
string
Enter the end date of the chart.
string
Enter the custom view ID.
string
required
Identifier of an owner. You can obtain it from the Get Portal Users API (the “id” field in the response).
string
Enter the start date of the chart.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the project ID (Not required for global reports). You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
string ("days" | "weeks" | "months")
Enter the view period.Accepted values : days , weeks , months
string ("users" | "teams")
Enter the report based on value.Accepted values : users , teams

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_PHASERetrieve complete details for a phase by ID.

Input Parameters

string
required
Phase ID returned by List Project Phases.
string
required
Portal ID returned by List Portals.
string
required
Project ID returned by List Projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_PHASE_STATUS_TIMELINERetrieve the status transition history of a phase.

Input Parameters

string
required
Portal ID returned by List Portals.
string
required
Project ID returned by List Projects.
string
required
Milestone ID returned by a phase listing action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_PORTAL_BUDGET_SETTINGSRetrieve the budget settings configured for the Zoho Projects portal. Use this API to get the current budget configuration, including EVM settings, currency, and profile permissions.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_PORTAL_CURRENCY_SETTINGSRetrieve the currency settings configured for the Zoho Projects portal. Use this API to get the base currency, currency list, and conversion settings.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_PORTAL_CUSTOM_VIEW_DETAILSGet portal Custom View Details.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of a customview. Obtained from the Get Custom Views (Project) API - the “id” field in the response corresponds to customview_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_PORTAL_DATE_TIME_SETTINGSGet the date and time settings of the portal.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_PORTAL_DETAILSRetrieve details and business settings for a Zoho Projects portal.

Input Parameters

string
required
Portal ID returned by List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_PORTAL_FOLDER_DETAILSReturn folder details available in a portal.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Module Name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_PORTAL_LICENSE_DETAILSNote.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_PORTAL_TIME_LOG_REPORTRetrieve time log reports from the Zoho Projects portal.

Input Parameters

object
Enter the filter criteria to narrow down the report results.
string
Enter the ID of the custom view to apply to the report.
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Type of view Available View Type are regex
string
Enter the start date.
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
string ("user" | "module")
required
Report Type Available Report Type are user , module
object
required
Required custom date range for the report.
boolean
Decides whether pagination occurs based on dependant entity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_PORTAL_USERRetrieve a portal user by ZPUID or email address.

Input Parameters

string
required
User ZPUID or email address.
string
required
Portal ID returned by List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_PORTAL_USER_EXPORTRetrieve a portal user export job and its output URLs.

Input Parameters

string
required
Export ID returned by List Portal User Export History.
string
required
Portal ID returned by List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_PROFILE_DETAILSRetrieve a profile and its configuration from a portal.

Input Parameters

string
required
Portal ID returned by List Portals.
string
required
Profile ID returned by List Profiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_PROFILE_PERMISSIONSRetrieve record-level or field-level permissions for a profile.

Input Parameters

string
Module name; required for fields and bugfields.
string
required
Portal ID returned by List Portals.
string
required
Profile ID returned by List Profiles.
string
required
Record category such as records or task, or field category fields, bugfields, or flp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_PROJECT_CUSTOM_VIEW_DETAILSRetrieve the details of a custom task view. Use this API to fetch the filters, grouping, and display settings configured for a specific custom view.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of a customview. Obtained from the Get Custom Views (Project) API - the “id” field in the response corresponds to customview_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_PROJECT_DETAILSRetrieve details of a project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_PROJECT_EXPORT_FORMRetrieve the Project export form from the Zoho Projects portal.

Input Parameters

string ("add" | "edit" | "clone")
Specify the form opening action. Accepted values: add , edit , clone
string
Enter the custom view ID.
string
Enter the export ID.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_PROJECT_FOLDER_SETTINGSRetrieve details of the folder settings from a project.

Input Parameters

string
Projects folder or folder Id
string
required
Identifier of a folder. Obtained from the Get Folders Details API - the “id” field in the response corresponds to folder_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_PROJECT_TEAM_FOLDER_DETAILSRetrieve the team folder or folder settings from a project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_PROJECT_TEAM_FOLDER_SETTINGSRetrieve the team folder settings of a project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of a teamfolder. Obtained from the Get Project Team Folder Details API - the “id” field in the response corresponds to teamfolder_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_PROJECT_TIME_LOG_REPORTRetrieve time log reports from a project.

Input Parameters

object
Enter the filter criteria to narrow down the report results.
string
Enter the custom view ID. You can obtain it from the Get Task Custom Views API (the “id” field in the response).
string ("timeloggroup_draft" | "timeloggroup_update" | "timeloggroup_regenerate")
Enter the source page from which the report is being accessed. Accepted values: timeloggroup_draft, timeloggroup_update, timeloggroup_regenerate
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string ("day" | "week" | "month")
Type of view Available view types are day , week , month
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Enter the start date.
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
string ("user" | "module")
required
Specify the Report Type Available Report Type are user , module
object
Custom date range for report
string
Enter the timelog group ID. You can obtain it from the Get Project Time Logs API (the “id” field in the response).
boolean
Decides whether pagination occurs based on dependant entity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_PROJECT_USERRetrieve a project user by ZPUID or email address.

Input Parameters

string
required
User ZPUID or email address.
string
required
Portal ID returned by List Portals.
string
required
Project ID returned by List Projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_PROJECT_USER_EXPORTRetrieve a project user export job and its output URLs.

Input Parameters

string
required
Export ID returned by List Project User Export History.
string
required
Portal ID returned by List Portals.
string
required
Project ID returned by List Projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_PROJECT_USER_PERMISSIONSRetrieve record-level or field-level permissions for one project user.

Input Parameters

string
Module name; required for fields and bugfields.
string
required
Project user ID returned by List Project Users.
string
required
Portal ID returned by List Portals.
string
required
Project ID returned by List Projects.
string
required
Record category or field category fields, bugfields, or flp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_ROLE_DETAILSRetrieve a role from a portal.

Input Parameters

string
required
Role ID returned by List Roles.
string
required
Portal ID returned by List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_SKILLRetrieve a skill and its associated users from a Zoho Projects portal.

Input Parameters

string
required
Skill ID returned by List Skills.
string
required
Portal ID returned by List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_STATUS_TIMELINERetrieve the status change timeline for a task. Use this API to track how a task has progressed through different statuses over time.

Input Parameters

string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_TASK_COUNTDisplays the total number of tasks associated with each project.

Input Parameters

object
Specify the filter criteria to apply to the task count.
string
Id of the Custom View You can obtain it from the Get Task Custom Views API (the “id” field in the response).
string
Enter the criteria.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_TASK_DETAILSRetrieve the details of a specific task in a project. Use this API to fetch metadata such as assignee, status, priority, and dates for a given task.

Input Parameters

string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_TASK_DETAILS_FROM_BASELINERetrieve task details captured under a specific baseline. Use this API to compare current task data against a baseline to identify deviations.

Input Parameters

integer
Enter the range to retrieve. E.g. 10
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Enter the baseline ID.
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_TASK_LISTRetrieve the details of a specific task list. Use this API to fetch metadata and configuration of a task list within a project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of a tasklist. Obtained from the Get Tasklists API - the “id” field in the response corresponds to tasklist_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_TASK_LIST_COMMENTRetrieve a specific comment from a task list. Use this API to fetch the details of a single comment posted on a task list.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the comment within the specified task. You can obtain it from the Get Multiple Comments API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of a tasklist. Obtained from the Get Tasklists API - the “id” field in the response corresponds to tasklist_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_TIME_LOG_BY_REFERENCERetrieve time log details from a project.

Input Parameters

string ("task" | "issue" | "general")
required
Type Available Types are task , issue , general
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of the task, issue, or general time-log reference selected by “type”. For task or issue references, use the “id” returned by the corresponding Get/List Tasks or Get/List Issues action; for general time logs, use the project ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_TIME_LOG_CLIENT_REPORTGet time log client report.

Input Parameters

integer
Enter the number of records to retrieve.
object
Enter the filter criteria.
string
Enter the custom view ID.
string
Enter the end date.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string ("day" | "week" | "month" | "customdate" | "fullreport")
Type of view Available view types are day , week , month , customdate , fullreport
string
required
Enter the start date.
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_TIME_LOG_DETAILSRetrieve time log details from a project.

Input Parameters

string ("task" | "issue" | "general")
required
Type Available Types are task , issue , general
string
required
Identifier of a log. Obtained from the Get Project Time Logs API - the “id” field in the response corresponds to log_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_TIME_LOG_PROJECT_REPORTGet time log project report.

Input Parameters

integer
Enter the number of records to retrieve.
object
Enter the filter criteria.
string
Enter the end date.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string ("day" | "week" | "month" | "customdate" | "fullreport")
Type of viewAvailable view types are day , week , month , customdate , fullreport
string
required
Enter the start date.
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_TIME_LOG_REPORT_COUNTRetrieve time log report count.

Input Parameters

object
Enter the filter criteria.
string
Enter the custom view ID.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string ("day" | "week" | "month")
Enter the view type. Accepted values: day , week , month
string
Enter the project ID to get report count for a specific project. You can obtain it from the Get Projects API (the “id” field in the response).
string
Enter the start date. Format: YYYY-MM-DD
string ("user" | "module")
required
Enter the report type. Accepted values: user , module
object
required
Required custom date range for the report.
boolean
Decides whether the count is of dependant entities. When false, the count is of the entity the report paginates by: users for the user report, projects for the portal level module report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_TIME_LOG_SETTINGSRetrieve the time log settings for a specific portal. Use this API to access the current configuration of time log settings in a portal.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_TIME_LOG_SETTINGS_METADATARetrieve the metadata for time log settings in a specific portal. Use this API to access the available options and configurations for time log settings.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_TIMER_DETAILS_BY_LOG_IDRetrieve timer details for a specific time log entry in a project. Use this API to access the timer information associated with a particular time log entry.

Input Parameters

string ("task" | "issue")
required
Work-item type used by the provider route.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of the timesheet (timelog group).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_USER_AUDIT_LOGReturn one page of audit records for a portal user.

Input Parameters

integer
Page number used for the initial request.
object
Structured audit filter serialized as JSON for Zoho.
string
required
User ID returned by List Portal Users.
integer
Audit records per page.
string
required
Portal ID returned by List Portals.
string
Continuation cursor from a previous response’s next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_USER_LICENSE_DETAILSRetrieve portal and client user license usage and availability.

Input Parameters

string
required
Portal ID returned by List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_USERS_ALLOCATED_WORKRetrieve allocated work details of multiple users or resources from the Zoho Projects portal.

Input Parameters

integer
Enter the index of the record.
integer
Enter the range of the record.
object
Enter the filter criteria to narrow down results.
string
Enter the end date of the chart.
string
Enter the custom view ID.
integer
Enter the number of entries to display per page.
string
Enter the start date of the chart.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the project ID (Not required for global reports). You can obtain it from the Get Projects API (the “id” field in the response).
array
Enter the entity IDs.
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
string ("days" | "weeks" | "months")
Enter the view period.Accepted values : days , weeks , months
string ("users" | "teams")
Enter the report based on value.Accepted values : users , teams

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_WORKLOAD_REPORTRetrieve workload report details from the Zoho projects portal.

Input Parameters

integer
Enter the index of the record.
integer
Enter the range of the record.
object
Enter the filter criteria to narrow down results.
string
Enter the end date of the chart.
string
Enter the custom view ID.
integer
Enter the number of entries to display per page.
string
Enter the start date of the chart.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the project ID (Not required for global reports). You can obtain it from the Get Projects API (the “id” field in the response).
string ("asc" | "desc")
Enter the sort order.Accepted values : asc , desc
array
Enter the entity IDs.
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
string
Enter the search term to look up specific records.
string ("days" | "weeks" | "months")
Enter the view period. Accepted values : days , weeks , months
string ("users" | "teams")
Enter the report based on value. Accepted values : users , teams
boolean
Specify whether to fetch the details of unassigned user only.Accepted values : true , false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_WORKLOAD_REPORT_METADATARetrieve workload report meta details from the Zoho projects portal.

Input Parameters

object
Enter the filter criteria to narrow down results.
string
Enter the end date of the chart.
string
Enter the custom view ID.
string
Enter the start date of the chart.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the project ID (Not required for global reports). You can obtain it from the Get Projects API (the “id” field in the response).
string ("days" | "weeks" | "months")
Enter the view period. Accepted values : days , weeks , months

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GET_WORKLOAD_TASK_DETAILSRetrieve the workload details of a task from the Zoho Projects portal.

Input Parameters

string
Enter the end date of the chart.
string
Enter the custom view ID.
string
required
Identifier of an entity. Obtained from the Get Entities API - the “id” field in the response corresponds to entity_id.
string
Enter the start date of the chart.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the project ID of the task. You can obtain it from the Get Projects API (the “id” field in the response).
string ("users" | "teams")
Enter the report based on value.Accepted values : users , teams

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_GRANT_PROFILE_ACCESSGrant record-level or field-level actions to a profile.

Input Parameters

string
required
Module whose permissions are granted.
array
required
Actions to grant.
string
Field ID; required for field-level access.
string
required
Portal ID returned by List Portals.
string
required
Profile ID returned by List Profiles.
string
required
Record category or field category fields, bugfields, or flp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_INVOKE_CUSTOM_FUNCTIONExecute a custom function in the Zoho Projects portal.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
object
Additional query parameters required by the selected custom function, keyed by that function’s parameter names (maximum 25).
string
required
Identifier of the custom function.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_BASELINESRetrieve all baselines from a project. Use this API to view saved project snapshots for comparing planned versus actual progress.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_BLOCKING_WAITING_TASKSRetrieve details of a blocking waiting tasks for a given task.

Input Parameters

string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_BLUEPRINTSRetrieve one page of blueprints from the Zoho Projects portal.

Input Parameters

integer
Enter the number of entries to display per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Enter the module name. Accepted value: Task
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_BLUEPRINT_TRANSITIONSRetrieve actions that are set to execute after transition.

Input Parameters

string
required
Enter the entity ID.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Enter the module name. Accepted value: Task

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_BULK_READ_FIELDSRetrieve the field metadata for the specified modules from the Zoho Projects portal. The fields returned will be aggregated from all layouts of the selected modules.

Input Parameters

string
required
Enter the module names in a comma-separated list. Accepted values: projects,projects_comments,projects_status_timeline,milestones,tasks,timesheets,bugs,users,teams,tags,milestone_invoice,portal_users,project_groups,portal_clients,project_clients,task_workhrs,project_group_users,task_status_timeline,custom_status,task_invoice,issue_comments,milestone_comments,issue_status_timeline,milestone_status_timeline
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_BUSINESS_HOURSRetrieve the list of business hours from the Zoho Projects portal.

Input Parameters

object
Enter the filter criteria.
string
Enter the sort order. Accepted values : ASC(field_name) or DESC(field_name)
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_BUSINESS_HOUR_USERSRetrieve the list of users associated to the business hours from the Zoho Projects portal.

Input Parameters

integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
string
Enter the user details.
string
required
Identifier of a business hour. Obtained from the Get Business Hours API - the “id” field in the response corresponds to business-hour_id.
boolean
Specify whether to exclude the matching users with the business hour.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_CATEGORIESRetrieve one page of forum categories in a project.

Input Parameters

string ("created_time" | "updated_time")
Enter the sort criteria Accepted values: created_time , updated_time
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string ("asc" | "desc")
Enter the sort order Accepted values: asc , desc
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
string
Enter the search term to fetch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_CUSTOMER_CONTACTSRetrieve contacts belonging to a specific portal customer.

Input Parameters

integer
Enter the range of the record.
string
required
Identifier of a client. Obtained from the Get Clients API - the “id” field in the response corresponds to client_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
string
Enter the search term.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_CUSTOMER_PROJECTSRetrieve one page of projects associated with a customer.

Input Parameters

string ("active" | "template" | "archived")
Enter the project status. Accepted values : active , template , archived
integer
Enter the number of entries to be displayed per page.
string
required
Identifier of a client. Obtained from the Get Clients API - the “id” field in the response corresponds to client_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
string
Enter the search term.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_CUSTOMERSRetrieve customer details from the Zoho Projects portal.

Input Parameters

object
Enter the filter criteria.
string
Enter the sort criteria. Accepted values: ASC(field_name) or DESC(field_name) . Available fields: name, address_first, address_second, city, state, country, zip_code, added_time, updated_time.
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_CUSTOMERS_BY_CLIENT_USERRetrieve customers and client users from the Zoho Projects portal.

Input Parameters

string ("ASC" | "DESC")
Enter the sort order. Accepted values: ASC or DESC.
integer
Enter the number of entries to display per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
integer ("0" | "1")
Enter the view type. Accepted values: 0 (Inactive), 1 (Active).
string
Continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_CUSTOM_MODULE_EXPORTSRetrieve scheduled and completed exports for a portal-level Custom Module. Use is_completed to choose between the two: pass false for exports that are still scheduled, and true for exports that have finished and can be downloaded.

Input Parameters

string ("portal" | "all")
Enter the view type. Accepted values: portal or all
object
Enter the filter criteria.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the project ID to retrieve its export form metadata.
boolean
required
Specify whether to retrieve completed export details. Accepted values: true or false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_CUSTOM_MODULE_PROFILE_PERMISSIONSRetrieve custom-module permissions for multiple profiles.

Input Parameters

string
required
Portal ID returned by List Portals.
string
required
Comma-separated profile IDs returned by List Profiles.
string
required
Use custom for module actions or fields for field permissions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_CUSTOM_MODULE_RECORD_ATTACHMENTSRetrieve all attachments of a record.

Input Parameters

string
required
Identifier of an entity. Obtained from the Get Entities API - the “id” field in the response corresponds to entity_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the project ID. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_CUSTOM_MODULE_RECORD_COMMENTSRetrieve one page of comments for a custom-module record.

Input Parameters

string
Specify the sort criteria. Accepted values: ASC(field_name) or DESC(field_name)
integer
Enter the number of entries to be displayed per page.
string
required
Identifier of an entity. Obtained from the Get Entities API - the “id” field in the response corresponds to entity_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_CUSTOM_MODULE_RECORD_EDITSRetrieve one page of changes made to a custom-module record.

Input Parameters

integer
Enter the index of the record.
integer
Enter the range of the record.
integer
Enter the number of entries to be displayed per page.
string
required
Identifier of an entity. Obtained from the Get Entities API - the “id” field in the response corresponds to entity_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_CUSTOM_MODULE_RECORD_FOLLOWERSRetrieve the list of followers from the record.

Input Parameters

integer
Enter the number of entries to be displayed per page.
string
required
Identifier of an entity. Obtained from the Get Entities API - the “id” field in the response corresponds to entity_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_CUSTOM_MODULE_RECORDSRetrieve the list of records from a module.

Input Parameters

integer
Enter the index of the record.
integer
Enter the range of the record.
object
Enter the filter criteria.
string
Specify the sort criteria. Accepted values: ASC(field_name) or DESC(field_name).
string
Enter the custom view ID.
integer
Enter the number of entries to be displayed per page.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the project ID. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_DATA_BACKUP_HISTORYRetrieve previously generated portal backups with their status and download links.

Input Parameters

string
required
Portal ID returned by List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_ENTITY_INTEGRATIONSRetrieve the integration details of a module from the Zoho Projects portal.

Input Parameters

string
required
Enter the api name or module id. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the entity ID’s (comma separated).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_EVENT_COMMENTSRetrieve one page of comments on an event in a project.

Input Parameters

string
required
Identifier of an event. Obtained from the Get Project Events API - the “id” field in the response corresponds to event_id.
integer
Specify the number of entries per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_FIELD_LAYOUTSRetrieve layouts associated with a field, one page at a time.

Input Parameters

object
Structured criteria for associated layouts.
string
required
Module API name or ID from List Modules.
string
required
Field ID from Get Custom Module Fields.
integer
Maximum layouts on this page.
string
required
Unique portal ID from List Portals.
string
Continuation cursor from the previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_FIELD_OPTIONSRetrieve selectable options for a field, one page at a time.

Input Parameters

string
required
Field name or ID from Get Custom Module Fields.
object
Structured field-option filter.
string
required
Module API name or ID from List Modules.
integer
Maximum options on this page.
string
required
Unique portal ID from List Portals.
string
Continuation cursor from the previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_FIELD_PROJECTSRetrieve projects associated with a field, one page at a time.

Input Parameters

object
Structured criteria for associated projects.
string
required
Module API name or ID from List Modules.
string
required
Field ID from Get Custom Module Fields.
integer
Maximum projects on this page.
string
required
Unique portal ID from List Portals.
string
Continuation cursor from the previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_FOLLOWERS_OF_ISSUERetrieve followers of an issue in a project.

Input Parameters

string
required
Identifier of an issue. Obtained from the Get Issues API - the “id” field in the response corresponds to issue_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_FORUM_COMMENTSRetrieve one page of comments from a forum in a project.

Input Parameters

string ("created_time" | "updated_time")
Enter the sort criteria Accepted values: created_time , updated_time
string
required
Identifier of a forum. Obtained from the Get Forums API - the “id” field in the response corresponds to forum_id.
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string ("asc" | "desc")
Enter the sort order Accepted values: asc , desc
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_FORUM_FOLLOWERSRetrieve all followers of a specific forum in a project. Use this API to access the list of users subscribed to forum notifications within a project.

Input Parameters

string
required
Identifier of a forum. Obtained from the Get Forums API - the “id” field in the response corresponds to forum_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_FORUMS_IN_PROJECTRetrieve one page of forums in a project.

Input Parameters

object
Enter the filter criteria to narrow down the forum results. Available fields: title, category, flag (internal, external), tags, type (regular, question and answer), sticky (true, false), announcement (true, false), posted_by (ZUID), commented_by (ZUID) and posted_time.
string ("created_time" | "updated_time" | "last_activity")
Enter the sort criteria. Accepted values: created_time , updated_time , last_activity
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string ("asc" | "desc")
Enter the sort order. Accepted values: asc , desc
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_FORUM_TASKSRetrieve one page of tasks linked to a forum in a project.

Input Parameters

string
required
Identifier of a forum. Obtained from the Get Forums API - the “id” field in the response corresponds to forum_id.
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_GLOBAL_STATUSESRetrieve global statuses for a module, one page at a time.

Input Parameters

object
Structured status filter; use one attribute per request.
string
required
Module API name or ID from List Modules.
integer
Maximum statuses on this page.
string
required
Unique portal ID from List Portals.
string
Continuation cursor from the previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_HOLIDAY_BUSINESS_HOURSRetrieve business hours associated with the holiday list.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of a holiday list. Obtained from the Get Holiday List API - the “id” field in the response corresponds to holiday-list_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_HOLIDAY_LISTSRetrieve holiday lists from the Zoho Projects portal.

Input Parameters

object
Enter the filter criteria.
string
Enter the sort order. Accepted values : ASC(field_name) or DESC(field_name)
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_HOLIDAYSRetrieve holidays for the specified year from the Zoho Projects portal.

Input Parameters

integer
Enter the year.
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
string
required
Identifier of a holiday list. Obtained from the Get Holiday List API - the “id” field in the response corresponds to holiday-list_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_IANA_TIME_ZONESRetrieve the list of IANA timezones from the Zoho Projects portal.

Input Parameters

integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
string
Enter the time zone name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_INTEGRATION_MODULE_FIELDSRetrieve fields from an external service module for mapping.

Input Parameters

string
required
Integration module ID from List Integration Service Modules.
string
required
Unique portal ID from List Portals.
string
required
Integration service ID from List Integration Services.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_INTEGRATION_SERVICE_MODULESRetrieve modules available within an external service.

Input Parameters

string
required
Unique portal ID from List Portals.
string
required
Integration service ID from List Integration Services.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_INTEGRATION_SERVICESRetrieve external services available for integration fields.

Input Parameters

string
required
Unique portal ID from List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_INVITATION_TEMPLATESReturn one page of portal invitation email templates.

Input Parameters

string
Provider-supported sort expression.
integer
Templates per page (1-200).
string
required
Portal ID returned by List Portals.
string
Continuation cursor from a previous response’s next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page.
string
Search text used to filter invitation templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_ISSUE_ACTIVITIESRetrieve activities performed on issues in a project.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
object
Specify filter criteria to narrow down the activity log entries.
string
Enter the sort order for the results
integer
Enter the number of entries to display per page
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_ISSUE_ATTACHMENTSRetrieve all attachments of an issue.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
string
Enter the sub type. Available types: comments , resolution , or bug
array
Enter the application type to filter attachments.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
Enter details for attachment extension IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_ISSUE_COMMENTSRetrieve one page of comments on an issue.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
object
Specify filter criteria to narrow down the comments returned.
string
Enter the sort criteria. Accepted values: ASC(field_name) or DESC(field_name)
integer
Enter the number of entries to display per page
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_ISSUE_CUSTOM_VIEWSRetrieve custom views of the portal.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_ISSUE_FOLLOWERSRetrieve the followers of an issue in a project.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_ISSUES_BY_PORTALRetrieve one page of issues across a portal.

Input Parameters

object
Specify the filter criteria for the issues
string ("created_time" | "due_date" | "modified_time")
Enter the sort order. Accepted values: created_time , due_date or modified_time
string
Enter the ID of a custom view to apply its saved filters and column settings.
integer
required
Enter the number of entries to be included per page
string
Enter the issue IDs to retrieve You can obtain it from the Get Issues by Portal API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_ISSUE_TASKSRetrieve tasks associated to a specific issue.

Input Parameters

string
required
Identifier of an issue. Obtained from the Get Issues API - the “id” field in the response corresponds to issue_id.
integer
Specify the number of entries per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_LAYOUT_RECORDSRetrieve entities associated with a layout, one page at a time.

Input Parameters

object
Structured associated-entity filter.
string
required
Module API name or ID from List Modules.
integer
required
Number of entities per page.
string
required
Layout ID from List Layouts.
string
required
Unique portal ID from List Portals.
string
Continuation cursor from the previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_LAYOUTSRetrieve module layouts, one page at a time.

Input Parameters

integer
Legacy layout index.
integer
Legacy layout range.
object
Structured layout filter.
string
required
Module API name or ID from List Modules.
integer
required
Number of layouts per page.
string
required
Unique portal ID from List Portals.
string
Continuation cursor from the previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_LEAVESRetrieve one page of leaves from the Zoho Projects portal.

Input Parameters

object
Enter the filter criteria.
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_LINKED_BUGSRetrieve all linked issues of an issue.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_LINKED_ISSUESRetrieve one page of issues linked to a specific issue.

Input Parameters

string
required
Identifier of an issue. Obtained from the Get Issues API - the “id” field in the response corresponds to issue_id.
integer
Number of records per page
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_MODULESRetrieve portal modules and configuration, one page at a time.

Input Parameters

object
Structured module filter.
integer
Maximum modules on this page.
string
required
Unique portal ID from List Portals.
string
Continuation cursor from the previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_MULTIPLE_WORKLOAD_GROUP_OWNERSRetrieve the list of records across multiple groups in the workload report. Use this API to fetch user, team, profile or role-level workload data across multiple groups, apply filters, and paginate through results.

Input Parameters

integer
Enter the index of the record.
integer
Enter the range of the record.
object
Enter the filter criteria to narrow down results.
string
Enter the end date of the chart.
string
Enter the custom view ID.
object
required
Specify the grouping criteria for the report data.
integer
Enter the number of entries to display per page.
string
Enter the start date of the chart.
array
Specify the list of groups to retrieve owners for.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the project ID (Not required for global reports).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
string
Enter the search term to look up specific records.
string ("days" | "weeks" | "months")
Enter the view period.Accepted values : days , weeks , months

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_MY_CUSTOM_MODULE_IMPORTSRetrieve the list of import operations.

Input Parameters

integer
Enter the index of the import record.
integer
Enter the range of the import record.
object
Enter the filter criteria.
integer
Enter the number of entries to be displayed per page.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the Project ID.
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_MY_PROJECT_GROUPSRetrieve project groups associated with a user.

Input Parameters

integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PARTICIPANTSRetrieve one page of participants for an event in a portal.

Input Parameters

string
required
Identifier of an event. Obtained from the Get Project Events API - the “id” field in the response corresponds to event_id.
integer
Specify the number of entries per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PHASE_ACTIVITIESReturn one page of activities performed on a phase.

Input Parameters

integer
Activities per page (1-200).
string
required
Portal ID returned by List Portals.
string
required
Project ID returned by List Projects.
string
Continuation cursor from a previous response’s next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page.
string
required
Milestone ID returned by a phase listing action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PHASE_COMMENTSReturn one page of comments on a phase.

Input Parameters

integer
Comments per page (1-200).
string
required
Portal ID returned by List Portals.
string
required
Project ID returned by List Projects.
string ("ascending" | "descending")
Comment sort order.
string
Continuation cursor from a previous response’s next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page.
string
required
Milestone ID returned by a phase listing action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PHASE_FOLLOWERSReturn one page of users following a phase.

Input Parameters

integer
required
Followers per page (1-200).
string
required
Portal ID returned by List Portals.
string
required
Project ID returned by List Projects.
string
Continuation cursor from a previous response’s next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page.
string
required
Milestone ID returned by a phase listing action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PHASESReturn one page of phases across a portal with sorting, custom-view, ID, and structured-filter controls.

Input Parameters

object
Structured phase filter serialized as JSON for Zoho.
string
Sort expression such as ASC(name) or DESC(start_date).
string
Custom view ID.
integer
Phases per page; Zoho defaults to 100.
string
Specific phase IDs to fetch.
string
required
Portal ID returned by List Portals.
string
Continuation cursor from a previous response’s next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PORTAL_BUG_TASK_MAPPINGSRetrieve the tasks associated with issues.

Input Parameters

integer
Enter the number of entries to be displayed per page.
array
Enter the issue IDs. You can obtain it from the Get Issues by Portal API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PORTAL_PINNED_TIME_LOGSRetrieve all pinned entries from the time logs weekly form for a specific portal. Use this API to access the list of pinned time log entries across a portal.

Input Parameters

string
Enter the pin ID.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PORTALSRetrieve all portals accessible to the current user, including company, owner, profile, plan, timezone, and environment details.

Input Parameters

string ("active" | "inactive")
Portal status to return. Omit to return every status.
string ("sandbox" | "production")
Portal environment to return. Omit to return every environment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PORTAL_TASK_ATTACHMENTSReturn task attachments across the portal for the documented project-to-task mapping.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
object
Id’s of the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PORTAL_TASK_STATUS_HISTORYRetrieve one page of task status transitions across a portal.

Input Parameters

integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
integer
Fetch results by last modified time

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PORTAL_USER_EXPORT_HISTORYReturn one page of portal user export jobs.

Input Parameters

string ("portal_users" | "all_project_users" | "portal_clientusers" | "all_project_clientusers" | "portal_clients" | "all_project_clients" | "portal_contacts" | "all_project_contacts" | "portal_allclients")
required
Portal export type to return.
integer
Exports per page (1-200).
string
required
Portal ID returned by List Portals.
string
Continuation cursor from the previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PORTAL_USERSReturn one page of portal users, client users, and contacts.

Input Parameters

string ("portal_user" | "client_user" | "client_contact")
User type to return.
object
Structured user filter serialized as JSON for Zoho.
string
Sort expression such as ASC(first_name) or DESC(last_name).
integer
Users per page; Zoho defaults to 100.
string
required
Portal ID returned by List Portals.
string ("active" | "inactive" | "active_read_only" | "inactive_read_only" | "subordinates_active" | "direct_reporters_active" | "activate_user_request" | "sandboxdevelopers" | "inactive_lite_user" | "active_lite_user")
Portal user view to return.
string
Continuation cursor from a previous response’s next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROFILE_PERMISSIONSRetrieve record-level or field-level permissions for multiple profiles.

Input Parameters

string
Module name; required for fields and bugfields.
string
required
Portal ID returned by List Portals.
string
required
Comma-separated profile IDs returned by List Profiles.
string
required
Record category such as records or task, or field category fields, bugfields, or flp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROFILESRetrieve one page of profiles and their configurations in a portal.

Input Parameters

string
Comma-separated profile IDs to return.
object
Structured profile filter serialized as JSON for Zoho.
string
Sort expression using ASC(field_name) or DESC(field_name).
integer
Profiles to return per page; Zoho defaults to 25.
string
required
Portal ID returned by List Portals.
string
Continuation cursor from a previous response’s next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_ATTACHMENTSGet attachments details by Entity id

Input Parameters

string
required
Entity Id
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Enter the module name. Available entities: project_comment , status , status_comment , milestone_comment , tasklist_comment , task , task_comment , bug , bug_resolution , bug_comment , event , event_comment , forum , forum_comment , announcement_comment , zoho_meeting_comment . For custom modules, use the Get List of Modules API with the filter is_customized = ‘true’ and use the returned api_name value as the entity_type. For comments under a custom module, use the format ‘api_name’_cm_comment .

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_BUG_TASK_MAPPINGSRetrieve the tasks associated with an issue.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
string
Enter the starting index for paginating through associated tasks. Example: 0
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_CLIENT_USERSRetrieve customers and client users associated with a project.

Input Parameters

string
Enter the sort criteria.E.g. last_accessed_time:desc
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
integer ("0" | "1")
Enter the view type.Accepted values : 0 (Inactive), 1 (Active).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_COMMENTSRetrieve comments from a project. Use this API to list comments with pagination support.

Input Parameters

string
Sorts by ascending ASC or descending DESC based on created_time or last_updated_time
integer
Specify the number of entries per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_CRM_ACCOUNTSRetrieve CRM accounts associated with a project.

Input Parameters

integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_CRM_CONTACTSRetrieve CRM contacts associated with a project.

Input Parameters

integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_CRM_DEALSRetrieve CRM deals associated with a project in the Zoho Projects portal.

Input Parameters

integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_CUSTOMER_CONTACTSRetrieve one page of customer contacts associated with a project.

Input Parameters

integer
Enter the range of the record.
string
required
Identifier of a client. Obtained from the Get Clients API - the “id” field in the response corresponds to client_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
string
Enter the search term.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_CUSTOMERSRetrieve details of customers associated with a project.

Input Parameters

object
Enter the filter criteria.
string
Enter the sort criteria. Accepted values: ASC(field_name) or DESC(field_name) . Available fields: name, address_first, address_second, city, state, country, zip_code, added_to_project_time, updated_in_project_time.
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_CUSTOM_VIEWSRetrieve the custom views available for a specific project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string ("0" | "1" | "2")
Specify the project type. Accepted values : 0 , 1 , 2

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_EVENTSRetrieve one page of events scheduled within a project.

Input Parameters

string
Enter the IDs of events to retrieve.
object
Specify the additional filter criteria for the events.
string ("open" | "completed")
Specify the status of the event. Accepted values: open, completed.
integer
Specify the number of entries per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_EXPORTSRetrieve the details of project exports from the Zoho Projects portal.

Input Parameters

string ("portal" | "all")
Enter the export type. Accepted values: portal , all
object
Enter the filter criteria.
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Continuation cursor returned by the previous call; omit for the first page.
boolean
required
Specify whether to retrieve details of the completed exports Accepted values - true , false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_GROUPSRetrieve one page of project groups from a Zoho Projects portal.

Input Parameters

integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_ISSUE_CUSTOM_VIEWSRetrieve custom views of a project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_ISSUESRetrieve one page of issues in a project.

Input Parameters

object
Specify the filter criteria for the issues
string ("created_time" | "due_date" | "modified_time")
Enter the sort order. Accepted values: created_time , due_date or modified_time
string
Enter the custom view ID. You can obtain it from the Get Task Custom Views API (the “id” field in the response).
integer
required
Enter the number of entries to be included per page
string
Enter the issue IDs to retrieve You can obtain it from the Get Issues API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_MODULESGet Project Associated Modules Details.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_PHASESReturn one page of phases in a project with sorting, custom-view, ID, and structured-filter controls.

Input Parameters

object
Structured phase filter serialized as JSON for Zoho.
string
Sort expression such as ASC(name) or DESC(start_date).
string
Custom view ID.
integer
Phases per page; Zoho defaults to 100.
string
Specific phase IDs to fetch.
string
required
Portal ID returned by List Portals.
string
required
Project ID returned by List Projects.
string
Continuation cursor from a previous response’s next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_PINNED_TIME_LOGSRetrieve all pinned entries from the time logs weekly form for a specific project. Use this API to access the list of pinned time log entries within a project’s weekly form.

Input Parameters

string
Enter the ZPUID of the user. You can obtain it from the Get Project Users API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECTSRetrieve one page of projects from a Zoho Projects portal.

Input Parameters

object
Enter the filter criteria to retrieve specific projects. The filter is a JSON object containing a list of conditions (criteria) and a logical pattern that defines how those conditions are combined.
string
Specify the sort order for the results. Use the field API name wrapped in ASC() for ascending or DESC() for descending order. For example: ASC(start_date) to sort by start date ascending, DESC(created_time) to sort by creation time descending.
string
The ID of a saved custom view to apply. When provided, the saved view’s filter criteria, columns, and sort order are applied. If a filter is also provided, the filter conditions are combined (AND) with the custom view’s criteria.
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_STATUS_UPDATESRetrieve the status from a project.

Input Parameters

string
Sort by field. Accepted values: ASC(field_name) or DESC(field_name) .
integer
Specify the number of entries per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_TAGSRetrieve tags from a project.

Input Parameters

object
Enter the filter criteria.
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_TASK_CUSTOM_VIEWSRetrieve one page of task custom views configured for a project.

Input Parameters

string ("ASC(created_time)" | "DESC(created_time)" | "ASC(last_updated_time)" | "DESC(last_updated_time)")
Specify the sort order for the results. Accepted values: ASC(created_time) , DESC(created_time) , ASC(last_updated_time) , DESC(last_updated_time) .
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
view type of custom views - predefined_views|my_views|custom_views|favourite_views|default_view|i_created|shared_with_me
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_TASK_LISTSRetrieve task lists associated with a specific project.

Input Parameters

object
Enter the filter criteria.
string
Enter the sort criteria. Accepted values: ASC(field_name) or DESC(field_name)
string
Enter the custom view ID. You can obtain it from the Get Task Custom Views API (the “id” field in the response).
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_TASK_STATUS_HISTORYRetrieve one page of task status transitions across a project.

Input Parameters

integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
integer
Fetch results by last modified time

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_TEAM_FOLDERSReturn the team folders associated with a project, optionally filtered by association and available action.

Input Parameters

string ("view" | "upload")
Available Action are view , upload
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
boolean
Associated Team Folder
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_TEAMSRetrieve one page of teams and members associated with a project.

Input Parameters

string
Enter the team ID.
string
Enter the sort order. Accepted values : ASC(field_name) or DESC(field_name)
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque cursor from the previous response; omit for the first page.
string
Enter a search term to filter teams by name.
string
Enter the time to retrieve teams added to the project at or after this time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_TIME_LOGSRetrieve one page of time logs from a project.

Input Parameters

object
Enter the filter criteria to narrow down the time log results.
object
required
Enter the details of the module.
string
Enter the custom view ID. You can obtain it from the Get Task Custom Views API (the “id” field in the response).
string
Enter the end date of the time log range. Format: YYYY-MM-DD
string ("timeloggroup_draft" | "timeloggroup_update" | "timeloggroup_regenerate")
Enter the source page from which the API is called. Accepted values: timeloggroup_draft, timeloggroup_update, timeloggroup_regenerate
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string ("day" | "week" | "month" | "customdate" | "projectspan")
Enter the view type. Accepted values: day, week, month, customdate, projectspan. Use customdate for a custom date range; the difference between start_date and end_date must not exceed 6 months. When using projectspan, start_date and end_date are ignored.
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Enter the start date of the time log range. Format: YYYY-MM-DD
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
string
Enter the timelog group ID. You can obtain it from the Get Project Time Logs API (the “id” field in the response).
string ("true" | "false")
Specify whether to fetch records based on the last modified date instead of log date. Accepted values: true or false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_USER_EXPORT_HISTORYReturn one page of project user export jobs.

Input Parameters

string ("project_users" | "project_clientusers" | "project_clients" | "project_contacts" | "project_allclients")
required
Project export type to return.
integer
Exports per page (1-200).
string
required
Portal ID returned by List Portals.
string
required
Project ID returned by List Projects.
string
Continuation cursor from the previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_USER_PERMISSIONSRetrieve record-level or field-level permissions for project users.

Input Parameters

string
Module name; required for fields and bugfields.
string
Comma-separated project user IDs; required for field permissions.
string
required
Portal ID returned by List Portals.
string
required
Project ID returned by List Projects.
string
required
Record category or field category fields, bugfields, or flp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_PROJECT_USERSReturn one page of users associated with a project.

Input Parameters

string ("portal_user" | "client_user" | "client_contact")
User type to return.
object
Structured project user filter serialized as JSON for Zoho.
string
Sort expression such as ASC(first_name) or DESC(last_name).
integer
Users per page; Zoho defaults to 100.
string
required
Portal ID returned by List Portals.
string
Project user view to return.
string
required
Project ID returned by List Projects.
string
Continuation cursor from a previous response’s next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_RESOURCE_SKILLSRetrieve one page of skills associated with a portal resource.

Input Parameters

integer
Number of skills to retrieve per page.
string
required
Portal ID returned by List Portals.
string
Opaque continuation cursor returned by the previous call.
string
required
Resource ZPUID returned by List Portal Users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_ROLESRetrieve one page of roles from a portal.

Input Parameters

string
Comma-separated role IDs to return.
object
Structured role filter serialized as JSON for Zoho.
string
Sort expression using ASC(field_name) or DESC(field_name).
integer
Roles to return per page; Zoho defaults to 25.
string
required
Portal ID returned by List Portals.
string
Continuation cursor from a previous response’s next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_RUNNING_TIMERSRetrieve one page of running timers from a Zoho Projects portal.

Input Parameters

string ("all" | "generic" | "task" | "issue" | "empty")
Enter the timer type. Available timer types are all|generic|task|issue|empty
integer
Enter the number of records to retrieve.
string ("true" | "false")
Specify whether to retrieve timers of all users. Accepted values: true or false.
string
Enter the timer ID or entity ID to filter results. When provided, only the current user’s timer for that ID is retrieved.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
string ("true" | "false")
Specify whether to retrieve timers of archived projects. Accepted values: true or false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_SKILL_HISTORYRetrieve audit history for a skill, optionally continuing with a provider token.

Input Parameters

string
Pagination token from the previous response’s next_token header; valid for six hours.
string
required
Skill ID returned by List Skills.
string
required
Portal ID returned by List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_SKILL_RESOURCESRetrieve one page of resources associated with a skill.

Input Parameters

integer
Number of resources to retrieve per page.
string
required
Skill ID returned by List Skills.
string
required
Portal ID returned by List Portals.
string
Opaque continuation cursor returned by the previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_SKILLSRetrieve one page of skills configured for a Zoho Projects portal.

Input Parameters

string
JSON-encoded skill filter with optional pattern and criteria fields.
string ("ASC(created_time)" | "DESC(created_time)" | "ASC(last_updated_time)" | "DESC(last_updated_time)")
Sort order for the skills.
integer
Number of skills to retrieve per page.
string
required
Portal ID returned by List Portals.
string
Opaque continuation cursor returned by the previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_SKILL_USERSRetrieve one page of portal users associated with a skill.

Input Parameters

integer
Number of users to retrieve per page.
string
required
Skill ID returned by List Skills.
string
required
Portal ID returned by List Portals.
string
Opaque continuation cursor returned by the previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_TAGGED_PROJECTSGet associated projects for tags.

Input Parameters

integer
Page size. Zoho receives this as the inclusive end position.
array
Id’s of the tags You can obtain it from the Get Tags API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_TAGSRetrieve one page of tags from a Zoho Projects portal.

Input Parameters

object
Enter the filter criteria.
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_TASK_ASSOCIATED_BUGSGet Associated Bugs from a task.

Input Parameters

string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_TASK_ATTACHMENTSGet all attachments of a Task.

Input Parameters

string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
array
application Type
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
Identifier of the marketplace extension.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_TASK_COMMENTSRetrieve one page of comments from a task.

Input Parameters

string
Enter the sort criteria. Accepted values: ASC(field_name) or DESC(field_name)
string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_TASK_FOLLOWERSRetrieve followers for a task.

Input Parameters

string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_TASK_FORUMSRetrieve multiple forums from a task.

Input Parameters

string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
integer
Enter the number of entries to display per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_TASK_ISSUESRetrieve issues associated to a specific task.

Input Parameters

string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
integer
Specify the number of entries per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_TASK_LIST_COMMENTSRetrieve multiple comments from a task list.

Input Parameters

string
Enter the sort criteria. Accepted values: ASC(field_name) or DESC(field_name)
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
string
required
Identifier of a tasklist. Obtained from the Get Tasklists API - the “id” field in the response corresponds to tasklist_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_TASK_LIST_FOLLOWERSRetrieve the list of followers for a specific task list. Use this API to view who is monitoring updates and changes to a task list in a project.

Input Parameters

integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
string
required
Identifier of a tasklist. Obtained from the Get Tasklists API - the “id” field in the response corresponds to tasklist_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_TASK_LISTS_BY_PORTALRetrieve task lists from the Zoho Projects portal.

Input Parameters

object
Enter filter criteria.
string
Enter the sort criteria. Accepted values: ASC(field_name) or DESC(field_name)
string
Enter the custom view ID.
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_TASK_LISTS_FROM_TEMPLATERetrieves task lists that are associated with a template in the Zoho Projects portal.

Input Parameters

integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_TASKS_BY_PORTALRetrieve one page of tasks across all projects in a portal.

Input Parameters

object
Specify the filter criteria to apply to the task list.
string
Enter the sort criteria. Accepted values: ASC(field_name) or DESC(field_name). Fields you can sort by include id , name , start_date , end_date , completion_percentage , created_time , last_modified_time , created_by and is_completed .
string
Enter the custom view ID.
integer
Enter the number of entries to display per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
string
Enter the start date of the task

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_TASKS_BY_PROJECTRetrieve one page of tasks in a project.

Input Parameters

object
Specify the filter criteria to apply to the task list.
string
Enter the sort criteria. Accepted values: ASC(field_name) or DESC(field_name). Fields you can sort by include id , name , start_date , end_date , completion_percentage , created_time , last_modified_time , created_by and is_completed .
string
Enter the custom view ID. You can obtain it from the Get Task Custom Views API (the “id” field in the response).
integer
Enter the number of entries to display per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
string
Enter the start date of the task

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_TASKS_FROM_TASK_LIST_TEMPLATERetrieve tasks from a task list template.

Input Parameters

integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
string
required
Identifier of a tasklist. Obtained from the Get Tasklists API - the “id” field in the response corresponds to tasklist_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_TEAM_PROJECTSRetrieve one page of projects associated with teams in a portal.

Input Parameters

integer
Enter the number of entries to be displayed per page.
array
Enter the team IDs. You can obtain it from the Get Teams API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque cursor from the previous response; omit for the first page.
string
Enter the time to retrieve projects associated with the teams at or after this time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_TEAMSRetrieve one page of teams and their details in a portal.

Input Parameters

string
Enter the team ID.
string
Enter the sort order. Accepted values : ASC(field_name) or DESC(field_name)
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque cursor from the previous response; omit for the first page.
string
Enter a search term to filter teams by name.
string
Enter the last modified time to retrieve teams created or modified at or after this time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_TEAM_USERSRetrieve one page of users associated with teams in a portal.

Input Parameters

integer
Enter the number of entries to be displayed per page.
array
Enter the team IDs. You can obtain it from the Get Teams API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque cursor from the previous response; omit for the first page.
string
Enter the time to retrieve users added to the teams at or after this time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_TIME_LOGSRetrieve one page of time logs across a Zoho Projects portal.

Input Parameters

object
Enter the filter criteria to narrow down the time log results.
object
required
Enter the details of the module.
array
Specify the logIds You can obtain it from the Get Time Logs API (the “id” field in the response).
string
Enter the custom view ID.
string
Enter the end date of the time log range. Format: YYYY-MM-DD
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string ("day" | "week" | "month" | "customdate")
Enter the view type. Accepted values: day, week, month, customdate. Use customdate for a custom date range; the difference between start_date and end_date must not exceed 6 months.
string
Enter the start date of the time log range. Format: YYYY-MM-DD
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
string ("true" | "false")
Specify whether to fetch records based on the last modified date instead of log date. Accepted values: true or false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_TRASHED_RECORDSRetrieve one page of records in a portal’s recycle bin, optionally filtered and sorted.

Input Parameters

object
Structured filter serialized as JSON for Zoho.
string ("trashed_time" | "name")
Field used to sort trashed records.
integer
Records per page (1-200).
string
required
Portal ID returned by List Portals.
string
Continuation cursor returned by the previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_USER_PROJECTSRetrieve one page of projects associated with a portal user.

Input Parameters

string ("active" | "archived")
Project status to return.
string
required
User ID returned by List Portal Users.
integer
Projects per page (1-200).
string
required
Portal ID returned by List Portals.
string
Continuation cursor from a previous response’s next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page.
string
Text used to filter projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_USER_SKILLSRetrieve one page of skills associated with a portal user.

Input Parameters

string
required
Portal user ZPUID returned by List Portal Users.
integer
Number of skills to retrieve per page.
string
required
Portal ID returned by List Portals.
string
Opaque continuation cursor returned by the previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_USER_SUBORDINATESReturn one page of descendants in a user’s reporting hierarchy.

Input Parameters

integer
Number of hierarchy records to return; defaults to 100.
string
required
User ID returned by List Portal Users.
string
required
Portal ID returned by List Portals.
string
Continuation cursor from a previous response’s next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_USER_TEAMSRetrieve one page of teams associated with a user.

Input Parameters

string
required
User ID returned by List Portal Users.
integer
Teams per page; Zoho defaults to 50.
string
required
Portal ID returned by List Portals.
string
Continuation cursor from a previous response’s next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_WORKLOAD_GROUP_OWNERSRetrieve the list of records that belong to a specific group in the workload report. Use this API to fetch user, team, profile or role-level workload data, apply filters, and paginate through results for a specific group.

Input Parameters

object
Enter the filter criteria to narrow down results.
string
Enter the end date of the chart.
string
Enter the custom view ID.
object
required
Specify the grouping criteria for the report data.
string
required
Identifier of a group in the workload report. You can obtain it from the Get Workload Report Groups API (the “id” field in the response).
string
Enter the start date of the chart.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the project ID (Not required for global reports).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
string
Enter the search term to look up specific records.
string ("days" | "weeks" | "months")
Enter the view period.Accepted values : days , weeks , months

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_LIST_WORKLOAD_GROUPSRetrieve the groups from the workload report. When a Group By option is selected, records are organized under the selected group. Use this API to fetch these groups, apply filters, and configure the time range for global or project-specific reports.

Input Parameters

integer
Enter the index of the record.
integer
Enter the range of the record.
object
Enter the filter criteria to narrow down results.
string
Enter the end date of the chart.
string
required
Enter the custom view ID.
object
Specify the grouping criteria for the report data.
integer
Enter the number of entries to display per page.
string
Enter the start date of the chart.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the project ID (Not required for global reports).
string
Opaque continuation cursor returned by the previous call. Omit for the first page.
string
Enter the search term to look up specific records.
string ("days" | "weeks" | "months")
Enter the view period.Accepted values : days , weeks , months

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_MARK_COMMENT_AS_BEST_ANSWERMark a specific comment as the best answer in a forum. Use this API to highlight the most helpful response within a forum discussion.

Input Parameters

string
required
Identifier of a forum. Obtained from the Get Forums API - the “id” field in the response corresponds to forum_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the comment within the specified forum post. You can obtain it from the Get Comments API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_MARK_CUSTOM_VIEW_AS_FAVORITE_PROJECTMark a time log custom view as favourite in a project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of the custom view.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_MARK_VIEW_AS_FAVOURITE_PORTALMark a time log custom view as favourite across portal.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of the custom view.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_MOVE_ISSUEMove an issue to another project. Use this API to move an issue by specifying the destination project ID.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Enter the project ID to which the issue should be moved You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_MOVE_PHASEMove a phase to another project.

Input Parameters

string
required
Portal ID returned by List Portals.
string
required
Current project ID returned by List Projects.
string
Destination project ID returned by List Projects.
string
required
Milestone ID returned by a phase listing action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_MOVE_RECORDS_TO_TRASHMove records to the recycle bin while retaining the ability to restore them.

Input Parameters

array
Record IDs to move to the recycle bin (up to 100).
string ("phases" | "tasklists" | "tasks" | "issues")
required
Module containing the records: phases, tasklists, tasks, or issues.
string
required
Portal ID returned by List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_MOVE_TASKMove a task to a different task list or milestone within a project.

Input Parameters

string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
Status Mapping if status not available in the moved layout
string
Identifier of the target task list. You can obtain it from the Get Task Lists API (the “id” field in the response).
string
Identifier of the target milestone. You can obtain it from the Get Project Milestones API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_PAUSE_TIMERPause a running timer in the Zoho Projects portal. Use this API to temporarily stop a running timer without deleting the tracked time.

Input Parameters

string
Enter the module type. E.g., task,issue,general.
string
Enter the timer information.
string
Enter the log ID. You can obtain it from the Get Time Logs API (the “id” field in the response).
string
required
Identifier of a timer. Obtained from the Get Running Timers API - the “id” field in the response corresponds to timer_id.
string
Enter the entity ID
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_PIN_TIME_LOGPin a time log in the Zoho Projects Portal. Use this API to mark a time log entry as pinned for quick access in the weekly form.

Input Parameters

string
Enter the ZPUID of the user. You can obtain it from the Get Portal Users API (the “id” field in the response).
object
Enter the item to pin: its ID and its type. For a general time log, the ID is the project ID and gen_log_title is required.
integer
Enter the sequence for the pinned time logs.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
boolean
Specify whether time log is billable. Accepted values: true or false.
string
Enter the project ID. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_POST_PROJECT_STATUS_UPDATECreate a new status in a project.

Input Parameters

string ("internal" | "external")
Enter the flag type. Accepted values: internal (visible only to project users) or external (visible to both project and client users)
string
required
Enter the status content.
array
Enter the tag IDs to associate. You can obtain it from the Get Project Tags API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
Enter the IDs of the files to be uploaded. You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_REMOVE_DEFAULT_INVITATION_TEMPLATERemove an invitation email template’s default status.

Input Parameters

string
required
Portal ID returned by List Portals.
string
required
Template ID returned by List Invitation Templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_REMOVE_ISSUE_FOLLOWERSRemove followers from an issue in a project.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_REMOVE_PHASE_FOLLOWERSRemove users from a phase’s followers.

Input Parameters

array
required
Zoho Projects user IDs to remove as followers (up to 100).
string
required
Portal ID returned by List Portals.
string
required
Project ID returned by List Projects.
string
required
Milestone ID returned by a phase listing action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_REMOVE_VIEW_FROM_FAVORITES_PORTALRemove a custom view from favorites at the portal level. Use this API to unpin a view that no longer needs to be featured as a favourite across the portal.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of a customview. Obtained from the Get Custom Views (Project) API - the “id” field in the response corresponds to customview_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_REMOVE_VIEW_FROM_FAVORITES_PROJECTRemove a custom view from the favorite views for a project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of a customview. Obtained from the Get Custom Views (Project) API - the “id” field in the response corresponds to customview_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_REORDER_TASKSUpdate the order of tasks within a task list.

Input Parameters

string
Enter the ID of the task after which this task should be placed. Provide only one of before , after , or position . You can obtain it from the Get Tasks API (the “id” field in the response).
string
Enter the ID of the task before which this task should be placed. Provide only one of before , after , or position . You can obtain it from the Get Tasks API (the “id” field in the response).
string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
string ("first" | "last")
Relative placement of the task within the task list. Accepted values: first or last . Ignored if before or after is specified (those take precedence). Applies only to top-level tasks; has no effect on subtasks. If none of before , after , or position are specified, the task retains its current position.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_RESTORE_CUSTOM_MODULE_RECORDRestore the trashed record from recycle bin.

Input Parameters

string
required
Identifier of an entity. Obtained from the Get Entities API - the “id” field in the response corresponds to entity_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_RESTORE_MODULERestore a module from trash.

Input Parameters

string
required
Deleted module ID in the recycle bin.
string
required
Unique portal ID from List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_RESTORE_PROJECTRestore a project from the trash.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_RESTORE_RECORDS_FROM_TRASHRestore selected records from the recycle bin within the retention period.

Input Parameters

array
Record IDs to restore (up to 100).
string ("phases" | "tasklists" | "tasks" | "issues")
required
Module containing the records: phases, tasklists, tasks, or issues.
string
required
Portal ID returned by List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_RESUME_TIMERResume a paused timer in the Zoho Projects portal. Use this API to continue tracking time on a previously paused timer.

Input Parameters

string
Enter the module type. E.g., task,issue,general.
string
Enter the timer information.
string
Enter the log ID. You can obtain it from the Get Time Logs API (the “id” field in the response).
string
required
Identifier of a timer. Obtained from the Get Running Timers API - the “id” field in the response corresponds to timer_id.
string
Enter the entity ID
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_REVOKE_PROFILE_ACCESSRevoke record-level or field-level actions from a profile.

Input Parameters

string
required
Module whose permissions are revoked.
array
required
Actions to revoke.
string
Field ID; required for field-level access.
string
required
Portal ID returned by List Portals.
string
required
Profile ID returned by List Profiles.
string
required
Record category or field category fields, bugfields, or flp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_SCHEDULE_DATA_BACKUPSchedule generation of a downloadable portal backup, or return an existing backup generated within the last 24 hours.

Input Parameters

string
required
Portal ID returned by List Portals.
string
Optional password used to secure the downloaded backup file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_SEARCH_PORTALRetrieve search results from the Zoho Projects portal.

Input Parameters

string
required
Enter the module name. Accepted values for default modules: all , projects , milestones , tasklists , tasks , bugs , forums , events , status . For custom modules, enter the API name of the custom module. You can obtain it from the Get Modules API .
string ("all" | "active" | "archived" | "template")
required
Specify the module status. Accepted values: all , active , archived , template
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call.
string
required
Enter the search term.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_SEARCH_PROJECTRetrieve search results from a project

Input Parameters

string
required
Enter the module name. Accepted values for default modules: all , milestones , tasklists , tasks , bugs , forums , events , status . For custom modules, enter the API name of the custom module. You can obtain it from the Get Modules API .
integer
Enter the number of entries to be displayed per page.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Opaque continuation cursor returned by the previous call.
string
required
Enter the search term.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_SEND_TIMER_NOTIFICATIONSend the documented timer notification to affected Zoho Projects users.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Provider-documented notification for value.
string
Provider-documented notification action value.
string
Provider-documented notification content value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_SET_CUSTOM_VIEW_AS_DEFAULT_PORTALSet a time log custom view as the default view across the portal.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of the custom view.
string
Set/Remove this view as default for all users in portal/project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_SET_CUSTOM_VIEW_AS_DEFAULT_PROJECTSet a time log custom view as the default view in a project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of the custom view.
string
Set/Remove this view as default for all users in portal/project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_SET_DEFAULT_BUSINESS_HOURSSet default business hours in the Zoho Projects portal.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of a business hour. Obtained from the Get Business Hours API - the “id” field in the response corresponds to business-hour_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_SET_DEFAULT_INVITATION_TEMPLATESet an invitation email template as the portal default.

Input Parameters

string
required
Portal ID returned by List Portals.
string
required
Template ID returned by List Invitation Templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_SET_DEFAULT_PROFILESet a profile as the portal default.

Input Parameters

string
required
Portal ID returned by List Portals.
string
required
Profile ID returned by List Profiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_SET_DEFAULT_ROLESet a role as the portal default.

Input Parameters

string
required
Role ID returned by List Roles.
string
required
Portal ID returned by List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_SET_DEFAULT_VIEW_PORTALSet a custom view as the default view at the portal level. Use this API to define which view is displayed by default when users access tasks across the portal.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of a customview. Obtained from the Get Custom Views (Project) API - the “id” field in the response corresponds to customview_id.
string
Set/Remove this view as default for all users in portal/project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_SET_DEFAULT_VIEW_PROJECTSet a custom task view as the default view for a project. Use this API to define which view is displayed by default when users access tasks within a specific project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of a customview. Obtained from the Get Custom Views (Project) API - the “id” field in the response corresponds to customview_id.
string
Set/Remove this view as default for all users in portal/project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_SET_FAVORITE_VIEW_PROJECTSet a custom view as a favourite for a project. Use this API to pin frequently used views for quicker access within a specific project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of a customview. Obtained from the Get Custom Views (Project) API - the “id” field in the response corresponds to customview_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_SET_FAVOURITE_VIEW_PORTALSet a custom view as a favourite at the portal level. Use this API to pin frequently used views for quicker access across the portal.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of a customview. Obtained from the Get Custom Views (Project) API - the “id” field in the response corresponds to customview_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_SET_PROJECT_PRIMARY_CUSTOMERModify the primary customer for a project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of a primary client. You can obtain it from the Get Customers API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_SET_RESOURCE_SKILLSAssociate or dissociate skills for a portal resource.

Input Parameters

array
Skills to associate.
array
Skills to dissociate.
string
required
Portal ID returned by List Portals.
string
required
Resource ZPUID returned by List Portal Users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_SET_USER_SKILLSAssociate or dissociate skills for a portal user.

Input Parameters

array
Skills to associate.
array
Skills to dissociate.
string
required
Portal user ZPUID returned by List Portal Users.
string
required
Portal ID returned by List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_START_TIMERStart a new timer for a module.

Input Parameters

string
Enter the ID of the entity to start a timer for
string
Specify the module ID You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the project ID You can obtain it from the Get Projects API (the “id” field in the response).
string ("tasks" | "bugs")
Enter the module name of the entity. Accepted values: tasks, bugs. Not required if module_id is provided or for a generic timer.
string ("true" | "false")
Specify whether to check for existing timers. Accepted values: true or false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_STOP_TIMERStop a running timer in the Zoho Projects portal. Additional fields such as item_id, type, log_name and project_id are required when stopping a generic timer to associate the log with a project.

Input Parameters

string
Enter the date to add log. If not specified, the value is automatically set based on timer created time.
string ("task" | "issue" | "general")
Enter the log type. Accepted values: task, issue, and general.
string
Enter the log hours. If not specified, the value is automatically set based on total time spent.
string
Enter the additional information for the log
string
Enter the log ID You can obtain it from the Get Time Logs API (the “id” field in the response).
string
Enter the ID of the work item to be associated with the time log.
string
Enter the ZPUID of the approver. If not specified, the value is automatically set based approval configuration. You can obtain it from the Get Portal Users API (the “id” field in the response).
string
Enter the end time. If not specified, the value is automatically set based on stop api initiation time.
string
Enter the log name
string
required
Identifier of a timer. Obtained from the Get Running Timers API - the “id” field in the response corresponds to timer_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the project ID You can obtain it from the Get Projects API (the “id” field in the response).
string
Enter the start time. If not specified, the value is automatically set based on timer created time.
string ("Billable" | "Non Billable")
Specify the billing status of the time log. Accepted values: Billable, Non Billable. If not specified, the value is automatically set based on the billing configuration of the associated project.
object
Provider-documented force allow value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_TRASH_CUSTOM_MODULE_RECORDMove a record to recycle bin within Zoho Projects portal.

Input Parameters

string
required
Identifier of an entity. Obtained from the Get Entities API - the “id” field in the response corresponds to entity_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_TRASH_MODULEMove a module to trash.

Input Parameters

string
required
Module ID from List Modules.
string
required
Unique portal ID from List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_TRASH_PHASEMove a phase to the project recycle bin.

Input Parameters

string
required
Phase ID returned by List Project Phases.
string
required
Portal ID returned by List Portals.
string
required
Project ID returned by List Projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_TRASH_PROJECTMove a project to the trash.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UNFOLLOW_CUSTOM_MODULE_RECORDRemove a follower from the record.

Input Parameters

string
required
Identifier of an entity. Obtained from the Get Entities API - the “id” field in the response corresponds to entity_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UNFOLLOW_FORUMUnfollow a specific forum in a project to stop receiving notifications. Use this API to unsubscribe a user from forum updates within a project.

Input Parameters

string
required
Identifier of a forum. Obtained from the Get Forums API - the “id” field in the response corresponds to forum_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UNFOLLOW_ISSUERemove followers from an issue in a project.

Input Parameters

string
required
Identifier of an issue. Obtained from the Get Issues API - the “id” field in the response corresponds to issue_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
Enter the follower IDs. You can obtain it from the Get Project Users API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UNFOLLOW_TASKAPI to unfollow a given task.

Input Parameters

string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UNFOLLOW_TASK_LISTUnfollow a task list to stop receiving its notifications. Use this API to unsubscribe a user from activity updates on a specific task list within a project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of a tasklist. Obtained from the Get Tasklists API - the “id” field in the response corresponds to tasklist_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UNMARK_COMMENT_AS_BEST_ANSWERRemove the best answer designation from a specific comment in a forum. Use this API to unmark a comment that was previously marked as the best answer in a forum discussion.

Input Parameters

string
required
Identifier of a forum. Obtained from the Get Forums API - the “id” field in the response corresponds to forum_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the comment within the specified forum post. You can obtain it from the Get Comments API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UNMARK_VIEW_AS_FAVOURITE_PORTALUnmark a time log custom view as favourite across portal.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of the custom view.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UNMARK_VIEW_AS_FAVOURITE_PROJECTUnmark a time log custom view as favourite in a project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of the custom view.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UNPIN_TIME_LOG_ENTRYRemove a pinned time log from the Zoho Projects portal.

Input Parameters

string
required
Identifier of a pin. Obtained from the Get Pins API - the “id” field in the response corresponds to pin_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_BUG_RESOLUTION_V3Replace a bug resolution with the V3 PUT bug_id contract. This variant supports V3 custom-field and WorkDrive thirdparty_id inputs and returns no content; use Update Issue Resolution (V3.1 PATCH) for the V3.1 contract.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
string
Enter the value for a character-type custom field. The field name must follow the UDF_NCHAR naming convention.
string
Enter the user ID for a user-type custom field. The field name must follow the UDF_NUSER naming convention. You can obtain it from the Get Project Users API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the status ID. You can obtain it from the Get Global Statuses API .
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Enter the updated resolution details for this issue.
array
Enter the WorkDrive resource IDs of the files to associate. The WorkDrive resource ID is different from the attachment ID in Zoho Projects. Up to 50 IDs can be passed in a single request. To retrieve the resource ID, refer to the ( WorkDrive Upload Large File API ). Users without upload permission to the folder or team folder can upload files up to 20 MB only.
array
Enter the IDs of attachments to include with the updated resolution. Maximum 100 attachments allowed. You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_BUSINESS_HOURSModify the work hours by archiving the business hours and creating a new one in the Zoho Projects portal.

Input Parameters

string
required
Enter the business hours’ ID.
string
Enter the business hours’ name.
object
Enter the holiday list details to associate.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
array
Enter the work hour details.
string ("all_day" | "same_hours" | "different_hours")
Enter the work hours type. Accepted values : all_day , same_hours , different_hours

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_BUSINESS_HOUR_USERSAssociate/disassociate user from the business hours.

Input Parameters

array
Enter the user IDs to associate.
array
Enter the user details to dissociate.
array
Enter the user IDs to dissociate.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of a business hour. Obtained from the Get Business Hours API - the “id” field in the response corresponds to business-hour_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_CATEGORYUpdate a forum category in a specific project. Use this API to modify the name of an existing forum category within a project.

Input Parameters

string
required
Enter the name of the category
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of a category. Obtained from the Get Categories API - the “id” field in the response corresponds to category_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_CONTACTUpdate a contact in the Zoho Projects portal.

Input Parameters

string
Enter the email ID.
array
Enter the project IDs. You can obtain it from the Get Projects API (the “id” field in the response).
string
Enter the last name.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of a contact. Obtained from the Get Contacts API - the “id” field in the response corresponds to contact_id.
string
Enter the first name.
boolean
Specify whether to select all projects. Accepted values: true or false.
string
Enter the invoice rate of the user. E.g. $30 per hour.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_CURRENCYUpdate an existing currency configured for the Zoho Projects portal. Use this API to modify the currency code, symbol, format, or exchange rate. Only the fields included in the request are modified.

Input Parameters

string ("###,##0" | "###.##0" | "### ##0" | "#,##,##0" | "###,##0.00" | "###.##0,00" | "### ##0,00" | "#,##,##0.00" | "###,##0.000" | "###.##0,000" | "### ##0,000" | "#,##,##0.000")
required
Enter the display format for the currency amount. Accepted values: No decimals: ###,##0, ###.##0, ### ##0, or #,##,##0 2 decimals: ###,##0.00, ###.##0,00, ### ##0,00, or #,##,##0.00 3 decimals: ###,##0.000, ###.##0,000, ### ##0,000, or #,##,##0.000
string
Enter the display symbol for the currency. For example, $, €, or AED.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Enter the currency ID. You can obtain it from the Get Currency Setting (the “id” field in the response in currency list).
string
Enter the currency code. For example, USD, EUR, or AED.
number
Enter the exchange rate relative to the base currency. For example, 3.67 means 1 base unit equals 3.67 of this currency.
string ("0" | "2" | "3")
required
Enter the number of decimal places for the currency. Accepted values: 0, 2, or 3.
string ("1" | "2")
Enter the conversion type to determine how the exchange rate is updated. Accepted values: 1 (manual) or 2 (live).
boolean
Specify whether to set this as the base currency. Accepted values: true or false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_CUSTOM_DOMAIN_STATUSUpdate the custom domain status. Enable the domain after SSL verification or disable the active domain mapping. When disabled, the portal will be accessible using the default Zoho Projects domain.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
boolean
required
Provider-documented is enabled value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_CUSTOMERModify customer details in the Zoho Projects portal.

Input Parameters

string
Enter the city.
string
Enter the customer name.
string
Enter the state.
string
Enter the country.
string
Enter the ZIP code.
string
required
Identifier of a client. Obtained from the Get Clients API - the “id” field in the response corresponds to client_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the web address.
string
Enter address line 1.
integer ("1" | "2")
Enter the customer type. Accepted values: 1 (Business), 2 (Individual).
string
Enter address line 2.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_CUSTOMER_PROJECTSModify the projects associated with customer in the Zoho Projects portal.

Input Parameters

object
Enter selected project details.
string
required
Identifier of a client. Obtained from the Get Clients API - the “id” field in the response corresponds to client_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
boolean
Specify whether to select all projects. Accepted values: true or false.
object
Enter unselected project details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_CUSTOM_MODULE_EXPORTEvery field is replaced by the value sent, so pass the complete configuration rather than only the keys that changed.

Input Parameters

object
Enter the custom view details.
object
Enter the filter criteria for the export.
string
required
Identifier of a record export. Obtained from the Get Portal Exports API - the “id” field in the response corresponds to export_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the project ID to scope the export to a single project. Omit it to export across the portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Enter the access code. It protects the exported file and must be at least 6 characters.
string ("csv" | "xlsx" | "pdf")
required
Enter the export file format. Accepted values: csv, xlsx, or pdf
string ("active" | "archived" | "both")
Enter the project type. Accepted values : active, archived, or both
object
Enter the schedule details for the export. Pass this to create a recurring export instead of a one-time one.
array
Specify the fields to include in the export. Pass the API name of each field.
boolean
Specify whether the scheduled export is active or inactive. Accepted values : true or false
boolean
Specify whether to include export details. Accepted values : true or false
boolean
Specify whether to export all project items in a single sheet. Accepted values : true or false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_CUSTOM_MODULE_EXPORT_STATUSToggle a portal-level Custom Module scheduled export on or off. Switching it off suspends the schedule without deleting the export, so it can be resumed later.

Input Parameters

string ("on" | "off")
required
Enter the status. Accepted values : on or off
string
required
Identifier of a record export. Obtained from the Get Portal Exports API - the “id” field in the response corresponds to export_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the project ID to retrieve its export form metadata. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_CUSTOM_MODULE_IMPORTModify the details of an import operation.

Input Parameters

string ("file_uploaded" | "scheduled" | "sheet_selected" | "field_mapped" | "users_mapped" | "status_mapped" | "layout_mapped" | "import_scheduled")
Enter the progress. Accepted values : file_uploaded, scheduled, sheet_selected, field_mapped, users_mapped, status_mapped, layout_mapped, import_scheduled
string
required
Identifier of an import job. Obtained from the Initiate Import API - the “id” field in the response corresponds to import_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
object
Enter the extra data.
object
Enter the sheet information.
string
Enter the date format.
array
Enter the user mapping details.
array
Enter the field mapping details.
array
Enter the layout mapping details.
array
Enter the status mapping details.
boolean
Specify if the invalid records should be rejected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_CUSTOM_MODULE_RECORDModify details of an existing record. Use this API to modify fields such as name, status, layout, or other record properties.

Input Parameters

string
Enter the record name.
object
Enter the record layout.
object
Enter the status details of the record. To get the status ID, use the Get Global Statuses API .
object
Enter the project details of the entity.
string
required
Identifier of an entity. Obtained from the Get Entities API - the “id” field in the response corresponds to entity_id.
boolean
Specify whether the record is closed. Accepted values : true or false
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the record description.
boolean
Specify whether the record is external. Accepted values : true or false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_CUSTOM_MODULE_RECORD_COMMENTModify details of an existing comment in a record. Use this API to modify comment content or associated attachments.

Input Parameters

string
required
Enter the comment.
string
required
Identifier of an entity. Obtained from the Get Entities API - the “id” field in the response corresponds to entity_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the comment within the specified record. You can obtain it from the Get All Comments API (the “id” field in the response).
array
Enter the attachment details.
array
Enter the WorkDrive resource IDs of the files to associate. The WorkDrive resource ID is different from the attachment ID in Zoho Projects. Up to 50 IDs can be passed in a single request. To retrieve the resource ID, refer to the ( WorkDrive Upload Large File API ). Users without upload permission to the folder or team folder can upload files up to 20 MB only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_CUSTOM_MODULE_RECORD_FOLLOWERSAdd multiple followers to a custom-module record.

Input Parameters

string
required
Identifier of an entity. Obtained from the Get Entities API - the “id” field in the response corresponds to entity_id.
string
required
Identifier of the module. You can obtain it from the Get Modules API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
array
required
Users to add as followers. Zoho requires this collection as the complete top-level JSON request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_DEFAULT_APPROVERModify the default time log approver of the user in a project.

Input Parameters

string
Enter the ZPUID of the user. You can obtain it from the Get Project Users API (the “id” field in the response).
string
Enter the ZPUID of the approver. You can obtain it from the Get Project Users API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_DEFAULT_VIEWMark a custom view as the default view for a project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
boolean
Pass the value as true or false.
string
required
Identifier of a customview. Obtained from the Get Custom View List API - the “id” field in the response corresponds to customview_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_DEPENDENCYModify the dependency between tasks in a project.

Input Parameters

object
Enter the lag details to apply between the predecessor and successor tasks.
Specify the dependency link type. Accepted values: 0 for Hard Link, 1 for Soft Link
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
object
required
Enter the details of the successor task.
string ("FS" | "FF" | "SF" | "SS" | "AutoSet")
Specify the type of dependency between the tasks. Accepted values: FS , FF , SF , SS , AutoSet
object
required
Enter the details of the predecessor task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_EVENTUpdate details of an event in the Zoho Projects portal.

Input Parameters

string
Specify the new title for the event.
string
Enter the end date and time in the ISO8601 format.
string
required
Identifier of an event. Obtained from the Get Project Events API - the “id” field in the response corresponds to event_id.
string
Specify the new Location for the event.
array
Specify the updated list of attendees for the event.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the start date and time in the ISO8601 format.
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Specify the reminder duration before the event.
array
Enter the WorkDrive resource IDs of the files to associate. The WorkDrive resource ID is different from the attachment ID in Zoho Projects. Up to 50 IDs can be passed in a single request. To retrieve the resource ID, refer to the ( WorkDrive Upload Large File API ). Users without upload permission to the folder or team folder can upload files up to 20 MB only.
array
Enter the IDs of the attachments to associate with the event. You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).
integer
Specify the new recurrence count for the event.
string
Specify the recurrence frequency of the event.Available recurrence types : only once, every day, every week, every month, every year.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_EVENT_COMMENTUpdate an existing comment associated with an event in a project within the Zoho Projects portal.

Input Parameters

string
required
Content for the event comment.
string
required
Identifier of an event. Obtained from the Get Project Events API - the “id” field in the response corresponds to event_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the comment within the specified event. You can obtain it from the Get Event Comments API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
Enter the WorkDrive resource IDs of the files to associate. The WorkDrive resource ID is different from the attachment ID in Zoho Projects. Up to 50 IDs can be passed in a single request. To retrieve the resource ID, refer to the ( WorkDrive Upload Large File API ). Users without upload permission to the folder or team folder can upload files up to 20 MB only.
array
Array of attachment IDs associated with the comment. You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_EXTENSION_PROPERTYModify the entity or app property in an extension.

Input Parameters

string
required
Enter the property ID.
string ("entity" | "app")
required
Enter the property type. Accepted values: entity or app.
integer
Enter the number of occurrences.
string
required
Enter the new value.
object
Enter the entity details if the type is entity.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of an extension. Obtained from the Get Extension Configuration API - the “id” field in the response corresponds to extension_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_FAVORITE_VIEWMark a custom view as a favorite view for a project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
boolean
Pass the value as true or false.
string
required
Identifier of a customview. Obtained from the Get Custom View List API - the “id” field in the response corresponds to customview_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_FIELD_OPTIONSRename or reorder existing options for a field.

Input Parameters

string
required
Field ID from Get Custom Module Fields.
array
Role options to update.
array
User options to update.
string
required
Module API name or ID from List Modules.
object
Updated option position.
array
Status options to update.
string
Layout ID from List Layouts.
string
required
Unique portal ID from List Portals.
array
Custom options to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_FORUMUpdate a forum in a specific project. Use this API to modify the details of an existing forum within a project.

Input Parameters

string ("internal" | "external")
Mark the forum as internal (visible only to project users) or external (visible to both project and client users) Accepted values: internal , external
array
Enter the tags to add to the forum post
string ("normal" | "question")
Enter the forum type Accepted values: normal , question
string
Enter the forum title
string
Enter the forum content
string
required
Identifier of a forum. Obtained from the Get Forums API - the “id” field in the response corresponds to forum_id.
boolean
Specify whether to mark the post as sticky Accepted values: true , false
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Enter the project category ID You can obtain it from the Get Forum Categories API (the “id” field in the response).
array
Enter the WorkDrive resource IDs of the files to associate. The WorkDrive resource ID is different from the attachment ID in Zoho Projects. Up to 50 IDs can be passed in a single request. To retrieve the resource ID, refer to the ( WorkDrive Upload Large File API ). Users without upload permission to the folder or team folder can upload files up to 20 MB only.
array
Enter the attachment IDs You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).
boolean
Specify whether to mark the post as announcement Accepted values: true , false
array
Enter the attachment IDs to remove You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_FORUM_COMMENTUpdate a comment in a specific forum in a project. Use this API to modify the content of an existing comment within a forum.

Input Parameters

string
required
Enter the updated content of the comment.
string
required
Identifier of a forum. Obtained from the Get Forums API - the “id” field in the response corresponds to forum_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the comment within the specified forum post. You can obtain it from the Get Comments API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
Enter the WorkDrive resource IDs of the files to associate. The WorkDrive resource ID is different from the attachment ID in Zoho Projects. Up to 50 IDs can be passed in a single request. To retrieve the resource ID, refer to the ( WorkDrive Upload Large File API ). Users without upload permission to the folder or team folder can upload files up to 20 MB only.
array
Enter the attachment IDs You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).
array
Enter the attachment IDs to remove You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_HOLIDAY_LISTModify the details of an holiday list in the Zoho Projects portal.

Input Parameters

string
required
Enter the holiday list name.
object
Specify the holidays in the list.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of a holiday list. Obtained from the Get Holiday List API - the “id” field in the response corresponds to holiday-list_id.
object
Enter the business hours’ details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_INVITATION_TEMPLATEModify a portal invitation email template.

Input Parameters

string
Updated template name.
string
Updated email content.
string
Updated email subject.
string
required
Portal ID returned by List Portals.
boolean
Whether this is the default template.
string ("Users" | "Clients")
Module that uses the template.
string
required
Template ID returned by List Invitation Templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_ISSUEModify an issue in a project. Use this API to modify issue details such as status, assignee, or fields.

Input Parameters

string ("Internal" | "External")
Specify the flag type of the issue. Accepted values: Internal or External
string
Enter the name of the issue
array
Update the tags associated with this issue. Use add to attach new tags or remove to detach existing ones.
object
Specify the module of the issue
object
Enter the status of the issue
object
Specify the assignee of the issue
string
Enter the updated due date for the issue in ISO 8601 format. Example: 2025-12-31T00:00:00+05:30
string
required
Identifier of an issue. Obtained from the Get Issues API - the “id” field in the response corresponds to issue_id.
object
Specify the severity of the issue
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Enter the description of the issue
number
Enter the updated billing rate per hour for the assignee working on this issue.
object
Specify the classification of the issue
object
Specify the team associated with the issue
object
Specify the Release Milestone of the issue
object
Specify the Affected Milestone of the issue
number
Enter the cost per hour for the assignee working on this issue.
object
Specify if the issue is reproducible

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_ISSUE_COMMENTUpdate a comment on an issue.

Input Parameters

string
required
Identifier of a bug. Obtained from the Get Bugs API - the “id” field in the response corresponds to bug_id.
string
required
Enter the comment content
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the comment within the specified issue. You can obtain it from the Get Comments API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
Enter the ZUIDs of the users to notify about this comment update. Maximum 100 users allowed.
array
Enter the WorkDrive resource IDs of the files to associate. The WorkDrive resource ID is different from the attachment ID in Zoho Projects. Up to 50 IDs can be passed in a single request. To retrieve the resource ID, refer to the ( WorkDrive Upload Large File API ). Users without upload permission to the folder or team folder can upload files up to 20 MB only.
array
Enter IDs of the attachments to be associated You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).
string
Enter IDs of the SalesIO chat to be associated This identifier is owned by Zoho SalesIQ; obtain it from the Zoho SalesIQ API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_ISSUE_RESOLUTION_V3_1Update an issue resolution with the V3.1 PATCH issue_id contract and return the updated resolution list. Use Update Bug Resolution (V3 PUT) for V3 custom-field or WorkDrive thirdparty_id inputs.

Input Parameters

string
required
Identifier of an issue. Obtained from the Get Issues API - the “id” field in the response corresponds to issue_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the status ID. You can obtain it from the Get Global Statuses API .
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Enter the resolution content.
array
Enter the attachment IDs. You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_LAYOUTModify an existing layout.

Input Parameters

string
required
Updated layout name.
string
Updated layout type.
string
required
Module API name or ID from List Modules.
string
required
Layout ID from List Layouts.
string
required
Unique portal ID from List Portals.
array
Entities to associate with the layout.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_LEAVEUpdate the leave details in the Zoho Projects portal.

Input Parameters

string
required
Enter the Leave type. A maximum of 100 characters can be added.
object
required
Enter the ZPUID of the user in JSONObject.
string
Enter the reason for the leave. A maximum of 250 characters can be added.
string
required
Enter the end date of the leave. E.g. 2024-07-02T10:00:00Z
string
required
Identifier of a leave. Obtained from the Get Leave API - the “id” field in the response corresponds to leave_id.
string
required
Enter the start date of the leave. E.g. 2024-07-02T10:00:00Z
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the reference ID. A maximum of 250 characters can be added.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_MODULEModify a custom module’s configuration.

Input Parameters

string
required
Module ID from List Modules.
string
required
Unique portal ID from List Portals.
string
Module icon class.
string
Plural module display name.
string
Singular module display name.
boolean
Whether the module appears in all projects.
object
Custom module properties to update.
boolean
Whether the module appears in overview.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_PHASEUpdate a phase’s name, owner, status, dates, tags, position, template settings, or budget details.

Input Parameters

string ("Internal" | "External")
Whether the phase is internal or external.
string
Updated phase name.
array
Tag IDs to associate with the phase.
string
Hex color for the phase’s Gantt bar.
object
Updated phase owner.
object
Updated phase status.
string
End date in YYYY-MM-DD format.
string
required
Phase ID returned by List Project Phases.
object
Updated placement of the phase.
string
required
Portal ID returned by List Portals.
string
required
Project ID returned by List Projects.
string
Start date in YYYY-MM-DD format.
object
Phase budget details when budgeting is enabled.
string
Completion date in YYYY-MM-DD format, accepted for a closed status.
object
Settings used when the project is a template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_PHASE_COMMENTUpdate a phase comment and its optional notifications or attachments.

Input Parameters

array
Project user IDs to notify (up to 100).
string
required
Updated comment content.
string
required
Portal ID returned by List Portals.
string
required
Comment ID returned by List Phase Comments.
string
required
Project ID returned by List Projects.
string
required
Milestone ID returned by a phase listing action.
array
WorkDrive resource IDs to associate (up to 49).
array
Zoho Projects attachment IDs to associate (up to 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_PORTAL_BUDGET_SETTINGSUpdate the budget settings configured for the Zoho Projects portal. Use this API to enable or disable budget tracking, configure EVM settings, set the default currency, and manage profile permissions.

Input Parameters

array
required
Specify the profiles to grant access to the project budget.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string ("atypical" | "typical")
required
Enter the EVM Estimate at Completion (EAC) calculation type. Accepted values: atypical or typical.
string ("24" | "12" | "6" | "3" | "1")
required
Enter the interval hour to auto-update the budget. Accepted values: 24, 12, 6, 3, or 1.
string ("weekly" | "monthly")
required
Enter the EVM chart view type. Accepted values: weekly or monthly.
boolean
required
Specify whether to enable Earned Value Management (EVM) for the portal. Accepted values: true or false.
string
Enter the default currency code. For example, USD or EUR.
boolean
required
Specify whether to enable budget tracking for the portal. Accepted values: true or false.
boolean
required
Specify whether to enable budget threshold alerts. Accepted values: true or false.
boolean
required
Specify whether to enable budget overrun alerts. Accepted values: true or false.
boolean
required
Specify whether to enable revenue budget tracking. Accepted values: true or false.
boolean
required
Specify whether to include non-billable hours in budget calculations. Accepted values: true or false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_PORTAL_DATE_TIME_SETTINGSUpdate date and time settings for the portal.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Date format
string
Date format
string
First Day of the week with Monday starting as 1 and Sunday ending as 7 matching with java.time.DayOfWeek
string
First week of year that includes - 1 for first day of the year, 2 for first Thursday, 3 for first full week

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_PORTAL_USERModify a portal user’s profile, role, reporting line, projects, rates, or skills.

Input Parameters

object
Role to assign.
object
Portal rate changes.
boolean
Whether to notify the user.
array
Skill associations to add or remove.
string
required
User ZPUID or email address.
string
required
Portal ID returned by List Portals.
object
Reporting manager to assign.
object
Bulk project assignment and rate changes.
object
Business hours to assign.
object
Portal profile to assign.
boolean
Whether the portal rate applies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_PROFILEUpdate a profile in a portal.

Input Parameters

string
required
Updated profile name.
string
required
Portal ID returned by List Portals.
boolean
Whether to make this the default profile.
string
required
Profile ID returned by List Profiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_PROJECTModify details of an existing project.

Input Parameters

string
Enter the Project name.
array
Enter the tags for the project.
string
Enter the color of the project.
object
Enter the project owner.
object
Enter the project layout details.
object
Enter the status of the project.
string
Enter the end date of the project (YYYY-MM-DD).
string ("web" | "api")
Enter the source from which the project is added. Accepted values : web , api
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Enter the start date of the project (YYYY-MM-DD).
object
Enter the project budget details.
string
Enter the project description.
string ("active" | "template" | "archived")
Enter the project type. Accepted values : active , template , archived
object
Custom field values keyed by each field’s snake_case API name from the module field metadata. Values must match that field’s documented type.
object
Enter the project group details
string
Enter the completed time of the project
string
Enter the business hours ID. You can obtain it from the Get Business Hours API (the “id” field in the response).
boolean
Specify whether the project is public. Accepted values : true or false
boolean
Specify whether the project is rollup project. Accepted values : true or false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_PROJECT_COMMENTModify an existing comment. Use this API to modify content or replace attachments.

Input Parameters

string
required
Enter the comment
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the comment within the specified project. You can obtain it from the Get Comments API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
Enter the WorkDrive resource IDs of the files to associate. The WorkDrive resource ID is different from the attachment ID in Zoho Projects. Up to 50 IDs can be passed in a single request. To retrieve the resource ID, refer to the ( WorkDrive Upload Large File API ). Users without upload permission to the folder or team folder can upload files up to 20 MB only.
array
Specify the attachment Id’s. You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).
array
Specify the ID of the deleted attachment. You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_PROJECT_EXPORTModify the details of an existing project export in the Zoho Projects portal.

Input Parameters

object
Enter the custom view details
object
Enter the filter criteria for the export
string ("users" | "date" | "client" | "project")
Enter the grouping criteria. Accepted values : users , date , client , project
string
required
Identifier of a project export. Obtained from the Get Project Exports Details API - the “id” field in the response corresponds to export_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
object
Enter the extension configuration details.
string
Enter the access cod
string ("csv" | "xlsx")
required
Enter the export file format. Accepted values: csv , xlsx
string ("active" | "archived" | "both")
Enter the project type. Accepted values : active , archived , both
object
Enter the schedule details for the export
array
Specify mandatory fields to include in the export.
array
Specify the fields to include in the export
boolean
Specify whether the scheduled export is active or inactive
boolean
Specify whether to include export details. Accepted values: true or false.
boolean
Specify whether export extension is enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_PROJECT_FOLDER_DETAILSModify folder settings in a project.

Input Parameters

string
required
Identifier of a folder. Obtained from the Get Folders Details API - the “id” field in the response corresponds to folder_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
required
Enter the permission details for the folder.To get the default folder permission, use the Get Project Team Folder Details

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_PROJECT_GROUPUpdate details of a project group.

Input Parameters

string
Enter the project group name.
string ("public" | "private")
Enter the project group type. Accepted values: public or private.
string
Enter a prefix of the project group.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Identifier of a project group. Obtained from the Get User’s Project Groups API - the “id” field in the response corresponds to project-group_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_PROJECT_TEAM_FOLDER_DETAILSModify the settings of a team folder in a project.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of a teamfolder. Obtained from the Get Project Team Folder Details API - the “id” field in the response corresponds to teamfolder_id.
array
required
Enter the permission details for the team folder.To get the default team folder permission, use the Get Project Team Folder Details

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_PROJECT_USER_DETAILSModify a user’s rates or profile within a project.

Input Parameters

string
User invoice rate, such as $30 per hour.
string
required
User ZPUID, ZUID, or email address.
string
User cost rate, such as $15 per hour.
string
required
Portal ID returned by List Portals.
string
Project profile ID to assign.
string
required
Project ID returned by List Projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_PROJECT_USER_PERMISSIONSGrant or revoke project permissions for a user.

Input Parameters

string ("records" | "others" | "portal" | "settings" | "integrations" | "fields" | "custom")
required
Permission category.
string
required
Module whose permissions are changed.
array
required
Actions to grant or revoke.
string
required
Project user ID returned by List Project Users.
string
Field ID for a field-level permission.
string
required
Operation such as grant or revoke.
string
required
Portal ID returned by List Portals.
string
required
Project ID returned by List Projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_RESOURCE_SKILL_LEVELUpdate one resource’s proficiency level for a skill.

Input Parameters

string ("beginner" | "intermediate" | "advanced")
required
New resource proficiency level.
string
required
Skill ID returned by List Skills.
string
required
Portal ID returned by List Portals.
string
required
Resource ZPUID returned by List Portal Users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_ROLEUpdate a role in a portal.

Input Parameters

string
required
Updated role name.
string
required
Role ID returned by List Roles.
integer
Updated sequence number.
string
required
Portal ID returned by List Portals.
boolean
Whether to make this the default role.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_SKILLUpdate a skill’s name or description.

Input Parameters

string
New unique skill name.
string
required
Skill ID returned by List Skills.
string
required
Portal ID returned by List Portals.
string
New skill description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_SKILL_RESOURCESAssociate or dissociate resources for a skill.

Input Parameters

array
Resources to associate.
array
Resources to dissociate.
string
required
Skill ID returned by List Skills.
string
required
Portal ID returned by List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_SKILL_SETTINGSEnable or disable the skill feature for a Zoho Projects portal.

Input Parameters

string
required
Portal ID returned by List Portals.
boolean
required
Whether the portal skill feature should be enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_SKILL_USERSAssociate or dissociate portal users for a skill.

Input Parameters

array
Users to associate.
array
Users to dissociate.
string
required
Skill ID returned by List Skills.
string
required
Portal ID returned by List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_STATUSActivate or deactivate a module.

Input Parameters

string ("activate" | "deactivate")
required
Status operation to apply.
string
required
Module ID from List Modules.
string
required
Unique portal ID from List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_TAGUpdate a tag in the Zoho Projects portal.

Input Parameters

string
Enter the tag ID.
string
Enter the tag name.
object
Enter the tag information.
string
required
Identifier of a tag. Obtained from the Get Tags API - the “id” field in the response corresponds to tag_id.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
Enter the color code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_TASKModify details of the task in a project.

Input Parameters

string
Enter the task name
array
Enter the tags for the task
string
Enter the color of the task.
array
Add or remove teams associated with the task
object
Enter the task status details if not provided default open will be taken
string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
object
Enter the duration of the task
string
Enter the end date of the task in ISO 8601 format. Use yyyy-MM-dd’T’HH:mm:ss’Z’ for UTC or yyyy-MM-dd’T’HH:mm:ss[+|-]HH:mm for other time zones.
string ("none" | "low" | "medium" | "high")
Enter the task priority Possible values are none , low , medium , high
object
Enter the Reminder details of the task
object
Enter the task list details. Uses the general task list when task list details are not provided; the project must have a general task list or an exception is thrown. To create one, use the Create Default Task List
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
object
Enter the recurrence details for the task. To remove recurrence from the task, pass an empty object.
string
Enter the start date of the task in ISO 8601 format. Use yyyy-MM-dd’T’HH:mm:ss’Z’ for UTC or yyyy-MM-dd’T’HH:mm:ss[+|-]HH:mm for other time zones.
array
Enter the IDs of files to be uploaded You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).
object
Enter the Budget details of the task
string
Enter the task description
string ("none" | "billable" | "non_billable")
Enter the billing type for the task Possible values are none , billable , non_billable
object
Custom field values keyed by each field’s snake_case API name from the module field metadata. Values must match that field’s documented type.
object
Enter parent task details if sub task is need to be created
array
Enter the WorkDrive resource IDs of the files to associate. The WorkDrive resource ID is different from the attachment ID in Zoho Projects. You can pass up to 50 IDs. To get the thirdPartyId, refer to the WorkDrive API User who does not have upload permission to the folder/team folder can upload file upto 20 MB only.
object
Enter the task owner name and work details
integer
Enter the task completion percentage
boolean
Specify whether to forcefully remove the lag from task dependencies. Accepted values: true , false .

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_TASK_COMMENTModify a comment in a task.

Input Parameters

string
required
Enter the comment.
string
required
Unique, immutable identifier of the task within the specified project. You can obtain it from the Get Tasks API (the “id” field in the response).
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the comment within the specified task. You can obtain it from the Get Comments API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
Enter the attachment IDs. You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).
array
Enter the WorkDrive resource IDs of the files to associate. The WorkDrive resource ID is different from the attachment ID in Zoho Projects. Up to 50 IDs can be passed in a single request. This identifier is owned by Zoho WorkDrive; obtain it from the Zoho WorkDrive API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_TASK_LISTModify details of the task list in a project.

Input Parameters

string
Specify the visibility of the task list. Accepted values: internal (hidden from client users) or external (visible to client users).
string
Enter the task list name.
array
Update the tags associated with this task list. Use add to attach new tags or remove to detach existing ones.
string
Enter the color of the tasklist.
string ("active" | "completed")
Specify the status of the task list. Accepted values: active or completed .
object
Specify the milestone to associate with this task list. Enter the milestone ID.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of a tasklist. Obtained from the Get Tasklists API - the “id” field in the response corresponds to tasklist_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_TASK_LIST_COMMENTModify a comment in a task list.

Input Parameters

string
required
Enter the comment.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the comment within the specified task. You can obtain it from the Get Multiple Comments API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
array
Enter the attachment IDs. You can obtain it from the Get Project Attachments API (the “attachment_id” field in the response).
string
required
Identifier of a tasklist. Obtained from the Get Tasklists API - the “id” field in the response corresponds to tasklist_id.
array
Enter the WorkDrive resource IDs of the files to associate. The WorkDrive resource ID is different from the attachment ID in Zoho Projects. Up to 50 IDs can be passed in a single request. To retrieve the resource ID, refer to the ( WorkDrive Upload Large File API ). Users without upload permission to the folder or team folder can upload files up to 20 MB only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_TEAMModify the details of a specific team in a portal. Use this API to modify the name, members, or other details of an existing team.

Input Parameters

string
ZPUID of the team lead.
string
Team name.
string
Team email address.
boolean
Whether to notify affected users.
string
required
Identifier of a team. Obtained from the Get Project Teams API - the “id” field in the response corresponds to team_id.
object
Portal-user IDs to add to or remove from the team.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
object
Project IDs to associate with or dissociate from the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_TIME_LOGModify the time log in a project.

Input Parameters

string
Enter the date to update the log.
string
Enter the log hours.
string
Enter the additional information for the log.
string
required
Identifier of a log. Obtained from the Get Project Time Logs API - the “id” field in the response corresponds to log_id.
object
required
Enter the details of the module.
string
Enter the ZPUID of the approver. You can obtain it from the Get Project Users API (the “id” field in the response).
string
Enter the end time of the time log. Accepted values: 12-hour (with AM/PM), 12-hour (without AM/PM), or 24-hour formats. Example: 11:59 PM
string ("true" | "false")
Specify whether the time log is saved as a draft. Accepted values: true or false
string
Enter the log name.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
object
Enter additional time entry details to log alongside the main entry.
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
Enter the start time of the time log. Accepted values: 12-hour (with AM/PM), 12-hour (without AM/PM), or 24-hour formats. Example: 11:59 PM
string ("Billable" | "Non Billable")
Enter the billing status of the time log. Accepted values: Billable, Non Billable
string
Enter the ZPUID of the owner. You can obtain it from the Get Project Users API (the “id” field in the response).
object
Enter the details of the custom fields.
string ("Approved" | "Unapproved" | "Rejected")
Enter the approval status of the time log. Accepted values: Approved, Unapproved, Rejected
number
Enter the Cost Per Hour.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_TIME_LOG_PINUpdate an existing pinned entry in the time logs for a portal. Use this API to modify the details of a pinned time log entry in the weekly form.

Input Parameters

string
Enter the ZPUID of the user. You can obtain it from the Get Portal Users API (the “id” field in the response).
object
Enter the item to pin: its ID and its type. For a general time log, the ID is the project ID and gen_log_title is required.
string
required
Identifier of a pin. Obtained from the Get Pins API - the “id” field in the response corresponds to pin_id.
integer
Enter the sequence for the pinned time logs.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
boolean
Specify whether time log is billable. Accepted values: true or false.
string
Enter the project ID. You can obtain it from the Get Projects API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_TIME_LOG_SETTINGSModify the time log settings of a project.

Input Parameters

object
Timelog Approval Settings
object
Enter the reminder settings for time logging.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
object
Allowed IP Addresses as JSON Object
object
Enter the period restriction settings for time logging.
boolean
Specify whether to enable draft mode for timesheets. Accepted values: true or false
string ("owners" | "everyone" | "teams")
Time Log User Restriction! Available Inputs are : owners , everyone , teams
object
Enter the restriction settings for time logs.
object
Log Hour Limit for Daily and Weekly
string ("allow" | "warn" | "restrict")
Time Log Overlap Restriction! Available Inputs are : allow , warn , restrict
boolean
Specify whether to restrict time logging based on IP address. Accepted values: true or false
boolean
Specify whether to restrict time logging based on task work hours. Accepted values: true or false
object
Enter the configuration settings for time logs.
boolean
Specify whether to restrict time logging based on task or issue start and end dates. Accepted values: true or false
boolean
Specify whether to restrict running multiple timers simultaneously. Accepted values: true or false
boolean
Specify whether to restrict time logging for closed tasks and issues. Accepted values: true or false
array
Restricted Profile IDs as JSON Array for timer
boolean
Specify whether to restrict time logging based on task completion percentage. Accepted values: true or false
object
Restriction Based on Project Status
boolean
Specify whether to allow time logging for unassigned tasks and issues. Accepted values: true or false
boolean
Specify whether to restrict time logging based on Zoho People check-in and check-out time. Accepted values: true or false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_TIMER_NOTES_BY_LOG_IDModify the notes for a timer associated with a specific time log entry in a project.

Input Parameters

integer
Enter the position order of the notes. E.g. 1, 2, 3.
string ("task" | "issue")
required
Work-item type used by the provider route.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the “id” field in the response).
string
required
Identifier of the timesheet (timelog group).
string
Enter the timer information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPDATE_USER_SKILL_LEVELUpdate one portal user’s proficiency level for a skill.

Input Parameters

string ("beginner" | "intermediate" | "advanced")
required
New user proficiency level.
string
required
Portal user ZPUID returned by List Portal Users.
string
required
Skill ID returned by List Skills.
string
required
Portal ID returned by List Portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPLOAD_AND_ASSOCIATE_FILESUpload one file and associate it with a record in Zoho Projects.

Input Parameters

string
required
Enter the record ID.
string
Enter the folder ID. You can obtain it from the Get Project Team Folder Details API (the “workdrive_folder_id” field in the response) or the Get Folders API .
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
required
Enter the module name. Accepted values. Available entities: project_comment , statuses , status_comment , milestone_comment , tasklist_comment , task , task_comment , bug , bug_resolution , bug_comment , event , event_comment , forum , forum_comment , announcement_comment , zoho_meeting_comment . For custom modules, use the Get List of Modules API with the filter is_customized = ‘true’ and use the returned api_name value as the entity_type. For comments under a custom module, use the format ‘api_name’_cm_comment .
object
required
File to upload and associate. Zoho permits 1 to 10 files per request; this action sends one file per invocation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPLOAD_GLOBAL_ATTACHMENTSUpload one file at portal level and store it in a project folder.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
string
JSON array containing optional attachment metadata.
object
required
File to upload. Zoho permits up to 10 files per request; this action sends one file per invocation.
string
JSON array of document IDs associated with the upload.
string
JSON object containing storage_type and location_details for the upload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPLOAD_INLINE_COMMENT_ATTACHMENTUpload one image for display within comment content.

Input Parameters

object
Image file to upload for use inline in a comment.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPLOAD_PDF_LOGOUpload the logo file used in task Gantt PDF exports.

Input Parameters

string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
Provider-documented uploadlogo value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_UPSERT_CUSTOM_WORKLOAD_REPORTCreate or Update a custom workload report in the Zoho projects portal.

Input Parameters

string
Enter the view ID (Required for update).
string
Enter the name of the custom workload report.
string
required
Enter the module name.
object
Specify the project details to associate with the report.
array
Specify the grouping details for the report.
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).
object
Specify the filter criteria configuration for the report.
string
Enter the description of the report.
object
Specify the view period configuration for the report.
array
Specify the list of users to share the report with.
array
Specify the list of projects to share the report with.
string ("only_to_me" | "public" | "shared" | "internal")
Specify the access type for the report view.Accepted values : only_to_me , public , shared , internal
object
Specify the display preferences for the report.
string ("all_projects" | "specific_project" | "selected_projects")
Specify the project access type.Accepted values : all_projects , specific_project , selected_projects
boolean
Specify whether this report is globally accessible.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PROJECTS_VALIDATE_CUSTOM_DOMAINValidate custom domain configuration.

Input Parameters

string
required
Enter the custom domain name to validate
string
required
Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the “id” field in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not