Skip to content
Get started

Delete a worker template

client.workers.delete(stringworkerID, RequestOptionsoptions?): DeleteWorkerResponse { deleted }
DELETE/api/workers/{workerId}

Soft-delete a worker template so it no longer appears in list or retrieve endpoints. Tasks, turns, files, schedules, and integrations remain in the database for analytics. Only the worker creator can delete a worker.

ParametersExpand Collapse
workerID: string
ReturnsExpand Collapse
DeleteWorkerResponse { deleted }
deleted: boolean

Delete a worker template

import Handinger from '@ramensoft/handinger';

const client = new Handinger({
  apiKey: process.env['HANDINGER_API_KEY'], // This is the default and can be omitted
});

const deleteWorkerResponse = await client.workers.delete('t_org_123_w_01HZY2ZJQ8G7K42W2D7WF6V4GM');

console.log(deleteWorkerResponse.deleted);
{
  "deleted": true
}
Returns Examples
{
  "deleted": true
}