enhancedocs
For agentsOpen Enhance ↗
Reference / comment.react

Enhance documentation

comment.react

Set or remove one emoji reaction on a comment message.

↓ Markdown

comment.react

mutation write

Use when the requested change exactly matches comment.react; read the current state first when a version or identifier may have changed.

Before calling

  • Authenticate as the accountable Enhance person.
  • Use only resource identifiers returned by an earlier capability result or supplied by the person.
  • Reuse clientToken only when retrying this exact mutation input.

Input

Show complete JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "canvasId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "threadId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "messageId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "emoji": {
      "type": "string",
      "minLength": 1,
      "maxLength": 16
    },
    "reacted": {
      "type": "boolean"
    }
  },
  "required": [
    "canvasId",
    "threadId",
    "messageId",
    "emoji",
    "reacted"
  ],
  "additionalProperties": false
}

Example

Show example input 
{
  "canvasId": "00000000-0000-4000-8000-000000000010",
  "threadId": "00000000-0000-4000-8000-000000000010",
  "messageId": "00000000-0000-4000-8000-000000000010",
  "emoji": "x",
  "reacted": false
}

Result

Returns a typed comment.react result from the Enhance API without transport-specific prose.

Recovery

  • BAD_REQUEST: correct the named fields and call again.
  • UNAUTHORIZED: restore Enhance authentication, then retry once.
  • FORBIDDEN or NOT_FOUND: list accessible resources and choose an allowed identifier.
  • CONFLICT: read the current resource, merge the intended change, and retry with its version.
  • INTERNAL: run Enhance diagnostics, report the failure, and stop repeating the call.

Continue with

  • Read the affected comment resource to confirm the result.

Compatibility: bc04729e19fc5324e20bc23d8a9436e93edad1a9d048a75a16cb73c3ff88b9b1.