Enhance documentation
canvas.invites.accept
Accept a canvas invitation using its secret token.
canvas.invites.accept
mutation write
Use when the requested change exactly matches canvas.invites.accept; 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": {
"token": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"token"
],
"additionalProperties": false
}
Example
Show example input
{
"token": "x"
}
Result
Returns a typed canvas.invites.accept 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 canvas resource to confirm the result.
Compatibility: b7c288409eedea08a46a21c21e1dfb0c7cc4df9d6a3be2d7571ef8dc19b2d09d.