Events

Archive an event

Archives the event like « Archive » in the app (same service): the event becomes read-only and leaves the lists, its open tasks are cancelled, the requests and platform quotes of its request are re-routed, it is removed from the connected calendars and the activity is written. The status is kept. Reversible with POST /events/{id}/unarchive; required before DELETE /events/{id}. Idempotent (already_archived: true). No body. Role permission: data.write.

post/events/{id}/archive

Request

  • Base URL: https://joinways.app/api/v1
  • URL: https://joinways.app/api/v1/events/{id}/archive
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://joinways.app/oauth/authorize, token URL https://joinways.app/api/oauth/token, scopes: mcp.write)

Headers

Idempotency-Keystring

Optional client-generated key (1 to 255 characters, e.g. a UUID v4) that makes the request idempotent for 24 hours: a retry with the same key replays the recorded response (marked Idempotency-Replayed: true) instead of executing the operation again. Same key with another body: 422 idempotency_key_reuse; while the first request runs: 409 idempotency_conflict. See the Idempotency section.

Response

Archived.

successboolean required
idstring uuid required
archivedtrue required
already_archivedboolean required

The event was already archived (nothing changed).

Changes

No recorded changes to this operation across all 1 revision of this API.