Skip to content
New

Person Report API and New Zealand identity checks are now live.

See what's new
Talk to the team

9am–5pm AEST, Monday to Friday.

03 9948 4089
WatchEye · Notes

Delete a note

Deleting a note is a soft delete: the note stays in the database for audit and compliance purposes but is removed from list and show responses, which return 404 for it afterwards. Only notes written by an API key on the account can be deleted, and the deleted note is returned once as confirmation.

  • Soft delete: hidden, not destroyed, within the 30-day recovery window
  • Archiving in the portal keeps a note accessible instead
For developers

After the technical detail?

For the technical detail, go to the API documentation. It holds the request and response schema, the integration guides and the error codes for this endpoint.

  • Request and response schema
  • Soft-deletion policy
Go to the API docs

New accounts begin with sandbox access.

ISO 27001 certified Handled under Australian privacy law Every API call written to the audit log
What the check gives you

Removing a note your system wrote

A note written in error, or one whose source record was withdrawn, is removed from view in one call. WatchEye preserves it, so the audit trail stays intact and the deletion can be reversed within the recovery window.

That the note is gone from the working views

After deletion the note is no longer returned by the list and its show endpoint returns 404. The response returns the deleted note once as confirmation.

That it can be recovered

Soft-deleted records can be restored within 30 days by a user with the account manager role from the portal's Show deleted filter. There is no API restore. After 30 days the record may be permanently removed.

That protected notes stay put

A note written by a portal user returns 404 from this endpoint, and an immutable audit-trail note returns 403.

How a check runs

The lifecycle a note moves through

A note is created, can be edited while an API key owns it, and is soft-deleted rather than destroyed. Archiving is a portal-only action.

Prefer archiving in the portal where the note must stay accessible for compliance.

Related checks

Others in WatchEye Notes

Show a note reads it before you delete it. Update a note changes its text instead. List notes no longer shows it afterwards.

Questions

Questions we get asked about deleting a note

What does our system need to send?
The note UUID in the path. Nothing else.
What comes back?
A 200 with the deleted note record, returned once as confirmation. Subsequent calls for the same UUID return 404.
Which notes can the API change?
Only notes authored by an API key on the account. A note written by a portal user returns 404 from the update and delete endpoints even though it exists; its author or an account manager edits it in the portal. A note marked immutable, such as the audit-trail note left by a bulk update, returns 403 because no one can change it through any channel.
Can it be undone?
Within 30 days, in the portal: a user with the account manager role applies the Show deleted filter, opens the record and chooses Restore. There is no API equivalent. After the window the record is eligible for permanent removal.
Getting started

The first step to access is a conversation

Sandbox accounts are provisioned by your Global Data account manager. API keys are created and managed in the WatchEye portal, and the same endpoints serve sandbox and live; the account behind the key decides which environment you are in.

Call 03 9948 4089, 9am–5pm AEST Monday to Friday

ISO 27001 certified
Handled under Australian privacy law
Every API call written to the audit log