Delete Guest
Removes a guest from an event.
With send_email=true and a guest who held a seat (going or checked_in), the cancellation email is sent right away, during the request.
Endpoint
- Method:
DELETE - Path:
/fluent-event/v2/events/{eventId}/guests/{guestId} - Controller:
GuestController@deleteGuest - Route source:
fluent-event/app/Http/Routes/api.php:64 - Controller source:
fluent-event/app/Http/Controllers/GuestController.php:115
Permissions
- Requires the
manage_optionscapability (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.
Delete Guest
DELETE
/events/{eventId}/guests/{guestId}
Removes a guest from an event.
Controller: GuestController@deleteGuest
Route source: fluent-event/app/Http/Routes/api.php:64
Authorizations
ApplicationPasswords
A WordPress username and an Application Password.
Type
HTTP (basic)
Parameters
Path Parameters
eventId*
Event ID (fe_event_details.id).
Type
Requiredinteger
Minimum
1guestId*
Guest ID (fe_guests.id).
Type
Requiredinteger
Minimum
1Query Parameters
send_email
Send the cancellation email.
Type
boolean
Example
falseResponses
Success
application/json
JSON "message": "string"
{
}