projects

Applies an operation to selected projects.

Changed on

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. <Check title="Required Permissions" icon="key">The user must have write permission for all projects and related entities modified by the operation.</Check>

post/projects/batch/{operation}

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/projects/batch/{operation}
  • Auth: HTTP bearer

Path parameters

operationstring required

Batch operation route key.

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

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id PostProjectsBatchByOperation removed and replaced with projects_PostProjectsBatchByOperation