Delete a help center article

1 parameter

idstringrequired

The unique identifier of the article to delete.

3 status codes

204Returns no response body and confirms the article was deleted.

401Returned when the request does not include valid authentication credentials.

errorobjectoptional

404Returned when no article exists with the given identifier.

errorobjectoptional

Error handling

A 401 is returned when the request does not include valid authentication credentials. A 404 is returned when no article exists with the given id path parameter.

import { Client } from "supdesk-sdk";

const client = new Client({
  baseUrl: "https://api.supdesk.app",
});

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

{
  "error": {
    "code": "123456",
    "message": "This is an example message."
  }
}

Request

Response

Errors