Skip to navigation
API v1 ReferenceProjects

Applies an operation to selected projects.

Applies the selected operation to each project and returns successful and failed results. Supported operations include changing status or type, linking workflows, updating clients, leads, dates, teams, and tags, and deleting projects.
Required Permissions
The user must have write permission for all projects and related entities modified by the operation.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

operationstringRequired
Batch operation route key.

Request

Validated request body for the selected operation.
projectIdslist of stringsRequired
Project ids affected by the batch operation.
projectStatusIdstring or nullOptionalformat: "uuid"

Target project status for changeprojectstatus.

projectTypeIdstring or nullOptionalformat: "uuid"

Target project type for changeprojecttype.

workflowIdstring or nullOptionalformat: "uuid"

Workflow to link for linkworkflow.

projectStatusMappinglist of objects or nullOptional
Project status mappings used when linking a workflow.
taskStatusMappinglist of objects or nullOptional
Task status mappings used when linking a workflow.
keepCustomFieldsboolean or nullOptional
Whether custom fields should be kept when linking a workflow.
keepCustomAutomationsboolean or nullOptional
Whether custom automations should be kept when linking a workflow.
companyIdstring or nullOptionalformat: "uuid"

Company to assign for setclient.

responsibleUserIdstring or nullOptionalformat: "uuid"

Responsible user to assign for setprojectlead.

teamIdslist of strings or nullOptional
Team ids to add or remove for team batch operations.
newStartDatestring or nullOptionalformat: "date-time"

New start date for setdates.

newDueDatestring or nullOptionalformat: "date-time"

New due date for setdates.

removeStartDateboolean or nullOptional

Whether the start date should be removed for setdates.

removeDueDateboolean or nullOptional

Whether the due date should be removed for setdates.

daysOffsetdouble or nullOptional

Day offset for adjustdates.

tagslist of objects or nullOptional

Tags to add for addtags.

tagsToRemovelist of objects or nullOptional

Tags to remove for removetags.

deleteTimeTrackingsboolean or nullOptional

Whether related time trackings should be deleted for delete.

Response

Multi-Status

okobjectOptional
notFoundobjectOptional
unauthorizedobjectOptional
badRequestobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error