Update a sprint

PATCHhttps://<your-url>/api/v2/sprints/{sprint}

MCP id sprints.updateAlso on this path: GET Read a sprint, DELETE Delete a sprint

Partially updates a sprint's name, description or planned dates: absent keys are untouched, an empty body is rejected.

Token scope: api:write:project_management
Without it: 403 insufficient-token-scope.
Permission: project_management::manage_sprints
Without it: 403 insufficient-permission.
Rate cost: 1 unit, write bucket. A write costs the same whatever view you ask for.
Also: Accepts If-Match. Never cached: private, no-store. Unknown body keys are refused, never dropped.

Both are checked, scope first. A token never does more than its user. How access is checked

Request

Example: Rename a sprint and shift its planned end

curl -X PATCH \
  'https://<your-url>/api/v2/sprints/1' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'If-Match: *' \
  -d '{
    "name": "Sprint 14: invoicing",
    "end_date": "2026-03-20"
  }'

const response = await fetch('https://<your-url>/api/v2/sprints/1', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'If-Match': '*',
  },
  body: JSON.stringify({
    "name": "Sprint 14: invoicing",
    "end_date": "2026-03-20"
  }),
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->withHeader('If-Match', '*')
    ->patch('https://<your-url>/api/v2/sprints/1', [
        'name' => 'Sprint 14: invoicing',
        'end_date' => '2026-03-20',
    ]);

import requests
response = requests.request(
    'PATCH',
    'https://<your-url>/api/v2/sprints/1',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json', 'Content-Type': 'application/json', 'If-Match': '*'},
    json={'name': 'Sprint 14: invoicing', 'end_date': '2026-03-20'},
)

Response

The shape of the response, with sample values.

{
  "data": {
    "id": 1,
    "project_id": 1,
    "name": "Sprint 14: invoicing",
    "description": "Finish the invoicing export.",
    "start_date": "2026-03-02",
    "end_date": "2026-03-20",
    "started_at": "2026-03-04T09:15:00Z",
    "completed_at": "2026-03-04T09:15:00Z",
    "is_active": false,
    "order": 1,
    "work_items_count": 1,
    "created_at": "2026-03-04T09:15:00Z"
  }
}

{
  "type": "https://developers.plnnrly.com/api/v2/problems/precondition-failed",
  "title": "Precondition failed",
  "status": 412,
  "detail": "The record changed since the version named in If-Match. Re-read it and retry.",
  "instance": "/api/v2/work-items/812",
  "request_id": "01K4B7Q9YV3PZ2N8T1E6M0XR4S",
  "current_version": 12
}

{
  "type": "https://developers.plnnrly.com/api/v2/problems/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "3 fields failed validation.",
  "instance": "/api/v2/worklogs",
  "request_id": "01K4B7Q9YV3PZ2N8T1E6M0XR4S",
  "errors": [
    {
      "pointer": "/date",
      "code": "date_format",
      "detail": "The date does not match the format Y-m-d."
    },
    {
      "pointer": "/minutes",
      "code": "min",
      "detail": "The minutes must be at least 1."
    },
    {
      "pointer": "/description",
      "code": "required",
      "detail": "The description field is required."
    }
  ]
}

3 more fields, listed under Response

project_id is not accepted: a sprint cannot be moved between projects, because its work items and its order position are both scoped to the project it was created on. Neither are order, is_active, started_at or completed_at: the first is read-only and the other three belong to the start and complete actions. ⚠ end_date is checked against start_date only when both are sent, so a PATCH carrying an end_date earlier than the stored start_date succeeds; send the pair together if you need the ordering enforced. Send If-Match with the ETag from your last read to detect a concurrent edit, which answers 412. Treat it as best-effort only: this resource carries no concurrency token, and updated_at is second-precision, so two writes inside the same second are indistinguishable.

Path parameters

sprintintegerRequired

The Sprint's numeric id.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

viewstring

Which field set to render.

summarydetaildefault

Request headers

X-Request-Idstringpattern

A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.

If-Matchstring

The ETag a write is conditional on. A stale validator is 412 precondition-failed.

Request body

Unknown keys are refused with 422, naming the key.

namestring≤ 255

Sprint name as shown in plnnrly, e.g. Sprint 14.

descriptionstring or null

Free-text sprint goal. Plain text, not markup.

start_datedate (YYYY-MM-DD) or null

Planned first day of the sprint. Independent of started_at: planning a date does not start the sprint.

end_datedate (YYYY-MM-DD) or null

Planned last day of the sprint. Independent of completed_at.

Must be on or after start_date.

Response 200

Returns a Sprint in the detail view.

Headers

ETag: A strong validator of exactly this representation.
RateLimit: The IETF httpapi-ratelimit-headers form of your remaining allowance on the tightest bucket this request touched.
RateLimit-Policy: The ceiling and window of that bucket, as <limit>;w=<seconds>.
X-Request-Id: The server-generated ULID correlating this response with our logs.

Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning