Delete a suggestion
DELETE/api/v1/suggestions/:id_suggestion
Remove a suggestion permanently.
Dismissing (PUT with dismissed: true) is reversible and is what the
user interface does when someone sets a suggestion aside. Delete is for a
feeder retracting an event that should never have been sent — a meeting
cancelled, a record fed in error.
This action is irreversible and cannot be undone. Please be certain you want to delete the suggestion before proceeding.
An accepted suggestion cannot be deleted
A suggestion with actualized: true is refused with a 409, for two
reasons. The entry it produced still refers to it, so deleting would
break that link. And an accepted suggestion is training data: it records
which codes a person really chose for an event, which is what sharpens
later predictions. Dismiss it instead.
Your own suggestions, or those of a user you hold a timekeeping ability
over. Over a Bearer token this needs the jx:suggestions:write scope.
Request
Responses
- 204
- 400
- 401
- 403
- 404
- 409
- 500
- 503
The object was successfully deleted. The response body is empty.
A 400 Bad Request is returned when the client request was malformed,
invalid, or otherwise could not be processed as-is. Usually, the cause for
the error is included in the error.message field of the response, and the
client should correct the request and try again.
See also Core Concepts#Error Responses.
Not authenticated - you must be signed in to access this resource. Please check the section of the documentation on authentication.
A 403 Forbidden response means that you are not authorized to perform
this action or access this object, or the object does not exist at all.
The client request may have been valid but the client does not have permission to access the requested resource or perform the requested action.
In most cases, the system will not return a 404 Not Found error response;
it returns 403 Forbidden both when the object doesn't exist at all,
and also when it exists but the client does not have permission to access it.
This is a security measure to prevent unauthorized users from determining
whether an object exists or not.
See also Core Concepts#Error Responses.
Not found - the requested resource could not be found or does not exist. This may also include cases where the resource does exist, but the client does not have permission to access that resource.
In most cases, the system will not return a 404 Not Found error response;
it returns 403 Forbidden both when the object doesn't exist at all,
and also when it exists but the client does not have permission to access it.
This is a security measure to prevent unauthorized users from determining
whether an object exists or not.
See also Core Concepts#Error Responses.
Conflict — the suggestion has been accepted into an entry and cannot be deleted. Dismiss it instead.
Internal server error; an unexpected error occurred on the server. This could be due to a temporary condition or might be the result of a bug in the server software. Also, in some cases, an incorrect client input can trigger this error, and can be resolved by correcting the input.
If the error persists, please contact support along along with the following details when possible:
- any error messages received from the server
- the full request and response details (full headers and body)
- a description of the steps that led to the error
- the time range when it occurred.
Service unavailable - the server is currently unable to handle the request, usually due to maintenance activity on the server. Check if the server's web interface is currently available, or try again later.