Skip to content

Delete a record watcher

Work module

DELETE/record-watchers/{id}recordWatchers.delete

A person watching a record for notifications. Soft-deletes the record watcher: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability inbox.notifications.write.
  • OAuth scopes: inbox.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

recordWatchers.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the record watcher.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/record-watchers/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.recordWatchers.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.record_watchers.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos record-watchers delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f