DELETE
/Distribution
When to Use
- Remove distribution records created in error before any processing
- Clean up test or draft distributions that won't be declared
- Cancel distributions before declaration phase begins
- Remove distributions that have been superseded by corrected versions
Common Scenarios
- Test Distribution Cleanup: Remove draft distributions created during testing before production declaration
- Erroneous Distribution Cancellation: Delete distributions created with incorrect parameters before processing begins
- Pre-Declaration Modifications: Remove initial distributions to recreate with corrected details
- System Migration Cleanup: Delete incomplete distributions from data migration processes
Prerequisites
- Valid Bearer token with distribution deletion permissions
- Distribution must be in Created stage (Step 1) only - not declared, distributed, or allotted
- No distribution account records should exist (delete accounts first)
- Authorization from appropriate stakeholders for permanent deletion
Considerations
- Deletion is only possible before any distribution actions are performed
- Once declared, distributed, or allotted, distributions cannot be deleted
- Distribution account records must be deleted first if they exist
- Deletion is permanent and cannot be undone - consider updates instead
- Use with caution as this removes all distribution configuration
Description
Permanently deletes a distribution record from the system. This operation is only allowed for distributions that have not yet been declared or processed. The distribution must be in its initial created state with no dependent records or processing actions performed.
Workflow Stage Restriction
Deletion only permitted during Created stage (Step 1 of 4). Once any workflow actions performed (Declare/Distribute/Allotment), deletion is permanently blocked.
⚠️ Critical Deletion Restrictions
Per the 7G API specification: "A distribution record cannot be deleted once any actions have been performed on it." This includes declaration, distribution execution, or allotment processing.
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 product identifier for enhanced security validation. | |
ExternalProductId |
string | Client-supplied product reference for enhanced security validation. |
CorporateActionID
Native 7G distribution identifier for deletion (preferred for performance).
ExternalCorporateActionId
Client-supplied distribution reference for deletion (when 7G ID unavailable).
ProductID
Native 7G product identifier for enhanced security validation.
ExternalProductId
Client-supplied product reference for enhanced security validation.
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 "Content-Type: application/json" \
-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 "Content-Type: application/json" \
-H "Authorization: {accessToken}" \
-H "Version: 2.0"Response Examples
json
{
"result": true,
"message": "Distribution deleted successfully",
"recordCount": 0,
"data": null
}