enhancedocs
For agentsOpen Enhance ↗
Reference / organisation.invites.create

Enhance documentation

organisation.invites.create

Invite an email address to join a team with the selected role.

↓ Markdown

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

Show complete JSON Schema 
{"$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

Show example input 
{
 "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.

Show complete result JSON Schema 
{"$schema":"https://json-schema.org/draft/2020-12/schema","oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"personId":{"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)$"}},"required":["kind","personId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"invitation"},"invite":{"type":"object","properties":{"inviteId":{"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","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"contentAccess":{"default":"can-comment","type":"string","enum":["can-view","can-comment","can-edit"]},"role":{"type":"string","enum":["admin","member"]},"sendCount":{"type":"integer","minimum":1,"maximum":9007199254740991},"lastSentAt":{"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))$"},"expiresAt":{"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))$"},"state":{"type":"string","enum":["pending","expired"]},"deliveryState":{"type":"string","enum":["queued","accepted","failed"]},"deliveryError":{"type":"string"}},"required":["inviteId","email","contentAccess","role","sendCount","lastSentAt","expiresAt","state","deliveryState","deliveryError"],"additionalProperties":false}},"required":["kind","invite"],"additionalProperties":false}]}

Example result

Show example result 
{
 "kind": "member",
 "personId": "00000000-0000-4000-8000-000000000010"
}

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.

Versions

Compatibility: ed10fc136e692873b5a5ae1244d38c8644b165699a005363bcca130240fb5731.

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