Project milestones

Bulk action on project milestones

Perform a bulk action on multiple project milestones at once. The action may run in the background for large selections.

post/project_milestones/bulk_action

Request

  • Base URL: https://api.pipelinecrm.com/api/v3
  • URL: https://api.pipelinecrm.com/api/v3/project_milestones/bulk_action
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer and API key in header app-key
    • API key in query parameter api_key and API key in query parameter app_key

Request body

bulk_action'delete' required

The bulk action to perform

checked_idsinteger[] required

IDs of the milestones to apply the action to

argsobject

Optional. Free-form arguments for actions that need parameters beyond the IDs (e.g. assigning a status). When omitted, the contents of the project_milestone body key are used as the args instead.

project_milestoneobject

Optional. Acts as a fallback for args — the controller uses params[:args] || params[:project_milestone] so clients may supply action arguments under either key.

calendar_taskobject

Optional. Used by actions that create or attach a calendar task to the targeted milestones (e.g. bulk-add-task). Pass the task attributes here as a hash.

Example request

{
  "bulk_action": "delete",
  "checked_ids": [
    1,
    2,
    3
  ]
}

Response

Successful Response

backgroundboolean

Whether the bulk action is running in the background

Changes

No recorded changes to this operation across all 1 revision of this API.