DELETE
/person
Usage Notes
When
- Remove persons created with incorrect details
- Clean up duplicate person records
- Delete test persons from development environments
Requirements
- Person must have no active BizEntityParty relationships
- No transaction history involving this person
Notes
- Deletion cascades to all associated Address and Communication records
- Deletion is permanent with no recovery mechanism
- Persons with any BizEntity links cannot be deleted
Description
Permanently deletes a person and cascades deletion to associated addresses and communications. Only works when no BizEntityParty relationships or transaction history exists.
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 |
|---|---|---|---|
PersonID |
integer | The 7G system identifier for the person to delete. Preferred for performance and direct system lookup. | |
ExternalPersonId |
string | Your external identifier for the person to delete. Use when you cannot store 7G's native PersonID. |
PersonID
The 7G system identifier for the person to delete. Preferred for performance and direct system lookup.
ExternalPersonId
Your external identifier for the person to delete. Use when you cannot store 7G's native PersonID.
Safe Deletion Process
- Verify person exists and you have the correct ID
- Check person has no active BizEntity relationships
- Confirm person has no transaction history
- Execute deletion (addresses and communications removed automatically)
Example Requests
bash
# Delete person by PersonID (recommended for performance)
curl -X DELETE "https://api.7g.com.au/person?PersonID=12345" \
-H "Authorization: {accessToken}" \
-H "Version: 2.0"
# Delete person by ExternalPersonId (alternative identifier)
curl -X DELETE "https://api.7g.com.au/person?ExternalPersonId=EXT-PERSON-001" \
-H "Authorization: {accessToken}" \
-H "Version: 2.0"Response Examples
json
{
"result": true,
"message": "Person deleted successfully",
"recordCount": 0,
"data": null
}