Skip to main content

forceReservation

client.mail.forceReservation(data: ForceReservationRequest): Promise<void>

Force-releases a reservation, overriding the owning agent's hold.

Forcefully frees a resource reservation regardless of the current owner. Use this as an administrative override when an agent has become unresponsive or the reservation is stale.

Parameters

ParameterTypeRequiredDescription
dataForceReservationRequestYesThe force-release payload

Returns

Promise<void> — A promise that resolves when the reservation has been forcefully released

Example

import { CodeBoltClient } from '@codebolt/clientsdk';

const client = new CodeBoltClient();

const result = await client.mail.forceReservation(/* ForceReservationRequest */);
console.log(result);