Developer Hub
»
Events PATCH API Documentation
Update Event: /orgs/{org_uuid}/events/{event_uuid}
Purpose
This endpoint is used to update the booking start and end times for a specific event within an organisation.
Scope
event.update → Events update permission must be granted from the application to update the event.
Use Case
This endpoint is used by event organisers to modify the booking window for an event. This allows for flexibility in controlling when attendees can purchase tickets or register for sessions.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| org_uuid | string | Unique identifier of the organisation. |
| event_uuid | string | The unique identifier of the event to be updated. |
Query Parameters
This endpoint does not have any query parameters.
Request Body
The request body includes the updated settings for the specified event. It provides the updated booking start and end times for the event, including options for specific times or timings relative to the occurrence of the event.
JSON
{
"event": {
"settings": {
"booking_starts_on": {
"type": "BOOKING_STARTS_TYPE",
"utc": "UTC_TIME",
"local": "LOCAL_TIME",
"occurrence_booking_start_type": "OCCURRENCE_BOOKING_START_TYPE",
"occurrence_booking_start_offset": "OCCURRENCE_BOOKING_START_OFFSET",
"hide_ticket_until_booking_start": "HIDE_TICKET_UNTIL_BOOKING_START",
"level": "LEVEL"
},
"booking_ends_on": {
"type": "BOOKING_ENDS_TYPE",
"utc": "UTC_TIME",
"local": "LOCAL_TIME",
"occurrence_booking_end_type": "OCCURRENCE_BOOKING_END_TYPE",
"occurrence_booking_end_offset": "OCCURRENCE_BOOKING_END_OFFSET",
"level": "LEVEL"
}
}
}
}| Key | Type | Description |
|---|---|---|
booking_starts_on.type |
String | Type of booking start. |
booking_starts_on.utc |
String | UTC timestamp indicating when booking starts. |
booking_starts_on.local |
String | Local timestamp indicating when booking starts. |
booking_starts_on.occurrence_booking_start_type |
String | Type defining the occurrence-specific booking start. |
booking_starts_on.occurrence_booking_start_offset |
Integer | Offset (in minutes) for occurrence-specific booking start. |
booking_starts_on.hide_ticket_until_booking_start |
Boolean | Determines if tickets remain hidden until the booking start time. |
booking_starts_on.level |
String | Level of booking start. |
booking_ends_on.type |
String | Type of booking end. |
booking_ends_on.utc |
String | UTC timestamp indicating when booking ends. |
booking_ends_on.local |
String | Local timestamp indicating when booking ends. |
booking_ends_on.occurrence_booking_end_type |
String | Type defining the occurrence-specific booking end. |
booking_ends_on.occurrence_booking_end_offset |
Integer | Offset (in minutes) for occurrence-specific booking end. |
booking_ends_on.level |
String | Level of booking end. |
Response
The successful response includes the updated details of the event, including the newly configured booking start and end times as specified in the request. This allows the client to verify that the update was successful and retrieve the updated event information.
JSON
{
"statusCode": "202",
"result": {
"event": {
"uuid": "EVENT_UUID",
"status": "EVENT_STATUS",
"premium": "EVENT_PREMIUM",
"extended_status": [
{
"name": "EXTENDED_STATUS_NAME",
"value": "EXTENDED_STATUS_VALUE"
}
],
"name": "EVENT_NAME",
"display_name": "EVENT_DISPLAY_NAME",
"slug": "EVENT_SLUG",
"description": "EVENT_DESCRIPTION",
"banner": [
{
"name": "BANNER_NAME",
"image": "BANNER_IMAGE",
"primary": "BANNER_PRIMARY"
}
],
"thumbnail": {
"name": "THUMBNAIL_NAME",
"image": "THUMBNAIL_IMAGE",
"primary": "THUMBNAIL_PRIMARY"
},
"resources": [],
"links": [
{
"name": "LINKS_NAME",
"value": "LINKS_VALUE"
}
],
"timezone": "EVENT_TIMEZONE",
"enable_datetime_conversion": "EVENT_ENABLE_DATETIME_CONVERSION",
"currency": "CURRENCY",
"tax": [
{
"name": "TAX_NAME",
"value": "TAX_VALUE"
}
],
"created_on": "EVENT_CREATED_ON",
"updated_on": "EVENT_UPDATED_ON",
"event_occurrence": [],
"occurrence": {
"type": "OCCURRENCE_TYPE",
"attributes": {
"starts_on": {
"utc": "STARTS_ON_UTC",
"local": "STARTS_ON_LOCAL"
},
"event_duration": "ATTRIBUTES_EVENT_DURATION"
},
"exclusions": []
},
"org": {
"uuid": "ORG_UUID",
"name": "ORG_NAME",
"slug": "ORG_SLUG",
"info": "ORG_INFO",
"image": "ORG_IMAGE",
"metrics": [
{
"name": "METRICS_NAME",
"value": "VALUE"
}
],
"interactions": {
"preferences": [
{
"name": "PREFERENCES_NAME",
"value": "PREFERENCES_VALUE"
}
],
"follows": "FOLLOWS",
"followed_by": "FOLLOWED_BY",
"mutes": "MUTES"
}
},
"configuration": {
"type": "CONFIGURATION_TYPE",
"attributes": [
{
"name": "ATTRIBUTES_NAME",
"value": {
"name": "VALUE_NAME",
"image": "VALUE_IMAGE",
"url": "VALUE_URL",
"latitude": "UNKNOWN",
"longitude": "UNKNOWN",
"address": {
"address_line1": "ADDRESS_LINE1",
"address_line2": "ADDRESS_LINE2",
"country": "ADDRESS_COUNTRY",
"state": "ADDRESS_STATE",
"city": "ADDRESS_CITY",
"post_code": "POST_CODE"
}
}
},
{
"name": "ATTRIBUTES_NAME",
"value": {
"enabled": "VALUE_ENABLED",
"have_conditions": "VALUE_HAVE_CONDITIONS",
"list": []
}
}
]
},
"survey_configuration": [],
"coupons": [],
"early_bird_discount": {
"discount_type": "DISCOUNT_TYPE",
"discount": "EARLY_BIRD_DISCOUNT",
"type": "EARLY_BIRD_DISCOUNT_TYPE",
"is_enable_customise_discount_start": "EARLY_BIRD_DISCOUNT_IS_ENABLE_CUSTOMISE_DISCOUNT_START",
"discount_starts_on": {
"utc": "DISCOUNT_STARTS_ON_UTC",
"local": "DISCOUNT_STARTS_ON_LOCAL",
"occurrence_discount_start_type": "OCCURRENCE_DISCOUNT_START_TYPE",
"occurrence_discount_start_offset": "OCCURRENCE_DISCOUNT_START_OFFSET"
},
"discount_ends_on": {
"utc": "UTC",
"local": "LOCAL",
"occurrence_discount_end_type": "OCCURRENCE_DISCOUNT_END_TYPE",
"occurrence_discount_end_offset": "OCCURRENCE_DISCOUNT_END_OFFSET"
}
},
"tickets": {
"price_is_fee_inclusive": "TICKETS_PRICE_IS_FEE_INCLUSIVE",
"price_is_tax_inclusive": "TICKETS_PRICE_IS_TAX_INCLUSIVE",
"levels": [
{
"uuid": "UUID",
"display_order": "DISPLAY_ORDER",
"name": "NAME",
"description": "DESCRIPTION",
"quantity": "QUANTITY",
"max_quantity_per_customer": "MAX_QUANTITY_PER_CUSTOMER",
"quantity_sold": "QUANTITY_SOLD",
"total_purchased_by_user": "TOTAL_PURCHASED_BY_USER",
"category": "CATEGORY",
"min_donation_amount": "MIN_DONATION_AMOUNT",
"max_donation_amount": "MAX_DONATION_AMOUNT",
"default_donation_amount": "DEFAULT_DONATION_AMOUNT",
"status": "STATUS",
"session_id": "SESSION_ID",
"parent_id": "PARENT_ID",
"url_digital_pass": "URL_DIGITAL_PASS",
"pricing_details": [
{
"uuid": "UUID",
"variation": "VARIATION",
"price": "PRICE",
"quantity_included": "QUANTITY_INCLUDED",
"minimum_quantity": {
"enable": "MINIMUM_QUANTITY_ENABLE",
"mandatory": "MINIMUM_QUANTITY_MANDATORY",
"quantity": "MINIMUM_QUANTITY_QUANTITY"
},
"quantity_sold": "QUANTITY_SOLD"
}
],
"early_bird_discount": {
"discount_type": "DISCOUNT_TYPE",
"discount": "DISCOUNT",
"type": "EARLY_BIRD_DISCOUNT_TYPE",
"is_enable_customise_discount_start": "EARLY_BIRD_DISCOUNT_IS_ENABLE_CUSTOMISE_DISCOUNT_START",
"discount_starts_on": {
"utc": "UTC",
"local": "LOCAL",
"occurrence_discount_start_type": "DISCOUNT_STARTS_ON_OCCURRENCE_DISCOUNT_START_TYPE",
"occurrence_discount_start_offset": "DISCOUNT_STARTS_ON_OCCURRENCE_DISCOUNT_START_OFFSET"
},
"discount_ends_on": {
"utc": "UTC",
"local": "LOCAL",
"occurrence_discount_end_type": "DISCOUNT_ENDS_ON_OCCURRENCE_DISCOUNT_END_TYPE",
"occurrence_discount_end_offset": "DISCOUNT_ENDS_ON_OCCURRENCE_DISCOUNT_END_OFFSET"
}
},
"coupons": [],
"settings": {
"booking_starts_on": {
"type": "TYPE",
"utc": "UTC",
"local": "LOCAL",
"occurrence_booking_start_type": "OCCURRENCE_BOOKING_START_TYPE",
"occurrence_booking_start_offset": "OCCURRENCE_BOOKING_START_OFFSET",
"hide_ticket_until_booking_start": "HIDE_TICKET_UNTIL_BOOKING_START"
},
"booking_ends_on": {
"type": "TYPE",
"utc": "UTC",
"local": "LOCAL",
"occurrence_booking_end_type": "OCCURRENCE_BOOKING_END_TYPE",
"occurrence_booking_end_offset": "OCCURRENCE_BOOKING_END_OFFSET",
"level": "LEVEL"
}
},
"ticket_instruction": "TICKET_INSTRUCTION",
"custom_attributes": [],
"created_on": {
"utc": "CREATED_ON_UTC",
"local": "CREATED_ON_LOCAL"
}
}
]
},
"publising": {
"state": "PUBLISING_STATE",
"updated_on": "PUBLISING_UPDATED_ON",
"published_on": {
"utc": "PUBLISHED_ON_UTC",
"local": "PUBLISHED_ON_LOCAL"
}
},
"listing": {
"enabled": "LISTING_ENABLED",
"visibility_in_org_profile": "LISTING_VISIBILITY_IN_ORG_PROFILE",
"categories": [
{
"uuid": "CATEGORIES_UUID",
"name": "CATEGORIES_NAME",
"description": "CATEGORIES_DESCRIPTION",
"url": "URL",
"image": "CATEGORIES_IMAGE"
}
],
"tags": []
},
"settings": {
"booking_starts_on": {
"type": "TYPE",
"utc": "UTC",
"local": "LOCAL",
"occurrence_booking_start_type": "OCCURRENCE_BOOKING_START_TYPE",
"occurrence_booking_start_offset": "OCCURRENCE_BOOKING_START_OFFSET",
"hide_ticket_until_booking_start": "HIDE_TICKET_UNTIL_BOOKING_START",
"level": "LEVEL"
},
"booking_ends_on": {
"type": "TYPE",
"utc": "UTC",
"local": "LOCAL",
"occurrence_booking_end_type": "OCCURRENCE_BOOKING_END_TYPE",
"occurrence_booking_end_offset": "OCCURRENCE_BOOKING_END_OFFSET",
"level": "LEVEL"
},
"event_capacity": "EVENT_CAPACITY",
"max_ticket_per_customer": "MAX_TICKET_PER_CUSTOMER",
"terminology": "TERMINOLOGY",
"enable_guest_checkout": "ENABLE_GUEST_CHECKOUT",
"enable_share": "ENABLE_SHARE",
"digital_pass": {
"enabled": "DIGITAL_PASS_ENABLED",
"level": "DIGITAL_PASS_LEVEL"
},
"discount": {
"enabled": "DISCOUNT_ENABLED",
"level": "DISCOUNT_LEVEL"
},
"coupon": {
"enabled": "COUPON_ENABLED",
"level": "COUPON_LEVEL"
},
"service_charge": {
"enabled": "SERVICE_CHARGE_ENABLED",
"level": "SERVICE_CHARGE_LEVEL"
},
"boxoffice": "BOXOFFICE",
"sell_session": {
"enabled": "SELL_SESSION_ENABLED",
"level": "SELL_SESSION_LEVEL"
},
"sell_session_individually": {
"enabled": "SELL_SESSION_INDIVIDUALLY_ENABLED",
"level": "SELL_SESSION_INDIVIDUALLY_LEVEL"
},
"sell_tickets_on_venue": {
"enabled": "SELL_TICKETS_ON_VENUE_ENABLED",
"level": "SELL_TICKETS_ON_VENUE_LEVEL"
},
"special_instruction": {
"enabled": "SPECIAL_INSTRUCTION_ENABLED",
"level": "SPECIAL_INSTRUCTION_LEVEL"
},
"waiting_list": {
"enabled": "WAITING_LIST_ENABLED",
"level": "WAITING_LIST_LEVEL"
},
"qr_code": {
"enabled": "QR_CODE_ENABLED",
"level": "QR_CODE_LEVEL"
},
"configure_ticket_remaining": {
"enabled": "CONFIGURE_TICKET_REMAINING_ENABLED",
"level": "CONFIGURE_TICKET_REMAINING_LEVEL",
"remaining_tickets": "CONFIGURE_TICKET_REMAINING_REMAINING_TICKETS",
"hide_on_the_event_details": "CONFIGURE_TICKET_REMAINING_HIDE_ON_THE_EVENT_DETAILS"
},
"custom_thumbnails": {
"enabled": "CUSTOM_THUMBNAILS_ENABLED",
"thumbs": {
"portrait": "THUMBS_PORTRAIT",
"landscape": "THUMBS_LANDSCAPE"
}
},
"custom_seo_details": {
"enabled": "CUSTOM_SEO_DETAILS_ENABLED",
"title": "TITLE",
"description": "DESCRIPTION",
"image": "IMAGE"
},
"collect_additional_info_from_buyer": {
"enabled": "COLLECT_ADDITIONAL_INFO_FROM_BUYER_ENABLED",
"mandatory": "COLLECT_ADDITIONAL_INFO_FROM_BUYER_MANDATORY"
},
"ticket_scanning": {
"enabled": "TICKET_SCANNING_ENABLED",
"allow_scanning_only_during_event_hour": "TICKET_SCANNING_ALLOW_SCANNING_ONLY_DURING_EVENT_HOUR"
},
"configure_pricing_display_text": {
"enabled": "CONFIGURE_PRICING_DISPLAY_TEXT_ENABLED",
"display": "CONFIGURE_PRICING_DISPLAY_TEXT_DISPLAY"
},
"enable_ticket_mandatory": "ENABLE_TICKET_MANDATORY",
"enable_rsvp": "ENABLE_RSVP",
"tracking_codes": [],
"blockout_period": "BLOCKOUT_PERIOD",
"restrictions": "RESTRICTIONS",
"terms_and_condition": [],
"include_tax_or_gst": "INCLUDE_TAX_OR_GST",
"company_registration_details": "COMPANY_REGISTRATION_DETAILS",
"abn_activate_on": "ABN_ACTIVATE_ON",
"organisation_entity_name": "ORGANISATION_ENTITY_NAME",
"dgr_status": "DGR_STATUS",
"reminder_email_before_event": {
"enabled": "ENABLED",
"include_ticket": "INCLUDE_TICKET",
"reminder_email_time": "REMINDER_EMAIL_TIME"
},
"reminder_email_after_event": {
"enabled": "REMINDER_EMAIL_AFTER_EVENT_ENABLED",
"reminder_email_time": "REMINDER_EMAIL_AFTER_EVENT_REMINDER_EMAIL_TIME"
},
"enable_full_day": "ENABLE_FULL_DAY"
},
"sessions": {
"enabled": "SESSIONS_ENABLED",
"type": "SESSIONS_TYPE",
"session_lists": [
{
"uuid": "UUID",
"sell_session": "SELL_SESSION",
"status": "STATUS",
"name": "NAME",
"capacity": "CAPACITY",
"display_name": "DISPLAY_NAME",
"description": "DESCRIPTION",
"duration": "DURATION",
"image": "IMAGE",
"created_on": "CREATED_ON",
"updated_on": "UPDATED_ON",
"occurrences": {
"type": "OCCURRENCES_TYPE",
"uuid": []
},
"session_starts_on": {
"utc": "SESSION_STARTS_ON_UTC",
"local": "SESSION_STARTS_ON_LOCAL"
},
"session_ends_on": {
"utc": "SESSION_ENDS_ON_UTC",
"local": "SESSION_ENDS_ON_LOCAL"
},
"tickets": []
}
]
},
"refund": {
"available": "REFUND_AVAILABLE",
"policy": {
"cancel_before_event_starts": "POLICY_CANCEL_BEFORE_EVENT_STARTS",
"automatic": "POLICY_AUTOMATIC",
"amount": {
"discount_type": "AMOUNT_DISCOUNT_TYPE",
"discount_unit": "AMOUNT_DISCOUNT_UNIT"
}
}
},
"ticket_instruction": "EVENT_TICKET_INSTRUCTION",
"metrics": [
{
"name": "METRICS_NAME",
"value": "METRICS_VALUE"
}
],
"fees": {
"currency": "FEES_CURRENCY",
"pass_on": "PASS_ON",
"rate": [
{
"name": "RATE_NAME",
"value": "RATE_VALUE"
}
],
"price_is_tax_inclusive": "FEES_PRICE_IS_TAX_INCLUSIVE",
"tax": [
{
"name": "TAX_NAME",
"value": "TAX_VALUE"
}
]
},
"interactions": {
"saves": [],
"shares": [],
"attendees": [],
"speaker": [],
"reviews": [],
"waiting_list": [],
"join_url": []
},
"merchandise": {
"products": []
},
"event_reviewed": "EVENT_EVENT_REVIEWED",
"custom_attributes": [],
"event_code": {
"type": "EVENT_CODE_TYPE",
"value": "EVENT_CODE_VALUE",
"image": "IMAGE"
},
"activities": [
{
"name": "ACTIVITIES_NAME",
"value": "ACTIVITIES_VALUE"
}
]
}
}
}| Attribute | Type | Description |
|---|---|---|
| result.event | Object | Details of the event. |
| result.event.uuid | String | Unique identifier for the event. |
| result.event.status | String | Null | Status of the event. |
| result.event.premium | Boolean | Indicates if the event is a premium event. |
| result.event.extended_status | Array of Objects | Additional status information for the event. |
| result.event.extended_status.name | String | Name of the extended status. |
| result.event.extended_status.value | String | Value of the extended status. |
| result.event.name | String | Name of the event. |
| result.event.display_name | String | Display name of the event. |
| result.event.slug | String | Slugified version of the event name, used in URLs. |
| result.event.description | String | Description of the event. |
| result.event.banner | Array of Objects | List of banners associated with the event. |
| result.event.banner.name | String | Name of the banner. |
| result.event.banner.image | String (URL) | URL of the banner image. |
| result.event.banner.primary | Boolean | Indicates if this is the primary banner. |
| result.event.thumbnail | Object | Thumbnail details for the event. |
| result.event.thumbnail.name | String | Name of the thumbnail. |
| result.event.thumbnail.image | String (URL) | URL of the thumbnail image. |
| result.event.thumbnail.primary | Boolean | Indicates if this is the primary thumbnail. |
| result.event.resources | Array | List of resources related to the event (empty in this case). |
| result.event.links | Array of Objects | Links associated with the event. |
| result.event.links.name | String | Name of the link. |
| result.event.links.value | String (URL) | URL of the link. |
| result.event.timezone | String | Timezone of the event. |
| result.event.enable_datetime_conversion | Boolean | Indicates if datetime conversion is enabled. |
| result.event.currency | String | Currency used for the event. |
| result.event.tax | Array of Objects | Tax details associated with the event. |
| result.event.tax.name | String | Name of the tax. |
| result.event.tax.value | String | Value of the tax. |
| result.event.created_on | String (Timestamp) | Event creation timestamp. |
| result.event.updated_on | String (Timestamp) | Event last updated timestamp. |
| result.event.event_occurrence | Array | Event occurrence details (empty in this case). |
| result.event.occurrence | Object | Details of event occurrence. |
| result.event.occurrence.type | String | Type of the occurrence. |
| result.event.occurrence.attributes | Object | Attributes related to the event occurrence. |
| result.event.occurrence.attributes.starts_on | Object | Start date details for the event occurrence. |
| result.event.occurrence.attributes.starts_on.utc | String (UTC) | Start date and time in UTC format. |
| result.event.occurrence.attributes.starts_on.local | String | Start date and time in the local timezone. |
| result.event.occurrence.attributes.event_duration | String | Duration of the event. |
| result.events.org | Object | Details of the organisation associated with the event. |
| result.events.org.uuid | String | Unique identifier for the organisation. |
| result.events.org.name | String | Name of the organisation. |
| result.events.org.slug | String | URL-friendly identifier for the organisation. |
| result.events.org.info | String | Additional information about the organisation. |
| result.events.org.image | String (URL) | URL to the organisation's image. |
| result.events.org.metrics | Array | List of metric objects related to the organisation. |
| result.events.org.metrics.name | String | Name of the metric. |
| result.events.org.metrics.value | Any | Value of the metric. |
| result.events.org.interactions | Object | Interaction preferences and status for the organisation. |
| result.events.configuration | Object | Configuration settings for the event. |
| result.events.configuration.type | String | Type of configuration. |
| result.events.configuration.attributes | Array | List of configuration attribute objects. |
| result.events.survey_configuration | Array | Configuration settings for event surveys. |
| result.events.coupons | Array | List of coupons associated with the event. |
| result.events.early_bird_discount | Object | Early bird discount settings for the event. |
| result.events.tickets | Object | Details of ticketing for the event. |
| result.events.publising | Object | Publishing details of the event. |
| result.events.listing | Object | Listing and visibility settings for the event. |
| result.events.settings | Object | Event-wide settings, including booking, ticketing, and sharing options. |
| result.events.sessions | Object | Session details and settings for the event. |
| result.events.refund | Object | Refund policy and settings for the event. |
| result.events.metrics | Array | Event metrics, such as share counts. |
| result.events.fees | Object | Fee details, including tax and service charges. |
| result.events.interactions | Object | Interaction details, such as saves, shares, and attendees. |
| result.events.merchandise | Object | Merchandise details for the event. |
| result.events.event_settings_reviewed | Boolean | Indicates if the event settings have been reviewed. |
| result.events.custom_attributes | Array | Custom attributes associated with the event. |
| result.events.event_code | Object | QR code and event code details. |
| result.events.activities | Array | Activities related to the event. |
| result.events.store_url | String (URL) | URL to the event store. |
| result.events.location | String | Location of the event. |
Update Session: /events/{event_uuid}/sessions/{session_uuid}
Purpose
This endpoint is used to update an existing session within an event. It allows changes to session details such as the name, description, schedule, and ticket information. The updated session can then reflect the new configuration, making it accessible for attendees.
Scope
event.update_session → Events update permission must be granted from the application to update the session.
Use Case
Event organisers use this endpoint to modify the details of a session within an event. This is useful when adjustments to session information such as timing, status, or ticketing are needed, ensuring the session is up to date for attendees.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uuid | string | The unique identifier for the event that contains the session. |
| session_uuid | string | The unique identifier for the session to be updated. |
Query Parameters
This endpoint does not have any query parameters.
Request Body
This request updates specific attributes of a session, including name, status, description, session start and end times, occurrences, and ticket information.
JSON
{
"sessions": {
"name": "UPDATED_SESSION_NAME",
"sell_session": "BOOLEAN",
"status": "STATUS_ACTIVE",
"description": "SESSION_DESC_MANAGERS",
"image": "UPLOADS_DEFAULT_EVENTS/IMAGE.jpg",
"session_starts_on": "2025-01-24 00:00",
"duration": DURATION,
"occurrences": {
"type": "SPECIFIC",
"uuid": [
"UUID_PLACEHOLDER"
]
},
"tickets": {
"type": "SPECIFIC",
"uuid": [
"TICKET_UUID_PLACEHOLDER"
]
}
}
}
| Attribute | Type | Description |
|---|---|---|
| sessions.name | String | The name of the session. Maximum length: 75 characters. |
| sessions.sell_session | Boolean | Indicates whether the session is available for sale. Can be true or false. |
| sessions.status | String | The current status of the session (e.g., "active", "inactive"). Valid values: active or inactive. |
| sessions.description | String | A description of the session. Maximum length: 2500 characters. |
| sessions.image | File | URL of an image associated with the session. Must be greater than 300x300 pixels. Allows formats: .jpg, .jpeg, .png. |
| sessions.session_starts_on | String (Datetime) | The date and time when the session starts in local time. Should be a valid future date and time. |
| sessions.duration | Integer | Duration of the session. |
| sessions.occurrences | Object | Contains data related to the occurrences of the session, including the occurrence type and associated UUIDs. |
| sessions.occurrences.type | String | The type of occurrence. Valid values: all or specific. |
| sessions.occurrences.uuid | Array of Strings (UUID) | A list of UUIDs associated with occurrences. Must be valid occurrence UUIDs. |
| sessions.tickets | Object | A list of tickets associated with the session, including details like ticket UUID, quantity sold, and pricing details. |
| sessions.tickets.uuid | String (UUID) | Unique identifier for the ticket. Must be a valid ticket UUID. |
Response
The response confirms the successful update of the session, providing the updated session details such as name, status, schedule, and ticket information.
JSON
{
"statusCode": 202,
"result": {
"session": {
"session": {
"uuid": "UUID_PLACEHOLDER",
"sell_session": "BOOLEAN",
"status": "STATUS_ACTIVE",
"name": "UPDATED_SESSION_NAME",
"capacity": CAPACITY,
"display_name": "DISPLAY_NAME",
"description": "SESSION_DESC_MANAGERS",
"duration": DURATION,
"image": "UPLOADS_DEFAULT_EVENTS/IMAGE.jpg",
"created_on": "2025-01-23T03:17:23+00:00",
"updated_on": "2025-01-23T06:34:52+00:00",
"occurrences": {
"type": "SPECIFIC",
"uuid": []
},
"session_starts_on": {
"utc": "2025-01-23 13:00",
"local": "2025-01-24 00:00"
},
"session_ends_on": {
"utc": "2025-01-23 13:20",
"local": "2025-01-24 00:20"
},
"tickets": [
{
"uuid": "TICKET_UUID_PLACEHOLDER",
"quantity_sold":QUANTITY_SOLD ,
"total_purchased_by_user": TOTAL_PURCHASE,
"pricing_details": [
{
"uuid": null,
"quantity_sold": QUANTITY_SOLD
}
]
}
]
}
}
}
}
| Attribute | Type | Description |
|---|---|---|
| result.sessions | Array of Objects | Contains a list of session objects. Each session includes details like the session's UUID, name, capacity, and other session data. |
| result.sessions.uuid | String | Unique identifier for the session. |
| result.sessions.sell_session | Boolean | Indicates whether the session is available for sale. Can be true or false. |
| result.sessions.status | String | The current status of the session. |
| result.sessions.name | String | The name of the session. |
| result.sessions.capacity | Integer | The total number of available spots for the session. |
| result.sessions.display_name | String | The display name for the session, which may differ from the internal name. |
| result.sessions.description | String | A description of the session. |
| result.sessions.duration | Integer | Duration of the session in minutes. |
| result.sessions.image | String (URL) | URL of an image associated with the session. |
| result.sessions.created_on | String (Timestamp) | The timestamp indicating when the session was created. Format: YYYY-MM-DDTHH:MM:SSZ. |
| result.sessions.updated_on | String (Timestamp) | The timestamp indicating when the session was last updated. Format: YYYY-MM-DDTHH:MM:SSZ. |
| result.sessions.occurrences | Object | Contains data related to the occurrences of the session, including the occurrence type and associated UUIDs. |
| result.sessions.session_starts_on | Object (Datetime) | The start time of the session in both UTC and local time formats. |
| result.sessions.session_ends_on | Object (Datetime) | The end time of the session in both UTC and local time formats. |
| result.sessions.tickets | Array of Objects | A list of tickets associated with the session, including details like ticket UUID, quantity sold, and pricing details. |
| result.sessions.tickets.uuid | String | Unique identifier for the ticket. |
| result.sessions.tickets.quantity_sold | Integer | The number of tickets sold for the session. |
| result.sessions.tickets.total_purchased_by_user | Integer | The total number of tickets purchased by a user. |
| result.sessions.tickets.pricing_details | Array of Objects | List of pricing details, including ticket UUID and quantity sold per price level. |
| result.sessions.tickets.pricing_details.uuid | String (UUID) | Unique identifier for the pricing detail. |
| result.sessions.tickets.pricing_details.quantity_sold | Integer | The number of tickets sold at this specific price level. |