Change event status

Request

Archives or restores an event. Requires SITE_CALENDAR:WRITE.

Security

bearerAuth

Path

eventIdintegerrequired

ID of the event to archive or restore.

Bodyapplication/jsonrequired

archivebooleanrequired

Set to true to archive the event (hidden from default listings but kept and restorable), or false to restore a previously archived event.

curl -i -X PATCH \
  'https://api-doc.immo-facile.com/_mock/openapi/calendar/events/{eventId}/status' \
  -H 'Authorization: Bearer <YOUR_opaque_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "archive": true
  }'

Responses

Event status changed

Bodyapplication/json

dataobject(EventResponse)

A calendar event. The set of populated fields depends on the event type and on the information supplied when the event was created.

Response

{
  "data": {
    "id": 0,
    "type": "VISIT",
    "starts_at": "2026-01-15T09:00:00Z",
    "ends_at": "2026-01-15T10:00:00Z",
    "all_day": true,
    "title": "string",
    "location": "string",
    "location_geo": { … },
    "sequence_duration": 0,
    "gathering_gauge": 0,
    "commute_duration": 0,
    "communicate_location": true,
    "is_confidential": true,
    "remind_time_in_min": 0,
    "appointment_mode": "OFFICE",
    "participants": [ … ],
    "products": [ … ],
    "contacts": [ … ],
    "notes": "string",
    "visio_url": "string",
    "immo360_organizer_url": "string",
    "immo360_participation_url": "string",
    "archived": true,
    "parent_id": 0,
    "recurrence": {}
  }
}