Skip to content
Dashboard

Delete a response

client.responses.delete(stringid, RequestOptionsoptions?): ResponseDeleteResponse { id, deleted, object }
DELETE/v1/responses/{id}

Permanently delete a response and all its output items.

ParametersExpand Collapse
id: string
ReturnsExpand Collapse
ResponseDeleteResponse { id, deleted, object }
id?: string
deleted?: boolean
object?: string

Delete a response

import Lightcone from '@tzafon/lightcone';

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

const response = await client.responses.delete('id');

console.log(response.id);
{
  "id": "id",
  "deleted": true,
  "object": "object"
}
Returns Examples
{
  "id": "id",
  "deleted": true,
  "object": "object"
}