social.colibri.beta.community.createInvitation

Creates an invitation code for a community.

Repository @colibri.social did:plc:mprdjqjluoswa7awzggaggj3 namespace authority
Details · procedure
Kindprocedure
Authoritycommunity.beta.colibri.social
Indexed

Procedure

procedure · POST

Input

application/json

community

requiredstring · did

The community to create an invitation for.

expiresAt

string · datetime

When the invitation stops being redeemable, if ever.

maxUses

integer

How many times the invitation may be redeemed, if limited.

  • minimum: 1

Output

application/json

invitation

requiredref

The newly created invitation.

Errors

AuthRequired

The request is missing, malformed, or unverifiable service auth.

Forbidden

The requesting user lacks the invitation.create permission.

CommunityNotFound

No community exists with that DID.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.