Create an estimate

POST/api/v1/workspaces/{slug}/projects/{project_id}/estimates/

Create a new estimate for the project.

Path Parameters

project_id:requiredstring

Project ID

slug:requiredstring

Workspace slug

Body Parameters

name:requiredstring

Name of the estimate.

description:optionalstring

Description of the estimate.

type:optionalstring

Type of estimate. Possible values: categories, points, time.

last_used:optionalboolean

Whether this estimate is the most recently used estimate for the project.

external_id:optionalstring

External ID from an external system.

external_source:optionalstring

External source identifier.

Scopes

projects.estimates:write

Create an estimate

curl -X POST \
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/estimates/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Story Points",
    "description": "Standard story point scale",
    "type": "points"
  }'

import requests

response = requests.post(
    "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/estimates/",
    headers={"X-API-Key": "your-api-key"},
    json={
        "name": "Story Points",
        "description": "Standard story point scale",
        "type": "points",
    },
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/estimates/",
  {
    method: "POST",
    headers: {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      name: "Story Points",
      description: "Standard story point scale",
      type: "points",
    }),
  }
);
const data = await response.json();

Response201

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T12:10:00Z",
  "name": "Story Points",
  "description": "Standard story point scale",
  "type": "points",
  "last_used": true,
  "external_id": null,
  "external_source": null,
  "created_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "project": "4af68566-94a4-4eb3-94aa-50dc9427067b",
  "workspace": "cd4ab5a2-1a5f-4516-a6c6-8da1a9fa5be4"
}