Sign in

v1

latestOpenAPI 3.1.02026-08-066984441.1 MB
projects

Edits multiple projects using the specified operation.

Returns MultiStatus including the list of successful and failed projects.

         Supported operations:
         <ul>
<li>changeprojectstatus: changes the status of all selected projects.</li> <li>changeprojecttype: changes the type of all selected projects.</li> <li>linkworkflow: links a workflow to all selected projects.</li> <li>setclient: sets the client for all selected projects.</li> <li>setprojectlead: changes the responsible project member for all selected projects.</li> <li>addteams: adds teams to all selected projects.</li> <li>removeteams: removes teams from all selected projects.</li> <li>setdates: sets or removes project start and due dates.</li> <li>adjustdates: offsets project start and due dates by the specified amount of days.</li> <li>addtags: adds tags to all selected projects.</li> <li>removetags: removes tags from all selected projects.</li> <li>delete: deletes all selected projects.</li> </ul><Check title="Required Permissions" icon="key">The user must have `write` permissions on all projects as well as related entities modified by the operation.</Check>
post/projects/batch/{operation}

Path parameters

operationstring required

Batch operation route key.

Headers

Authorizationstring required

Bearer authentication

Request body

projectIdsstring[] required

Project ids affected by the batch operation.

projectStatusIdstring uuid nullable

Target project status for changeprojectstatus.

projectTypeIdstring uuid nullable

Target project type for changeprojecttype.

workflowIdstring uuid nullable

Workflow to link for linkworkflow.

keepCustomFieldsboolean nullable

Whether custom fields should be kept when linking a workflow.

keepCustomAutomationsboolean nullable

Whether custom automations should be kept when linking a workflow.

companyIdstring uuid nullable

Company to assign for setclient.

responsibleUserIdstring uuid nullable

Responsible user to assign for setprojectlead.

teamIdsstring[] nullable

Team ids to add or remove for team batch operations.

newStartDatestring date-time nullable

New start date for setdates.

newDueDatestring date-time nullable

New due date for setdates.

removeStartDateboolean nullable

Whether the start date should be removed for setdates.

removeDueDateboolean nullable

Whether the due date should be removed for setdates.

daysOffsetnumber double nullable

Day offset for adjustdates.

deleteTimeTrackingsboolean nullable

Whether related time trackings should be deleted for delete.

Response

Multi-Status