DELETE
/address
Usage Notes
When
- Remove addresses created with incorrect details
- Clean up duplicate address records
- Delete test addresses from development environments
Requirements
- Address must not be the sole address for an entity with active relationships
Notes
- Deletion is permanent with no recovery mechanism
- Addresses referenced by active workflows may be protected from deletion
Description
Permanently deletes an address record. Only works when the address is not required for active entity relationships or compliance requirements.
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 |
|---|---|---|---|
AddressID |
integer | The unique system identifier for the address record to delete. Provide this for direct deletion using the internal 7G ID. | |
ExternalAddressId |
string | Your external system identifier for the address record to delete. Use this when referencing addresses by your organization's ID system for cross-system consistency. |
AddressID
The unique system identifier for the address record to delete. Provide this for direct deletion using the internal 7G ID.
ExternalAddressId
Your external system identifier for the address record to delete. Use this when referencing addresses by your organization's ID system for cross-system consistency.
Example Requests
bash
# Delete address by internal ID
curl -X DELETE "https://api.7g.com.au/address?AddressID=7001" \
-H "Authorization: {accessToken}" \
-H "Version: 2.0"
# Delete address by external ID
curl -X DELETE "https://api.7g.com.au/address?ExternalAddressId=EXT-ADDR-001" \
-H "Authorization: {accessToken}" \
-H "Version: 2.0"Response Examples
json
{
"result": true,
"message": "Address deleted successfully",
"recordCount": 0,
"data": null
}