organisation.people.add

mutation write

Use when the requested change exactly matches organisation.people.add; 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": {
  "organisationId": {
   "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)$"
  },
  "email": {
   "type": "string",
   "maxLength": 254,
   "format": "email",
   "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
  },
  "role": {
   "default": "member",
   "type": "string",
   "enum": [
    "admin",
    "member"
   ]
  }
 },
 "required": [
  "organisationId",
  "email",
  "role"
 ],
 "additionalProperties": false
}

Example

{
 "organisationId": "00000000-0000-4000-8000-000000000010",
 "email": "agent@example.test",
 "role": "member"
}

Result

Returns a typed organisation.people.add 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: 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 organisation resource to confirm the result.

Compatibility: 6cbadfa8df6adcda399770c0a772e889aaf051e42c3b6b8b2737082e4835a141.