Developer Hub
»
Events POST API Documentation
Create Event: POST /orgs/{org_uuid}/events
Purpose
This endpoint serves as the primary method for creating new events within the organisation's platform. It allows event organisers to define comprehensive event details, including scheduling, recurrence patterns, venue information, and associated resources.
Scope
event.create → Events create permission must be granted from the application to create an event.
Use Case
This endpoint empowers event organisers to efficiently schedule events, manage recurring occurrences, associate venues and resources, and prepare events for public listing, all within a centralised platform.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| org_uuid | string | Unique identifier of the organisation. |
Query Parameters
This endpoint does not have any query parameters.
Request Body
The request body takes comprehensive event details, including the event name, description, scheduling information (including recurrence patterns and duration), venue information, associated resources, and settings for public listing.
JSON
{
"event": {
"name": "EVENT_NAME",
"description": "EVENT_DESCRIPTION",
"is_update_org_settings": BOOLEAN,
"occurrence": {
"type": "OCCURRENCE_TYPE",
"attributes": {
"starts_on": "STARTS_ON",
"event_duration": "EVENT_DURATION",
"occurrence_ends": {
"type": "OCCURRENCE_ENDS_TYPE",
"value": "OCCURRENCE_ENDS_VALUE"
}
}
},
"banner": [
{
"name": "BANNER_NAME",
"image": "BANNER_IMAGE",
"primary": "BANNER_PRIMARY"
}
],
"timezone": "EVENT_TIMEZONE",
"enable_datetime_conversion": "EVENT_ENABLE_DATETIME_CONVERSION",
"configuration": {
"type": "CONFIGURATION_TYPE",
"attributes": [
{
"name": "NAME",
"value": {
"name": "NAME",
"image": "IMAGE",
"url": "URL",
"latitude": "LATITUDE",
"longitude": "LONGITUDE",
"address": {
"address_line1": "ADDRESS_LINE1",
"address_line2": "ADDRESS_LINE2",
"country": "COUNTRY",
"state": "STATE",
"city": "CITY",
"post_code": "POST_CODE"
}
}
}
]
},
"listing": {
"enabled": BOOLEAN,
"categories": []
},
"resources": []
}
}| Key | Type | Description |
|---|---|---|
| event | Object | Contains all details about the event, including name, description, occurrence, banners, etc. |
| event.name | String | Name of the event. Max character limit of 75. |
| event.description | String | Description of the event. Max character limit of 2500. |
| event.is_update_org_settings | Boolean | Indicates if the organisation settings should be updated. |
| event.occurrence | Object | Defines occurrence details of the event. |
| occurrence.type | String | Type of occurrence (e.g., daily, monthly, weekly, schedule, does_not_repeat, timeslots). |
| occurrence.attributes | Object | Attributes for the occurrence, including start time and duration. |
| occurrence.attributes.starts_on | String (ISO 8601) | Start date and time of the occurrence. |
| occurrence.attributes.event_duration | String | Duration of the event in a readable format. Hours, with 15 minute of interval. |
| occurrence.attributes.occurrence_ends | Object | Details on how the occurrence ends. |
| occurrence.attributes.occurrence_ends.type | String | Type of occurrence end. |
| occurrence.attributes.occurrence_ends.value | String | Value associated with the end type |
| event.banner | Array of Objects | List of banners associated with the event. |
| banner[].name | String | Name of the banner. |
| banner[].image | String (URL) | URL of the banner image. |
| banner[].primary | String | Indicates if the banner is the primary banner. |
| event.timezone | String | Timezone of the event. |
| event.enable_datetime_conversion | String | Indicates if datetime conversion is enabled for the event. |
| event.configuration | Object | Configuration details for the event. |
| configuration.type | String | Type of configuration. |
| configuration.attributes | Array of Objects | Attributes for configuration settings. |
| configuration.attributes[].name | String | Name of the configuration attribute. |
| configuration.attributes[].value | Object | Value associated with the configuration attribute. |
| configuration.attributes[].value.name | String | Name of the value. |
| configuration.attributes[].value.image | String (URL) | URL of an image associated with the value. |
| configuration.attributes[].value.url | String (URL) | URL linked to the value. |
| configuration.attributes[].value.latitude | String | Latitude coordinate for the location. |
| configuration.attributes[].value.longitude | String | Longitude coordinate for the location. |
| configuration.attributes[].value.address | Object | Address details of the location. |
| event.listing | Object | Listing details for the event. |
| listing.enabled | Boolean | Indicates if the event is listed. |
| listing.categories | Array | List of categories associated with the event listing. |
| event.resources | Array | Resources related to the event. |
Response
The successful response includes a representation of the newly created event, containing essential details such as the event ID, name, and description, along with other relevant properties.
JSON
{
"statusCode": "201",
"result": {
"event": {
"uuid": "EVENT_UUID",
"status": "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": "EVENT_CURRENCY",
"tax": [
{
"name": "TAX_NAME",
"value": "TAX_VALUE"
}
],
"created_on": "EVENT_CREATED_ON",
"updated_on": "EVENT_UPDATED_ON",
"event_occurrence": [
{
"uuid": "UUID",
"enabled": "ENABLED",
"start_on": {
"utc": "START_ON_UTC",
"local": "START_ON_LOCAL"
},
"end_on": {
"utc": "END_ON_UTC",
"local": "END_ON_LOCAL"
},
"timeslots": [],
"sessions": [],
"tickets": []
}
],
"occurrence": {
"type": "OCCURRENCE_TYPE",
"attributes": {
"starts_on": {
"utc": "STARTS_ON_UTC",
"local": "STARTS_ON_LOCAL"
},
"event_duration": "ATTRIBUTES_EVENT_DURATION",
"occurrence_ends": {
"type": "OCCURRENCE_ENDS_TYPE",
"value": "OCCURRENCE_ENDS_VALUE"
}
},
"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": "VALUE"
}
],
"follows": "FOLLOWS",
"followed_by": {
"uuid": "UUID",
"created_on": "CREATED_ON",
"updated_on": "UPDATED_ON"
},
"mutes": "MUTES"
}
},
"configuration": {
"type": "CONFIGURATION_TYPE",
"attributes": [
{
"name": "ATTRIBUTES_NAME",
"value": {
"name": "NAME",
"image": "IMAGE",
"url": "URL",
"latitude": "LATITUDE",
"longitude": "LONGITUDE",
"address": {
"address_line1": "ADDRESS_LINE1",
"address_line2": "ADDRESS_LINE2",
"country": "COUNTRY",
"state": "STATE",
"city": "CITY",
"post_code": "POST_CODE"
}
}
},
{
"name": "ATTRIBUTES_NAME",
"value": {
"enabled": "ENABLED",
"have_conditions": "HAVE_CONDITIONS",
"list": []
}
}
]
},
"survey_configuration": [],
"coupons": [],
"early_bird_discount": {
"discount_type": "DISCOUNT_TYPE",
"discount": "DISCOUNT",
"type": "TYPE",
"is_enable_customise_discount_start": "IS_ENABLE_CUSTOMISE_DISCOUNT_START",
"discount_starts_on": {
"utc": "UTC",
"local": "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": []
},
"publising": {
"state": "PUBLISING_STATE",
"updated_on": "PUBLISING_UPDATED_ON",
"published_on": {
"utc": "UTC",
"local": "LOCAL"
}
},
"listing": {
"enabled": "LISTING_ENABLED",
"visibility_in_org_profile": "LISTING_VISIBILITY_IN_ORG_PROFILE",
"categories": [],
"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": "REMINDER_EMAIL_BEFORE_EVENT_ENABLED",
"include_ticket": "REMINDER_EMAIL_BEFORE_EVENT_INCLUDE_TICKET",
"reminder_email_time": "REMINDER_EMAIL_BEFORE_EVENT_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": []
},
"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": "TICKET_INSTRUCTION",
"metrics": [
{
"name": "METRICS_NAME",
"value": "METRICS_VALUE"
}
],
"fees": {
"currency": "FEES_CURRENCY",
"pass_on": "PASS_ON",
"rate": [
{
"name": "RATE_NAME",
"value": "UNKNOWN"
}
],
"price_is_tax_inclusive": "FEES_PRICE_IS_TAX_INCLUSIVE",
"tax": [
{
"name": "TAX_NAME",
"value": "TAX_VALUE"
},
{
"name": "TAX_NAME",
"value": "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": "ACTIVITIES"
}
}
}| 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. |
Create Duplicate Of Event: /events/{event_uuid}/duplicate
Purpose
Duplicate a specific event, creating an identical copy with all associated configurations, ticket information, booking data, and session details.
Scope
event.create → Events create permission must be granted from the application to create a duplicate of an event.
Use Case
This endpoint is used by event organisers to create a duplicate of an existing event, including all key event details such as name, description, sessions, and ticket information.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uuid | string | The unique identifier for the event to be duplicated. |
Query Parameters
This endpoint does not have any query parameters.
Request Body
No request body is required for this endpoint.
Response
The response confirms the successful creation of a duplicate event and includes detailed information about the new event, such as the event UUID, name, description, associated organisations, interactions, configurations, ticket data, booking information, session details, and other metadata.
JSON
{
"statusCode": 201,
"result": {
"events": {
"uuid": "EVENT_UUID",
"status": "STATUS",
"premium": "BOOLEAN",
"extended_status": [
{
"name": "PUBLISHING",
"value": "READY_TO_PUBLISH"
}
],
"name": "EVENT_NAME",
"display_name": "EVENT_DISPLAY_NAME",
"slug": "EVENT_SLUG",
"description": "DESCRIPTION",
"banner": [
{
"name": "BANNER_NAME",
"image": "UPLOADS/_DEFAULT/EVENTS/BANNER/SET2/JPG/IMAGE=XXL.JPG",
"primary": "BOOLEAN"
}
],
"thumbnail": {
"name": "THUMBNAIL_NAME",
"image": "UPLOADS/_DEFAULT/EVENTS/BANNER/SET2/JPG/IMAGE=XXL.JPG",
"primary": "BOOLEAN"
},
"resources": [],
"links": [
{
"name": "WEBSITE",
"value": "LINK_VALUE"
}
],
"timezone": "AUSTRALIA/SYDNEY",
"enable_datetime_conversion": "BOOLEAN",
"currency": "CURRENCY",
"tax": [
{
"name": "CODE",
"value": "TAX_CODE"
},
{
"name": "RATE",
"value": "RATE"
}
],
"created_on": "2025-01-23T04:11:17+00:00",
"updated_on": "2025-01-23T04:11:17+00:00",
"event_occurrence": [],
"occurrence": {
"type": "DOES_NOT_REPEAT",
"attributes": {
"starts_on": {
"utc": "2035-01-23 13:00",
"local": "2035-01-24 00:00"
},
"event_duration": "EVENT_DURATION"
},
"exclusions": []
},
"org": {
"uuid": "ORG_UUID",
"name": "ORG_NAME",
"slug": "ORG_SLUG",
"info": "ORG_INFO",
"image": "UPLOADS/ORGS/DEFAULT_IMG/AVATER/AVATAR=2.PNG",
"metrics": [
{
"name": "FOLLOWED_BY_ME",
"value": "METRICS_VALUE"
}
],
"interactions": {
"preferences": [
{
"name": "ALLOW_PEOPLE_TO_CONTACT_MY_ORGANISATION",
"value": "BOOLEAN"
}
],
"follows": "FOLLOW",
"followed_by": "FOLLOWED_BY",
"mutes": "MUTES"
}
},
"configuration": {
"type": "VENUE_EVENT",
"attributes": [
{
"name": "VENUE",
"value": {
"name": "VENUE_NAME",
"image": "UPLOADS/ORGS/C8F4FE51F64B1424FE51C49D49808C44/MAP/ABCD0CC3-D1D5-41D9-8A96-84596CA885BC.PNG",
"url": "https://MAP_URL",
"latitude": "LATITUDE",
"longitude": "LONGITUDE",
"address": {
"address_line1": "ADDRESS_LINE1",
"address_line2": "ADDRESS_LINE2",
"country": "COUNTRY",
"state": "STATE",
"city": "CITY",
"post_code": "POST_CODE"
}
}
},
{
"name": "SURVEY",
"value": {
"enabled": "BOOLEAN",
"list": []
}
}
]
},
"survey_configuration": [],
"coupons": [],
"early_bird_discount": {
"discount_type": "DISCOUNT_TYPE",
"discount": "DISCOUNT_AMOUNT",
"type": "SPECIFIC_TIME",
"is_enable_customise_discount_start": "BOOLEAN",
"discount_starts_on": {
"utc": "2025-01-23 04:00",
"local": "2025-01-23 15:00",
"occurrence_discount_start_type": "DISCOUNT_START_TYPE",
"occurrence_discount_start_offset": "DISCOUNT_START_OFFSET"
},
"discount_ends_on": {
"utc": "DISCOUNT_END_UTC",
"local": "DISCOUNT_END_LOCAL",
"occurrence_discount_end_type": "DISCOUNT_END_TYPE",
"occurrence_discount_end_offset": "DISCOUNT_END_OFFSET"
}
},
"tickets": {
"price_is_fee_inclusive": "BOOLEAN",
"price_is_tax_inclusive": "BOOLEAN",
"levels": [
{
"uuid": "TICKET_UUID",
"display_order": "NATURAL",
"name": "GENERAL_TICKET",
"description": "TICKET_DESCRIPTION",
"quantity": "QUANTITY",
"max_quantity_per_customer": "MAX_QUANTITY_PER_CUSTOMER",
"quantity_sold": "QUANTITY_SOLD",
"total_purchased_by_user": "TOTAL_PURCHASED_BY_USER",
"category": "TICKET_CATEGORY",
"min_donation_amount": "MIN_DONATION_AMOUNT",
"max_donation_amount": "MAX_DONATION_AMOUNT",
"default_donation_amount": "DEFAULT_DONATION_AMOUNT",
"status": "BOOLEAN",
"session_id": "SESSION_ID",
"parent_id": "PARENT_ID",
"url_digital_pass": "URL_DIGITAL_PASS",
"pricing_details": [
{
"uuid": "PRICING_UUID",
"variation": "PRICING_VARIATION",
"price": "PRICING_PRICE",
"quantity_included": "QUANTITY_INCLUDED",
"quantity_sold": "QUANTITY_SOLD"
}
],
"early_bird_discount": {
"discount_type": "DISCOUNT_TYPE",
"discount": "DISCOUNT_AMOUNT",
"type": "SPECIFIC_TIME",
"is_enable_customise_discount_start": "BOOLEAN",
"discount_starts_on": {
"utc": "2025-01-23 04:00",
"local": "2025-01-23 15:00",
"occurrence_discount_start_type": "DISCOUNT_START_TYPE",
"occurrence_discount_start_offset": "DISCOUNT_START_OFFSET"
},
"discount_ends_on": {
"utc": "DISCOUNT_END_UTC",
"local": "DISCOUNT_END_LOCAL",
"occurrence_discount_end_type": "DISCOUNT_END_TYPE",
"occurrence_discount_end_offset": "DISCOUNT_END_OFFSET"
}
},
"coupons": [],
"settings": [],
"ticket_instruction": "TICKET_INSTRUCTION",
"custom_attributes": [],
"created_on": {
"utc": "2025-01-23 02:49",
"local": "2025-01-23 13:49"
}
}
]
},
"publishing": {
"state": "READY_TO_PUBLISH",
"updated_on": "2025-01-23T04:11:17+00:00",
"published_on": {
"utc": "PUBLISHED_UTC",
"local": "PUBLISHED_LOCAL"
}
},
"listing": {
"enabled": "BOOLEAN",
"visibility_in_org_profile": "BOOLEAN",
"categories": [
{
"uuid": "CATEGORY_UUID",
"name": "BUSINESS",
"description": "BUSINESS",
"url": "URL",
"image": "UPLOADS_ORGS/"
}
],
"tags": []
},
"settings": {
"booking_starts_on": {
"type": "IMMEDIATE",
"utc": "2025-01-23 04:00",
"local": "2025-01-23 15:00",
"occurrence_booking_start_type": "BOOKING_START_TYPE",
"occurrence_booking_start_offset": "BOOKING_START_OFFSET",
"hide_ticket_until_booking_start": "BOOLEAN",
"level": "EVENT"
},
"booking_ends_on": {
"type": "CONTINUE_UNTIL_EVENT_ENDS",
"utc": "2035-01-24 00:00",
"local": "2035-01-24 11:00",
"occurrence_booking_end_type": "BOOKING_END_TYPE",
"occurrence_booking_end_offset": "BOOKING_END_OFFSET",
"level": "EVENT"
},
"event_capacity": "EVENT_CAPACITY",
"max_ticket_per_customer": "MAX_TICKET_PER_CUSTOMER",
"terminology": "TERMINOLOGY",
"enable_guest_checkout": "BOOLEAN",
"enable_share": "BOOLEAN",
"digital_pass": {
"enabled": "BOOLEAN",
"level": "EVENT"
},
"discount": {
"enabled": "BOOLEAN",
"level": "EVENT"
},
"coupon": {
"enabled": "BOOLEAN",
"level": "EVENT"
},
"service_charge": {
"enabled": "BOOLEAN",
"level": "EVENT"
},
"boxoffice": "BOXOFFICE",
"sell_session": {
"enabled": "BOOLEAN",
"level": "EVENT"
},
"sell_session_individually": {
"enabled": "BOOLEAN",
"level": "EVENT"
},
"sell_tickets_on_venue": {
"enabled": "BOOLEAN",
"level": "EVENT"
},
"special_instruction": {
"enabled": "BOOLEAN",
"level": "EVENT"
},
"waiting_list": {
"enabled": "BOOLEAN",
"level": "EVENT"
},
"qr_code": {
"enabled": "BOOLEAN",
"level": "EVENT"
},
"configure_ticket_remaining": {
"enabled": "BOOLEAN",
"level": "EVENT",
"remaining_tickets": "REMAINING_TICKETS",
"hide_on_the_event_details": "BOOLEAN"
},
"custom_thumbnails": {
"enabled": "BOOLEAN",
"thumbs": {
"portrait": "THUMB_PORTRAIT",
"landscape": "THUMB_LANDSCAPE"
}
},
"custom_seo_details": {
"enabled": "BOOLEAN",
"title": "SEO_TITLE",
"description": "SEO_DESCRIPTION",
"image": "SEO_IMAGE"
},
"collect_additional_info_from_buyer": {
"enabled": "BOOLEAN",
"mandatory": "BOOLEAN"
},
"ticket_scanning": {
"enabled": "BOOLEAN",
"allow_scanning_only_during_event_hour": "BOOLEAN"
},
"configure_pricing_display_text": {
"enabled": "BOOLEAN",
"display": "PRICE_RANGE"
},
"enable_ticket_mandatory": "BOOLEAN",
"enable_rsvp": "BOOLEAN",
"tracking_codes": [],
"blockout_period": "BLOCKOUT_PERIOD",
"restrictions": "RESTRICTIONS",
"terms_and_condition": [],
"include_tax_or_gst": "BOOLEAN",
"company_registration_details": "COMPANY_REGISTRATION_DETAILS",
"abn_activate_on": "ABN_ACTIVATE_ON",
"organisation_entity_name": "ORG_ENTITY_NAME",
"dgr_status": "BOOLEAN",
"reminder_email_before_event": {
"enabled": "BOOLEAN",
"include_ticket": "BOOLEAN",
"reminder_email_time": 1440
},
"reminder_email_after_event": {
"enabled": "BOOLEAN",
"reminder_email_time": 60
},
"enable_full_day": "BOOLEAN",
"sessions": {
"enabled": "BOOLEAN",
"type": "MULTIPLE_CHOICE",
"session_lists": [
{
"uuid": "SESSION_UUID_1",
"sell_session": "BOOLEAN",
"status": 1,
"name": "SESSION_NAME_1",
"capacity": 10,
"display_name": "DISPLAY_NAME",
"description": "SESSION_DESC_1",
"duration": 60,
"image": "IMAGE",
"created_on": "2025-01-23T03:17:23+00:00",
"updated_on": "2025-01-23T03:17:23+00:00",
"occurrences": {
"type": "SPECIFIC",
"uuid": []
},
"session_starts_on": {
"utc": "2035-01-23 23:00",
"local": "2035-01-24 10:00"
},
"session_ends_on": {
"utc": "2035-01-24 00:00",
"local": "2035-01-24 11:00"
},
"tickets": [
{
"uuid": "TICKET_UUID_1",
"quantity_sold": 0,
"total_purchased_by_user": 0,
"pricing_details": [
{
"uuid": "PRICING_UUID",
"quantity_sold": 0
}
]
}
]
},
{
"uuid": "SESSION_UUID_2",
"sell_session": "BOOLEAN",
"status": 1,
"name": "SESSION_NAME_2",
"capacity": 20,
"display_name": "DISPLAY_NAME",
"description": "SESSION_DESC_2",
"duration": 60,
"image": "UPLOADS_DEFAULT_EVENTS/IMAGE.jpg",
"created_on": "2025-01-23T03:18:04+00:00",
"updated_on": "2025-01-23T03:18:04+00:00",
"occurrences": {
"type": "SPECIFIC",
"uuid": []
},
"session_starts_on": {
"utc": "2035-01-23 13:00",
"local": "2035-01-24 00:00"
},
"session_ends_on": {
"utc": "2035-01-23 14:00",
"local": "2035-01-24 01:00"
},
"tickets": [
{
"uuid": "TICKET_UUID_2",
"quantity_sold": 0,
"total_purchased_by_user": 0,
"pricing_details": [
{
"uuid": "PRICING_UUID",
"quantity_sold": 0
}
]
}
]
}
]
},
"refund": {
"available": "BOOLEAN",
"policy": {
"cancel_before_event_starts": 0,
"automatic": "BOOLEAN",
"amount": {
"discount_type": "PERCENTAGE",
"discount_unit": 0
}
}
},
"ticket_instruction": "TICKET_INSTRUCTION",
"metrics": [
{
"name": "SHARED_COUNT",
"value": 0
}
],
"fees": {
"currency": "BDT",
"pass_on": "PASS_ON",
"rate": [
{
"name": "EVENTBOOKINGS_SERVICE_FEE_FIXED",
"value": 10
}
],
"price_is_tax_inclusive": "BOOLEAN",
"tax": [
{
"name": "TAX_CODE",
"value": "TAX_VALUE"
},
{
"name": "TAX_RATE",
"value": "TAX_RATE"
}
]
},
"interactions": {
"saves": [],
"shares": [],
"attendees": [],
"speaker": [],
"reviews": [],
"waiting_list": [],
"join_url": []
},
"merchandise": {
"products": []
},
"event_settings_reviewed": "BOOLEAN",
"custom_attributes": [],
"event_code": {
"type": "QR",
"value": "EVENT_CODE_URL",
"image": "IMAGE"
},
"activities": "ACTIVITIES"
}
}
}
}| 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. |
Create events session: /events/{event_uuid}/sessions
Purpose
This endpoint allows event organisers to add a new session to an existing event. The session details, such as the session name, description, timing, and ticket availability, are specified in the request body. Once successfully created, the session becomes part of the event and can be managed for attendees and ticket sales.
Scope
event.add_session → Events create permission must be granted from the application to create a session of an event.
Use Case
Event organisers can use this endpoint to create new sessions for an event. This is useful when adding additional sessions or defining specific session attributes like session timings, available tickets, and pricing details, which helps in managing event logistics and attendee engagement.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uuid | string | The unique identifier for the event to which the session is being added. |
Query Parameters
This endpoint does not have any query parameters.
Request Body
The request body contains the necessary session details for creating a session. This includes session name, description, duration, start time, ticket type, and occurrences. The body also defines whether the session will be for sale, and it includes ticket UUIDs to link the session to available ticket types.
JSON
{
"sessions": {
"name": "SESSION_NAME",
"sell_session": "BOOLEAN",
"status": "ACTIVE",
"description": "SESSION_DESC_MANAGERS",
"image": "UPLOADS_DEFAULT_EVENTS/IMAGE.jpg",
"session_starts_on": "2025-01-24 00:00",
"duration": DURATION,
"occurrences": {
"type": "ALL"
},
"tickets": {
"type": "ALL",
"uuid": [
"TICKET_UUID"
]
}
}
}
| 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 that the session has been created successfully and provides detailed information about the newly created session. This includes the session's UUID, its status, description, timing, and associated tickets. Additionally, the response includes metadata such as the creation time and the link to the session’s occurrence details.
JSON
{
"statusCode": 201,
"result": {
"session": {
"session": {
"uuid": "UUID_PLACEHOLDER",
"sell_session": "BOOLEAN",
"status": "STATUS_ACTIVE",
"name": "SESSION_NAME",
"capacity": CAPACITY,
"display_name": "DISPLAY_NAME",
"description": "SESSION_DESC_MANAGERS",
"duration": DURATION,
"image": "UPLOADS_DEFAULT_EVENTS/IMAGE.jpg",
"created_on": "2025-01-23T05:04:59+00:00",
"updated_on": "2025-01-23T05:04:59+00:00",
"occurrences": {
"type": "ALL",
"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",
"quantity_sold": QUANTITY_SOLD,
"total_purchased_by_user": TOTAL_PURCHASE,
"pricing_details": [
{
"uuid": null,
"quantity_sold": QUANTITY_SOLD
}
]
}
]
}
}
}
}
| Attribute | Type | Description |
|---|---|---|
| statusCode | Integer | Represents the HTTP status code of the API response. A value of 201 indicates a successful request of session create. |
| 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. |
Publish events: /events/{event_uuid}/publish
Purpose
This endpoint is used to publish a specific event, making it publicly accessible. When an event is published, it becomes visible to attendees, allowing them to view details, register, and interact with the event.
Scope
event.publish → Events update permission must be granted from the application to publish an event.
Use Case
Event organisers use this endpoint to publish an event after it has been fully set up. Once published, the event can be accessed by potential attendees for registration and participation.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uuid | string | The unique identifier for the event to be published. |
Query Parameters
This endpoint does not have any query parameters.
Request Body
No request body is required for this endpoint.
Response
The response confirms the successful publication of the event. It provides a status message indicating that the event has been successfully made live, allowing public access.
JSON
{
"statusCode": 201,
"result": "Event has been published successfully"
}| Attribute | Type | Description |
|---|---|---|
| statusCode | Integer | Represents the HTTP status code of the API response. A value of 201 indicates a resource was successfully created. |
| result | String | A message indicating the result of the operation. In this case, it confirms that the event was published successfully. |
Unpublish Event: /events/{event_uuid}/unpublish
Purpose
This endpoint is used to unpublish a specific event, making it no longer publicly accessible. Once an event is unpublished, attendees will not be able to view or register for the event until it is published again.
Scope
event.unpublish → Events update permission must be granted from the application to unpublish an event.
Use Case
Event organisers use this endpoint to unpublish an event, typically when the event is no longer active, or if changes need to be made before it is made available again to the public.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uuid | string | The unique identifier for the event to be unpublished. |
Query Parameters
This endpoint does not have any query parameters.
Request Body
No request body is required for this endpoint.
Response
The response confirms the successful unpublishing of the event. It provides a status message indicating that the event has been successfully made private again, restricting public access.
JSON
{
"statusCode": 201,
"result": "Event has been unpublished successfully"
}| Attribute | Type | Description |
|---|---|---|
| statusCode | Integer | Represents the HTTP status code of the API response. A value of 201 indicates a resource was successfully created. |
| result | String | A message indicating the operation's result. In this case, it confirms that the event was unpublished successfully. |
Cancel Event: /events/{event_uuid}/cancel
Purpose
This endpoint is used to cancel a specific event, which will prevent any further registration or participation. Once canceled, the event is no longer available for attendees, and its status is updated to reflect the cancellation.
Scope
event.cancel → Events update permission must be granted from the application to cancel an event.
Use Case
Event organisers use this endpoint to cancel an event, either due to unforeseen circumstances or changes in the event schedule. This ensures that potential attendees are informed and that the event no longer appears in the registration system.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uuid | string | The unique identifier for the event to be cancelled. |
Query Parameters
This endpoint does not have any query parameters.
Request Body
No request body is required for this endpoint.
Response
The response confirms that the event has been successfully canceled. It provides a status message indicating that the cancellation has been processed.
JSON
{
"statusCode": 200,
"result": "Event has been cancelled successfully."
}| Attribute | Type | Description |
|---|---|---|
| statusCode | Integer | Represents the HTTP status code of the API response. A value of 200 indicates the request was successful. |
| result | String | A message indicating the result of the operation. In this case, it confirms that the event was cancelled successfully. |