Update an event

PATCHhttps://<your-url>/api/v2/events/{event}

MCP id events.updateAlso on this path: GET Read an event, DELETE Delete an event

Partially updates an event: absent keys are untouched, an empty body is rejected. ⚠ On a recurring master this edits the whole series (every occurrence moves), where plnnrly would have asked "this occurrence / this and following / all".

Token scope: api:write:events
Without it: 403 insufficient-token-scope.
Permission: events::manage_self
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: Move an event an hour later

curl -X PATCH \
  'https://<your-url>/api/v2/events/1' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'If-Match: *' \
  -d '{
    "start": "2026-03-03T10:00:00Z",
    "end": "2026-03-03T11:30:00Z"
  }'

const response = await fetch('https://<your-url>/api/v2/events/1', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'If-Match': '*',
  },
  body: JSON.stringify({
    "start": "2026-03-03T10:00:00Z",
    "end": "2026-03-03T11:30:00Z"
  }),
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->withHeader('If-Match', '*')
    ->patch('https://<your-url>/api/v2/events/1', [
        'start' => '2026-03-03T10:00:00Z',
        'end' => '2026-03-03T11:30:00Z',
    ]);

import requests
response = requests.request(
    'PATCH',
    'https://<your-url>/api/v2/events/1',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json', 'Content-Type': 'application/json', 'If-Match': '*'},
    json={'start': '2026-03-03T10:00:00Z', 'end': '2026-03-03T11:30:00Z'},
)

Response

The shape of the response, with sample values.

{
  "data": {
    "id": 1,
    "user_id": 1,
    "task_id": 1,
    "parent_event_id": 1,
    "occurrence_date": "2026-03-04",
    "start": "2026-03-03T10:00:00Z",
    "end": "2026-03-03T11:30:00Z",
    "title": "Design review",
    "description": "<p>…</p>",
    "is_all_day": false,
    "is_recurring": false,
    "recurrence_interval": 1
  }
}

{
  "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."
    }
  ]
}

11 more fields, listed under Response

There is no per-occurrence write surface in this version: parent_event_id and occurrence_date are server-assigned. start, end and the two recurrence instants are stored exactly as sent, with no timezone conversion. Send task_id: null to unlink the task, which also stops time being logged on the event; setting a task additionally requires that the task be selectable by the event's owner, not merely by you, so re-pointing a colleague's event at your own task is refused. Note: end is only checked against start when both are sent in the same request, so sending end alone can leave it before the stored start; an event in that state measures zero planned minutes everywhere it is read. Changing the @-mentions in the description notifies the people newly mentioned. 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

eventintegerRequired

The Event's numeric id. Accepts a soft-deleted record.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

viewstring

Which field set to render.

summarydetaildefault

trashedstring

Whether soft-deleted rows are included.

withoutdefaultwithonly

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.

titlestring≤ 255

Event title, as shown on the calendar tile.

starttimestamp (YYYY-MM-DDThh:mm:ssZ)

When the event starts. RFC 3339 UTC.

Must be after -5 years.

endtimestamp (YYYY-MM-DDThh:mm:ssZ)

When the event ends. RFC 3339 UTC.

Must be on or after start. Must be before +5 years.

is_all_dayboolean

Whether the event occupies whole days rather than a time range. An all-day event is measured against the owner's working week rather than against start and end.

descriptionstring or null

Free-text description, authored in the rich editor. HTML, sanitised on the way in and on the way out; @-mention spans are preserved, and changing them is what notifies the people mentioned.

task_idinteger or null → Task.id

Kanban task this event is planned against, or null for a plain calendar block. Only an event with a task can have time logged on it.

is_recurringboolean

Whether this row is the master of a recurring series. When true, the recurrence fields describe how occurrences are generated.

recurrence_intervalinteger or null≥ 1

How many frequency units pass between occurrences: 2 with a weekly frequency is every other week.

recurrence_frequencystring or null

The unit the series repeats in.

day: Repeats every recurrence_interval days.
week: Repeats every recurrence_interval weeks, on the weekdays named in selected_weekdays.
month: Repeats every recurrence_interval months, positioned by recurrence_pattern.
year: Repeats every recurrence_interval years, positioned by recurrence_pattern.

New values may be added.

recurrence_patternstring or null

How a monthly or yearly series positions its occurrence within the month. Ignored for a daily or weekly frequency.

day_of_month: Falls on the same day number as recurrence_start, such as the 17th of every month.
weekday_occurrence: Falls on the same weekday occurrence as recurrence_start, such as the third Tuesday of every month.

New values may be added.

Response 200

Returns a Event 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

idinteger

Unique identifier.

user_idintegerServer-assigned

Whose agenda the event is on. Always the authenticated user at creation time; not writable.

task_idinteger or null

Kanban task this event is planned against, or null for a plain calendar block. Only an event with a task can have time logged on it.

parent_event_idinteger or nullServer-assigned

Master event, when this row is a separated occurrence of a recurring series. Set by the server; not writable.

occurrence_datedate (YYYY-MM-DD) or nullServer-assigned

The date of the series occurrence this row replaces. Set by the server; not writable.

starttimestamp (YYYY-MM-DDThh:mm:ssZ)

When the event starts. RFC 3339 UTC.

endtimestamp (YYYY-MM-DDThh:mm:ssZ)

When the event ends. RFC 3339 UTC.

titlestring≤ 255

Event title, as shown on the calendar tile.

descriptionhtml or nullDetail only

Free-text description, authored in the rich editor. HTML, sanitised on the way in and on the way out; @-mention spans are preserved, and changing them is what notifies the people mentioned.

is_all_dayboolean

Whether the event occupies whole days rather than a time range. An all-day event is measured against the owner's working week rather than against start and end.

is_recurringboolean

Whether this row is the master of a recurring series. When true, the recurrence fields describe how occurrences are generated.

recurrence_intervalinteger or null

How many frequency units pass between occurrences: 2 with a weekly frequency is every other week.

recurrence_frequencystring or null

The unit the series repeats in.

dayweekmonthyear

New values may be added.

recurrence_patternstring or null

How a monthly or yearly series positions its occurrence within the month. Ignored for a daily or weekly frequency.

day_of_monthweekday_occurrence

New values may be added.

recurrence_starttimestamp (YYYY-MM-DDThh:mm:ssZ) or null

First moment the series may generate an occurrence.

recurrence_endtimestamp (YYYY-MM-DDThh:mm:ssZ) or null

Last moment the series may generate an occurrence; null for an open-ended series.

selected_weekdaysarray of string or nullDetail only

Weekdays a recurring event falls on. Applies to a weekly frequency; ignored otherwise.

monday
tuesday
wednesday
thursday
friday
saturday
sunday

New values may be added.

recurrence_exceptionsarray of string or nullDetail only

Dates on which this recurrence does not occur. plnnrly adds one whenever a single occurrence is separated or deleted.

created_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Creation timestamp.

updated_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Last-write timestamp; use for incremental sync.

deleted_attimestamp (YYYY-MM-DDThh:mm:ssZ) or null

When the event was deleted, or null while it is live. Reach a deleted event with trashed=with and undo it with POST events/{event}/actions/restore.

userRef or UserSummary

The user whose agenda the event is on. Renders as an {"id": N} reference unless expanded.

linksEventLinks

Show 1 child field

links.selfurl

The canonical URI of this record.

Errors

403 Forbidden.

forbidden-by-policy insufficient-permission insufficient-token-scope

forbidden-by-policy: The event is your own and you hold events::manage_for_others but not events::manage_self, or the task_id you send is a task the event's owner cannot select. Another user's event answers 404 instead when you do not hold events::manage_for_others, because you cannot see it.