DELETE
/Distribution
Usage Notes
When
- Remove distributions created with incorrect details
- Delete test distributions from development environments
- Clean up distributions before declaration stage
Requirements
- Distribution must not be declared or processed
Notes
- Only works before declaration stage
- Deletion is permanent with no recovery mechanism
- Declared distributions cannot be deleted
Description
Permanently deletes a distribution record. Only available for distributions that have not been declared.
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 |
|---|---|---|---|
CorporateActionID |
integer | Native 7G distribution identifier for deletion (preferred for performance). | |
ExternalCorporateActionId |
string | Client-supplied distribution reference for deletion (when 7G ID unavailable). | |
ProductID |
integer | Native 7G identifier for the product. | |
ExternalProductId |
string | External system identifier for the product (alternative to ProductID). |
CorporateActionID
Native 7G distribution identifier for deletion (preferred for performance).
ExternalCorporateActionId
Client-supplied distribution reference for deletion (when 7G ID unavailable).
ProductID
Native 7G identifier for the product.
ExternalProductId
External system identifier for the product (alternative to ProductID).
Example Requests
bash
# Delete by corporate action ID with security validation
curl -X DELETE 'https://api.7g.com.au/Distribution?CorporateActionID=12346&ProductID=100' \
-H 'Authorization: {accessToken}' \
-H 'Version: 2.0'
# Delete by external corporate action ID with external product validation
curl -X DELETE 'https://api.7g.com.au/Distribution?ExternalCorporateActionId=DIST-2024-Q2&ExternalProductId=FUND-001' \
-H 'Authorization: {accessToken}' \
-H 'Version: 2.0'Response Examples
json
{
"result": true,
"message": "Distribution deleted successfully",
"recordCount": 0,
"data": null
}