DELETE
/Communication
When to Use
- Permanently remove communication records that are no longer valid
- Clean up duplicate or incorrect contact information
- Remove communications before transferring ownership to different entities
- Comply with data retention policies
Common Scenarios
- Duplicate Contact Cleanup: Remove duplicate email addresses or phone numbers created during data imports
- Outdated Contact Removal: Delete old business emails or phone numbers that are no longer active
- Privacy Compliance: Remove communication records as part of data subject requests or right to erasure
- Entity Transfer Preparation: Clean up communication records before transferring entities between systems
Prerequisites
- Valid Bearer token with communication deletion permissions
- Communication record must exist and be accessible to your account
- Understanding of cascade deletion effects
Considerations
- Compliance Impact: Removes communication from regulatory notification systems
- Irreversible: Deletion is permanent and cannot be undone
- Email Uniqueness: Deleted email addresses become available for reuse
- Alternative: Consider updating to different contact information rather than deletion
Description
Permanently deletes a communication record from the system. This removes the communication association from any related entities and impacts compliance notification routing.
Advanced Resource: Communication records are typically managed through BizEntity operations. Use this endpoint for direct communication deletion only when the communication is no longer associated with active entities or for data cleanup purposes.
⚠️ Deletion Impact
Communication deletion affects:
- Entity compliance notifications (CRS/FATCA, AML/KYC)
- Investor correspondence and communication routing
- Distribution and transaction notifications
- Regulatory reporting and audit trails
Recommended: Update communication details rather than delete when possible.
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 |
---|---|---|---|
CommunicationID |
integer | The native 7G identifier for the communication to delete. | |
ExternalCommunicationId |
string(50) | Your external identifier for the communication to delete. |
CommunicationID
The native 7G identifier for the communication to delete.
ExternalCommunicationId
Your external identifier for the communication to delete.
Example Requests
bash
# Delete communication by native ID
curl -X DELETE "https://api.7g.com.au/Communication?CommunicationID=12345" \
-H "Authorization: {accessToken}" \
-H "Version: 2.0"
# Delete communication by external ID
curl -X DELETE "https://api.7g.com.au/Communication?ExternalCommunicationId=EMAIL-001" \
-H "Authorization: {accessToken}" \
-H "Version: 2.0"
Response Examples
json
{
"result": true,
"message": "Communication deleted successfully",
"recordCount": 0,
"data": null
}