Delete a conversation | Sample

1 parameter

conversation_idstringrequired

The ID of the conversation to delete.

2 status codes

200Success

objectstringrequired

Allowed:conversation.deletedDefault:conversation.deleted

deletedbooleanrequired

idstringrequired

429The request was rejected because a rate limit was exceeded.

errorobjectrequired

Error handling

A 429 is returned: The request was rejected because a rate limit was exceeded.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.conversations.delete({ conversationId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "object": "conversation.deleted",
  "deleted": true,
  "id": "550e8400-e29b-41d4-a716-446655440000"
}

Request

Response

Errors