DELETE

/Communication

When to Use

  • Remove communications created with incorrect details
  • Clean up duplicate communication records
  • Delete test communications from development environments

Prerequisites

  • Communication record must exist

Considerations

  • Deletion is permanent and cannot be undone
  • Deleted email addresses become available for reuse
  • Alternative: Use PUT to update contact information instead of deleting

Description

Permanently deletes a communication record from the system. This removes the communication association from the related entity.

Advanced Resource: Communication records are typically managed through BizEntity operations. Use this endpoint for direct communication deletion only when the communication is no longer needed or for data cleanup purposes.

Communication deletion is permanent with no recovery mechanism available. Consider using PUT to update contact information instead of deleting when possible.

Required Headers - See Authentication

HeaderValueDescription
Authorization{accessToken}Bearer token for API access
Version2.0API 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
integer
The native 7G identifier for the communication to delete.
ExternalCommunicationId
string(50)
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
}