API v1 ReferenceProjects

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>

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.
newStartDatedatetime or nullOptional

New start date for setdates.

newDueDatedatetime or nullOptional

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

okobject
notFoundobject
unauthorizedobject
badRequestobject

Errors

400
Bad Request Error
401
Unauthorized Error