Skip to content

Update Guest ​

Changes a guest. Fields you leave out keep their values.

Send user_id: null to unlink a WordPress user. Moving to checked_in stamps checked_in_at (kept if already set); leaving it clears it. With send_email=true and a status change, a move to going queues the confirmation email and a move to not_going or cancelled queues the cancellation email.

Endpoint ​

  • Method: PATCH
  • Path: /fluent-event/v2/events/{eventId}/guests/{guestId}
  • Controller: GuestController@updateGuest
  • Route source: fluent-event/app/Http/Routes/api.php:62
  • Controller source: fluent-event/app/Http/Controllers/GuestController.php:69

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 Guest​

PATCH
/events/{eventId}/guests/{guestId}

Changes a guest. Fields you leave out keep their values.

Controller: GuestController@updateGuest
Route source: fluent-event/app/Http/Routes/api.php:62

Authorizations​

ApplicationPasswords

A WordPress username and an Application Password.

Type
HTTP (basic)

Parameters​

Path Parameters

eventId*

Event ID (fe_event_details.id).

Type
integer
Required
Minimum
1
guestId*

Guest ID (fe_guests.id).

Type
integer
Required
Minimum
1

Request Body​

application/json
JSON
{
  
"send_email": true,
  
"name": "string",
  
"email": "string",
  
"status": "string",
  
"user_id": 0
}

Responses​

Success

application/json
JSON
{
  
"message": "string",
  
"guest": {
  
  
"id": 0,
  
  
"event_id": 0,
  
  
"calendar_id": 0,
  
  
"ticket_type_id": "string",
  
  
"group_id": "string",
  
  
"is_buyer": 0,
  
  
"name": "string",
  
  
"email": "string",
  
  
"user_id": 0,
  
  
"status": "string",
  
  
"hash": "string",
  
  
"checked_in_at": "string",
  
  
"payment_status": "string",
  
  
"payment_ref": "string",
  
  
"price": "string",
  
  
"paid_at": "string",
  
  
"source": "string",
  
  
"source_id": "string",
  
  
"meta": "string",
  
  
"created_at": "string",
  
  
"updated_at": "string",
  
  
"avatar": "string"
  
}
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

FluentEvent developer documentation