DELETE

/Address

When to Use

Remove addresses that are no longer valid
Clean up duplicate or incorrect addresses
Delete test addresses from development

Prerequisites

Address must exist and be accessible

Considerations

Deletion is permanent and cannot be undone
May affect tax residency reporting for associated entities
Alternative: Update address details rather than delete

Description

Permanently deletes an address record from the system.

Advanced Resource: Address records are typically managed through BizEntity operations. Use this endpoint for direct address deletion or data cleanup.

Recommendation: Update address details rather than delete when possible to preserve audit trails.

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	> Conditional...	The unique system identifier for the address record to delete. Provide this for direct deletion using the internal 7G ID.
`ExternalAddressId` >	string	> Conditional...	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

integer

> Conditional...

The unique system identifier for the address record to delete. Provide this for direct deletion using the internal 7G ID.

ExternalAddressId

string

> Conditional...

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 native ID
curl -X DELETE "https://api.7g.com.au/Address?AddressID=12345" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

# Delete address by external ID
curl -X DELETE "https://api.7g.com.au/Address?ExternalAddressId=RES-001" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

Response Examples

json

{
  "result": true,
  "message": "Address deleted successfully",
  "recordCount": 0,
  "data": null
}