canvas.invites.preview

query read

Use when current canvas state is needed before deciding or changing anything.

Before calling

• Authenticate as the accountable Enhance person.
• Use only resource identifiers returned by an earlier capability result or supplied by the person.

Input

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512
    }
  },
  "required": [
    "token"
  ],
  "additionalProperties": false
}

Example

{
  "token": "x"
}

Result

Returns a typed canvas.invites.preview 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

• Use the returned identifiers and version in the next canvas operation.

Compatibility: 151596b0e44a38afe95abaa97a1275a90b66675647c8a067b99b0a15b315b49b.