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

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

Example

{
  "displayName": "x"
}

Result

Returns a typed person.updateDisplayName 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 person resource to confirm the result.

Compatibility: a124060401f6f01824c7bd4395853a44fc71ae62b33ae7bff419021008006644.