PUT

/BizEvent/Cancel

Usage Notes

When

Cancel pending events before processing
Remove events created in error

Requirements

Event must be in pending state

Notes

Updates event status to cancelled
Cannot cancel processed events

Description

Cancels a pending event by updating its status. Only works for events not yet processed.

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	> Conditional...	Native 7G identifier for the product.
`ExternalProductId` >	string	> Conditional...	External system identifier for the product (alternative to ProductID).
`BizEventID` >	integer	> Required...	Native 7G identifier for the business event.

ProductID

integer

> Conditional...

Native 7G identifier for the product.

ExternalProductId

string

> Conditional...

External system identifier for the product (alternative to ProductID).

BizEventID

integer

> Required...

Native 7G identifier for the business event.

Example Requests

bash

# Cancel with ProductID and BizEventID
curl -X PUT 'https://api.7g.com.au/BizEvent/Cancel?ProductID=100&BizEventID=12345' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0'

# Cancel with External Product ID
curl -X PUT 'https://api.7g.com.au/BizEvent/Cancel?ExternalProductId=PROD-001&BizEventID=12345' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0'

Response Examples

json

{
  "result": true,
  "message": "Event cancelled successfully",
  "recordCount": 0,
  "data": null
}