Enhance documentation

enhance-dev organisation invites create

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

enhance-dev organisation invites create

enhance-dev organisation invites create [options]

Arguments

This command takes no positional arguments.

Options

Option	Required	Default	Meaning
`--organisation-id <string>`	Yes	None	Team id, from `enhance organisation list`.
`--email <string>`	Yes	None	Email address of the person to invite or add.
`--role [string]`	No	`member`	Team role to grant: admin or member.
`--content-access [string]`	No	`can-comment`	Team content access to grant independently of its administrative role: can-edit, can-comment, or can-view.
`--json <json>`	No	None	Complete procedure input as JSON; do not combine it with field flags.
`--client-token <uuid>`	No	None	Stable UUID to reuse when retrying the exact same mutation.

Input

This command presents the capability organisation.invites.create. It has write effect and single idempotency.

Show complete input 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"]}

Output

This command writes JSON records to standard output. Returns a typed organisation.invites.create result from the Enhance API without transport-specific prose.

Show complete output 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}]}

Examples

enhance-dev organisation invites create --organisation-id <string> --email <string>

Show example input

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

Show example output

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

Exit behaviour

Exit code	Meaning
`0`	The command succeeded.
`1`	The command failed for another reason (`INTERNAL`). A write may have an unknown outcome.
`2`	The command line was malformed. Nothing ran.
`3`	The API refused the input (`BAD_REQUEST`).
`4`	The credential is missing or expired (`UNAUTHORIZED`).
`5`	The API refused the request (`FORBIDDEN`, `NOT_FOUND`, `CONFLICT`, `RATE_LIMITED`).
`6`	A batch finished only in part. Retry with the same `--client-token`.

Versions

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