Restore a deleted event
POSThttps://
Clears the soft-delete marker and returns the event in the detail view, putting it back on its owner's agenda.
Access
- 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
viewyou ask for. - Also
- Accepts
Idempotency-Key. AcceptsIf-Match. Never cached:private, no-store. Unknown query parameters are refused, never ignored.
Both are checked, scope first. A token never does more than its user. How access is checked
Restoring somebody else's event additionally requires events::manage_for_others, on top of events::manage_self. Restoring an event that is not deleted succeeds and returns an already_in_target_state warning, so a retry is safe. On a recurring master this brings the whole series back. The restore reaches a deleted event without the trashed parameter and does not accept it.
Path parameters
Query parameters
Unknown parameters are refused with 400, naming the parameter.
Request headers
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.
Response 200
Returns a Event in the detail view.
Headers
ETag- A strong validator of exactly this representation.
Idempotency-Replayedtruewhen this response was replayed from a storedIdempotency-Keyrather than produced by a new write.RateLimit- The IETF
httpapi-ratelimit-headersform 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
Whose agenda the event is on. Always the authenticated user at creation time; not writable.
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.
Master event, when this row is a separated occurrence of a recurring series. Set by the server; not writable.
The date of the series occurrence this row replaces. Set by the server; not writable.
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.
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.
Whether this row is the master of a recurring series. When true, the recurrence fields describe how occurrences are generated.
How many frequency units pass between occurrences: 2 with a weekly frequency is every other week.
The unit the series repeats in.
dayweekmonthyear
New values may be added.
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.
First moment the series may generate an occurrence.
Last moment the series may generate an occurrence; null for an open-ended series.
Weekdays a recurring event falls on. Applies to a weekly frequency; ignored otherwise.
mondaytuesdaywednesdaythursdayfridaysaturdaysunday
New values may be added.
Dates on which this recurrence does not occur. plnnrly adds one whenever a single occurrence is separated or deleted.
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.
The user whose agenda the event is on. Renders as an {"id": N} reference unless expanded.
Errors
409 Conflict.
412 Precondition failed.
7 errors every operation can return: 400, 401, 404, 406, 429, 500, 503
400 Bad request.
idempotency-key-requiredinvalid-cursorinvalid-query-parametermalformed-requestunsupported-parameter
401 Unauthenticated.
404 Not found.
406 Not acceptable.
429 Too many requests.
500 Server error.
503 Service unavailable.
This path allows POST. Anything else answers 405.
Something wrong or missing on this page? Tell us