Function: deleteActivitiesById()

deleteActivitiesById<ThrowOnError>(options): RequestResult<DeleteActivitiesByIdResponses, DeleteActivitiesByIdErrors, ThrowOnError>

Defined in: app/api/sdk.gen.ts:49

Deletes a specific activity by its unique identifier. The DeleteActivity endpoint allows clients to remove an existing activity from the system based on the provided ID. This endpoint is designed to handle the deletion of activities, ensuring that proper authorization is enforced to allow only authorized users to delete activities, while also providing appropriate error handling for cases where the activity may not be found or the user does not have access rights. Upon successful deletion, the endpoint returns a 204 No Content status code, indicating that the activity has been successfully removed from the system without returning any content in the response body.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<DeleteActivitiesByIdData, ThrowOnError>

Returns

RequestResult<DeleteActivitiesByIdResponses, DeleteActivitiesByIdErrors, ThrowOnError>