DELETE
/communication
Usage Notes
When
- Remove communications created with incorrect details
- Clean up duplicate communication records
- Delete test communications from development environments
Requirements
- Communication must not be referenced by active operational workflows
Notes
- Deletion is permanent with no recovery mechanism
- Deleted email addresses become available for reuse
- Alternative: use PUT to update contact information instead
Description
Permanently deletes a communication record. Deleted email addresses become available for new records. Consider PUT update as alternative when preserving history matters.
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 CommunicationID (recommended)
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
}