Skip to content

Update Event

Defines the structure of the request body for the PUT event/details endpoint

Schema

{
"event_name": "string",
"event_cover_file": "string",
"event_location": "string",
"event_location_longitude": "string",
"event_location_latitude": "string",
"event_start": "2025-01-01T05:14:05.801Z",
"event_end": "2025-01-01T05:14:05.801Z",
"event_details": "string",
"event_photos_per_guest": 1,
"event_media_reveal": 3,
"event_media_reveal_at": "2025-01-01T05:14:05.801Z",
"event_visibility": 0,
"event_setting_join_approval": true
}

Properties

event_name

The event’s name

Data Type: String
Required: Yes
Table: Event

event_cover_file

The file for the cover image

Data Type: String
Required: Yes

event_location

The event’s location

Data Type: String
Required: Yes
Table: Event

event_location_longitude

The longitude of the event’s location

Data Type: String
Required: No
Table: Event

event_location_latitude

The latitude of the event’s location

Data Type: String
Required: No
Table: Event

event_start

The start time of the event

Data Type: String (date-time UTC)
Required: Yes
Table: Event

event_end

The end time of the even

Data Type: String (date-time UTC)
Required: No
Table: Event

event_details

The description of the event

Data Type: String
Required: No
Table: Event

event_photos_per_guest

The number of photos that can be uploaded by the user to the event album

Data Type: Integer
Required: No
Table: Event

event_media_reveal

The condition when will the gallery will be revealed to the guests

Data Type: Integer
Required: Yes
Table: Event
Values:

  • During - 1
  • After - 2
  • Hidden - 3

event_media_reveal_at

The date and time on when the gallery will be revealed. This is required when the

Data Type: String (date-time UTC)
Required: No
Table: Event

event_visibility

The visibility of the event

Data Type: Integer
Required: Yes
Table: Event
Values:

  • Public - 1
  • Private - 2

event_setting_join_approval

Indicates whether joining the event requires approval from an admin or the creator

Data Type: Boolean
Required: No
Table: Event Settings