AblyDocs

Channels annotations delete

Open in

Use the ably channels annotations delete command to delete an annotation from a channel message.

Synopsis

ably channels annotations delete <channel-name> <message-serial> <annotation-type> [options]

Arguments

channel-name
Required

The name of the channel containing the message.

message-serial
Required

The serial of the message to delete the annotation from.

annotation-type
Required

The annotation type to delete, specified in the format namespace:summarization.version. The namespace is a custom string that groups related annotations, such as reactions, categories, metrics, rating etc. For example, reactions:unique.v1 or receipts:flag.v1.

The following summarization methods are available:

MethodDescription
total.v1Counts all annotations without client attribution. Unidentified clients can publish this type.
flag.v1Counts distinct clients contributing once per type. Requires an identified client.
distinct.v1Counts unique clients per annotation name. Each client contributes once per name. Requires an identified client.
unique.v1Guarantees each client contributes to only one name at a time. Publishing a new name auto-removes the previous one. Requires an identified client.
multiple.v1Tracks per-client and total counts. A client can contribute to the same annotation name multiple times. Requires an identified client.

See the annotations documentation for more details.

Options

--name | -n

The annotation name to delete. Use this to target a specific annotation when multiple annotations of the same type exist.

--client-id

A client ID to use when deleting the annotation.

--json

Output results as compact JSON. Mutually exclusive with --pretty-json.

--pretty-json

Output results in formatted JSON. Mutually exclusive with --json.

--verbose | -v

Enable verbose logging. Can be combined with --json or --pretty-json.

Examples

Delete a receipt annotation:

ably channels annotations delete my-channel "msg-serial" "receipts:unique.v1"

Delete a reaction by name:

ably channels annotations delete my-channel "msg-serial" "reactions:unique.v1" --name thumbsup

Delete a flag-type annotation such as a read receipt:

ably channels annotations delete my-channel "msg-serial" "receipts:flag.v1"

Delete a distinct category annotation by name:

ably channels annotations delete my-channel "msg-serial" "categories:distinct.v1" --name important

Delete an annotation and output the result in JSON format:

ably channels annotations delete my-channel "msg-serial" "receipts:flag.v1" --json

See also

  • Channels — Explore all ably channels commands.
  • CLI reference — Full list of available commands.