Skip to content

Update Event ​

Updates an event and its post. Send the full event: every required field is validated again.

When calendar_id changes, every guest row moves with the event and fluent_event/event/calendar_changed fires. When start_at changes, the reminder emails are rescheduled and sent again for the new time. Keys of meta you leave out keep their stored values.

Endpoint ​

  • Method: PATCH
  • Path: /fluent-event/v2/events/{id}
  • Controller: EventController@updateEvent
  • Route source: fluent-event/app/Http/Routes/api.php:57
  • Controller source: fluent-event/app/Http/Controllers/EventController.php:120

Permissions ​

  • Requires the manage_options capability (a site administrator). FluentEvent has no separate staff roles: its admin API is for administrators only.

Hooks Fired ​

Live sample

The request and response below were recorded on a running FluentEvent site and then anonymised. Names, emails and event titles are fictional, and long lists are cut to a few items.

Update Event​

PATCH
/events/{id}

Updates an event and its post. Send the full event: every required field is validated again.

Controller: EventController@updateEvent
Route source: fluent-event/app/Http/Routes/api.php:57

Authorizations​

ApplicationPasswords

A WordPress username and an Application Password.

Type
HTTP (basic)

Parameters​

Path Parameters

id*

Record ID.

Type
integer
Required
Minimum
1

Request Body​

application/json
JSON
{
  
"calendar_id": 0,
  
"title": "string",
  
"description_md": "string",
  
"status": "string",
  
"start_at": "string",
  
"end_at": "string",
  
"timezone": "string",
  
"venue_type": "string",
  
"cover_url": "string",
  
"online_meeting_url": "string",
  
"venue": "string",
  
"address": "string",
  
"entry_type": "string",
  
"show_guest_count": "string",
  
"capacity": 0,
  
"show_spots_left": "string",
  
"start_display": "string"
}

Responses​

Success

application/json
JSON
{
  
"message": "string",
  
"event": {
  
  
"id": 0,
  
  
"post_id": 0,
  
  
"calendar_id": 0,
  
  
"parent_event_id": "string",
  
  
"status": "string",
  
  
"start_at": "string",
  
  
"end_at": "string",
  
  
"timezone": "string",
  
  
"venue_type": "string",
  
  
"meta": {
  
  
  
"cover_url": "string",
  
  
  
"online_meeting_url": "string",
  
  
  
"venue": "string",
  
  
  
"address": "string",
  
  
  
"entry_type": "string",
  
  
  
"show_guest_count": "string",
  
  
  
"capacity": 0,
  
  
  
"show_spots_left": "string",
  
  
  
"start_display": "string",
  
  
  
"description_md": "string"
  
  
},
  
  
"created_at": "string",
  
  
"updated_at": "string",
  
  
"title": "string",
  
  
"start_at_local": "string",
  
  
"end_at_local": "string",
  
  
"start_at_site": "string",
  
  
"end_at_site": "string"
  
}
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

FluentEvent developer documentation