PUT
/BizEvent/Cancel
When to Use
- Update event status to cancelled for pending events
- Mark events as cancelled in the event record
Prerequisites
- Valid event identifier (BizEventID)
- Valid product identifier (ProductID or ExternalProductId)
Considerations
- Returns success message upon event cancellation
- Does not return event record data (only success/failure message)
Description
Updates the specified event's status to cancelled. Accepts ProductID (or ExternalProductId) and BizEventID as query parameters. Returns success or failure message indicating cancellation result.
Cancellation Response
This endpoint returns a message-only response without event data. Use GET /BizEvent with the BizEventID to retrieve the updated event record after cancellation.
Required Headers - See Authentication
| Header | Value | Description |
|---|---|---|
| Authorization | {accessToken} | Bearer token for API access |
| Version | 2.0 | API version identifier |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
ProductID |
integer | Native 7G identifier for the product. | |
ExternalProductId |
string | External system identifier for the product (alternative to ProductID). | |
BizEventID |
integer | Native 7G identifier for the business event. |
ProductID
Native 7G identifier for the product.
ExternalProductId
External system identifier for the product (alternative to ProductID).
BizEventID
Native 7G identifier for the business event.
Example Requests
json
# Cancel using ProductID and BizEventID
curl -X PUT "https://api.7g.com.au/BizEvent/Cancel?ProductID=100&BizEventID=12345" \
-H "Authorization: {accessToken}" \
-H "Version: 2.0"Response Examples
json
{
"result": true,
"message": "Event cancelled successfully",
"recordCount": 0,
"data": null
}