AdminInvitationCodeService
Chatto exposes this service below /api/connect.
Shared message and enum definitions are documented in Shared Types And Enums.
AdminInvitationCodeService
Section titled “AdminInvitationCodeService”Issues and manages registration codes. user.invite permits access to own codes. Effective user.manage-invites permits access to all codes and requires privileged mode for human sessions. External systems can issue codes with an authorized API credential.
ListInvitationCodes
Section titled “ListInvitationCodes”Lists visible current and historical codes. Pagination and totals include only visible codes.
POST /api/connect/chatto.admin.v1.AdminInvitationCodeService/ListInvitationCodesInput: ListInvitationCodesRequest
Section titled “Input: ListInvitationCodesRequest”Lists codes newest first, with ID as the tie-breaker.
| Field | Type | Description |
|---|---|---|
page | chatto.api.v1.PageRequest | Default limit: 20. Maximum: 100. |
Result: ListInvitationCodesResponse
Section titled “Result: ListInvitationCodesResponse”No message description provided.
| Field | Type | Description |
|---|---|---|
invitation_codes | repeated InvitationCode | No field description provided. |
page | chatto.api.v1.PageInfo | No field description provided. |
GetInvitationCode
Section titled “GetInvitationCode”Reads a code by ID. Returns NOT_FOUND for an unknown or inaccessible ID.
POST /api/connect/chatto.admin.v1.AdminInvitationCodeService/GetInvitationCodeInput: GetInvitationCodeRequest
Section titled “Input: GetInvitationCodeRequest”No message description provided.
| Field | Type | Description |
|---|---|---|
id | string | No field description provided. |
Result: GetInvitationCodeResponse
Section titled “Result: GetInvitationCodeResponse”No message description provided.
| Field | Type | Description |
|---|---|---|
invitation_code | InvitationCode | No field description provided. |
CreateInvitationCode
Section titled “CreateInvitationCode”Creates a code that expires seven days after creation for every caller. Not idempotent: retrying creates another code.
POST /api/connect/chatto.admin.v1.AdminInvitationCodeService/CreateInvitationCodeInput: CreateInvitationCodeRequest
Section titled “Input: CreateInvitationCodeRequest”Creates one single-use code. The server sets expiry to seven days after creation.
| Field | Type | Description |
|---|---|---|
note | string | Optional plain-text note, up to 250 Unicode characters. Surrounding whitespace is removed. Visible to the creator and invitation managers; it does not bind the code to a recipient. |
Result: CreateInvitationCodeResponse
Section titled “Result: CreateInvitationCodeResponse”No message description provided.
| Field | Type | Description |
|---|---|---|
invitation_code | InvitationCode | No field description provided. |
RevokeInvitationCode
Section titled “RevokeInvitationCode”Revokes a code without deleting its history. Repeating revocation is safe. Returns NOT_FOUND for an unknown or inaccessible ID.
POST /api/connect/chatto.admin.v1.AdminInvitationCodeService/RevokeInvitationCodeInput: RevokeInvitationCodeRequest
Section titled “Input: RevokeInvitationCodeRequest”No message description provided.
| Field | Type | Description |
|---|---|---|
id | string | No field description provided. |
Result: RevokeInvitationCodeResponse
Section titled “Result: RevokeInvitationCodeResponse”No message description provided.
| Field | Type | Description |
|---|---|---|
invitation_code | InvitationCode | No field description provided. |