---
title: "Trigger Planning for a Plan"
method: POST
path: "/orders/plans/{plan_id}/trigger"
tags: ["Orders"]
---

# Trigger Planning for a Plan

`POST /orders/plans/{plan_id}/trigger`

## Request

- Base URL: `https://v3.api.hypertrack.com`
- URL: `https://v3.api.hypertrack.com/orders/plans/{plan_id}/trigger`
- Auth: one of:
  - HTTP basic
  - HTTP bearer
- TypeScript: <https://skmtc.dev/hypertrack/apis/hypertrack-api/docs/orders/plans/:plan_id/trigger/post.ts> (a function with typed inputs; its response is checked against the schema)

API to Trigger Planning for a plan

## Path parameters

- `plan_id` string, required

## Request body

- TriggerPlanningRequest
  - `orders` OrderWithHandleInput[], nullable: List of orders to plan
    - `order_handle` string, required: Unique customer provided identifier for an order
  - `plan_mode` 'scheduled' | 'on_demand' | 'null', nullable: Mode of planning to be used to plan orders
  - `profile_filter` object, nullable: Optional filter on worker profile metadata. When provided, only workers whose profile matches the given key/values are considered for planning (cohort planning).

## Response `200`

Successful response

- PlanOrdersResponse
  - `message` string, nullable: Message on the status of planning. Provided if the request does not have plan_mode as `manual`
  - `plan` union: Information about asynchronous planning of the orders provided
    - Plan
      - `id` string, required: Unique identifier for the plan
      - `href` string, required: Endpoint path to use to get the latest plan status
    - unknown

## Other responses

- `400`: Validation error
- `401`: Authentication error
- `404`: Not found

---

[API](https://skmtc.dev/hypertrack/apis/hypertrack-api.md) - [All operations](https://skmtc.dev/hypertrack/apis/hypertrack-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hypertrack/apis/hypertrack-api/revisions/389326c4c9c8?raw)