organisation.invites.create

mutation write

Use when the requested change exactly matches organisation.invites.create; 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},"role":{"default":"member","type":"string","enum":["admin","member"]},"contentAccess":{"default":"can-comment","type":"string","enum":["can-view","can-comment","can-edit"]}},"required":["organisationId","email"]}

Example

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

Result

Returns a typed organisation.invites.create 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: ed10fc136e692873b5a5ae1244d38c8644b165699a005363bcca130240fb5731.