DELETE

/organisation

Usage Notes

When

  • Remove organisations created with incorrect details
  • Clean up duplicate organisation records
  • Delete test organisations from development environments

Requirements

  • Organisation must have no active BizEntityParty relationships
  • No trustee roles or transaction history

Notes

  • All associated Address and Communication records automatically removed
  • Deletion is permanent with no recovery mechanism
  • Associated person links removed but person records remain

Description

Permanently deletes an organisation and cascades deletion to associated addresses and communications. Only works when no BizEntityParty relationships or trustee roles exist.

Required Headers - See Authentication

HeaderValueDescription
Authorization{accessToken}Bearer token for API access
Version2.0API version identifier

Query Parameters

Parameter Type Required Description
OrganisationID >
integer
The native 7G identifier for the organisation to delete. Preferred for performance and direct system lookup.
externalOrganisationId >
string
Your external identifier for the organisation to delete. Use when you cannot store 7G's native IDs.
OrganisationID
integer
The native 7G identifier for the organisation to delete. Preferred for performance and direct system lookup.
externalOrganisationId
string
Your external identifier for the organisation to delete. Use when you cannot store 7G's native IDs.

Example Requests

bash
# Delete by OrganisationID (recommended)
curl -X DELETE "https://api.7g.com.au/organisation?OrganisationID=123" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

# Delete by External ID
curl -X DELETE "https://api.7g.com.au/organisation?ExternalOrganisationId=EXT-ABC-001" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

Response Examples

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