Delete a memo | Memos unofficial

2 parameters

memostringrequired

The identifier of the memo to delete.

forcebooleanoptional

Set to true to delete the memo even if it has associated data.

2 status codes

200Confirms that the memo was deleted.

defaultReturned when the request fails; includes an error code, a developer-facing message, and optional error details.

codeintegeroptional

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestringoptional

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsarray<object>optional

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Error handling

The memo path parameter must identify the memo to delete. Set force to true if you want deletion to proceed when the memo has associated data; deletion removes incident relations but does not delete other memos.

import { Client } from "memos-unofficial-sdk";

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

const result = await client.memos.delete({
  memo: "example",
  force: "example",
});

{
  "code": "123456",
  "message": "This is an example message.",
  "details": [
    {
      "@type": "example_value"
    }
  ]
}

Request

Response

Errors