> This page is for Developer Documentation.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.benchling.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.benchling.com/_mcp/server.

# Create ProcedureRunPlan

POST https://{tenant_name}.benchling.com/api/v3/procedure-run-plan
Content-Type: application/json

Create a draft recipe or assay run plan (procedure run plan) within a study.
## Required fields
| Field | Description |
| --- | --- |
| `description` | Human-readable description of the plan |
| `studyId` | ID of the parent study (`stdy_XXXXXXXX`). Use `GET /benchling/study/items` to list studies. |
## Optional fields
| Field | Default | Description |
| --- | --- | --- |
| `dataEntryMode` | `INDIVIDUAL_CONDITION_REPLICATES` | Controls worksheet creation upon promotion |
| `workflowFlowchartConfigVersionId` | `null` | Optional ID of the workflow flowchart config version (`wffccv_XXXXXXXX`) defining the procedure structure |
| `confirmationMethodByParamVersionId` | Confirmation method overrides per parameter (omit or pass `[]` for no overrides) |
## Notes
- The **creator** is automatically set to the authenticated user.
- `description` must not exceed 255 characters.
- The study must be of a type that supports run plans (e.g., recipe or assay run studies). Assay development studies reject `ALL_CONDITION_REPLICATES_TOGETHER` mode.
- After creating the plan, add conditions using the Create ProcedureRunPlanCondition endpoint.
- When the plan is ready, promote it to an active run using the Promote endpoint.

Reference: https://docs.benchling.com/docs/api/benchling-api/procedure-run-plan/create

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Headers

- `EARLY-ACCESS` (string, optional) — Set to true to access beta operations via /api/v3.

### Body (application/json)

This endpoint expects a CreateProcedureRunPlanInput.

- `description` (string, required) — A human-readable description of the run plan. Must not exceed 255 characters.
- `studyId` (string, required) — The ID of the study this run plan belongs to. Format: `stdy_XXXXXXXX`.
- `confirmationMethodByParamVersionId` (list of ConfirmationMethodByParamVersionIdInput, optional) — Override the default confirmation method for specific procedure parameters. Each entry maps a parameter version ID to a confirmation method (TABLE or PLATE_MAP). Omit or pass an empty array to use the default confirmation methods.
- `dataEntryMode` (enum, optional) — Controls how data entry worksheets are created upon promotion. `INDIVIDUAL_CONDITION_REPLICATES` creates one worksheet per condition-replicate. `ALL_CONDITION_REPLICATES_TOGETHER` creates a single shared worksheet (not supported for assay run plans). Defaults to `INDIVIDUAL_CONDITION_REPLICATES` if omitted.
  - Allowed values: `INDIVIDUAL_CONDITION_REPLICATES`, `ALL_CONDITION_REPLICATES_TOGETHER`
- `workflowFlowchartConfigVersionId` (string, optional, nullable) — The ID of the workflow flowchart config version that defines the procedure template for this run plan. Format: `wffccv_XXXXXXXX`. Omit or set to null to create a run plan with no linked procedure.

## Response

### 201

Created

- `__typename` (string, optional)
- `confirmationMethodByParamVersionId` (list of ConfirmationMethodByParamVersionId, optional)
- `createdAt` (string, optional)
- `creator` (PrincipalRef, optional)
- `dataEntryMode` (enum, optional)
  - Allowed values: `INDIVIDUAL_CONDITION_REPLICATES`, `ALL_CONDITION_REPLICATES_TOGETHER`
- `description` (string, optional)
- `id` (string, optional)
- `modifiedAt` (string, optional)
- `procedureFlowchartConfigVersion` (ProcedureFlowchartConfigVersionRef, optional, nullable)
- `procedureRun` (ProcedureRunRef, optional, nullable)
- `procedureRunPlanConditions` (string, optional)
- `study` (StudyRef, optional)

## Errors

### 400 Procedure Run Plan Create Request Bad Request Error

Bad Request

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 403 Procedure Run Plan Create Request Forbidden Error

Forbidden

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 404 Procedure Run Plan Create Request Not Found Error

Not Found

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 409 Procedure Run Plan Create Request Conflict Error

Conflict

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 429 Procedure Run Plan Create Request Too Many Requests Error

Too Many Requests

- `detail` (TooManyRequestsErrorBodyDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)
- `violated-policies` (list of enum, optional) — The budget policies that rejected the request, in canonical order: `user`, `integration`, then `tenant`.
  - Allowed values: `user`, `integration`, `tenant`

### 500 Procedure Run Plan Create Request Internal Server Error

Internal Server Error

- `detail` (InternalServerErrorBodyDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `errorId` (string, optional)

## Types

### ConfirmationMethodByParamVersionIdInput

- `confirmationMethod` (enum, required)
  - Allowed values: `TABLE`, `PLATE_MAP`
- `paramVersionId` (string, required)

### ConfirmationMethodByParamVersionId

Associates a procedure parameter version with its confirmation method, keyed by the parameter version ID. Used in `ProcedureRunPlan` to look up how a specific version of a parameter's values should be confirmed—either via TABLE (structured table entry) or PLATE_MAP (plate-based layout).

- `__typename` (string, optional)
- `confirmationMethod` (enum, optional)
  - Allowed values: `TABLE`, `PLATE_MAP`
- `paramVersionId` (string, optional)

### PrincipalRef

- `__typename` (string, optional)
- `id` (string, optional)

### ProcedureFlowchartConfigVersionRef

- `__typename` (string, optional)
- `id` (string, optional)

### ProcedureRunRef

- `__typename` (string, optional)
- `id` (string, optional)

### StudyRef

- `__typename` (string, optional)
- `id` (string, optional)

### GeneralErrorDetail

### TooManyRequestsErrorBodyDetail

### InternalServerErrorBodyDetail

## Examples

**Request**

```json
{
  "description": "Dose-response run plan",
  "studyId": "stdy_9CYiCggY",
  "confirmationMethodByParamVersionId": [
    {
      "confirmationMethod": "TABLE",
      "paramVersionId": "schver_Rm4nTvWz"
    }
  ],
  "dataEntryMode": "INDIVIDUAL_CONDITION_REPLICATES",
  "workflowFlowchartConfigVersionId": "wffccv_Lk3mQpXn"
}
```

**Response**

```json
{
  "__typename": "__typename",
  "confirmationMethodByParamVersionId": [
    {
      "__typename": "__typename",
      "confirmationMethod": "TABLE",
      "paramVersionId": "paramVersionId"
    }
  ],
  "createdAt": "createdAt",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "dataEntryMode": "INDIVIDUAL_CONDITION_REPLICATES",
  "description": "description",
  "id": "id",
  "modifiedAt": "modifiedAt",
  "procedureFlowchartConfigVersion": {
    "__typename": "__typename",
    "id": "id"
  },
  "procedureRun": {
    "__typename": "__typename",
    "id": "id"
  },
  "procedureRunPlanConditions": "procedureRunPlanConditions",
  "study": {
    "__typename": "__typename",
    "id": "id"
  }
}
```

**SDK Code**

```python
import requests

url = "https://{tenant_name}.benchling.com/api/v3/procedure-run-plan"

payload = {
    "description": "Dose-response run plan",
    "studyId": "stdy_9CYiCggY",
    "confirmationMethodByParamVersionId": [
        {
            "confirmationMethod": "TABLE",
            "paramVersionId": "schver_Rm4nTvWz"
        }
    ],
    "dataEntryMode": "INDIVIDUAL_CONDITION_REPLICATES",
    "workflowFlowchartConfigVersionId": "wffccv_Lk3mQpXn"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://{tenant_name}.benchling.com/api/v3/procedure-run-plan';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"description":"Dose-response run plan","studyId":"stdy_9CYiCggY","confirmationMethodByParamVersionId":[{"confirmationMethod":"TABLE","paramVersionId":"schver_Rm4nTvWz"}],"dataEntryMode":"INDIVIDUAL_CONDITION_REPLICATES","workflowFlowchartConfigVersionId":"wffccv_Lk3mQpXn"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```