enhancedocs
For agentsOpen Enhance ↗
Reference / person.updateDisplayName

Enhance documentation

person.updateDisplayName

Change the name shown for the current person throughout Enhance.

↓ Markdown

person.updateDisplayName

mutation write

Use when the requested change exactly matches person.updateDisplayName; 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":{"displayName":{"type":"string","minLength":1,"maxLength":120}},"required":["displayName"]}

Example

Show example input 
{
 "displayName": "x"
}

Result

Returns a typed person.updateDisplayName result from the Enhance API without transport-specific prose.

  • person (required): Returned field person.
Show complete result JSON Schema 
{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"person":{"type":"object","properties":{"id":{"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)$"},"preparedCanvasId":{"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)$"},"displayName":{"type":"string","minLength":1,"maxLength":120},"initials":{"type":"string","minLength":1,"maxLength":4},"avatarUrl":{"anyOf":[{"type":"string","maxLength":2048},{"type":"null"}]},"email":{"anyOf":[{"type":"string","maxLength":254},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["id","preparedCanvasId","displayName","initials","avatarUrl","email","createdAt"],"additionalProperties":false}},"required":["person"],"additionalProperties":false}

Example result

Show example result 
{
 "person": {
  "id": "00000000-0000-4000-8000-000000000010",
  "preparedCanvasId": "00000000-0000-4000-8000-000000000010",
  "displayName": "x",
  "initials": "x",
  "avatarUrl": "x",
  "email": "x",
  "createdAt": "2026-08-10T00:00:00.000Z"
 }
}

Recovery

  • BAD_REQUEST: correct the named fields and call again.
  • UNAUTHORIZED: restore Enhance authentication, then retry once.
  • FORBIDDEN or NOT_FOUND: check the supplied resource and selection; do not substitute unrelated content. Ask for corrected access or scope if needed.
  • 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 person resource to confirm the result.

Versions

Compatibility: 87de82e443bb2a517fd5584ffd918e91f6899a721c282310301de6e8e61fc51a.

Minimum tested versions: Enhance CLI and MCP runtime 0.1.40, plugin 1.0.38, Node.js 24. No older floor is published.